Fix for @Testid tag handling in Scenario Outline (issue #215) (#240)

* test(FRT-3058): fixed bug 215
* fix: commit that triggers release for #240

---------

Co-authored-by: Galina Tarasevich <[email protected]>

Author: GalyRain

CONTRIBUTING.md

@@ -123,4 +123,3 @@ Fixes: #123
 ```
 
 A tool like [Commitizen](https://github.com/commitizen/cz-cli) can be used to help with formatting commit messages.
-

cypress/e2e/cucumber/allure.feature

@@ -5,17 +5,30 @@
 Feature: AllureAPI
     I want to use allure api in cypress tests
 
-@tagForRule
-Rule: TestRule
+    @tagForRule
+    Rule: TestRule
 
-@testID("12345")
-@issue("jira","tmsLink")
-@tms("tms","tmsLink")
-@link("example","https://example.com")
-@severity("minor")
-@tagForTest
-Scenario: Cucumber tags should work
-    Given I have allure tags set for Feature
-    When  I run any test
-    Then  I should see allure api working properly
-    And   Tags from test should overwrite tags from feature
+    @testID("12345")
+    @issue("jira", "tmsLink")
+    @tms("tms", "tmsLink")
+    @link("example", "https://example.com")
+    @severity("minor")
+    @tagForTest
+    Scenario: Cucumber tags should work
+        Given I have allure tags set for Feature
+        When I run any test
+        Then I should see allure api working properly
+        And Tags from test should overwrite tags from feature
+
+
+    @testID("111|222")
+    Scenario Outline: Cucumber tags should work
+        Given I have allure tags set for Feature
+        When I run any test with "<Value>"
+        Then I should see allure api working properly
+        And Tags from test should overwrite tags from feature
+
+        Examples:
+            | Value |
+            | 1111  |
+            | 2222  |

cypress/e2e/cucumber/allure/steps.cy.js

@@ -8,6 +8,10 @@ When('I run any test', () => {
     cy.log('child command for when');
 });
 
+When('I run any test with {string}', (value) => {
+    cy.log(`child command for when ${value}`);
+});
+
 Then('I should see allure api working properly', () => {
     cy.log('child command for allure api "then" step');
 });

package.json

@@ -65,4 +65,4 @@
         "nonGlobalStepDefinitions": true,
         "stepDefinitions": "cypress/e2e/cucumber"
     }
-}
+}

reporter/allure-cypress/CucumberHandler.js

@@ -83,15 +83,17 @@ class CucumberHandler {
     get outlineExampleIndex() {
         if (this.isNewFormat) {
             const [, exampleId] = this.state.pickle.astNodeIds;
-            if (
-                !this.currentScenario.examples ||
-                !this.currentScenario.examples.length
-            ) {
-                return -1;
+            const examples = this.currentScenario.examples || [];
+
+            for (const example of examples) {
+                const index = example.tableBody.findIndex(
+                    (item) => item.id === exampleId
+                );
+                if (index !== -1) {
+                    return index;
+                }
             }
-            return this.currentScenario.examples[0].tableBody.findIndex(
-                (item) => item.id === exampleId
-            );
+            return -1;
         }
         const num = parseInt(
             exampleNumber.exec(this.currentScenario.name).pop()
@@ -113,7 +115,7 @@ class CucumberHandler {
             }
 
             const newTags = [
-                ...currentTags.filter((t) => !t.type && !t.type !== 'Tag'),
+                ...currentTags.filter((t) => !(t && t.type === 'Tag')),
                 tag
             ];
 
@@ -220,29 +222,38 @@ class CucumberHandler {
                 }
 
                 kind.tags
-                    .filter(function ({ name }) {
-                        const match = tagToLabel.exec(name);
-                        if (match) {
-                            const [, command, value] = match;
-                            // feature and suite should be overwritten to avoid duplicates
-                            if (['feature', 'suite'].includes(command)) {
-                                const index = currentTest.info.labels.findIndex(
-                                    (label) => label.name === command
-                                );
-                                currentTest.info.labels[index] = {
-                                    name: command,
-                                    value: value
-                                };
-                            } else {
-                                // handle renaming label for testID, or just use label name
-                                currentTest.addLabel(
-                                    command === 'testID' ? 'AS_ID' : command,
-                                    value
-                                );
+                    .filter(
+                        function ({ name }) {
+                            const match = tagToLabel.exec(name);
+                            if (match) {
+                                const [, command, value] = match;
+
+                                // testID handling with outline index support
+                                if (command === 'testID') {
+                                    const ids = value.split('|');
+                                    const index = this.outlineExampleIndex ?? 0;
+                                    const id = ids[index] || ids[0];
+                                    currentTest.addLabel('AS_ID', id);
+                                } else if (
+                                    ['feature', 'suite'].includes(command)
+                                ) {
+                                    // feature and suite should be overwritten to avoid duplicates
+                                    const labelIndex =
+                                        currentTest.info.labels.findIndex(
+                                            (label) => label.name === command
+                                        );
+                                    currentTest.info.labels[labelIndex] = {
+                                        name: command,
+                                        value: value
+                                    };
+                                } else {
+                                    // use label name
+                                    currentTest.addLabel(command, value);
+                                }
                             }
-                        }
-                        return !match;
-                    })
+                            return !match;
+                        }.bind(this) // bind context to access this.outlineExampleIndex inside callback
+                    )
                     // check for links
                     .filter(function ({ name }) {
                         const match = tagToLink.exec(name);
@@ -276,7 +287,7 @@ class CucumberHandler {
                     .forEach(function ({ name }) {
                         currentTest.addLabel('tag', name.replace('@', ''));
                     });
-            }
+            }.bind(this)
         );
     }
 }