Added script to verify all tests scenario are associated with a version tag #2421
+93
−21
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Contributor
Author
There was a problem hiding this comment. Actually no tests were breaking this rule, but wanna enforce it, it's important to know "this test was shipped with a feature on version 2.15.1" Tested it in codespace by removing tags from some scenarios : 
Contributor
There was a problem hiding this comment. We usually put them in .github/scripts ? Also we should have tests for it 🙏 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
| @@ -0,0 +1,75 @@ | ||||
| /** | ||||
| * Verifies that every Scenario in the ctst feature files | ||||
| * has a semver version tag (e.g. @2.6.0), either on the Feature, | ||||
| * an enclosing Rule, or directly on the scenario. | ||||
| * | ||||
| * Exits with code 1 and lists offenders if any are missing. | ||||
| */ | ||||
|
|
||||
| /* eslint-disable no-console */ | ||||
|
|
||||
| import { Parser, AstBuilder, GherkinClassicTokenMatcher } from '@cucumber/gherkin'; | ||||
|
SylvainSenechal marked this conversation as resolved.
|
||||
| import { IdGenerator } from '@cucumber/messages'; | ||||
| import * as fs from 'fs'; | ||||
| import * as path from 'path'; | ||||
|
|
||||
| const VERSION_TAG_REGEX = /^@\d+\.\d+\.\d+$/; | ||||
| const FEATURES_DIR = path.resolve(__dirname, '../features'); | ||||
|
|
||||
| function collectFeatureFiles(dir: string): string[] { | ||||
| const files: string[] = []; | ||||
| for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { | ||||
| const full = path.join(dir, entry.name); | ||||
| if (entry.isDirectory()) { | ||||
| files.push(...collectFeatureFiles(full)); | ||||
| } else if (entry.name.endsWith('.feature')) { | ||||
| files.push(full); | ||||
| } | ||||
| } | ||||
| return files; | ||||
| } | ||||
|
|
||||
| let totalScenarios = 0; | ||||
| const offenders: string[] = []; | ||||
| const parser = new Parser(new AstBuilder(IdGenerator.incrementing()), new GherkinClassicTokenMatcher()); | ||||
|
|
||||
| for (const file of collectFeatureFiles(FEATURES_DIR)) { | ||||
| const rel = path.relative(FEATURES_DIR, file); | ||||
| const ast = parser.parse(fs.readFileSync(file, 'utf8')); | ||||
| const feature = ast.feature; | ||||
| if (!feature) { continue; } | ||||
|
|
||||
| const featureHasVersion = feature.tags.some(t => VERSION_TAG_REGEX.test(t.name)); | ||||
|
|
||||
| for (const child of feature.children) { | ||||
| if (child.scenario) { | ||||
| totalScenarios++; | ||||
| const hasVersion = featureHasVersion || child.scenario.tags.some(t => VERSION_TAG_REGEX.test(t.name)); | ||||
| if (!hasVersion) { | ||||
| offenders.push(` ${rel}:${child.scenario.location.line} — "${child.scenario.name}"`); | ||||
|
|
||||
| } | ||||
| } else if (child.rule) { | ||||
| // Version tag can be inherited from Feature or Rule | ||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||
| const ruleHasVersion = child.rule.tags.some(t => VERSION_TAG_REGEX.test(t.name)); | ||||
| for (const ruleChild of child.rule.children) { | ||||
| if (!ruleChild.scenario) { continue; } // skip Background inside Rule | ||||
| totalScenarios++; | ||||
| const hasVersion = featureHasVersion || ruleHasVersion | ||||
| || ruleChild.scenario.tags.some(t => VERSION_TAG_REGEX.test(t.name)); | ||||
| if (!hasVersion) { | ||||
| offenders.push(` ${rel}:${ruleChild.scenario.location.line} — "${ruleChild.scenario.name}"`); | ||||
|
Contributor
There was a problem hiding this comment. You can create a new function to do that instead of duplicating the logic ( |
||||
| } | ||||
| } | ||||
| } | ||||
| // Background nodes are intentionally ignored | ||||
|
Contributor
There was a problem hiding this comment. You have twice the same comment https://github.com/scality/Zenko/pull/2421/changes#diff-637785e467dea30f38c5f19d551eefd93a7feffae2da263d44066c7d8c8c2adcR55. It's maybe better to add the why, than just describing the code (if relevant). |
||||
| } | ||||
| } | ||||
|
|
||||
| if (offenders.length > 0) { | ||||
| console.error(`\n${offenders.length} scenario(s) missing a version tag (@X.Y.Z):\n`); | ||||
| offenders.forEach(o => console.error(o)); | ||||
| console.error('\nAdd a version tag (e.g. @2.15.0) to each scenario or its parent Feature.\n'); | ||||
| process.exit(1); | ||||
| } | ||||
|
|
||||
| console.log(`All ${totalScenarios} scenarios have a version tag.`); | ||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why do we want that?
this "tagging" was introduced when CTST was used in Artesca, and embedded the tests : so there was one version of CTST and tests targeting multiple zenko versions.
the tests are now managed in
git-so the information is really available via git blame or others-, I don't see the benefit of manually adding the tag on every test?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, yes, there is another version of this pr where I just remove all tags + the useless before hook
I kinda liked having directly visible tags attached to the scenarios as its faster to read than commits but you're right