Adding support for JavaScript String interpolation in Scenario Names a… #1416

joelpramos · 2020-12-28T21:46:53Z

Description

Thanks for contributing this Pull Request. Make sure that you submit this Pull Request against the develop branch of this repository, add a brief description, and tag the relevant issue(s) and PR(s) below.

Relevant Issues : Replace token values with nested json (from Examples Table) #1413
Relevant PRs : (optional)
Type of change :
- New feature
- Bug fix for existing feature
- Code quality improvement
- Addition or Improvement of tests
- Addition or Improvement of documentation

…nd Descriptions

ptrthomas · 2020-12-29T03:45:45Z

karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java

+        }
+    }
+
+    public void evaluateScenarioDescription() {


is fixing the description really necessary (then I have to include this in the JSON when we serialize a test result)

is supporting the \ to spill over 2 lines really necessary

I'd like to keep it simple :|

what I meant when I said we need to care about multiple lines is I believe the first line always goes into the name and any extra lines go into the description. if that is the case, I propose we only interpolate the name

for those who want extra / dynamic docs - the new doc keyword is what I'd like users to use, and this can go into any Step

when I thought about 2 lines I was thinking about wrapping lines - different developers might have different views in terms of the size of a line / line wrap. I agree that anything past 2 lines is probably bad practice (and reports won't look pretty at all) but what do you think about still supporting any lines and leaving the "good practice" of keeping the name short and simple to the test scripters?

I'm just thinking that might need to throw an exception if we want to limit to 2 lines and one day someone will want "just" the 3 lines :)

The description was already in the code (saw it in the replace). Are you planning on removing it all together? I agree with not evaluating as the scenario outline should always do the same validations so a static description should suffice.

I hear ya. I'd be okay if this wasn't cucumber, the syntax is biased towards "one line at a time", the only way to span multiple lines is to use the triple-quotes """

so I'd really like to stick to one-line for the name. I also made this commit to verify what I was saying, that the parser already gives you the name and description separate: 77310ac

not planning to remove the description but we have now created a JSON for representing "an executed scenario" - see the toKarateJson() methods in ScenarioResult etc. right now I'm not including the scenario description because it can always be derived from the original feature-file.

so yes, good point - if the description is already being included in the replace - we can decide to not do it anymore. and one reason is we have a new way of adding fancy descriptions in-line. the name is important to stand out in reports

got it - will remove the usage of \ altogher

will remove the option of using string interpolation in the description but for now will leave the replace on the description - can probably be marked as deprecated or something but might be important to keep it for backwards compability

ptrthomas · 2020-12-29T03:47:47Z

karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java

+        this(featureRuntime, scenario, null, false);
+    }
+
+    public ScenarioRuntime(FeatureRuntime featureRuntime, Scenario scenario, boolean backgroundRuntime) {


do we need the extra boolean won't it be a property of the ScenarioRuntime

When running Scenario Outlines the Background runs wrapped in a ScenarioRuntime - while when running a scenario the background section is just included in the steps. That background ScenarioRuntime doesn't have a scenario associated with thus I had a nullpointer.

I think there was a way to figure out (like null scenario maybe or something) that I can use instead of the boolean to avoid evaluating the scenario name.

try scenario.isDynamic() you can see it used elsewhere in the same file

ptrthomas · 2020-12-29T08:37:31Z

thanks for the detailed PR with tests 👍
apologies that I was in the middle of a refactoring that will impact your PR / constructor of ScenarioRuntime hope it is not too much trouble

joelpramos · 2020-12-29T21:40:24Z

thanks for the detailed PR with tests 👍
apologies that I was in the middle of a refactoring that will impact your PR / constructor of ScenarioRuntime hope it is not too much trouble

Np happy to help as I think you created an amazing tool here and I'm just doing little tweaks here and there where I noticed some use cases. Your PR doesn't seem to affect that much, once you let me know your preference for the comment on this PR I'll do the changes and update this.

ptrthomas · 2020-12-30T04:51:54Z

@joelpramos added my comments, no hurry

…nterpolation-scenario-name-#1413 # Conflicts: # karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java

joelpramos

PR comments addressed

joelpramos · 2021-01-02T17:17:50Z

karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java

+        }
+    }
+
+    public void evaluateScenarioDescription() {


will remove the option of using string interpolation in the description but for now will leave the replace on the description - can probably be marked as deprecated or something but might be important to keep it for backwards compability

…nterpolation-scenario-name-#1413

joelpramos · 2021-01-03T19:35:58Z

Updated #1373 (comment)

Adding support for JavScript String interpolation in Scenario Names a…

3d68425

…nd Descriptions

joelpramos changed the title ~~Adding support for JavScript String interpolation in Scenario Names a…~~ Adding support for JavaScript String interpolation in Scenario Names a… Dec 28, 2020

ptrthomas requested changes Dec 29, 2020

View reviewed changes

ptrthomas added a commit that referenced this pull request Dec 30, 2020

add test to discuss #1416

77310ac

joelpramos added 2 commits January 2, 2021 12:32

Removing backslash (\) as option to add new line

20e3f74

Merge remote-tracking branch 'upstream/develop' into feature/string-i…

33d49df

…nterpolation-scenario-name-#1413 # Conflicts: # karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java

joelpramos commented Jan 2, 2021

View reviewed changes

joelpramos requested a review from ptrthomas January 2, 2021 17:36

joelpramos added 4 commits January 2, 2021 12:37

Removing unnecessary imports

f3bd1fe

Merge remote-tracking branch 'upstream/develop' into feature/string-i…

0453664

…nterpolation-scenario-name-#1413

Simplifying by removing the need to use backticks in scenario name

a101d7a

Updating documentation

725e9f0

ptrthomas merged commit 56d90af into karatelabs:develop Jan 4, 2021

ptrthomas added a commit that referenced this pull request Jan 4, 2021

minor formatting over #1416

91e0040

dependabot bot mentioned this pull request Mar 15, 2021

build(deps-dev): bump karate-junit5 from 0.9.9.RC4 to 1.0.0 HSRM-Vegetables/myfoodcoop-service#35

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support for JavaScript String interpolation in Scenario Names a… #1416

Adding support for JavaScript String interpolation in Scenario Names a… #1416

joelpramos commented Dec 28, 2020

ptrthomas Dec 29, 2020

ptrthomas Dec 29, 2020

joelpramos Dec 29, 2020

ptrthomas Dec 30, 2020

ptrthomas Dec 30, 2020

joelpramos Jan 2, 2021

joelpramos Jan 2, 2021

ptrthomas Dec 29, 2020

joelpramos Dec 29, 2020

ptrthomas Dec 30, 2020

ptrthomas commented Dec 29, 2020

joelpramos commented Dec 29, 2020

ptrthomas commented Dec 30, 2020

joelpramos left a comment

joelpramos Jan 2, 2021

joelpramos commented Jan 3, 2021

Adding support for JavaScript String interpolation in Scenario Names a… #1416

Adding support for JavaScript String interpolation in Scenario Names a… #1416

Conversation

joelpramos commented Dec 28, 2020

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ptrthomas commented Dec 29, 2020

joelpramos commented Dec 29, 2020

ptrthomas commented Dec 30, 2020

joelpramos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joelpramos commented Jan 3, 2021