INTEGRATIONS
CI/CD Integration

5min
You can integrate Relicx with your CI/CD pipeline using GitHub Actions or CLI.
Github Actions
Repo: https://github.com/relicx-ai/relicx-githubaction﻿
Text
    uses: relicx-ai/relicx-githubaction@v1.2
    with:
      username: ${{ secrets.USERNAME }}
      password: ${{ secrets.PASSWORD }}
      app_id: <app_id>
      command: run_test_suite
      test_suite_id:<test_suite_id? 
      environment_id: <env_id>
      wait: false
    uses: relicx-ai/relicx-githubaction@v1.2
    with:
      username: ${{ secrets.USERNAME }}
      password: ${{ secrets.PASSWORD }}
      app_id: <app_id>
      command: run_test_suite
      test_suite_id:<test_suite_id? 
      environment_id: <env_id>
      wait: false
﻿
To generate the Github Actions code navigate to Settings -> Integrations -> CI/CD
﻿
﻿
Python CLI
Setup
Please ensure the following pre-requisites are met before using the python cli
python3
Access to https://app.relicx.ai﻿
Alternatively you may have to install urllib package if you come across this error ModuleNotFoundError: No module named 'urllib3'
Text
pip install urllib3
pip install urllib3
﻿
Now install the Relicx package
Text
wget https://s3.us-west-1.amazonaws.com/apiclient.relicx.ai/prod/relicx.tar.gz
pip install relicx.tar.gz
wget https://s3.us-west-1.amazonaws.com/apiclient.relicx.ai/prod/relicx.tar.gz
pip install relicx.tar.gz
﻿
Once the setup is complete, execute the test suite with the following commands. You can also generate the command from the product by navigating to Settings -> Integrations -> CI/CD
export relicx_username= <credentials>
export relicx_password= <credentials>
python -m relicx.cli --app_id <app_id> run_test_suite --environment_id <env_id> --test_suite_id <test_suite_id> --wait true
Set wait to true to make the run blocking and false otherwise. A blocking run will make your CD wait until the test suite execution has finished.
Updated 04 Dec 2023
Did this page help you?
Testing Firewall Protected Apps
Notifications