From 3c22c865ccec0a977abf233f774935b7010d0576 Mon Sep 17 00:00:00 2001 From: Amark19 Date: Mon, 10 Mar 2025 20:00:26 +0530 Subject: [PATCH 1/6] feat: Initial commit. --- .circleci/config.yml | 29 +++++++++ .circleci/test-deploy.yml | 51 +++++++++++++++ .github/ISSUE_TEMPLATE/BUG.yml | 41 ++++++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml | 34 ++++++++++ .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md | 25 ++++++++ .gitignore | 3 + .yamllint | 7 +++ LICENSE | 21 +++++++ README.md | 62 +++++++++++++++++++ src/@orb.yml | 15 +++++ src/README.md | 26 ++++++++ src/commands/greet.yml | 15 +++++ src/examples/example.yml | 13 ++++ src/executors/default.yml | 12 ++++ src/jobs/hello.yml | 14 +++++ src/scripts/greet.sh | 6 ++ 16 files changed, 374 insertions(+) create mode 100644 .circleci/config.yml create mode 100644 .circleci/test-deploy.yml create mode 100644 .github/ISSUE_TEMPLATE/BUG.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md create mode 100644 .gitignore create mode 100644 .yamllint create mode 100644 LICENSE create mode 100644 README.md create mode 100755 src/@orb.yml create mode 100644 src/README.md create mode 100755 src/commands/greet.yml create mode 100755 src/examples/example.yml create mode 100755 src/executors/default.yml create mode 100755 src/jobs/hello.yml create mode 100644 src/scripts/greet.sh diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..5a5adb6 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,29 @@ +version: 2.1 +setup: true +orbs: + orb-tools: circleci/orb-tools@12.3 + shellcheck: circleci/shellcheck@3.2 + +filters: &filters + tags: + only: /.*/ + +workflows: + lint-pack: + jobs: + - orb-tools/lint: + filters: *filters + - orb-tools/pack: + filters: *filters + - orb-tools/review: + orb_name: browserstack-circleci-orb + filters: *filters + - shellcheck/check: + filters: *filters + # Triggers the next workflow in the Orb Development Kit. + - orb-tools/continue: + pipeline_number: << pipeline.number >> + vcs_type: << pipeline.project.type >> + 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 new file mode 100644 index 0000000..00371aa --- /dev/null +++ b/.circleci/test-deploy.yml @@ -0,0 +1,51 @@ +version: 2.1 +orbs: + # Your orb will be automatically injected here during the pipeline. + # Reference your orb's jobs and commands below as they will exist when built. + orb-tools: circleci/orb-tools@12.3 + # The orb definition is intentionally not included here. It will be injected into the pipeline. + browserstack-circleci-orb: {} + +# Use this tag to ensure test jobs always run, +# even though the downstream publish job will only run on release tags. +filters: &filters + tags: + only: /.*/ + +# Filter for release tags. +release-filters: &release-filters + branches: + ignore: /.*/ + tags: + only: /^v[0-9]+\.[0-9]+\.[0-9]+$/ + +jobs: + # Create jobs to test the commands of your orbs. + # You may want to add additional validation steps to ensure the commands are working as expected. + command-test: + docker: + - image: cimg/base:current + steps: + - checkout + # Run your orb's commands to validate them. + - browserstack-circleci-orb/greet +workflows: + test-deploy: + jobs: + # Make sure to include "filters: *filters" in every test job you want to run as part of your deployment. + # Test your orb's commands in a custom job and test your orb's jobs directly as a part of this workflow. + - command-test: + filters: *filters + # The orb must be re-packed for publishing, and saved to the workspace. + - orb-tools/pack: + filters: *release-filters + - orb-tools/publish: + orb_name: browserstack/browserstack-circleci-orb + vcs_type: << pipeline.project.type >> + pub_type: production + # Ensure this job requires all test jobs and the pack job. + requires: + - orb-tools/pack + - command-test + context: orb-publishing + filters: *release-filters diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml new file mode 100644 index 0000000..7959796 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -0,0 +1,41 @@ +name: "\U0001F41E Bug Report" +description: Report any identified bugs. +title: 'Bug: ' +labels: [bug] +# assignees: '' +body: + - type: checkboxes + attributes: + label: "Is there an existing issue for this?" + description: "Please search [here](https://github.com///issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered" + options: + - label: "I have searched the existing issues" + required: true + + - type: input + attributes: + label: "Orb version" + description: | + Which version of `/` are you using? + placeholder: "1.0.0" + + - type: textarea + validations: + required: true + attributes: + label: "Current behavior" + description: "How does the issue manifest?" + + - type: textarea + validations: + required: true + attributes: + label: "Minimum reproduction config" + description: "Enter a URL to a failed build or write a config example to reproduce the issue" + placeholder: "https://app.circleci.com/..." + + - type: textarea + attributes: + label: "Other" + description: | + Anything else you want to share? diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml new file mode 100644 index 0000000..864fd10 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml @@ -0,0 +1,34 @@ +name: "\U0001F4A1 Feature Request" +description: Have an idea for a new feature? Begin by submitting a Feature Request +title: 'Request: ' +labels: [enhancement] +# assignees: '' +body: + - type: checkboxes + attributes: + label: "Is there an existing issue that is already proposing this?" + description: "Please search [here](https://github.com/CircleCI-Public/circleci-config-sdk-ts/issues?q=is%3Aissue) to see if an issue already exists for the feature you are requesting" + options: + - label: "I have searched the existing issues" + required: true + + - type: textarea + validations: + required: true + attributes: + label: "Describe the problem imposed by not having this feature" + description: "Please describe the use-case you are attempting to implement, and the current limitations you are facing." + + - type: textarea + validations: + required: true + attributes: + label: "Describe the solution you'd like" + description: "A clear and concise description of what you want to happen. Add any considered drawbacks" + + + - type: textarea + attributes: + label: "Other" + description: | + Anything else you want to share? \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md new file mode 100644 index 0000000..6b802b2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md @@ -0,0 +1,25 @@ +## PR Type +What kind of change does this PR introduce? + + +- [ ] Bugfix +- [ ] Feature +- [ ] Code style update (formatting) +- [ ] Refactoring (no functional changes) +- [ ] CI related changes +- [ ] Other... Please describe: + +## What is the current behavior? + + +Issue Number: N/A + +## What is the new behavior? + +## Does this PR introduce a breaking change? +- [ ] Yes +- [ ] No + + + +## Other information diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c88c1b --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# orb.yml is "packed" from source, and not published directly from the repository. +orb.yml +.DS_Store \ No newline at end of file diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..c9a8a2e --- /dev/null +++ b/.yamllint @@ -0,0 +1,7 @@ +extends: relaxed + +rules: + line-length: + max: 200 + allow-non-breakable-inline-mappings: true + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..23234b6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c7edaff --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# Orb Template + + +[![CircleCI Build Status](https://circleci.com/gh/JryBWxh6hsGZUqwDfzkkT7/browserstack-circleci-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/JryBWxh6hsGZUqwDfzkkT7/browserstack-circleci-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/browserstack/browserstack-circleci-orb.svg)](https://circleci.com/developer/orbs/orb/browserstack/browserstack-circleci-orb) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/JryBWxh6hsGZUqwDfzkkT7/browserstack-circleci-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs) + + + +A project template for Orbs. + +This repository is designed to be automatically ingested and modified by the CircleCI CLI's `orb init` command. + +_**Edit this area to include a custom title and description.**_ + +--- + +## Resources + +[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/browserstack/browserstack-circleci-orb) - The official registry page of this orb for all versions, executors, commands, and jobs described. + +[CircleCI Orb Docs](https://circleci.com/docs/orb-intro/#section=configuration) - Docs for using, creating, and publishing CircleCI Orbs. + +### 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! + +### 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. + - 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"_. + - This will create a summary of all of the merged pull requests since the previous release. + - If you have used _[Conventional Commit Messages](https://conventionalcommits.org/)_ it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published. +5. Now ensure the version tag selected is semantically accurate based on the changes included. +6. Click _"Publish Release"_. + - This will push a new tag and trigger your publishing pipeline on CircleCI. + +### Development Orbs + +Prerequisites: + +- An initial sevmer deployment must be performed in order for Development orbs to be published and seen in the [Orb Registry](https://circleci.com/developer/orbs). + +A [Development orb](https://circleci.com/docs/orb-concepts/#development-orbs) can be created to help with rapid development or testing. To create a Development orb, change the `orb-tools/publish` job in `test-deploy.yml` to be the following: + +```yaml +- orb-tools/publish: + orb_name: browserstack/browserstack-circleci-orb + vcs_type: << pipeline.project.type >> + pub_type: dev + # Ensure this job requires all test jobs and the pack job. + requires: + - orb-tools/pack + - command-test + context: orb-publishing + filters: *filters +``` + +The job output will contain a link to the Development orb Registry page. The parameters `enable_pr_comment` and `github_token` can be set to add the relevant publishing information onto a pull request. Please refer to the [orb-tools/publish](https://circleci.com/developer/orbs/orb/circleci/orb-tools#jobs-publish) documentation for more information and options. diff --git a/src/@orb.yml b/src/@orb.yml new file mode 100755 index 0000000..c798ce2 --- /dev/null +++ b/src/@orb.yml @@ -0,0 +1,15 @@ +version: 2.1 + +description: > + Sample orb description +# 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" + +# If your orb requires other orbs, you can import them like this. Otherwise remove the "orbs" stanza. +# orbs: +# hello: circleci/hello-build@0.0.5 diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..b8e1015 --- /dev/null +++ b/src/README.md @@ -0,0 +1,26 @@ +# Orb Source + +Orbs are shipped as individual `orb.yml` files, however, to make development easier, it is possible to author an orb in _unpacked_ form, which can be _packed_ with the CircleCI CLI and published. + +The default `.circleci/config.yml` file contains the configuration code needed to automatically pack, test, and deploy any changes made to the contents of the orb source in this directory. + +## @orb.yml + +This is the entry point for our orb "tree", which becomes our `orb.yml` file later. + +Within the `@orb.yml` we generally specify 4 configuration keys + +**Keys** + +1. **version** + Specify version 2.1 for orb-compatible configuration `version: 2.1` +2. **description** + Give your orb a description. Shown within the CLI and orb registry +3. **display** + Specify the `home_url` referencing documentation or product URL, and `source_url` linking to the orb's source repository. +4. **orbs** + (optional) Some orbs may depend on other orbs. Import them here. + +## See: + - [Orb Author Intro](https://circleci.com/docs/2.0/orb-author-intro/#section=configuration) + - [Reusable Configuration](https://circleci.com/docs/2.0/reusing-config) diff --git a/src/commands/greet.yml b/src/commands/greet.yml new file mode 100755 index 0000000..f4e2205 --- /dev/null +++ b/src/commands/greet.yml @@ -0,0 +1,15 @@ +description: > + This command echos "Hello World" using file inclusion. +# What will this command do? +# Descriptions should be short, simple, and clear. +parameters: + to: + type: string + default: "World" + description: "Hello to whom?" +steps: + - run: + environment: + PARAM_TO: <> + name: Hello Greeting + command: <> diff --git a/src/examples/example.yml b/src/examples/example.yml new file mode 100755 index 0000000..a2cdaab --- /dev/null +++ b/src/examples/example.yml @@ -0,0 +1,13 @@ +description: > + Sample example description. +# Provide a use-case based example for using this orb. +# Everything in the `usage` section will be displayed in the orb registry. +# Comments are not retained. +usage: + version: 2.1 + orbs: + : /@1.2.3 + workflows: + use-my-orb: + jobs: + - / diff --git a/src/executors/default.yml b/src/executors/default.yml new file mode 100755 index 0000000..ca3f5dc --- /dev/null +++ b/src/executors/default.yml @@ -0,0 +1,12 @@ +description: > + This is a sample executor using Docker and Node. If you want to provide a custom environment in your orb, insert your image here. + If you do not require an executor, you can simply delete this directory. +docker: + - image: 'cimg/node:<>' +parameters: + tag: + default: lts + description: > + Pick a specific cimg/node image variant: + https://hub.docker.com/r/cimg/node/tags + type: string diff --git a/src/jobs/hello.yml b/src/jobs/hello.yml new file mode 100755 index 0000000..8f1df04 --- /dev/null +++ b/src/jobs/hello.yml @@ -0,0 +1,14 @@ +description: > + Sample description +# What will this job do? + +executor: default + +parameters: + to: + type: string + default: "World" + description: "Hello to whom?" +steps: + - greet: + to: << parameters.to >> diff --git a/src/scripts/greet.sh b/src/scripts/greet.sh new file mode 100644 index 0000000..7d511d5 --- /dev/null +++ b/src/scripts/greet.sh @@ -0,0 +1,6 @@ +#!/bin/bash +# This example uses envsubst to support variable substitution in the string parameter type. +# https://circleci.com/docs/orbs-best-practices/#accepting-parameters-as-strings-or-environment-variables +TO=$(circleci env subst "${PARAM_TO}") +# If for any reason the TO variable is not set, default to "World" +echo "Hello ${TO:-World}!" From 73dba9bc19c7df06fc893faa5c0721f616721ec8 Mon Sep 17 00:00:00 2001 From: Amark19 Date: Mon, 10 Mar 2025 21:15:59 +0530 Subject: [PATCH 2/6] Initial commit --- .circleci/config.yml | 2 +- .circleci/test-deploy.yml | 2 +- .gitignore | 3 +- README.md | 4 +- src/@orb.yml | 6 +- src/commands/greet.yml | 15 --- src/commands/set_rerun_tests.yml | 8 ++ src/examples/{example.yml => cleanup_env.yml} | 0 src/examples/set_rerun_tests.yml | 19 +++ src/jobs/cleanup_env.yml | 8 ++ src/jobs/hello.yml | 14 --- src/scripts/greet.sh | 6 - src/scripts/rerun_tests.sh | 113 ++++++++++++++++++ 13 files changed, 157 insertions(+), 43 deletions(-) delete mode 100755 src/commands/greet.yml create mode 100755 src/commands/set_rerun_tests.yml rename src/examples/{example.yml => cleanup_env.yml} (100%) create mode 100644 src/examples/set_rerun_tests.yml create mode 100755 src/jobs/cleanup_env.yml delete mode 100755 src/jobs/hello.yml delete mode 100644 src/scripts/greet.sh create mode 100644 src/scripts/rerun_tests.sh diff --git a/.circleci/config.yml b/.circleci/config.yml index 5a5adb6..065439f 100644 --- 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 index 00371aa..26318d7 100644 --- 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 index 3c88c1b..5de9a49 100644 --- 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 \ No newline at end of file +.DS_Store +.idea \ No newline at end of file diff --git a/README.md b/README.md index c7edaff..49e56ad 100644 --- 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 index c798ce2..c15ba50 100755 --- 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 deleted file mode 100755 index f4e2205..0000000 --- a/src/commands/greet.yml +++ /dev/null @@ -1,15 +0,0 @@ -description: > - This command echos "Hello World" using file inclusion. -# What will this command do? -# Descriptions should be short, simple, and clear. -parameters: - to: - type: string - default: "World" - description: "Hello to whom?" -steps: - - run: - environment: - PARAM_TO: <> - name: Hello Greeting - command: <> diff --git a/src/commands/set_rerun_tests.yml b/src/commands/set_rerun_tests.yml new file mode 100755 index 0000000..bdcac6b --- /dev/null +++ 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: <> + environment: + CLEANUP_ENV_VAR: true diff --git a/src/examples/example.yml b/src/examples/cleanup_env.yml similarity index 100% rename from src/examples/example.yml rename to src/examples/cleanup_env.yml diff --git a/src/examples/set_rerun_tests.yml b/src/examples/set_rerun_tests.yml new file mode 100644 index 0000000..38fafe6 --- /dev/null +++ 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 new file mode 100755 index 0000000..2c6b7cb --- /dev/null +++ b/src/jobs/cleanup_env.yml @@ -0,0 +1,8 @@ +description: "Cleanup the project level environment variable" + +steps: + - run: + name: Cleanup Environment + command: <> + environment: + CLEANUP_ENV_VAR: true diff --git a/src/jobs/hello.yml b/src/jobs/hello.yml deleted file mode 100755 index 8f1df04..0000000 --- a/src/jobs/hello.yml +++ /dev/null @@ -1,14 +0,0 @@ -description: > - Sample description -# What will this job do? - -executor: default - -parameters: - to: - type: string - default: "World" - description: "Hello to whom?" -steps: - - greet: - to: << parameters.to >> diff --git a/src/scripts/greet.sh b/src/scripts/greet.sh deleted file mode 100644 index 7d511d5..0000000 --- a/src/scripts/greet.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash -# This example uses envsubst to support variable substitution in the string parameter type. -# https://circleci.com/docs/orbs-best-practices/#accepting-parameters-as-strings-or-environment-variables -TO=$(circleci env subst "${PARAM_TO}") -# If for any reason the TO variable is not set, default to "World" -echo "Hello ${TO:-World}!" diff --git a/src/scripts/rerun_tests.sh b/src/scripts/rerun_tests.sh new file mode 100644 index 0000000..d3aa476 --- /dev/null +++ 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 From 013c4fb5f78e6c7d6164149e742aaa763d8b2e53 Mon Sep 17 00:00:00 2001 From: Amark19 Date: Mon, 10 Mar 2025 21:23:09 +0530 Subject: [PATCH 3/6] changed cleanup_env job example --- src/examples/cleanup_env.yml | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/src/examples/cleanup_env.yml b/src/examples/cleanup_env.yml index a2cdaab..f0364b0 100755 --- a/src/examples/cleanup_env.yml +++ b/src/examples/cleanup_env.yml @@ -1,13 +1,10 @@ -description: > - Sample example description. -# Provide a use-case based example for using this orb. -# Everything in the `usage` section will be displayed in the orb registry. -# Comments are not retained. -usage: - version: 2.1 - orbs: - : /@1.2.3 - workflows: - use-my-orb: - jobs: - - / +version: '2.1' +orbs: + browserstack-circleci-orb: browserstack/browserstack-circleci-orb@1.0.0 +workflows: + cleanup-job-example: + jobs: + - my_test_job + - browserstack-circleci-orb/cleanup_env: + requires: + - my_test_job From e54cf3882965003613c9019c2d5cc8976f2e685f Mon Sep 17 00:00:00 2001 From: Amark19 Date: Tue, 11 Mar 2025 16:31:37 +0530 Subject: [PATCH 4/6] added vcs_type as github in test-deploy --- .circleci/test-deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/test-deploy.yml b/.circleci/test-deploy.yml index 26318d7..2457932 100644 --- a/.circleci/test-deploy.yml +++ b/.circleci/test-deploy.yml @@ -41,7 +41,7 @@ workflows: filters: *release-filters - orb-tools/publish: orb_name: browserstack/browserstack-circleci-orb - vcs_type: << pipeline.project.type >> + vcs_type: github pub_type: production # Ensure this job requires all test jobs and the pack job. requires: From ee3164f000c035b7f28879d32cfe521f7b0da803 Mon Sep 17 00:00:00 2001 From: Amark19 Date: Thu, 13 Mar 2025 13:07:37 +0530 Subject: [PATCH 5/6] Updated examples of orb --- src/examples/cleanup_env.yml | 24 +++++++++++-------- src/examples/set_rerun_tests.yml | 40 ++++++++++++++++++-------------- src/jobs/cleanup_env.yml | 2 ++ 3 files changed, 38 insertions(+), 28 deletions(-) diff --git a/src/examples/cleanup_env.yml b/src/examples/cleanup_env.yml index f0364b0..459a948 100755 --- a/src/examples/cleanup_env.yml +++ b/src/examples/cleanup_env.yml @@ -1,10 +1,14 @@ -version: '2.1' -orbs: - browserstack-circleci-orb: browserstack/browserstack-circleci-orb@1.0.0 -workflows: - cleanup-job-example: - jobs: - - my_test_job - - browserstack-circleci-orb/cleanup_env: - requires: - - my_test_job +description: | + This example demonstrates how to use the BrowserStack CircleCI Orb to clean up the project environment variables after the test execution. + +usage: + version: 2.1 + orbs: + browserstack-circleci-orb: browserstack/browserstack-circleci-orb@x.y.z + workflows: + cleanup-job-example: + jobs: + - my_test_job + - browserstack-circleci-orb/cleanup_env: + requires: + - my_test_job diff --git a/src/examples/set_rerun_tests.yml b/src/examples/set_rerun_tests.yml index 38fafe6..3a180e5 100644 --- a/src/examples/set_rerun_tests.yml +++ b/src/examples/set_rerun_tests.yml @@ -1,19 +1,23 @@ -version: '2.1' -orbs: - browserstack-circleci-orb: browserstack/browserstack-circleci-orb@1.0.0 +description: | + This example demonstrates how to use browserstack rerun tests command & set it in job environment variable. -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 +usage: + version: 2.1 + orbs: + browserstack-circleci-orb: browserstack/browserstack-circleci-orb@x.y.z + + 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 index 2c6b7cb..cc1755d 100755 --- a/src/jobs/cleanup_env.yml +++ b/src/jobs/cleanup_env.yml @@ -1,5 +1,7 @@ description: "Cleanup the project level environment variable" +executor: default + steps: - run: name: Cleanup Environment From 35a4fe4cb7c0845392994a001f27801c219495cb Mon Sep 17 00:00:00 2001 From: Amark19 Date: Thu, 13 Mar 2025 13:28:18 +0530 Subject: [PATCH 6/6] changed command name --- src/commands/set_rerun_tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/commands/set_rerun_tests.yml b/src/commands/set_rerun_tests.yml index bdcac6b..21a5672 100755 --- a/src/commands/set_rerun_tests.yml +++ b/src/commands/set_rerun_tests.yml @@ -2,7 +2,7 @@ description: "Cleanup the project level environment variable set by browserstack steps: - run: - name: Cleanup Environment + name: Set Rerun Tests command: <> environment: CLEANUP_ENV_VAR: true