PIMOB-2183: Add UI test GHA flow (#247)

.github/workflows/android-lint.yml

@@ -0,0 +1,14 @@
+on:
+  workflow_call:
+    inputs:
+      module:
+        description: 'Module to run'
+        required: true
+        type: string
+jobs:
+  android-lint:
+    uses: ./.github/workflows/gradle-task.yml
+    with:
+      module: ${{ inputs.module }}
+      task: lint
+      task-name: Run Android Lint Check

.github/workflows/assemble-module.yml

@@ -0,0 +1,18 @@
+on:
+  workflow_call:
+    inputs:
+      module:
+        description: 'Module to run'
+        required: true
+        type: string
+      variant:
+        description: 'Variant to build'
+        required: true
+        type: string
+jobs:
+  assemble:
+    uses: ./.github/workflows/gradle-task.yml
+    with:
+      module: ${{ inputs.module }}
+      task: assemble${{inputs.variant}}
+      task-name: Assemble ${{inputs.module}} - ${{inputs.variant}}

.github/workflows/codeql-analysis.yml

@@ -7,6 +7,13 @@ on:
     # The branches below must be a subset of the branches above
     types: [ opened, synchronize, reopened ]
     branches: [ master, "bugfix/*", "feature/*", "release/*" ]
+    paths:
+      - 'checkout/**'
+      - 'example_app_frames/**'
+      - 'app/**'
+      - 'frames/**'
+      - 'buildSrc/**'
+      - 'build.gradle.kt'
   schedule:
     - cron: '34 2 * * 0'
 

.github/workflows/gradle-task.yml

@@ -0,0 +1,40 @@
+on:
+  workflow_call:
+    inputs:
+      module:
+        description: 'Module to run'
+        required: true
+        type: string
+      task:
+        description: 'Task to run'
+        required: true
+        type: string
+      task-name:
+        description: 'Task Name'
+        required: true
+        type: string
+
+jobs:
+  task:
+    name: ${{ inputs.task-name }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: gradle
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Cache Gradle and wrapper
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+      - name: Run unit tests with Gradle
+        run: ./gradlew :${{ inputs.module }}:${{ inputs.task }}

.github/workflows/ktlint.yml

@@ -0,0 +1,14 @@
+on:
+  workflow_call:
+    inputs:
+      module:
+        description: 'Module to run'
+        required: true
+        type: string
+jobs:
+  ktlint:
+    uses: ./.github/workflows/gradle-task.yml
+    with:
+      module: ${{ inputs.module }}
+      task: ktlint
+      task-name: Run Ktlint Check

.github/workflows/ui-test.yml

@@ -0,0 +1,47 @@
+name: UI Test
+
+on:
+  workflow_call:
+    inputs:
+      module:
+        description: 'Module to run'
+        required: true
+        type: string
+
+jobs:
+  connected-android-tests:
+    name: Run Connected Android Tests
+    # Run on macOS because we need to run the emulator and the emulator is not supported on Linux
+    runs-on: macos-latest
+    strategy:
+      fail-fast: true
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: gradle
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Cache Gradle and wrapper
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+
+      - name: Launch Emulator
+        run: chmod +x ./scripts/launch-emulator.sh && ./scripts/launch-emulator.sh
+
+      - name: Run UI Test on ${{ inputs.module }}
+        run: ./gradlew :${{ inputs.module }}:connectedAndroidTest --stacktrace

.github/workflows/unit-test.yml

@@ -0,0 +1,14 @@
+on:
+  workflow_call:
+    inputs:
+      module:
+        description: 'Module to run'
+        required: true
+        type: string
+jobs:
+  unit-test:
+    uses: ./.github/workflows/gradle-task.yml
+    with:
+      module: ${{ inputs.module }}
+      task: test
+      task-name: Run Unit Tests

.github/workflows/verification-flow.yml

@@ -0,0 +1,73 @@
+name: Verification
+
+on:
+  workflow_call:
+    inputs:
+      module:
+        description: 'Module to run'
+        required: true
+        type: string
+      run-android-lint:
+        description: 'Should Run Android Lint'
+        required: false
+        type: boolean
+        default: false
+      run-ktlint:
+        description: 'Should Run Ktlint'
+        required: false
+        type: boolean
+        default: false
+      run-assemble:
+        description: 'Should Run Assemble'
+        required: false
+        type: boolean
+        default: false
+      assemble-variant:
+        description: 'Variant to Run Assemble'
+        required: false
+        type: string
+        default: ''
+      run-unit-test:
+        description: 'Should Run Unit Tests'
+        required: false
+        type: boolean
+        default: false
+      run-ui-test:
+        description: 'Should Run UI Tests'
+        required: false
+        type: boolean
+        default: false
+
+jobs:
+  android-lint:
+    if: ${{ inputs.run-android-lint }}
+    uses: ./.github/workflows/android-lint.yml
+    with:
+      module: ${{ inputs.module }}
+  ktlint:
+    if: ${{ inputs.run-ktlint }}
+    uses: ./.github/workflows/ktlint.yml
+    with:
+      module: ${{ inputs.module }}
+  assemble:
+    if: ${{ inputs.run-assemble }}
+    uses: ./.github/workflows/assemble-module.yml
+    # Add ktlint after ktlint is applied to all modules
+    needs: android-lint
+    with:
+      module: ${{ inputs.module }}
+      variant: ${{ inputs.assemble-variant }}
+  unit-test:
+    if: ${{ inputs.run-unit-test }}
+    uses: ./.github/workflows/unit-test.yml
+    # Add ktlint after ktlint is applied to all modules
+    needs: android-lint
+    with:
+      module: ${{ inputs.module }}
+  ui-test:
+    if: ${{ inputs.run-ui-test }}
+    uses: ./.github/workflows/ui-test.yml
+    # Add ktlint after ktlint is applied to all modules
+    needs: android-lint
+    with:
+      module: ${{ inputs.module }}

.github/workflows/verify-app.yml

@@ -0,0 +1,28 @@
+name: Verify App
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    types: [ opened, synchronize, reopened ]
+    branches: [ master, "bugfix/*", "feature/*", "release/*" ]
+    paths:
+      - 'app/**'
+      - 'checkout/**'
+      - 'frames/**'
+      - 'buildSrc/**'
+      - 'build.gradle.kt'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify-module:
+    uses: ./.github/workflows/verification-flow.yml
+    with:
+      module: app
+      run-android-lint: true
+      run-assemble: true
+      run-unit-test: true

.github/workflows/verify-checkout.yml

@@ -0,0 +1,27 @@
+name: Verify Checkout
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    types: [ opened, synchronize, reopened ]
+    branches: [ master, "bugfix/*", "feature/*", "release/*" ]
+    paths:
+      - 'checkout/**'
+      - 'buildSrc/**'
+      - 'build.gradle.kt'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify-module:
+    uses: ./.github/workflows/verification-flow.yml
+    with:
+      module: checkout
+      run-android-lint: true
+      run-ktlint: true
+      run-assemble: true
+      run-unit-test: true

.github/workflows/verify-example-app-frames.yml

@@ -0,0 +1,29 @@
+name: Verify Example App Frames
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    types: [ opened, synchronize, reopened ]
+    branches: [ master, "bugfix/*", "feature/*", "release/*" ]
+    paths:
+      - 'checkout/**'
+      - 'frames/**'
+      - 'example_app_frames/**'
+      - 'buildSrc/**'
+      - 'build.gradle.kt'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify-module:
+    uses: ./.github/workflows/verification-flow.yml
+    with:
+      module: example_app_frames
+      run-android-lint: true
+      run-ktlint: true
+      run-assemble: true
+      run-unit-test: true

.github/workflows/verify-frames.yml

@@ -0,0 +1,29 @@
+name: Verify Frames
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    types: [ opened, synchronize, reopened ]
+    branches: [ master, "bugfix/*", "feature/*", "release/*" ]
+    paths:
+      - 'checkout/**'
+      - 'frames/**'
+      - 'buildSrc/**'
+      - 'build.gradle.kt'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify-module:
+    uses: ./.github/workflows/verification-flow.yml
+    with:
+      module: frames
+      run-android-lint: true
+      run-ktlint: true
+      run-assemble: true
+      run-unit-test: true
+      run-ui-test: true