ci: store and update snapshots in ubuntu

dotnet · Mar 9, 2023 · 7890837 · 7890837
1 parent da4a796
commit 7890837
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 34 deletions.
diff --git a/.github/actions/build/action.yml b/.github/actions/build/action.yml
@@ -12,6 +12,7 @@ runs:
       dotnet-version: |
         6.x
         7.x
+
   - run: npm install
     shell: bash
     working-directory: templates

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,9 +32,31 @@ jobs:
         name: site
         path: docs/_site
 
+  snapshot-test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        lfs: true
+
+    - uses: ./.github/actions/build
+
+    - run: dotnet test -c Release --filter Stage=Snapshot --no-build
+      working-directory: test/docfx.Snapshot.Tests
+      env:
+        BUILD_SERVER: true
+
+    - uses: actions/upload-artifact@v3
+      if: failure()
+      with:
+        name: screenshots
+        path: |
+          test/docfx.Snapshot.Tests/**/*.received.png
+          test/docfx.Snapshot.Tests/**/*.diff.png
+
   publish-docs:
     if: github.ref == 'refs/heads/main'
-    needs: test
+    needs: [test, snapshot-test]
     runs-on: ubuntu-latest
     permissions:
       contents: write

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -0,0 +1,28 @@
+name: pr
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  update-snapshot:
+    if: ${{ github.event.comment.body == '/update-snapshot' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        lfs: true
+
+    - run: hub pr checkout ${{ github.event.issue.number }}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - uses: ./.github/actions/build
+
+    - run: dotnet test -c Release --filter Stage=Snapshot --no-build
+      working-directory: test/docfx.Snapshot.Tests
+
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: 'test(snapshot): update snapshots for ${{ github.sha }}'
diff --git a/.github/workflows/snapshot-test.yml b/.github/workflows/snapshot-test.yml
diff --git a/test/docfx.Snapshot.Tests/ModuleInitializer.cs b/test/docfx.Snapshot.Tests/ModuleInitializer.cs
@@ -3,14 +3,17 @@
 
 namespace Microsoft.DocAsCode.Tests
 {
+    using System;
     using System.Runtime.CompilerServices;
+    using DiffEngine;
     using VerifyTests;
 
     public static class ModuleInitializer
     {
         [ModuleInitializer]
         public static void Initialize()
         {
+            BuildServerDetector.Detected = Environment.GetEnvironmentVariable("BUILD_SERVER") == "true";
             VerifyDiffPlex.Initialize(VerifyTests.DiffPlex.OutputType.Compact);
         }
     }

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.cs b/test/docfx.Snapshot.Tests/SamplesTest.cs
@@ -136,10 +136,6 @@ await Verifier
                             .AutoVerify(includeBuildServer: false);
                     }
 
-                    // Verify screenshots only on windows
-                    if (!OperatingSystem.IsWindows())
-                        continue;
-
                     var bytes = await page.ScreenshotAsync(new() { FullPage = fullPage });
                     await Verifier
                         .Verify(new Target("png", new MemoryStream(bytes)))