Implement image diff plugin (#96)

stoat-dev · Jan 7, 2023 · 0ffd0e2 · 0ffd0e2
1 parent f1fb044
commit 0ffd0e2
Show file tree

Hide file tree

Showing 24 changed files with 75,510 additions and 15,775 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -46,6 +46,9 @@ jobs:
       - name: Build
         run: yarn build
 
+      - name: Download baseline logo image
+        run: curl https://stoat-dev--static.stoat.page/branding/128.png -o build/baseline-logo-128.png
+
       - name: Run Stoat Action
         uses: ./
         if: always()
diff --git a/.github/workflows/test-action.yaml b/.github/workflows/test-action.yaml
@@ -28,7 +28,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
       - name: Setup node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: '16'
       - name: Setup cache

diff --git a/.github/workflows/test-cli.yaml b/.github/workflows/test-cli.yaml
@@ -26,7 +26,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
       - name: Setup node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: '16'
       - name: Setup cache

diff --git a/.stoat/config.yaml b/.stoat/config.yaml
@@ -21,3 +21,9 @@ plugins:
       metadata:
         name: Documentation
       path: docs/build
+  image_diff:
+    compare_logo_image:
+      metadata:
+        name: Logo
+      image: docs/static/img/logo-128.png
+      baseline: docs/build/baseline-logo-128.png
diff --git a/action/__tests__/templateHelpers.test.ts b/action/__tests__/templateHelpers.test.ts
@@ -1,6 +1,6 @@
 import { describe, expect, test } from '@jest/globals';
 
-import { JsonPlugin, StaticHostingPlugin, StoatConfigSchema } from '../src/schemas/stoatConfigSchema';
+import { ImageDiffPlugin, JsonPlugin, StaticHostingPlugin, StoatConfigSchema } from '../src/schemas/stoatConfigSchema';
 import {
   getLocalTemplate,
   getPlugins,
@@ -27,6 +27,10 @@ const staticHosting2: StaticHostingPlugin = {
 const json1: JsonPlugin = {
   path: 'path1'
 };
+const imageDiff1: ImageDiffPlugin = {
+  image: 'path1',
+  baseline: 'baseline1'
+};
 
 describe('Read local template', () => {
   test('getTemplate', async () => {
@@ -52,8 +56,14 @@ describe('Read local template', () => {
   });
 
   test('getLocalTemplate', () => {
-    expect(getLocalTemplate(template1Path)).toEqual({ template: template1, format: TemplateFormat.Handlebars });
-    expect(getLocalTemplate(template2Path)).toEqual({ template: template2, format: TemplateFormat.Jinja2 });
+    expect(getLocalTemplate(template1Path)).toEqual({
+      template: template1,
+      format: TemplateFormat.Handlebars
+    });
+    expect(getLocalTemplate(template2Path)).toEqual({
+      template: template2,
+      format: TemplateFormat.Jinja2
+    });
   });
 });
 
@@ -67,18 +77,13 @@ describe('Read remote default template', () => {
   const stoatConfigWithOnePlugin: StoatConfigSchema = {
     version: 1,
     plugins: {
-      static_hosting: {
-        plugin1: staticHosting1
-      }
+      static_hosting: { plugin1: staticHosting1 }
     }
   };
   const stoatConfigWithMultiPlugins: StoatConfigSchema = {
     version: 1,
     plugins: {
-      static_hosting: {
-        plugin1: staticHosting1,
-        plugin2: staticHosting2
-      }
+      static_hosting: { plugin1: staticHosting1, plugin2: staticHosting2 }
     }
   };
 
@@ -107,9 +112,7 @@ describe('getPlugins', () => {
       getPlugins({
         version: 1,
         plugins: {
-          static_hosting: {
-            plugin1: staticHosting1
-          }
+          static_hosting: { plugin1: staticHosting1 }
         }
       })
     ).toEqual([Plugin.StaticHosting]);
@@ -120,15 +123,11 @@ describe('getPlugins', () => {
       getPlugins({
         version: 1,
         plugins: {
-          static_hosting: {
-            plugin1: staticHosting1,
-            plugin2: staticHosting2
-          },
-          json: {
-            plugin3: json1
-          }
+          static_hosting: { plugin1: staticHosting1, plugin2: staticHosting2 },
+          json: { plugin3: json1 },
+          image_diff: { plugin4: imageDiff1 }
         }
       }).sort()
-    ).toEqual([Plugin.Json, Plugin.StaticHosting].sort());
+    ).toEqual([Plugin.Json, Plugin.StaticHosting, Plugin.ImageDiff].sort());
   });
 });