myusufcse/android-test-report-action

GitHub Action that prints Android test reports.

Android Test Report Action

GitHub Action that prints Android test xml reports.

Getting Started

Add the following action to your GitHub Actions workflow.

- name: Android Test Report
  uses: asadmansr/android-test-report-action@v1.2.0

Usage

Basic

Once the test command has been executed, the Android Test Report action will parse all of the XML reports and output the results in a structured way.

name: Android CI
on: [push]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1

      - name: set up JDK 1.8
        uses: actions/setup-java@v1
        with:
          java-version: 1.8

      # Execute unit tests
      - name: Unit Test
        run: ./gradlew testDebugUnitTest

      - name: Android Test Report
        uses: asadmansr/android-test-report-action@v1.2.0
        if: ${{ always() }} # IMPORTANT: run Android Test Report regardless

Note

The workflow must contain the unit test job prior to running the Android Test Report action. The action will automatically pass or fail the job depending on the test results.

Alternate

If the basic usage fails to meet your requirement (running on MacOS machine or anything else), split the test and report into two jobs. The test job will run the tests and save the reports as artifacts. The report job will use the Android Test Report action to parse and print the results. Consider the following example below.

jobs:
  test:
    runs-on: macos-latest # or any other machine
    steps:
      ...
      - name: Unit Test
        run: ./gradlew testDebugUnitTest

      - name: Upload Test Reports Folder
        uses: actions/upload-artifact@v2
        if: ${{ always() }} # IMPORTANT: Upload reports regardless of status
        with:
          name: reports
          path: app/build/test-results # path to where the xml test results are stored
        
  report:
    runs-on: ubuntu-latest
    needs: test # The report job will run after test job
    if: ${{ always() }} # IMPORTANT: Execute report job regardless of status
    steps:
      - name: Download Test Reports Folder
        uses: actions/download-artifact@v2
        with:
          name: reports

      - name: Android Test Report
        uses: asadmansr/android-test-report-action@v1.2.0

Output

Sample Project

To learn how to use this action in an Android application, check out the following example repository: https://github.com/asadmansr/android-test-report-action-example

• master branch: Passed pipeline as all the tests passed
• failed-pipeline branch: Failed pipeline as some of the tests failed