Initial commit

Amark19 · Amark19 · commit 73dba9bc19c7 · 2025-03-10T21:15:59.000+05:30
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -23,7 +23,7 @@ workflows:
       # Triggers the next workflow in the Orb Development Kit.
       - orb-tools/continue:
           pipeline_number: << pipeline.number >>
-          vcs_type: << pipeline.project.type >>
+          vcs_type: github
           orb_name: browserstack-circleci-orb
           requires: [orb-tools/lint, orb-tools/pack, orb-tools/review, shellcheck/check]
           filters: *filters
diff --git a/.circleci/test-deploy.yml b/.circleci/test-deploy.yml
@@ -28,7 +28,7 @@ jobs:
     steps:
       - checkout
       # Run your orb's commands to validate them.
-      - browserstack-circleci-orb/greet
+      - browserstack-circleci-orb/set_rerun_tests
 workflows:
   test-deploy:
     jobs:
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 # orb.yml is "packed" from source, and not published directly from the repository.
 orb.yml
-.DS_Store
+.DS_Store
+.idea
diff --git a/README.md b/README.md
@@ -21,14 +21,14 @@ _**Edit this area to include a custom title and description.**_
 
 ### How to Contribute
 
-We welcome [issues](https://github.com/JryBWxh6hsGZUqwDfzkkT7/browserstack-circleci-orb/issues) to and [pull requests](https://github.com/JryBWxh6hsGZUqwDfzkkT7/browserstack-circleci-orb/pulls) against this repository!
+We welcome [issues](https://github.com/browserstack/browserstack-circleci-orb/issues) to and [pull requests](https://github.com/browserstack/browserstack-circleci-orb/pulls) against this repository!
 
 ### How to Publish An Update
 1. Merge pull requests with desired changes to the main branch.
     - For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/).
 2. Find the current version of the orb.
     - You can run `circleci orb info browserstack/browserstack-circleci-orb | grep "Latest"` to see the current version.
-3. Create a [new Release](https://github.com/JryBWxh6hsGZUqwDfzkkT7/browserstack-circleci-orb/releases/new) on GitHub.
+3. Create a [new Release](https://github.com/browserstack/browserstack-circleci-orb/releases/new) on GitHub.
     - Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) tag. (ex: v1.0.0)
       - We will have an opportunity to change this before we publish if needed after the next step.
 4.  Click _"+ Auto-generate release notes"_.
diff --git a/src/@orb.yml b/src/@orb.yml
@@ -1,14 +1,14 @@
 version: 2.1
 
 description: >
-  Sample orb description
+  Browserstack orb to set custom job-scope variables for a user config.
 # What will your orb allow users to accomplish?
 # Descriptions should be short, simple, and informative.
 
 # This information will be displayed in the orb registry and is not mandatory.
 display:
-  home_url: "https://www.example.com/docs"
-  source_url: "https://github.com/JryBWxh6hsGZUqwDfzkkT7/browserstack-circleci-orb"
+  home_url: "https://browserstack.com"
+  source_url: "https://github.com/browserstack/browserstack-circleci-orb"
 
 # If your orb requires other orbs, you can import them like this. Otherwise remove the "orbs" stanza.
 # orbs:
diff --git a/src/commands/greet.yml b/src/commands/greet.yml
diff --git a/src/commands/set_rerun_tests.yml b/src/commands/set_rerun_tests.yml
@@ -0,0 +1,8 @@
+description: "Cleanup the project level environment variable set by browserstack rerun API"
+
+steps:
+  - run:
+      name: Cleanup Environment
+      command: <<include(scripts/rerun_tests.sh)>>
+      environment:
+        CLEANUP_ENV_VAR: true
diff --git a/src/examples/cleanup_env.yml b/src/examples/cleanup_env.yml
diff --git a/src/examples/set_rerun_tests.yml b/src/examples/set_rerun_tests.yml
@@ -0,0 +1,19 @@
+version: '2.1'
+orbs:
+  browserstack-circleci-orb: browserstack/browserstack-circleci-orb@1.0.0
+
+jobs:
+  my_test_job:
+    executor: default
+    steps:
+      - checkout
+      - browserstack-circleci-orb/set_rerun_tests:
+          delete_env_var: true # Default value is False
+      - run:
+          name: Run Test
+          command: |
+            echo "Bs Tests: $BSTACK_RERUN_TESTS"
+workflows:
+  set-rerun-tests-example:
+    jobs:
+      - my_test_job
diff --git a/src/jobs/cleanup_env.yml b/src/jobs/cleanup_env.yml
@@ -0,0 +1,8 @@
+description: "Cleanup the project level environment variable"
+
+steps:
+  - run:
+      name: Cleanup Environment
+      command: <<include(scripts/rerun_tests.sh)>>
+      environment:
+        CLEANUP_ENV_VAR: true
diff --git a/src/jobs/hello.yml b/src/jobs/hello.yml
diff --git a/src/scripts/greet.sh b/src/scripts/greet.sh
diff --git a/src/scripts/rerun_tests.sh b/src/scripts/rerun_tests.sh
@@ -0,0 +1,113 @@
+#!/bin/bash
+
+# Logger function
+logger() {
+  local level="$1"
+  local message="$2"
+
+  case "$level" in
+    "INFO")    echo -e "\033[1;34m[INFO]\033[0m $message" ;;   # Blue
+    "SUCCESS") echo -e "\033[1;32m[SUCCESS]\033[0m $message" ;; # Green
+    "ERROR")   echo -e "\033[1;31m[ERROR]\033[0m $message" ;;   # Red
+    "WARNING") echo -e "\033[1;33m[WARNING]\033[0m $message" ;; # Yellow
+    *)         echo "[LOG] $message" ;;                         # Default
+  esac
+}
+
+cleanup_env_var() {
+  logger "INFO" "Delete env var : $DELETE_ENV_VAR"
+  logger "INFO" "Cleanup env var : $CLEANUP_ENV_VAR"
+  if [[ "$DELETE_ENV_VAR" == "1" || "$CLEANUP_ENV_VAR" == "1" ]]; then
+    logger "INFO" "Deleting the project environment variable: $env_var"
+    curl -X DELETE "https://circleci.com/api/v2/project/${PROJECT_SLUG}/envvar/${env_var}" \
+        -H "Circle-Token: ${CIRCLECI_TOKEN}" \
+        -H "Content-Type: application/json"
+    logger "SUCCESS" "Deleted environment variable: $env_var"
+  fi
+}
+
+set_env_var() {
+  if [[ -z "$CLEANUP_ENV_VAR" || "$CLEANUP_ENV_VAR" != "true" ]]; then
+    logger "INFO" "Setting BS_env_vars in BASH_ENV"
+    decoded_json=$(echo "$env_var_value" | base64 --decode 2>/dev/null)
+
+    if echo "$decoded_json" | jq empty 2>/dev/null; then
+        logger "SUCCESS" "Valid JSON detected."
+        echo "$decoded_json" | jq .
+        echo "$decoded_json" | jq -r 'to_entries | .[] | "export " + .key + "=\"" + (.value | tostring) + "\""' >> "$BASH_ENV"
+    else
+        logger "ERROR" "Invalid JSON detected. Exiting."
+        exit 0
+    fi
+  fi
+}
+
+sanitizeToAlphanumericKey() {
+  local key="$1"
+  echo "${key//[^a-zA-Z0-9]/_}"
+}
+
+sanitizeAndLimit() {
+  local key="$1"
+  local sanitized_key
+  sanitized_key=$(sanitizeToAlphanumericKey "$key")
+  echo "${sanitized_key:0:50}"
+}
+
+buildEnvironmentVariable() {
+  local envKey="$1"
+  shift
+  local values=("$@")
+
+  sanitized_values=()
+  for value in "${values[@]}"; do
+    sanitized_values+=("$(sanitizeAndLimit "$value")")
+  done
+
+  echo "$envKey"_"$(echo "${sanitized_values[*]}" | awk '{gsub(/ /, "_"); print}')"
+}
+
+# Check whether CircleCI token is present
+if [[ -z "$CIRCLECI_TOKEN" ]]; then
+  logger "ERROR" "CircleCI token not present in environment variables. Setting no tests to rerun."
+  exit 0
+fi
+
+logger "INFO" "Fetching workflow details..."
+WORKFLOW_RESPONSE=$(curl -s -H "Circle-Token: ${CIRCLECI_TOKEN}" \
+                        "https://circleci.com/api/v2/workflow/${CIRCLE_WORKFLOW_ID}")
+
+if echo "$WORKFLOW_RESPONSE" | jq empty 2>/dev/null; then
+  WORKFLOW_NAME=$(echo "$WORKFLOW_RESPONSE" | jq -r '.name // empty')
+  PROJECT_SLUG=$(echo "$WORKFLOW_RESPONSE" | jq -r '.project_slug // empty')
+  WORKFLOW_TAG=$(echo "$WORKFLOW_RESPONSE" | jq -r '.tag // empty')
+
+  if [[ -z "$WORKFLOW_NAME" || -z "$PROJECT_SLUG" ]]; then
+    logger "ERROR" "Missing workflow name or project slug in API response. Setting no tests to rerun."
+    exit 0
+  fi
+
+  if [[ "$WORKFLOW_TAG" =~ rerun ]]; then
+    logger "SUCCESS" "Workflow is a rerun. Proceeding with env var operations..."
+  else
+    logger "WARNING" "Workflow is not a rerun (tag: $WORKFLOW_TAG). Skipping env var operations."
+    exit 0
+  fi
+else
+  logger "ERROR" "Invalid response from CircleCI API. Check your API token. Setting no tests to rerun."
+  exit 0
+fi
+
+# Build environment variable
+ENV_KEY="BS_RERUN"
+env_var=$(buildEnvironmentVariable "$ENV_KEY" "$CIRCLE_PIPELINE_ID" "$WORKFLOW_NAME" "$CIRCLE_USERNAME")
+
+logger "INFO" "Looking for environment variable: $env_var"
+env_var_value=$(printenv "$env_var") || env_var_value=""
+
+if [[ -n "$env_var_value" ]]; then
+  set_env_var
+  cleanup_env_var
+else
+  logger "WARNING" "No value found for environment variable: $env_var"
+fi
