{"id":24221,"date":"2023-09-14T11:40:38","date_gmt":"2023-09-14T02:40:38","guid":{"rendered":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/?page_id=24221"},"modified":"2023-09-20T18:36:07","modified_gmt":"2023-09-20T09:36:07","slug":"bitbucket","status":"publish","type":"page","link":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/801\/test-automation\/ci-cd-tools-integration\/bitbucket\/","title":{"rendered":"Integrating with Bitbucket"},"content":{"rendered":"

With Bitbucket Pipelines<\/a>, you can automate all the steps required to build, test and deploy your code. Typically teams use Bitbucket to store their source code. With the CI\/CD capabilities, they can also build and test their code inside Bitbucket by creating pipelines to streamline building and testing the code before being deployed.<\/p>\n

An everyday use case for Bitbucket Pipelines 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, you can send your automated test results directly from Bitbucket to TestRail. This article will explore how to efficiently use Bitbucket Pipelines and the TestRail CLI<\/a> to accomplish this task.<\/p>\n

Please note that the TestRail CLI requires your test automation framework to generate a compatible JUnit XML report.<\/p>\n

Using the TestRail CLI in Bitbucket Pipelines<\/h2>\n

Automated processes can be configured in Bitbucket using a bitbucket-pipelines.yml<\/strong> file. These YAML files allow you to specify your build process in a structured manner. Under bitbucket-pipelines.yml<\/strong>, you can define a default build environment and the steps to execute when a pipeline is triggered.<\/p>\n

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

image: python:3.9\npipelines:\n  default:\n    - step:\n        name: Build and run the tests\n        caches:\n          - pip\n        script:\n          - apt-get update && apt install -y curl\n          - curl -fsSL https:\/\/deb.nodesource.com\/setup_20.x | bash - && apt-get install -y nodejs\n          - pip install robotframework-browser\n          - rfbrowser init\n          - npx playwright install-deps                                        \n          - robot -d reports -x junit-report.xml \".\/tests\" || true\n        artifacts:\n          - reports\/junit-report.xml\n    - step:\n        name: Install TR CLI and upload the test results to TestRail\n        script:\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 Bitbucket Pipelines\"\n            --run-description $BITBUCKET_GIT_HTTP_ORIGIN\/pipelines\/results\/$BITBUCKET_BUILD_NUMBER\n            -f \"reports\/junit-report.xml\"<\/pre>\n
Breaking down the bitbucket-pipelines.yml<\/strong>, we notice some interesting facts.<\/p>\n
    \n
  1. \n
      \n
    1. We have chosen the Python<\/a> image for running this build<\/li>\n
    2. We have two steps within the job<\/li>\n
    3. The first step is to install the Robot Framework Browser Library<\/a> and run the tests<\/li>\n
    4. The second step is to install TestRail CLI<\/a> and upload test results to TestRail<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n
      The script<\/strong> in both steps defines the commands to execute on the Python image. As a whole, these scripts perform the following functions:<\/p>\n