Add support for Rule Backgrounds. #2668

clrudolphi · 2022-10-28T17:52:32Z

This PR adds support for Rule Backgrounds.

Most of the additional logic has been added to the ScenarioPartHelper class:

logic to examine the Feature AST for Rules that have Backgrounds and generate the statement codes for each.
logic to identify which rule (if any) a given scenario belongs to (during scenario generation to find out which, if any, rule background steps to include)
The UnitTestMethodGenerator is modified to include the relevant rule background statements in the scenario

Types of changes

Bug fix (non-breaking change which fixes an issue).
[X ] New feature (non-breaking change which adds functionality).
Breaking change (fix or feature that would cause existing functionality to not work as expected).
Performance improvement
Refactoring (so no functional change)
Other (docs, build config, etc)

Checklist:

[X ] I've added tests for my code. (most of the time mandatory)
[X ] I have added an entry to the changelog. (mandatory)
My change requires a change to the documentation.
I have updated the documentation accordingly.

clrudolphi · 2022-10-28T17:53:53Z

Open to suggestions for improvements.
I will be adding tests to the Specs project. Considering adding a dedicated unit test project for this -- let me know whether you think that worthwhile.

…and code. Lacks tests.

gasparnagy

I think this is generally fine, thx! Please check my smaller notes below.

TechTalk.SpecFlow.Generator/Generation/ScenarioPartHelper.cs

TechTalk.SpecFlow.Generator/Generation/UnitTestMethodGenerator.cs

TechTalk.SpecFlow.Generator/Generation/ScenarioPartHelper.cs

Tests/TechTalk.SpecFlow.Specs/Features/Parser/RuleSupport.feature

…ethodBody to accept a ScenarioDefinitionInFeatureFile instead of an AST Scenario. This allows simpler tracking of the relationship between Scenario and Rule. Refactored Rule Background support in ScenarioPartHelper to simplify the code and accept changes suggested during PR review.

…h multiple Rules, each having a Background; the Background steps should only be executed for the Scenario(s) within their respective Rule.

clrudolphi · 2022-11-02T19:57:08Z

@gasparnagy Thank you so much for the review comments and suggestions! I've incorporated your suggestions, resulting in a greatly simplified implementation (largely isolated to the SPH).
Would welcome any further suggestions you might have.

I am having a problem with adding a Feature file to the SpecFlow.Specs tests however. Pls see my latest commit to this PR (#565afff). When executed the test fails with a TechTalk.SpecFlow.BindingException "Ambiguous step definitions..."
The exact error message related to the first scenario of the feature file is:
Error Message:
TechTalk.SpecFlow.BindingException : Ambiguous step definitions found for step 'Given something first as background': DefaultTestProject:RuleSteps1.GivenSomethingFirst(), DefaultTestProject:BindingsClass_76ec255a.StepBinding()
Stack Trace:
at TechTalk.SpecFlow.Infrastructure.TestExecutionEngine.GetStepMatch(StepInstance stepInstance)

Any suggestions?

…methods together.

clrudolphi · 2022-11-08T20:05:37Z

@gasparnagy never mind on the problem with ambiguous step definitions; I figured it out. My problem :).

This PR ready for final review/approval.

gasparnagy

Please remove that one scenario and then we are ready to go, i think.

Tests/TechTalk.SpecFlow.Specs/Features/Parser/RuleSupport.feature

SabotageAndi · 2022-11-09T10:04:13Z

Tests/TechTalk.SpecFlow.Specs/Features/Execution/RuleBackgroundExecution.feature

+		     public class RuleSteps1
+		     {
+
+			    [Given("something first as background")]


Is this formatting only broken on GitHub or also in VS?
If so, please fix it. Thanks

It is really hard to read for me in this style

@SabotageAndi I have rewritten this feature file in an attempt to improve its readability. Please let me know what you think.
RuleBackgroundExecution.feature

…cFlow.

…ub.com/clrudolphi/SpecFlow into SF2664_Add_Support_for_Rule_Background

clrudolphi · 2022-11-09T16:18:06Z

Please remove that one scenario and then we are ready to go, i think.

Removed. This feature file now reverted to what is in Master.

clrudolphi · 2022-11-22T18:40:46Z

@gasparnagy @SabotageAndi - checking in with you on this. I believe all prior suggestions/concerns are addressed. Are there any other changes you would like to see?

gasparnagy · 2022-12-15T17:48:14Z

@clrudolphi Thx! It took a bit more time... sry

praticandobdd · 2023-02-27T18:33:46Z

@SabotageAndi great news! awesome feature! Congrats.

GondilOndro · 2023-03-21T07:43:07Z

Has this already been released? Can't see it working in latest SpecFlow for Visual Studio 2022 released Dec 20 2022

clrudolphi · 2023-03-21T15:03:53Z

Has this already been released? Can't see it working in latest SpecFlow for Visual Studio 2022 released Dec 20 2022

It was incorporated into the v4.0.31-beta build (built on 15 Dec 22).

* Add support for Rule Backgrounds. Preliminary commit. Lacks tests. * Add support for Rule Backgrounds.Revised Commit to simplify approach and code. Lacks tests. * Refactored signature of method: UnitTestMethodGenerator.GenerateTestMethodBody to accept a ScenarioDefinitionInFeatureFile instead of an AST Scenario. This allows simpler tracking of the relationship between Scenario and Rule. Refactored Rule Background support in ScenarioPartHelper to simplify the code and accept changes suggested during PR review. * Adding a feature file in the Specs tests to demonstrate a Feature with multiple Rules, each having a Background; the Background steps should only be executed for the Scenario(s) within their respective Rule. * Further simplification of Rule support in SPH by merging two private methods together. * Corrected feature's binding code. Tests now pass. * Updating changelog * Reverting this feature back to the version present in SpecFlowOSS/SpecFlow. * Refactored/revised to improve readabliity and formatting Co-authored-by: Gáspár Nagy <[email protected]>

Add support for Rule Backgrounds. Preliminary commit. Lacks tests.

2c66944

Add support for Rule Backgrounds.Revised Commit to simplify approach …

bb93147

…and code. Lacks tests.

clrudolphi changed the title ~~Add support for Rule Backgrounds. Preliminary commit. Lacks tests.~~ Add support for Rule Backgrounds. Oct 29, 2022

gasparnagy mentioned this pull request Nov 2, 2022

Background not executing at Rule level #2664

Closed

gasparnagy requested changes Nov 2, 2022

View reviewed changes

clrudolphi added 2 commits November 2, 2022 14:22

Adding a feature file in the Specs tests to demonstrate a Feature wit…

565afff

…h multiple Rules, each having a Background; the Background steps should only be executed for the Scenario(s) within their respective Rule.

clrudolphi added 2 commits November 2, 2022 15:04

Further simplification of Rule support in SPH by merging two private …

85f54d5

…methods together.

Corrected feature's binding code. Tests now pass.

c534872

clrudolphi marked this pull request as ready for review November 8, 2022 20:05

clrudolphi and others added 2 commits November 8, 2022 14:07

Updating changelog

fbff15f

Merge branch 'master' into SF2664_Add_Support_for_Rule_Background

42fce5b

gasparnagy approved these changes Nov 9, 2022

View reviewed changes

Tests/TechTalk.SpecFlow.Specs/Features/Parser/RuleSupport.feature Outdated Show resolved Hide resolved

SabotageAndi reviewed Nov 9, 2022

View reviewed changes

clrudolphi added 3 commits November 9, 2022 09:11

Reverting this feature back to the version present in SpecFlowOSS/Spe…

4a84874

…cFlow.

Refactored/revised to improve readabliity and formatting

ab1a52e

Merge branch 'SF2664_Add_Support_for_Rule_Background' of https://gith…

f92020e

…ub.com/clrudolphi/SpecFlow into SF2664_Add_Support_for_Rule_Background

gasparnagy merged commit 8e0e7d4 into SpecFlowOSS:master Dec 15, 2022

gritcsenko mentioned this pull request Apr 30, 2023

Use backgrounds in SpecFlow gritcsenko/HomeInventory#232

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Rule Backgrounds. #2668

Add support for Rule Backgrounds. #2668

clrudolphi commented Oct 28, 2022 •

edited

Loading

clrudolphi commented Oct 28, 2022

gasparnagy left a comment

clrudolphi commented Nov 2, 2022

clrudolphi commented Nov 8, 2022

gasparnagy left a comment

SabotageAndi Nov 9, 2022

SabotageAndi Nov 9, 2022

clrudolphi Nov 9, 2022

clrudolphi commented Nov 9, 2022

clrudolphi commented Nov 22, 2022

gasparnagy commented Dec 15, 2022

praticandobdd commented Feb 27, 2023

GondilOndro commented Mar 21, 2023 •

edited

Loading

clrudolphi commented Mar 21, 2023

Add support for Rule Backgrounds. #2668

Add support for Rule Backgrounds. #2668

Conversation

clrudolphi commented Oct 28, 2022 • edited Loading

Types of changes

Checklist:

clrudolphi commented Oct 28, 2022

gasparnagy left a comment

Choose a reason for hiding this comment

clrudolphi commented Nov 2, 2022

clrudolphi commented Nov 8, 2022

gasparnagy left a comment

Choose a reason for hiding this comment

SabotageAndi Nov 9, 2022

Choose a reason for hiding this comment

SabotageAndi Nov 9, 2022

Choose a reason for hiding this comment

clrudolphi Nov 9, 2022

Choose a reason for hiding this comment

clrudolphi commented Nov 9, 2022

clrudolphi commented Nov 22, 2022

gasparnagy commented Dec 15, 2022

praticandobdd commented Feb 27, 2023

GondilOndro commented Mar 21, 2023 • edited Loading

clrudolphi commented Mar 21, 2023

clrudolphi commented Oct 28, 2022 •

edited

Loading

GondilOndro commented Mar 21, 2023 •

edited

Loading