Merge pull request #1 from KlacsoRobert/add-snapshot-testing

add snapshot testing with snapshots

Author: KlacsoRobert

.github/actions/snapshot_test_ios/action.yml

@@ -0,0 +1,86 @@
+name: Snapshot Test iOS
+description: A GitHub Actions workflow for running snapshot tests on iOS.
+
+inputs:
+  xcworkspacePath:
+    description: 'Path to the Xcode workspace file'
+    required: true
+
+  xcodeSnapshotTestScheme:
+    description: 'Scheme to run snapshot tests on'
+    required: true
+
+runs:
+  using: composite
+
+  steps:
+    - name: Run snapshot tests on iOS
+      id: run-ios-snapshot-tests
+      shell: bash
+      run: |
+        xcodebuild -workspace "${{ inputs.xcworkspacePath }}" \
+            -scheme ${{ inputs.xcodeSnapshotTestScheme }} \
+            -sdk iphonesimulator \
+            -destination 'platform=iOS Simulator,name=iPhone 14,OS=16.4' \
+            test
+
+    - name: Process failed iOS snapshot test
+      if: failure()
+      id: failed-ios-screenshots
+      shell: bash
+      run: |
+        if [[ -z ${GITHUB_TOKEN} ]]; then
+          echo "Missing GITHUB_TOKEN variable"
+          exit 1
+        fi
+
+        if [[ -z ${GITHUB_REPOSITORY} ]]; then
+          echo "Missing GITHUB_REPOSITORY variable"
+          exit 1
+        fi
+
+        if [[ -z ${PR_BRANCH} ]]; then
+          echo "Missing PR_BRANCH variable"
+          exit 1
+        fi
+
+        FAILED_SNAPSHOTS="$(find . -name "__FailedSnapshots__" -type d)"
+        SNAPSHOTS="$(find . -name "__Snapshots__" -type d)"
+        PR_NUMBER="${GITHUB_REF#refs/pull/}"
+        PR_NUMBER="${PR_NUMBER/\/merge/}"
+        NEW_BRANCH_NAME="snapshots/pr-${PR_NUMBER}"
+        
+        cp -a ${FAILED_SNAPSHOTS}/* ${SNAPSHOTS}
+        rm -rf ${FAILED_SNAPSHOTS}
+        echo "PR_NUMBER=${PR_NUMBER}" >> "${GITHUB_OUTPUT}"
+
+        git config user.name "${GITHUB_ACTOR}"
+        git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+        git fetch origin "${PR_BRANCH}"
+        git checkout --track "origin/${PR_BRANCH}"
+        git checkout -b "${NEW_BRANCH_NAME}"
+        git add ${SNAPSHOTS}
+        git commit -m "test(snapshots): Update screenshots"
+        git push --force-with-lease --set-upstream origin "${NEW_BRANCH_NAME}":"${NEW_BRANCH_NAME}"
+        echo "PR_COMMENT=\"Screenshot tests failed.\n\n[See differences](https://github.com/${GITHUB_REPOSITORY}/compare/${PR_BRANCH}...${NEW_BRANCH_NAME})\n\nMerge the branch if it's an intentional change.\"" >> "${GITHUB_OUTPUT}"
+
+        unset FAILED_SNAPSHOTS
+        unset SNAPSHOTS
+        unset PR_NUMBER
+        unset NEW_BRANCH_NAME
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+        GITHUB_REPOSITORY: ${{ github.repository }}
+        PR_BRANCH: ${{ github.head_ref }}
+        GITHUB_ACTOR: ${{ github.actor }}
+
+    - name: Comment PR if iOS snapshot tests failed
+      uses: octokit/[email protected]
+      if: always() && steps.failed-ios-screenshots.outputs.PR_COMMENT
+      with:
+        route: POST /repos/:repo/issues/:issue_number/comments
+        repo: ${{ github.repository }}
+        issue_number: ${{ steps.failed-ios-screenshots.outputs.PR_NUMBER }}
+        body: ${{ steps.failed-ios-screenshots.outputs.PR_COMMENT }}
+      env:
+        GITHUB_TOKEN: ${{ github.token }}

.github/workflows/test_snapshot_test_ios.yml

@@ -0,0 +1,45 @@
+name: Test Snapshots on iOS
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '.github/actions/snapshot_test_ios/action.yml'
+      - '.github/workflows/test_snapshot_test_ios.yml'
+
+jobs:
+  test_snapshot_test_ios:
+    runs-on: macos-13
+
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/[email protected]
+
+      - name: Select Xcode version
+        run: |
+          sudo xcode-select -s /Applications/Xcode_14.3.app
+
+      - name: Pod Install
+        shell: bash
+        run: |
+          pod install
+
+      - name: Cache Derived Data
+        uses: actions/[email protected]
+        if: ${{ !inputs.disableDerivedDataCache }}
+        with:
+          path: |
+            ~/Library/Developer/Xcode/DerivedData/
+          key: ${{ runner.os }}-xcode-${{ hashFiles('**/Podfile.lock', '**/Package.resolved') }}
+          restore-keys: |
+            ${{ runner.os }}-xcode-
+
+      - name: Run snapshot tests on iOS
+        uses: ./.github/actions/snapshot_test_ios
+        with:
+          xcworkspacePath: 'SnapshotArticle.xcworkspace'
+          xcodeSnapshotTestScheme: 'SnapshotArticle'

Extensions/View+Extensions.swift

@@ -0,0 +1,16 @@
+//
+//  View+Extensions.swift
+//  SnapshotArticleTests
+//
+//  Created by Robert Klacso on 2023. 08. 03..
+//
+
+import SwiftUI
+
+extension View {
+    func toViewController() -> UIViewController {
+        let viewController = UIHostingController(rootView: self)
+        viewController.view.frame = UIScreen.main.bounds
+        return viewController
+    }
+}

Podfile

@@ -0,0 +1,11 @@
+# Uncomment the next line to define a global platform for your project
+platform :ios, '15.0'
+
+target 'SnapshotArticle' do
+  # Comment the next line if you're not using Swift and don't want to use dynamic frameworks
+  use_frameworks!
+
+  # Pods for app
+  pod 'Sourcery', :subspecs => ['CLI-Only']
+
+end

Podfile.lock

@@ -0,0 +1,16 @@
+PODS:
+  - Sourcery/CLI-Only (2.0.2)
+
+DEPENDENCIES:
+  - Sourcery/CLI-Only
+
+SPEC REPOS:
+  trunk:
+    - Sourcery
+
+SPEC CHECKSUMS:
+  Sourcery: 9ae7eb711f830e8c3c02b98dc28fbd7e32e9d971
+
+PODFILE CHECKSUM: ec02f1c9d2f5b6c378ddad350b7ec1879d7d2ae8
+
+COCOAPODS: 1.12.1

PreviewProvider.stencil

@@ -0,0 +1,36 @@
+import SwiftUI
+import SnapshotTesting
+import XCTest
+@testable import SnapshotArticle
+
+private func assertPreviewSnapshot<T: PreviewProvider>(_ target: T.Type,
+                                                       file: StaticString = #file,
+                                                       testName: String = #function,
+                                                       line: UInt = #line,
+                                                       isDarkMode: Bool = false) {
+    for preview in T._allPreviews {
+        let content = preview.content
+        let viewController = content.toViewController()
+        if isDarkMode {
+            viewController.overrideUserInterfaceStyle = .dark
+        }
+        assertSnapshot(matching: viewController,
+                       as: .image(on: .iPhone13),
+                       file: file,
+                       testName: testName,
+                       line: line)
+    }
+}
+
+class PreviewSnapshotTests: XCTestCase {
+{% for type in types.based.PreviewProvider %}
+    func test{{type.name}}() {
+        assertPreviewSnapshot({{type.name}}.self)
+    }
+
+    func test{{type.name}}_dark() {
+        assertPreviewSnapshot({{type.name}}.self, isDarkMode: true)
+    }
+
+{% endfor %}
+}