From 2ab8fdf18c9d77627e391f044403b266e6568ff1 Mon Sep 17 00:00:00 2001
From: Moritz Mahringer <me@moritzmahringer.de>
Date: Sat, 3 Dec 2022 22:10:13 +0100
Subject: [PATCH] Improve reference image regeneration workflow and fix
 documentation

---
 .dockerignore                     |  2 +-
 README.md                         |  8 ++++----
 docker-compose.regenerate-e2e.yml | 13 +++++++++++++
 e2e/regenerate                    |  1 -
 e2e/run                           |  1 -
 regenerate-e2e-references         |  3 +++
 update-test-data                  |  3 ---
 7 files changed, 21 insertions(+), 10 deletions(-)
 create mode 100644 docker-compose.regenerate-e2e.yml
 delete mode 120000 e2e/regenerate
 delete mode 120000 e2e/run
 create mode 100755 regenerate-e2e-references
 delete mode 100755 update-test-data

diff --git a/.dockerignore b/.dockerignore
index 07fa571d..8cf07018 100644
--- 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
index 538d73ee..bdbec52a 100644
--- 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
new file mode 100644
index 00000000..42f4f2d5
--- /dev/null
+++ 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
deleted file mode 120000
index e9a240fb..00000000
--- a/e2e/regenerate
+++ /dev/null
@@ -1 +0,0 @@
-scripts/regenerate.sh
\ No newline at end of file
diff --git a/e2e/run b/e2e/run
deleted file mode 120000
index 8c48acdb..00000000
--- a/e2e/run
+++ /dev/null
@@ -1 +0,0 @@
-scripts/run.sh
\ No newline at end of file
diff --git a/regenerate-e2e-references b/regenerate-e2e-references
new file mode 100755
index 00000000..71d6b279
--- /dev/null
+++ 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
deleted file mode 100755
index e1a4a158..00000000
--- a/update-test-data
+++ /dev/null
@@ -1,3 +0,0 @@
-#!/usr/bin/env sh
-
-docker-compose up --build update-test-data