Fix gherkin terminal report colouring #372

hristiy4n · 2020-06-20T14:49:29Z

Add a extra hook to mark steps as skipped, which will allow to distinguish if a step is skipped or not and therefor the output colouring could be done properly.

This PR closes #214 #299 #248

codecov · 2020-06-24T18:33:50Z

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.06 🎉

Comparison is base (d45c543) 95.40% compared to head (4533677) 95.47%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #372      +/-   ##
==========================================
+ Coverage   95.40%   95.47%   +0.06%     
==========================================
  Files          49       49              
  Lines        1764     1789      +25     
  Branches      193      196       +3     
==========================================
+ Hits         1683     1708      +25     
  Misses         53       53              
  Partials       28       28

Impacted Files	Coverage Δ
src/pytest_bdd/gherkin_terminal_reporter.py	`81.81% <100.00%> (+0.27%)`	⬆️
src/pytest_bdd/hooks.py	`100.00% <100.00%> (ø)`
src/pytest_bdd/parser.py	`98.64% <100.00%> (+0.01%)`	⬆️
src/pytest_bdd/plugin.py	`98.21% <100.00%> (+0.10%)`	⬆️
src/pytest_bdd/reporting.py	`90.76% <100.00%> (+1.88%)`	⬆️
src/pytest_bdd/scenario.py	`93.15% <100.00%> (+0.14%)`	⬆️
tests/feature/test_report.py	`77.50% <100.00%> (+1.82%)`	⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

olegpidsadnyi

Looks good to me

JagadeeshJayachandran · 2021-09-13T13:17:30Z

any update on this, please.

moorchegue · 2023-05-22T15:47:38Z

Merge, please?

Warzroth · 2023-06-16T08:38:56Z

@hristiy4n Could you rebase your code and submit it again ? I'd love to have this feature.

- the skipped parameter can be used to track which steps have been skipped and adjust the behaviour appropriatelly (ex. change the output colour to yellow)

- the hook and the pluging work in a similar way to the fail hook and plugin where they set a flag wether the step is skipped or not

- trigger the skip hook if a step is skipped

- use the output of the individual steps to decide the output colour

- the PR proposes to expand the step with an additional skipped bool, to track weather the step has been skipped or not, therefor the expected behaviour of the steps in the tests should be modified

- when a step is skipped the step should have skipped set to True

for more information, see https://pre-commit.ci

hristiy4n · 2023-06-18T11:06:13Z

I rebased the MR, lets hope it gets merged this time.

Warzroth · 2023-06-21T12:12:58Z

@youtux Could you please review this ? I'd like to avoid it to fall back into oblivion.

Warzroth · 2023-06-30T13:13:19Z

@hristiy4n Could you ask for another reviewer ?

Warzroth · 2023-07-10T12:37:30Z

@hristiy4n ?

hristiy4n · 2023-07-10T12:55:21Z

@hristiy4n Could you ask for another reviewer ?

I re-requested the review from @olegpidsadnyi. I do not think I have the permissions to request a review from someone else.

Warzroth · 2023-07-10T14:08:36Z

@olegpidsadnyi @youtux Sorry for the brute forcing, but could you please review this please ?

olegpidsadnyi · 2023-07-10T14:55:58Z

@olegpidsadnyi @youtux Sorry for the brute forcing, but could you please review this please ?

I looked into the cucumber spec, I don't see any magic tag that skips the scenario from the scenario definition itself. So the cucumber is deselecting them from the command line by negating the tags. It could be any tag.
Pytest has similar CLI where you can pass the tags and we could utilize the pytest collection mechanism and hooks.
Is this PR introducing some magic tag? Do we delegate the skipping to the scenario execution itself instead of the pytest collection and run mechanism? How is it in line with pytest and with the cucumber?

Warzroth · 2023-07-21T07:18:03Z

@hristiy4n ?

Warzroth · 2023-08-02T15:11:14Z

@hristiy4n ?

hristiy4n force-pushed the fix-gherkin-terminal-report-coloring branch 2 times, most recently from aeca959 to e6bfb7e Compare June 24, 2020 18:28

hristiy4n force-pushed the fix-gherkin-terminal-report-coloring branch 2 times, most recently from e60130e to a050720 Compare June 25, 2020 07:59

olegpidsadnyi previously approved these changes Aug 17, 2021

View reviewed changes

olegpidsadnyi requested a review from youtux August 17, 2021 19:07

dsax7 added 6 commits June 18, 2023 12:24

Add skipped parameter to steps

8897a41

- the skipped parameter can be used to track which steps have been skipped and adjust the behaviour appropriatelly (ex. change the output colour to yellow)

Add hook and plugin to modify steps when skipped

a2e48b1

- the hook and the pluging work in a similar way to the fail hook and plugin where they set a flag wether the step is skipped or not

Use the skip hook and plugin if the step is skipped

0a8a4e3

- trigger the skip hook if a step is skipped

Color the steps independently of the scenario

bf2057a

- use the output of the individual steps to decide the output colour

Modify report test

9529e46

- the PR proposes to expand the step with an additional skipped bool, to track weather the step has been skipped or not, therefor the expected behaviour of the steps in the tests should be modified

Extend test_report with a skipping scenario

6eca0a3

- when a step is skipped the step should have skipped set to True

hristiy4n dismissed olegpidsadnyi’s stale review via 6eca0a3 June 18, 2023 11:00

hristiy4n force-pushed the fix-gherkin-terminal-report-coloring branch from a050720 to 6eca0a3 Compare June 18, 2023 11:00

[pre-commit.ci] auto fixes from pre-commit.com hooks

4533677

for more information, see https://pre-commit.ci

hristiy4n requested a review from olegpidsadnyi July 10, 2023 12:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix gherkin terminal report colouring #372

Fix gherkin terminal report colouring #372

hristiy4n commented Jun 20, 2020

codecov bot commented Jun 24, 2020 •

edited

olegpidsadnyi left a comment

JagadeeshJayachandran commented Sep 13, 2021

moorchegue commented May 22, 2023

Warzroth commented Jun 16, 2023

hristiy4n commented Jun 18, 2023

Warzroth commented Jun 21, 2023

Warzroth commented Jun 30, 2023

Warzroth commented Jul 10, 2023

hristiy4n commented Jul 10, 2023

Warzroth commented Jul 10, 2023 •

edited

olegpidsadnyi commented Jul 10, 2023

Warzroth commented Jul 21, 2023

Warzroth commented Aug 2, 2023

Fix gherkin terminal report colouring #372

Are you sure you want to change the base?

Fix gherkin terminal report colouring #372

Conversation

hristiy4n commented Jun 20, 2020

codecov bot commented Jun 24, 2020 • edited

Codecov Report

olegpidsadnyi left a comment

Choose a reason for hiding this comment

JagadeeshJayachandran commented Sep 13, 2021

moorchegue commented May 22, 2023

Warzroth commented Jun 16, 2023

hristiy4n commented Jun 18, 2023

Warzroth commented Jun 21, 2023

Warzroth commented Jun 30, 2023

Warzroth commented Jul 10, 2023

hristiy4n commented Jul 10, 2023

Warzroth commented Jul 10, 2023 • edited

olegpidsadnyi commented Jul 10, 2023

Warzroth commented Jul 21, 2023

Warzroth commented Aug 2, 2023

codecov bot commented Jun 24, 2020 •

edited

Warzroth commented Jul 10, 2023 •

edited