feat(initial release): dev to main

.github/workflows/main-release.yaml

@@ -0,0 +1,92 @@
+name: Main Release to GitHub
+
+on:
+  workflow_dispatch:
+
+jobs:
+  merge-dev-to-main:
+    name: Merge dev to main
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Git
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ secrets.GITHUB_EMAIL }}"
+
+      - name: Checkout dev branch
+        run: git checkout dev
+
+      - name: Merge dev into main
+        run: |
+          git checkout main
+          git merge dev --no-ff
+          git push origin main
+
+  release:
+    name: Release
+    needs: merge-dev-to-main
+    if: ${{ success() }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: yarn install
+      - name: Release to GitHub
+        env:
+          GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_BOT_PAT }} # <-- Allows semantic-release-bot to push changes to protected branches (using a PAT to avoid rate limits)
+          npm_config_tag: main # <-- See ./.releaserc for release branch config.
+        run: npx semantic-release
+
+  merge-main-to-dev:
+    name: Merge main back to dev
+    needs: [merge-dev-to-main, release]
+    if: ${{ success() }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Git
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ secrets.GITHUB_EMAIL }}"
+
+      - name: Checkout main branch
+        run: git checkout main
+
+      - name: Merge main into dev
+        run: |
+          git checkout dev
+          git merge main --no-ff
+          git push origin dev
+
+  notify-on-failure:
+    name: Notify on Failure
+    needs: [merge-dev-to-main, release, merge-main-to-dev]
+    if: ${{ failure() }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Notify Failure
+        run: |
+          echo "Merge or Release process failed. Check the logs for details."
+          # Add your preferred notification method here, e.g., send an email, create a GitHub issue, post a Slack message, etc.

.releaserc

@@ -0,0 +1,39 @@
+{
+    "branches": [
+        "main",
+        {
+            "name": "dev",
+            "prerelease": true
+        }
+    ],
+    "plugins": [
+        [
+            "@semantic-release/commit-analyzer",
+            {
+                "preset": "conventionalcommits"
+            }
+        ],
+        "@semantic-release/release-notes-generator",
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogFile": "CHANGELOG.md"
+            }
+        ],
+        [
+            "@semantic-release/npm",
+            {
+                "npmPublish": false
+            }
+        ],
+        [
+            "@semantic-release/git"
+        ],
+        [
+            "@semantic-release/github",
+            {
+                "assets": "./*.tgz"
+            }
+        ]
+    ]
+}

NOTICE

@@ -27,4 +27,8 @@ Licensed under the MIT License
 
 scenarios-original.tmpl is taken from https://github.com/WasiqB/multiple-cucumber-html-reporter which is:
 Copyright (c) 2023 Wasiq Bhamla
+Licensed under the MIT License
+
+Scripts/run.js uses code provided by cross-spawn taken from https://github.com/moxystudio/node-cross-spawn
+Copyright (c) 2018 Made With MOXY Lda hello@moxy.studio
 Licensed under the MIT License

Scripts/changeConfigModule.js

@@ -52,7 +52,7 @@ function addOrChangeConfigModule(configModuleUrl) {
 if (process.argv.length != 3) {
   console.log(
     'Invalid format. Required script format: "node ./changeConfigModule.js <configModuleUrl>"\n' +
-      'Ex: "node ./changeConfigModule.js git//git@github.com/myOrg/myConfigModule.git"'
+      'Ex: "node ./changeConfigModule.js "git+ssh://git@github.com:myOrg/myConfigModule"'
   );
   process.exit(1);
 }

Scripts/run.js

@@ -0,0 +1,104 @@
+const spawn = require('cross-spawn');
+const { v4: uuidv4 } = require('uuid');
+
+// Reading first parameter from the scripts to call function
+const functionName = process.argv[2];
+const params = process.argv.slice(3).join(' ');
+
+// Creating UUID
+function generateUUID() {
+  return uuidv4();
+}
+
+// Function to extract value of params that contain spaces
+function modifyParams(params) {
+  const envSectionMatch = params.match(/--env\s+(.*?)(?=\s+--|$)/);
+  const envSection = envSectionMatch ? envSectionMatch[1] : '';
+  const paramValuePairs = envSection.split(',');
+
+  let modifiedParams = params;
+  for (const pair of paramValuePairs) {
+    if (pair.includes(' ')) {
+      const [key, value] = pair.split('=');
+      process.env[`CYPRESS_${key}`] = value;
+      modifiedParams = modifiedParams.replace(pair + ',', '').replace(',' + pair, '');
+    }
+  }
+  return modifiedParams;
+}
+
+// Function to check if it's a combined test run
+function isCombinedTestRun(params) {
+  const specValueMatch = params.match(/--spec\s+([^ ]*)/);
+  const specValue = specValueMatch ? specValueMatch[1] : '';
+  return specValue === '*' || specValue.includes(',');
+}
+
+const isCombinedTest = isCombinedTestRun(params);
+process.env.CYPRESS_isCombinedTestRun = isCombinedTest;
+
+// Extract jobId from the parameters
+let jobId = '';
+const processingEnvArgs = params.includes('--env');
+if (processingEnvArgs) {
+  const envArgs = params.match(/--env\s+(.*?)(?=\s+--|$)/)[1].split(',');
+  for (const envArg of envArgs) {
+    if (envArg.startsWith('jobId=')) {
+      jobId = envArg.split('=')[1];
+      break;
+    }
+  }
+}
+
+// If jobId is not found in the parameters, generate a new one
+if (!jobId) {
+  jobId = generateUUID();
+}
+
+process.env.CYPRESS_jobId = jobId;
+
+// Function to execute cypress run
+function run() {
+  const args = ['run', '--e2e', ...modifyParams(params).split(' ')];
+  console.log(`[Running cypress command: cypress ${args.join(' ')}]`);
+
+  const cypressProcess = spawn('cypress', args, { stdio: 'inherit' });
+
+  cypressProcess.on('error', (error) => {
+    console.error(`Error: ${error.message}`);
+  });
+
+  cypressProcess.on('close', (code) => {
+    if (code !== 0) {
+      console.error(`Cypress process exited with code ${code}`);
+    }
+  });
+}
+
+// Function to open Cypress without report options
+function open() {
+  const command = 'cypress';
+  const args = ['open', '--e2e', ...modifyParams(params).split(' ')];
+  console.log(`[Running cypress command: ${command} ${args.join(' ')}]`);
+
+  const cypressProcess = spawn(command, args, { stdio: 'inherit' });
+
+  cypressProcess.on('error', (error) => {
+    console.error(`Error: ${error.message}`);
+  });
+
+  cypressProcess.on('close', (code) => {
+    if (code !== 0) {
+      console.error(`Cypress process exited with code ${code}`);
+    }
+  });
+}
+
+// Calling function based on name
+if (functionName === 'run') {
+  run();
+} else if (functionName === 'open') {
+  open();
+} else {
+  console.error('Invalid function name');
+}

cypress/TestCases/FireboltCertification/Advertising.feature

@@ -1,10 +1,11 @@
+@Advertising @coreSDK
 Feature: Advertising
 
    Background: Launch FCA for 'Advertising'
       Given the environment has been set up for 'Advertising' tests
       And 3rd party 'certification' app is launched
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.policy - Positive Scenario: <Scenario>
       When '3rd party app' registers for the 'advertising onPolicyChanged' event using the 'Firebolt' API
       And '3rd party app' invokes the 'Firebolt' API to 'get advertising policy'
@@ -19,7 +20,7 @@ Feature: Advertising
          | Enable limitAdTracking  | enable limitAdTracking  | Advertising policy limitAdTracking as false | onPolicyChanged for advertising limitAdTracking with false |
          | Disable limitAdTracking | disable limitAdTracking | Advertising policy limitAdTracking as true  | onPolicyChanged for advertising limitAdTracking with true  |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.policy - Positive Scenario: <Scenario>
       When '3rd party app' registers for the 'advertising onPolicyChanged' event using the 'Firebolt' API
       And '3rd party app' invokes the 'Firebolt' API to 'get advertising policy'
@@ -36,17 +37,17 @@ Feature: Advertising
          | SkipRestriction adsUnwatched | set skipRestriction as adsUnwatched | Advertising policy skipRestriction as adsUnwatched | onPolicyChanged for advertising skipRestriction with adsUnwatched |
          | SkipRestriction all          | set skipRestriction as all          | Advertising policy skipRestriction as all          | onPolicyChanged for advertising skipRestriction with all          |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario: Advertising.deviceAttributes - Positive Scenario: Get deviceAttributes
       When '3rd party app' invokes the 'Firebolt' API to 'get deviceAttributes'
       Then 'Firebolt' platform responds with 'advertising device attributes'
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario: Advertising.appBundleId - Positive Scenario: Get appBundleId
       When '3rd party app' invokes the 'Firebolt' API to 'get appBundleId'
       Then 'Firebolt' platform responds with 'advertising appBundleId'
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.advertisingId - Positive Scenario: Special Validation <Scenario>
       When '3rd party app' invokes the 'Firebolt' API to 'get advertisingId'
       And '3rd party app' invokes the 'Firebolt' API to 'get initialization parameters'
@@ -62,7 +63,7 @@ Feature: Advertising
          | limitAdTracking_ON  | disable limitAdTracking | limitAdTracking ON for advertisingId  | parameters initialization advertisingId ad on  |
          | limitAdTracking_OFF | enable limitAdTracking  | limitAdTracking OFF for advertisingId | parameters initialization advertisingId ad off |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.config Coppa value - Positive Scenario: <Scenario>
       When '3rd party app' invokes the 'Firebolt' API to '<API_Key>'
       Then 'Firebolt' platform responds with '<Method_Validation_key>'
@@ -76,7 +77,7 @@ Feature: Advertising
          | Coppa TRUE with environment value test  | get coppa as true with environment value test  | advertising config coppa as one  |
          | Coppa FALSE with environment value test | get coppa as false with environment value test | advertising config coppa as zero |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.config - special Scenario: Validation <Scenario>
       When '3rd party app' invokes the 'Firebolt' API to '<CORE_API_Key>'
       And 1st party app invokes the 'Firebolt' API to '<MANAGE_API_Key>'
@@ -93,7 +94,7 @@ Feature: Advertising
          | Only coppa as params                 | enable limitAdTracking  | get only coppa      | advertising config    |
          | Empty params                         | enable limitAdTracking  | get empty parameter | advertising config    |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.config - Negative Scenario: <Scenario> expecting error
       When '3rd party app' invokes the 'Firebolt' API to '<API_Key>'
       Then 'Firebolt' platform responds with '<Method_Validation_key>'
@@ -107,7 +108,7 @@ Feature: Advertising
          | Invalid environment value                   | get config with invalid environment          | invalid parameter error advertising config |
          | Integer values for params                   | get config with integer parameter            | invalid parameter error advertising config |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.advertisingId - Positive Scenario: <Scenario>
       When 1st party app invokes the 'Firebolt' API to '<MANAGE_API_Key>'
       And '3rd party app' invokes the 'Firebolt' API to '<CORE_API_Key>'
@@ -125,7 +126,7 @@ Feature: Advertising
          | limitAdTracking_ON_WITH_RANDOM_STRING_SCOPE_ID | disable limitAdTracking | get advertisingId with scope id as random string | limitAdTracking ON for advertisingId  |
          | limitAdTracking_ON_WITH_EMPTY_STRING_SCOPE_ID  | disable limitAdTracking | get advertisingId with scope id as empty string  | limitAdTracking ON for advertisingId  |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Advertising.advertisingId - Negative Scenario: <Scenario> expecting error
       When '3rd party app' invokes the 'Firebolt' API to '<API_Key>'
       Then 'Firebolt' platform responds with 'invalid parameter for advertising advertisingId'
@@ -140,7 +141,7 @@ Feature: Advertising
          | Without scope type               | get advertisingId without scope type        |
          | Invalid advertisingId scope      | get advertisingId with invalid scope        |
 
-   @Advertising @coreSDK @sdk @transport
+   @sdk @transport @requiresPlatformImplementation
    Scenario: Advertising.onPolicyChanged - Positive Scenario: Clearing event listeners
       When '3rd party app' registers for the 'advertising onPolicyChanged' event using the 'Firebolt' API
       And I clear 'advertising onPolicyChanged event' listeners

cypress/TestCases/FireboltCertification/Authentication.feature

@@ -1,10 +1,11 @@
+@Authentication @coreSDK 
 Feature: Authentication
 
    Background: Launch FCA for 'Authentication'
       Given the environment has been set up for 'Authentication' tests
       And 3rd party 'certification' app is launched
 
-   @Authentication @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Authentication.token - Positive Scenario: <Scenario>
       When '3rd party app' invokes the 'Firebolt' API to '<API_Key>'
       Then 'Firebolt' platform responds with '<Validation_key>'
@@ -17,7 +18,7 @@ Feature: Authentication
          | Get Distributor-CIMA token type | get the authentication token for distributor_CIMA | decode base64 authentication token |
          | Get Distributor-OAT token type  | get the authentication token for distributor_OAT  | decode base64 authentication token |
 
-   @Authentication @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Authentication.<Method> - Positive Scenario: <Scenario>
       When '3rd party app' invokes the 'Firebolt' API to '<API_Key>'
       Then 'Firebolt' platform responds with '<Validation_key>'
@@ -28,7 +29,7 @@ Feature: Authentication
          | Get Session token type | fetch session token | authentication session | session |
          | Get Root token type    | fetch root token    | authentication root    | root    |
 
-   @Authentication @coreSDK @sdk @transport
+   @sdk @transport
    Scenario Outline: Authentication.token - Negative Scenario: <Scenario> expecting error
       When '3rd party app' invokes the 'Firebolt' API to '<API_Key>'
       Then 'Firebolt' platform responds with '<Validation_key>'