Add workflow to run detox iOS tests

.github/PULL_REQUEST_TEMPLATE.md

@@ -27,6 +27,7 @@ Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fie
 - [ ] Has UI changes
 - [ ] Includes text changes and localization file updates
 - [ ] Have tested against the 5 core themes to ensure consistency between them.
+- [ ] Have run E2E tests by adding label `E2E iOS tests for PR`.
 
 #### Device Information
 This PR was tested on: <!-- Device name(s), OS version(s) -->

.github/actions/generate-specs/action.yml

@@ -0,0 +1,39 @@
+# Copyright 2024 Mattermost, Inc.
+name: "generate-specs"
+description: This action used to split Detox integration tests based on the parallelism provided
+
+inputs:
+  search_path:
+    description: The path to look for from within the directory
+    required: true
+  parallelism:
+    description: The parallelism for the tests
+    required: true
+  device_name:
+    description: The name of Device used for the tests
+    required: false
+    default: "iPhone 15"
+  device_os_version:
+    description: The os of the device used for the tests
+    required: false
+    default: "iOS 17.1"
+
+outputs:
+  specs:
+    description: The specs generated for the strategy
+    value: ${{ steps.generate-specs.outputs.specs }}
+runs:
+  using: "composite"
+  steps:
+    - name: ci/generate-specs
+      id: generate-specs
+      env:
+        PARALLELISM: ${{ inputs.parallelism }}
+        SEARCH_PATH: ${{ inputs.search_path }}
+        DEVICE_NAME: ${{ inputs.device_name }}
+        DEVICE_OS_VERSION: ${{ inputs.device_os_version }}
+      run: |
+        set -e
+        node ${{ github.action_path }}/split-tests.js | tee output.json
+        echo "specs=$(cat output.json)" >> $GITHUB_OUTPUT
+      shell: bash

.github/actions/generate-specs/split-tests.js

@@ -0,0 +1,94 @@
+const fs = require('fs');
+const path = require('path');
+
+class DeviceInfo {
+  constructor(deviceName, deviceOsVersion) {
+    this.deviceName = deviceName;
+    this.deviceOsVersion = deviceOsVersion;
+  }
+}
+
+class SpecGroup {
+  constructor(runId, specs, deviceInfo) {
+    this.runId = runId;
+    this.specs = specs;
+    this.deviceName = deviceInfo.deviceName;
+    this.deviceOsVersion = deviceInfo.deviceOsVersion;
+  }
+}
+
+class Specs {
+  constructor(searchPath, parallelism, deviceInfo) {
+    this.searchPath = searchPath;
+    this.parallelism = parallelism;
+    this.rawFiles = [];
+    this.groupedFiles = [];
+    this.deviceInfo = deviceInfo;
+  }
+
+  findFiles() {
+    const dirPath = path.join(this.searchPath);
+
+    const fileRegex = /\.e2e\.ts$/;
+
+    const walkSync = (currentPath) => {
+      const files = fs.readdirSync(currentPath);
+
+      files.forEach((file) => {
+        const filePath = path.join(currentPath, file);
+        const stats = fs.statSync(filePath);
+
+        if (stats.isDirectory()) {
+          walkSync(filePath);
+        } else if (fileRegex.test(filePath)) {
+          const relativeFilePath = filePath.replace(dirPath + '/', '');
+          const fullPath = path.join(this.searchPath, relativeFilePath);
+          this.rawFiles.push(fullPath);
+        }
+      });
+    };
+
+    walkSync(dirPath);
+  }
+
+  generateSplits() {
+    const chunkSize = Math.ceil(this.rawFiles.length / this.parallelism);
+    let runNo = 1;
+
+    for (let i = 0; i < this.rawFiles.length; i += chunkSize) {
+      const end = Math.min(i + chunkSize, this.rawFiles.length);
+      const fileGroup = this.rawFiles.slice(i, end).join(' ');
+      const specFileGroup = new SpecGroup(runNo.toString(), fileGroup, this.deviceInfo);
+      this.groupedFiles.push(specFileGroup);
+
+      if (end === this.rawFiles.length) {
+        break;
+      }
+
+      runNo++;
+    }
+  }
+
+  dumpSplits() {
+    const output = {
+      include: this.groupedFiles,
+    };
+
+    console.log(JSON.stringify(output));
+  }
+}
+
+function main() {
+  const searchPath = process.env.SEARCH_PATH;
+  const parallelism = parseInt(process.env.PARALLELISM, 10);
+  const deviceName = process.env.DEVICE_NAME;
+  const deviceOsVersion = process.env.DEVICE_OS_VERSION;
+  const deviceInfo = new DeviceInfo(deviceName, deviceOsVersion);
+  const specs = new Specs(searchPath, parallelism, deviceInfo);
+
+  specs.findFiles();
+  specs.generateSplits();
+  specs.dumpSplits();
+}
+
+main();

.github/actions/prepare-ios-build/action.yaml

@@ -14,3 +14,11 @@ runs:
         npm run ios-gems
         npm run pod-install
         echo "::endgroup::"
+
+    - name: Cache Pods
+      uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+      with:
+        path: Pods
+        key: ${{ runner.os }}-pods-${{ hashFiles('**/Podfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-pods-

.github/actions/prepare-mobile-build/action.yaml

@@ -15,5 +15,13 @@ runs:
         echo "::endgroup::"
       working-directory: ./fastlane
 
+    - name: Cache Ruby gems
+      uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
     - name: ci/prepare-node-deps
       uses: ./.github/actions/prepare-node-deps

.github/actions/prepare-node-deps/action.yaml

@@ -5,7 +5,7 @@ runs:
   using: composite
   steps:
     - name: ci/setup-node
-      uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
+      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
       with:
         node-version-file: ".nvmrc"
         cache: "npm"
@@ -21,6 +21,14 @@ runs:
         node node_modules/\@sentry/cli/scripts/install.js
         echo "::endgroup::"
 
+    - name: Cache Node.js modules
+      uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+
     - name: ci/patch-npm-dependencies
       shell: bash
       run: |

.github/workflows/build-android-beta.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - name: ci/test
         uses: ./.github/actions/test
 
@@ -26,7 +26,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: ci/prepare-android-build
         uses: ./.github/actions/prepare-android-build
@@ -54,7 +54,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-android-beta-build
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: android-build-beta-${{ github.run_id }}
           path: "*.apk"

.github/workflows/build-android-release.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - name: ci/test
         uses: ./.github/actions/test
 
@@ -26,7 +26,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: ci/prepare-android-build
         uses: ./.github/actions/prepare-android-build
@@ -54,7 +54,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-android-release-build
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: android-build-release-${{ github.run_id }}
           path: "*.apk"

.github/workflows/build-ios-beta.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - name: ci/test
         uses: ./.github/actions/test
 
@@ -28,7 +28,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: ci/prepare-ios-build
         uses: ./.github/actions/prepare-ios-build
@@ -44,7 +44,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-ios-pr-simulator
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: ios-build-simulator-${{ github.run_id }}
           path: Mattermost-simulator-x86_64.app.zip
@@ -56,7 +56,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: ci/output-ssh-private-key
         shell: bash
@@ -93,7 +93,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-ios-beta-build
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: ios-build-beta-${{ github.run_id }}
           path: "*.ipa"

.github/workflows/build-ios-release.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - name: ci/test
         uses: ./.github/actions/test
 
@@ -28,7 +28,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: ci/prepare-ios-build
         uses: ./.github/actions/prepare-ios-build
@@ -65,7 +65,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-ios-release-build
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: ios-build-release-${{ github.run_id }}
           path: "*.ipa"
@@ -77,7 +77,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: ci/prepare-ios-build
         uses: ./.github/actions/prepare-ios-build
@@ -93,7 +93,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-ios-pr-simulator
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: ios-build-simulator-${{ github.run_id }}
           path: Mattermost-simulator-x86_64.app.zip

.github/workflows/build-pr.yml

@@ -15,7 +15,7 @@ jobs:
     if: ${{ github.event.label.name == 'Build Apps for PR' || github.event.label.name == 'Build App for iOS' || github.event.label.name == 'Build App for Android' }}
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: ci/test
@@ -28,7 +28,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
@@ -60,7 +60,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-ios-pr-build
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: ios-build-pr-${{ github.run_id }}
           path: "*.ipa"
@@ -72,7 +72,7 @@ jobs:
       - test
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
@@ -94,7 +94,7 @@ jobs:
         working-directory: ./fastlane
 
       - name: ci/upload-android-pr-build
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         with:
           name: android-build-pr-${{ github.run_id }}
           path: "*.apk"

.github/workflows/ci.yml

@@ -16,6 +16,6 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: ci/checkout-repo
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - name: ci/test
         uses: ./.github/actions/test