Instructions

You can use our Endtest GitHub Action in order to integrate Endtest with GitHub.

This GitHub Action creates an Endtest deployment event, triggering any functional tests associated with that deployment and waiting for their results.

Example workflow:

on: [push]

name: endtest

jobs:
  test:
    name: Endtest Functional Test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master

      - name: Functional test deployment
        id: endtest_functional_tests
        uses: endtest-technologies/github-run-tests-action@v1.5
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          app_id: <your-endtest-app-id>
          app_code: <your-endtest-app-code>
          api_request: <your-endtest-api-request-for-starting-a-test-execution>
          number_of_loops: <the-number-of-times-the-API-request-for-fetching-the-results-will-be-sent-once-every-30-seconds>

      - name: Use the outputs from test execution in a different step
        run: |
          echo ${{ steps.endtest_functional_tests.outputs.test_suite_name }}
          echo ${{ steps.endtest_functional_tests.outputs.configuration }}
          echo ${{ steps.endtest_functional_tests.outputs.test_cases }}
          echo ${{ steps.endtest_functional_tests.outputs.passed }}
          echo ${{ steps.endtest_functional_tests.outputs.failed }}
          echo ${{ steps.endtest_functional_tests.outputs.errors }}
          echo ${{ steps.endtest_functional_tests.outputs.start_time }}
          echo ${{ steps.endtest_functional_tests.outputs.end_time }}
          echo ${{ steps.endtest_functional_tests.outputs.detailed_logs }}
          echo ${{ steps.endtest_functional_tests.outputs.screenshots_and_video }}
          echo ${{ steps.endtest_functional_tests.outputs.hash }}
          echo ${{ steps.endtest_functional_tests.outputs.results }}

Environment variables

• GITHUB_TOKEN {string} (optional) - The Github token for your repository. If provided, the Endtest action will associate a pull request with the deployment if the commit being built is associated with any pull requests. This token is automatically available as a secret in your repo but must be passed in explicitly in order for the action to be able to access it.

Inputs

• app_id {string} - The App ID for your Endtest account (available here).
• app_code {string} - The App Code for your Endtest account (available here).
• api_request {string} - The Endtest API request.
• number_of_loops {int32} - The number of times the API request for fetching the results will be sent once every 30 seconds.

Outputs:

• test_suite_name {string} - The name of the test suite.
• configuration {string} - The configuration of the machine or mobile device on which the test was executed.
• test_cases {int32} - The number of test cases.
• passed {int32} - The number of assertions that have passed.
• failed {int32} - The number of assertions that have failed.
• errors {int32} - The number of errors that have been encountered.
• start_time {timestamp} - The timestamp for the start of the test execution.
• end_time {timestamp} - The timestamp for the end of the test execution.
• detailed_logs {string} - The detailed logs for the test execution.
• screenshots_and_video {string} - The URLs for the screenshots and the video recording of the test execution.
• hash {string} - The unique hash for the test execution.
• results {string} - The link to the Results page for the test execution.

As an alternative, you can also write your own custom script and use the Endtest API to start a test execution and fetch the results.

More details are available in the Endtest API chapter.