Feature: Add keywords (Given, When, Then) to html report

[vitalets]

The problem
Currently html-report does not contain keywords (Given, When, Then):

It should be:

Given I am on Playwright home page
When I click link "Get started"
Then I see in title "Installation"

A solution
Pass keywords to Playwright steps to display them in report.
Use exactly the same keywords as used in feature file (e.g. don't convert And -> Given).
Handle i18n keywords.

Keep in mind Cucumber reporters: #9

[meeranharish]

@vitalets
Hi,
You have proposed an work around to pass keywords to the steps. Can we then use the steps in different context ?

Eg:
Given User logs out
When User login
Then User access main menu

Eg2:
Given User login
When User logs out
Then User cannot access main menu

In these examples we used the same step but in different context 'given' in eg1 and 'when' in eg 2
Can we use same step implementation for them if we pass the keyword to the step definition name?

Or did i misunderstood you?

Thanks

[vitalets]

Hi @meeranharish
Yes, scenarios are relax on keywords in step definitions, e.g. step defined with Given can be used also with When or Then.
The purpose of this issue is to display steps in html-report with corresponding keyword. For your example report should show exactly strings that you typed in scenario:

Given User logs out
When User login
Then User access main menu

Given User login
When User logs out
Then User cannot access main menu

Instead of current behavior:

User logs out
User login
User access main menu

User login
User logs out
User cannot access main menu

[meeranharish]

Thanks for the response. Yes, the steps are not tied to keywords but only that we might miss the keyword in the report.
As you proposed this
"
A solution
Pass keywords to Playwright steps to display them in report.
"
I felt that might bring in the restriction for the sake of reporting, right?

[vitalets]

I felt that might bring in the restriction for the sake of reporting, right?

Got it. No, steps will not be restricted to keywords.

[meeranharish]

@vitalets
whats your suggested way to pass the keywords to the step?

[vitalets]

whats your suggested way to pass the keywords to the step?

This is just internal implementation details. Nothing will change from the usage point.
Currently we actually pass keyword to the step - via Given / When / Then calls in generated files:

    await Given("State 1");
    await When("Action 1");
    await Then("Assertion 1");

[meeranharish]

whats your suggested way to pass the keywords to the step?

This is just internal implementation details. Nothing will change from the usage point. Currently we actually pass keyword to the step - via Given / When / Then calls in generated files:

    await Given("State 1");
    await When("Action 1");
    await Then("Assertion 1");

Is this sufficient enough to get the corresponding keywords in the html report for each step? Currently we don't get right?

[vitalets]

Is this sufficient enough to get the corresponding keywords in the html report for each step? Currently we don't get right?

Yes, it should be sufficient. There are also And / But calls for corresponding step texts. So I want to get html-report as close as possible to what we have in feature files.

[meeranharish]

Looking forward :)

[vitalets]

Released in 5.5.0 for English keywords.
Now html report is the following: