[CI] Snapshots recording improvement (#752)

Author: testableapple

.github/workflows/record-snapshots.yml

@@ -0,0 +1,21 @@
+name: Record Snapshots
+
+on:
+  workflow_dispatch:
+    inputs:
+      remove_and_record_snapshots:
+        description: 'Reset all the snapshots on CI?'
+        type: boolean
+        required: false
+        default: false
+
+jobs:
+  record:
+    name: Record
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/[email protected]
+    - run: gh workflow run smoke-checks.yml --ref "${GITHUB_REF#refs/heads/}" -f record_snapshots=true -f remove_and_record_snapshots=${{ github.event.inputs.remove_and_record_snapshots }}
+      timeout-minutes: 5
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/smoke-checks.yml

@@ -8,8 +8,13 @@ on:
 
   workflow_dispatch:
     inputs:
-      snapshots:
-        description: 'Should Snapshots be recorded on CI?'
+      record_snapshots:
+        description: 'Record missing snapshots on CI?'
+        type: boolean
+        required: false
+        default: false
+      remove_and_record_snapshots:
+        description: 'Reset all the snapshots on CI?'
         type: boolean
         required: false
         default: false
@@ -47,7 +52,7 @@ jobs:
   automated-code-review:
     name: Automated Code Review
     runs-on: macos-15
-    if: ${{ github.event.inputs.snapshots != 'true' }}
+    if: ${{ github.event.inputs.record_snapshots != 'true' && github.event.inputs.remove_and_record_snapshots != 'true' }}
     env:
       XCODE_VERSION: "15.4"
     steps:
@@ -66,7 +71,7 @@ jobs:
   build-xcode15:
     name: Build SDKs (Xcode 15.0)
     runs-on: macos-15
-    if: ${{ github.event.inputs.snapshots != 'true' }}
+    if: ${{ github.event.inputs.record_snapshots != 'true' && github.event.inputs.remove_and_record_snapshots != 'true' }}
     env:
       XCODE_VERSION: "15.4"
     steps:
@@ -99,7 +104,7 @@ jobs:
         INSTALL_YEETD: true
         INSTALL_SONAR: true
     - name: Run UI Tests (Debug)
-      run: bundle exec fastlane test_ui device:"${{ env.IOS_SIMULATOR_DEVICE }}" record:${{ github.event.inputs.snapshots }}
+      run: bundle exec fastlane test_ui device:"${{ env.IOS_SIMULATOR_DEVICE }}" record:"${{ github.event.inputs.record_snapshots }}" remove_and_record:"${{ github.event.inputs.remove_and_record_snapshots }}"
       timeout-minutes: 120
       env:
         GITHUB_TOKEN: ${{ secrets.CI_BOT_GITHUB_TOKEN }} # to open a PR
@@ -134,7 +139,7 @@ jobs:
   allure_testops_launch:
     name: Launch Allure TestOps
     runs-on: macos-13
-    if: ${{ github.event.inputs.snapshots != 'true' }}
+    if: ${{ github.event.inputs.record_snapshots != 'true' && github.event.inputs.remove_and_record_snapshots != 'true' }}
     needs: build-test-app-and-frameworks
     outputs:
       launch_id: ${{ steps.get_launch_id.outputs.launch_id }}
@@ -153,7 +158,7 @@ jobs:
   test-e2e-debug:
     name: Test E2E UI (Debug)
     runs-on: macos-15
-    if: ${{ github.event.inputs.snapshots != 'true' }}
+    if: ${{ github.event.inputs.record_snapshots != 'true' && github.event.inputs.remove_and_record_snapshots != 'true' }}
     needs:
       - allure_testops_launch
       - build-test-app-and-frameworks
@@ -208,7 +213,7 @@ jobs:
   build-apps:
     name: Build Demo App
     runs-on: macos-14
-    if: ${{ github.event.inputs.snapshots != 'true' }}
+    if: ${{ github.event.inputs.record_snapshots != 'true' && github.event.inputs.remove_and_record_snapshots != 'true' }}
     needs: build-test-app-and-frameworks
     steps:
     - uses: actions/[email protected]

fastlane/Fastfile

@@ -222,8 +222,10 @@ desc 'Runs tests in Debug config'
 lane :test_ui do |options|
   next unless is_check_required(sources: sources_matrix[:ui], force_check: @force_check)
 
-  record_mode = !options[:record].to_s.empty?
-  remove_snapshots if record_mode
+  soft_record_mode = options[:record].to_s == 'true'
+  hard_record_mode = options[:remove_and_record].to_s == 'true'
+  record_mode = soft_record_mode || hard_record_mode
+  remove_snapshots if hard_record_mode
 
   update_testplan_on_ci(path: 'StreamChatSwiftUITests/Tests/StreamChatSwiftUI.xctestplan')
 
@@ -257,7 +259,7 @@ lane :test_ui do |options|
     pr_create(
       title: '[CI] Snapshots',
       base_branch: current_branch,
-      head_branch: "#{current_branch}-snapshots"
+      head_branch: "#{current_branch}-snapshots-#{Time.now.to_i}"
     )
   else
     slather unless options[:build_for_testing]