search

behave-contrib / behave-html-pretty-formatter

HTML Pretty formatter for Behave
GNU General Public License v3.0
13 stars 4 forks source link

Embed the feature description in the report #24

Closed lu-maca closed 1 year ago

lu-maca commented 1 year ago

Hi,

is it possible to add the feature description in the report?

For example:

Feature: feature name
     Here I test some requirements related to some functionality...

Luca

modehnal commented 1 year ago

So while behave supports this and we could add this. The main panel with feature name is supposed to be clean and serve as a kind of divider between other features.

i suppose you want a multiline description and not a single comment under feature which could simply be used like this, correct? Feature: feature name: Here I test some requirements related to some functionality...

In effect you would use this as follows?

Feature: feature name
     Description 1
     Description 2
     Description 3
modehnal commented 1 year ago

@lu-maca Would this be acceptable? We have come to an agreement with @fpokryvk that this does not look bad, the margins and padding can be adjusted but at least the commentary is not located in the main feature panel.

If there is a feature commentary the scenaros status will get moved to the right and commentary will take its place. test_image_feature_info

Without any commentary the result is as usual. example_original

The commentary in feature files is done simply by 

@dummy
Feature: Test
  This is a test to see how big the entire space is and when the wrap will happen.
  This is another
  Hello there!

The behave will return the text to us from feature.description in form of a list of strings.

lu-maca commented 1 year ago

@modehnal this is good to me, sure!

modehnal commented 1 year ago

Very well, tomorrow I will do a pull request with these changes.

I have already made some cleanup we wanted to do with more coming this week. I believe this week I will have enough time to focus on this project and release 1.5 with all the changes.

lu-maca commented 1 year ago

Thank you @modehnal, appreciate that!