Merge pull request #1462 from isaacphysics/vrt-improvements

VRT improvements

Author: mwtrew

.github/workflows/cypress.yml

@@ -49,7 +49,7 @@ jobs:
           find ./src/test/pages/__image_snapshots__ -type f -name "*.actual.png" -exec bash -c 'exiftool -overwrite_original -FRSOURCE_CPVRD_V="1" "$1"; mv "$1" "${1/.actual./.}"' shell {} \;
           git fetch origin $target_ref
           git checkout -B $update_branch_name origin/$target_ref
-          git commit -am "Update VRT baselines"
+          git add . && git commit -m "Update VRT baselines"
           git push --set-upstream origin $update_branch_name --force
           echo "TARGET_REF=$target_ref" >> "$GITHUB_ENV"
           echo "UPDATE_BRANCH_NAME=$update_branch_name" >> "$GITHUB_ENV"

cypress.config.ts

@@ -5,30 +5,31 @@ const SITE_STRING = process.env.CYPRESS_SITE == 'ada' ? 'ada' : 'phy';
 const UPDATE_BASELINE = process.env.CYPRESS_UPDATE_BASELINE == 'true';
 
 export default defineConfig({
-  component: {
-    devServer: {
-      framework: "react",
-      bundler: "webpack",
-      webpackConfig: require(`./config/webpack.config.${SITE_STRING}.cypress.js`)
-    },
-    indexHtmlFile: `cypress/support/component-index-${SITE_STRING}.html`,
-    supportFile: `cypress/support/component-${SITE_STRING}.tsx`,
-    setupNodeEvents(on, config) {
-      initPlugin(on, config);
-      on('before:browser:launch', (browser, launchOptions) => {
-        if (browser.family === 'chromium') {
-          // Disable smooth scrolling, which can interfere with screenshots
-          launchOptions.args.push('--force-color-profile=srgb');
-          launchOptions.args.push('--disable-low-res-tiling');
-          launchOptions.args.push('--disable-smooth-scrolling');
+    component: {
+        devServer: {
+            framework: "react",
+            bundler: "webpack",
+            webpackConfig: require(`./config/webpack.config.${SITE_STRING}.cypress.js`)
+        },
+        indexHtmlFile: `cypress/support/component-index-${SITE_STRING}.html`,
+        supportFile: `cypress/support/component-${SITE_STRING}.tsx`,
+        setupNodeEvents(on, config) {
+            initPlugin(on, config);
+            on('before:browser:launch', (browser, launchOptions) => {
+                if (browser.family === 'chromium') {
+                    // Disable smooth scrolling, which can interfere with screenshots
+                    launchOptions.args.push('--force-color-profile=srgb');
+                    launchOptions.args.push('--disable-low-res-tiling');
+                    launchOptions.args.push('--disable-smooth-scrolling');
+                }
+                return launchOptions;
+            });
         }
-        return launchOptions;
-      });
+    },
+    env: {
+        pluginVisualRegressionImagesPath : `{spec_path}/__image_snapshots__/${SITE_STRING}`,
+        pluginVisualRegressionMaxDiffThreshold: 0,
+        pluginVisualRegressionUpdateImages: UPDATE_BASELINE,
+        pluginVisualRegressionCreateMissingImages: false,
     }
-  },
-  env: {
-    pluginVisualRegressionImagesPath : `{spec_path}/__image_snapshots__/${SITE_STRING}`,
-    pluginVisualRegressionMaxDiffThreshold: 0,
-    pluginVisualRegressionUpdateImages: UPDATE_BASELINE,
-  }
 });

docker-entrypoint-vrt.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 yarn install --frozen-lockfile
-yarn cypress run --component --browser chrome
+yarn cypress run --component --browser chrome "$@"

vrt-in-docker.py

@@ -2,7 +2,7 @@
 import subprocess
 import argparse
 
-def run(site: str, update_baselines: bool):
+def run(site: str, update_baselines: bool, cypress_args):
     subprocess.run([
         "docker",
         "run",
@@ -24,7 +24,8 @@ def run(site: str, update_baselines: bool):
         "-e", "CYPRESS_INTERNAL_BROWSER_CONNECT_TIMEOUT=300000",
         "-e", "CYPRESS_CACHE_FOLDER=/tests/.cache/Cypress",
         "cypress/browsers:node-20.14.0-chrome-125.0.6422.141-1-ff-126.0.1-edge-125.0.2535.85-1",
-        "/tests/docker-entrypoint-vrt.sh"
+        "/tests/docker-entrypoint-vrt.sh",
+        *cypress_args
     ])
 
 if __name__ == "__main__":
@@ -36,5 +37,5 @@ def run(site: str, update_baselines: bool):
         help="If provided, the run's results will become the new baselines for you to include in your commit.",
     )
 
-    args = parser.parse_args()
-    run(site=args.site, update_baselines=args.update_baselines)
+    args, unknown = parser.parse_known_args()
+    run(site=args.site, update_baselines=args.update_baselines, cypress_args=unknown)