Improve reference image regeneration workflow and fix documentation

mormahr · Dec 3, 2022 · 2ab8fdf · 2ab8fdf
1 parent be8833e
commit 2ab8fdf
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 10 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -287,4 +287,4 @@ Dockerfile
 README.md
 test-watch
 update-dependencies-from-setup
-update-test-data
+regenerate-e2e-references
diff --git a/README.md b/README.md
@@ -157,11 +157,11 @@ Desktop.
 
 ### Visual tests with reference images
 
-`test-data` contains reference inputs `*.html` and corresponding outputs `*.png`.
-A test suite will render the html files and will compare the output with the reference images to 
-ensure no changes slipped in.
+`e2e/data` contains reference inputs `*.html` and corresponding output `.png`.
+The e2e test will render the html files and compare the output with the reference images to ensure 
+no changes slipped in.
 
-To update test-data or add new test cases run `./update-test-data`.
+To update reference images or add new test cases run `./regenerate-e2e-references`.
 
 [weasyprint]: https://weasyprint.org
 [semver]: https://semver.org

diff --git a/docker-compose.regenerate-e2e.yml b/docker-compose.regenerate-e2e.yml
@@ -0,0 +1,13 @@
+version: "3.8"
+services:
+  pdf:
+    build: .
+
+  regenerate:
+    build: e2e
+    links:
+      - "pdf:pdf"
+    volumes:
+      - "./e2e/data:/root/data"
+      - "./e2e/diffs:/root/diffs"
+    command: ./scripts/regenerate.sh
diff --git a/e2e/regenerate b/e2e/regenerate
diff --git a/e2e/run b/e2e/run
diff --git a/regenerate-e2e-references b/regenerate-e2e-references
@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+docker-compose -f docker-compose.regenerate-e2e.yml up --build regenerate
diff --git a/update-test-data b/update-test-data
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#!/usr/bin/env sh

		docker-compose -f docker-compose.regenerate-e2e.yml up --build regenerate