Skip to content

Enable Gherkin Linting#191

Merged
PedroDiez merged 12 commits intocamaraproject:mainfrom
PedroDiez:Carrier_Billing_Testing_Linter_Format_Corrections
Jan 10, 2025
Merged

Enable Gherkin Linting#191
PedroDiez merged 12 commits intocamaraproject:mainfrom
PedroDiez:Carrier_Billing_Testing_Linter_Format_Corrections

Conversation

@PedroDiez
Copy link
Copy Markdown
Collaborator

@PedroDiez PedroDiez commented Nov 12, 2024 •
edited
Loading

What type of PR is this?

  • correction
  • enhancement/feature
  • tests

What this PR does / why we need it:

PR to enable Gherkin Linter as per Commonalities/PR#292.
Even it is ongoing PR, it is fine to incorporate into WG to have some preliminary linter rules

Which issue(s) this PR fixes:

Fixes #180

Special notes for reviewers:

Changes with regards to Commonalities/PR#292

  • Indentation (NOTE: reviewed test_definitions in other WGs and this makes sense)
    "Background" set to "2".
    "example" set to "6".

  • Disable "file-name" kebab-case checking as operationId is lowerCamelCase.

  • Specific for Carrier Billing: disable "validate" word in Feature as Carrier Billing has validatePayment operation

  • In commit d0402e2 removing unnecessary comments

Changelog input

 Enable Gherkin linter for Test Definitions

Additional documentation

N/A

@PedroDiez PedroDiez self-assigned this Nov 12, 2024
@PedroDiez PedroDiez added enhancement New feature or request correction API specification needs correction labels Nov 12, 2024
@PedroDiez PedroDiez requested a review from rartych November 12, 2024 19:53
@PedroDiez
Copy link
Copy Markdown
Collaborator Author

PedroDiez commented Nov 12, 2024 •
edited
Loading

@rartych I do not know how to manage pending linter errors.

image

@PedroDiez PedroDiez mentioned this pull request Nov 13, 2024
Merged
@PedroDiez
Copy link
Copy Markdown
Collaborator Author

PedroDiez commented Nov 13, 2024

Commit 9a46336 would be a workaround to fix "logical operators comparison" topic raised by linter configuration

cc @rartych @bigludo7 just in case no simple solution can be found at linter configuration level

@rartych
Copy link
Copy Markdown
Collaborator

rartych commented Nov 14, 2024

It looks that angle brackets <,> are interpreted in Gherkin as as delimiters of example variables only. (cf. cucumber/common#1004 )
As it was iterpreted that way by the linter it may be interpreted the same way when generating executable tests.
I support the proposed above solution.

@PedroDiez
Copy link
Copy Markdown
Collaborator Author

PedroDiez commented Nov 14, 2024

It looks that angle brackets <,> are interpreted in Gherkin as as delimiters of example variables only. (cf. cucumber/common#1004 ) As it was iterpreted that way by the linter it may be interpreted the same way when generating executable tests. I support the proposed above solution.

Thanks for the feedback and info Rafal. Yes I think we can move forward with proposed above solution

@PedroDiez
Copy link
Copy Markdown
Collaborator Author

PedroDiez commented Nov 15, 2024

@rartych, @bigludo7 I will wait some time in order to align with Commonalities/PR#292 when merged.

I think it be considered for MetaRelease Spring 25. And in case not finally merged, just merge this as part of WG work for MetaRelease Spring 25 as it works.

bigludo7
bigludo7 previously approved these changes Jan 8, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@PedroDiez
Copy link
Copy Markdown
Collaborator Author

PedroDiez commented Jan 8, 2025

Ready for final review @bigludo7, @rartych

@PedroDiez PedroDiez requested a review from bigludo7 January 8, 2025 14:56
bigludo7
bigludo7 approved these changes Jan 8, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks !

@PedroDiez PedroDiez merged commit 4972217 into camaraproject:main Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bigludo7 bigludo7 bigludo7 approved these changes

@ToshiWakayama-KDDI ToshiWakayama-KDDI Awaiting requested review from ToshiWakayama-KDDI ToshiWakayama-KDDI is a code owner

@rartych rartych Awaiting requested review from rartych

Assignees

@PedroDiez PedroDiez

Labels

correction API specification needs correction enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Results of applying gherkinlint to the test definitions

3 participants

@PedroDiez @rartych @bigludo7