{"id":24253,"date":"2023-09-15T00:08:25","date_gmt":"2023-09-14T15:08:25","guid":{"rendered":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/?page_id=24253"},"modified":"2023-09-20T18:36:03","modified_gmt":"2023-09-20T09:36:03","slug":"circleci","status":"publish","type":"page","link":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/test-automation\/ci-cd-tools-integration\/circleci\/","title":{"rendered":"Integrating with CircleCI"},"content":{"rendered":"

CircleCI<\/a> is a CI\/CD (Continuous Integration and Deployment) tool that helps development teams release code rapidly and automate the build, test, and deployment of their applications. Using CircleCI, engineers can automate their entire testing suite for new commits, reducing the potential for human error. After source-code repositories (on GitHub, Bitbucket, or GitLab) are authorized and added as a project to CircleCI, every commit triggers CircleCI to run jobs.<\/p>\n

An everyday use case for CircleCI is building and testing your application whenever code changes are submitted. To take full advantage of TestRail and manage all your test cases and test results, both manual and automated, in a centralized manner, you can send your automated test results directly from CircleCI to TestRail. This article will explore how to easily use CircleCI and the TestRail CLI<\/a> to accomplish this task.<\/p>\n

\n

\u00a0<\/em>[et_pb_text admin_label=”Note” _builder_version=”4.4.2″ background_color=”#F0F8FF” hover_enabled=”0″ border_width_all=”1px” border_color_all=”#b0c4de”]<\/p>\n

\n

Please note that the TestRail CLI<\/a> requires that a compatible JUnit report<\/strong> is generated by your test automation framework.<\/p>\n<\/div>\n

[\/et_pb_text]<\/p>\n<\/div>\n

Using the TestRail CLI in CircleCI workflows<\/h2>\n

Automated processes can be configured in CircleCI using workflow configuration files. These are YAML files that allow you to specify your processes in a structured manner and make use of CircleCI for each step of the way to make it easier to configure your execution environment, as well as execute any step you require.<\/p>\n

The easiest way to integrate TestRail with CircleCI is by configuring your workflow to use the TestRail CLI to send automated test results to TestRail. Below is a sample of how a workflow file using the TestRail CLI<\/a> to send test results to TestRail would look like.<\/p>\n

version: 2.1\norbs:\n  browser-tools: circleci\/browser-tools@1.4.1\nworking_directory: ~\/automation-framework-integration\njobs:\n  build-and-test:\n    docker:\n      - image: cimg\/openjdk:15.0\n    steps:\n      - browser-tools\/install-browser-tools:\n          chrome-version: 109.0.5414.74\n      - checkout  # Performs code checkout\n      - run:\n          name: Build and run the tests\n          command: |\n            chmod 777 drivers\/linux\/chromedriver\n            mvn clean compile test\n      - persist_to_workspace:\n          root: .\/\n          paths:\n            - target\/TEST-junit-jupiter.xml\n  install-trcli-and-upload-results:\n    docker:\n      - image: cimg\/python:3.11\n    steps:\n     - attach_workspace:\n         at: .\/automation-framework-integration\n     - run:\n         name: Install TR CLI and upload the test results to TestRail\n         command: |\n           pip install trcli\n           trcli -y \\\n             -h https:\/\/INSTANCE.testrail.io\/ \\\n             --project \"PROJECT NAME\" \\\n             -u USER_EMAIL \\\n             -p PASSWORD \\\n             parse_junit \\\n             --title \"Automated Tests from CircleCI workflow\" \\\n             --run-description $CIRCLE_BUILD_URL \\\n             -f \".\/automation-framework-integration\/target\/TEST-junit-jupiter.xml\"\n\n# Invoke configured jobs using a workflow:\nworkflows:\n  sample:  # Name of the workflow\n    jobs:\n      - build-and-test\n      - install-trcli-and-parse-results:\n         requires:\n            - build-and-test<\/pre>\n
A CircleCI job is a collection of sequential steps. All job steps are executed in a single unit within a fresh container or a virtual machine. Jobs are orchestrated using CircleCI workflows.<\/a><\/p>\n
Breaking down the file, we notice that the workflow comprises two jobs.<\/p>\n