DEV Community


Posted on • Updated on

Scenario Outline is coming in vitest-cucumber

I'm still wording on my library vitest-cucumber. I presented it in this post : Use Gherkin file in your unit tests with vitest

Step by step I add logic from Gherkin language, I worked with Scenario Outline.

Scenario Outline definition from Gherkin doc : The Scenario Outline keyword can be used to run the same Scenario multiple times, with different combinations of values.

We take this Scenario Outline as example :

Feature: Detect image ratio from width and height

    Scenario Outline: Detect image ratio when upload image
        Given As a user in an awesome project
        When  I upload an image <width>px on <height>px
        Then  I see my image <ratio>

            | width | height | ratio |
            | 100   | 100    | 1     |
            | 100   | 200    | 2     |
Enter fullscreen mode Exit fullscreen mode

With vitest-cucumber, now you can use it like this :

describeFeature(feature, ({ ScenarioOutline }) => {

    ScenarioOutline(`Detect image ratio when upload image`, ({ Given, When, Then }, variables) =>{
        Given(`As a user in an awesome project`, () => {})
        When(` I upload an image <width>px on <height>px`, () => {
        Then(`I see my image <ratio>`, () => {
                variables.height[1] / variables.width[1]
Enter fullscreen mode Exit fullscreen mode

Variables is an array with values extracted from Examples: :

    "width": ["100", "100"],
    "height": ["100", "200"],
    "ratio": ["1", "2"]
Enter fullscreen mode Exit fullscreen mode

But before publish a new version of vitest-cucumber I need your opinions ;)

For Scenario Outline I don't know what is best solution.

1) run scenario one time with variable values as arguments

Like my example, scenario is run one time and variable values is passed as arguments.
So inside ScenarioOutline callback we can use variables as an array.

2) run scenario x times for x variable values

In Examples we have two lines, so scenario is run two times. First run with 100, 100 and 1 values and second time with 100, 200 and 2 etc if we have more values.

3) run scenario one time with random value

Scenario is run one time but we don't know which values. With 100, 100 and 1 or 100, 200 and 2.

Let me know the solution that you prefer ;). After I will update vitest-cucumber and publish a new stable version 🍾🍾

Update 10 / 12 / 23

I publish a new vitest-cucumber version 1.1.0.

Now ScenarioOutline and Examples is included in my project.

Reading Gherkin docs I choose to run ScenarioOutline callback X times for X variables.

With the same Examples example, in ScenarioOutline callback, variables are :

    "width": 100, // 100 in second test
    "height": 100, // 200 in second test
    "ratio": 1 // 2 in second test
Enter fullscreen mode Exit fullscreen mode

I hope you will like it ;).

Top comments (0)