Remove playwright-snapshots submodule, instead clone it during test build in earthly

Karakatiza666 · Karakatiza666 · commit 909e323255b5 · 2023-12-29T21:11:50.000+02:00
Signed-off-by: George &lt;bulakh.96@gmail.com&gt;
diff --git a/.arg b/.arg
@@ -0,0 +1,2 @@
+# File used by earthly
+PLAYWRIGHT_SNAPSHOTS_COMMIT=4cd8430
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -90,9 +90,8 @@ jobs:
         run: earthly --version
 
       - name: Run CI
+        # run: earthly --verbose -P --ci --env-file-path .ci.env +all-tests
         run: earthly --verbose -P --ci +all-tests
-        env:
-          NEXT_PUBLIC_MUIX_PRO_KEY: ${{ secrets.muix_license }}
 
       - uses: actions/upload-artifact@v3
         if: always()
diff --git a/.gitignore b/.gitignore
@@ -58,4 +58,5 @@ __pycache__
 gh-pages
 
 # Playwright
-playwright-artifacts/
+playwright-artifacts/
+playwright-snapshots/
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +0,0 @@
-[submodule "web-console/playwright-snapshots"]
-	path = web-console/playwright-snapshots
-	url = https://github.com/feldera/playwright-snapshots.git
diff --git a/Earthfile b/Earthfile
@@ -611,6 +611,15 @@ ui-playwright-container:
     COPY web-console .
     COPY deploy/docker-compose.yml .
     COPY deploy/.env .
+
+    # Pull playwright-snapshots for visual regression testing
+    # It was decided it's better to clone the snapshots repo during the build rather than have it as a submodule
+    ARG PLAYWRIGHT_SNAPSHOTS_COMMIT
+    RUN echo PLAYWRIGHT_SNAPSHOTS_COMMIT=$PLAYWRIGHT_SNAPSHOTS_COMMIT
+    GIT CLONE https://github.com/feldera/playwright-snapshots.git playwright-snapshots
+    # [ -n "..." ] syntax returns true if the string is not empty, in which case the commands after `&&` execute
+    RUN [ -n "$PLAYWRIGHT_SNAPSHOTS_COMMIT" ] && cd playwright-snapshots && git checkout $PLAYWRIGHT_SNAPSHOTS_COMMIT
+
     WORKDIR web-console
     RUN yarn install
     RUN yarn playwright install
@@ -631,7 +640,6 @@ ui-playwright-container:
 
 ui-playwright-tests:
     FROM +ui-playwright-container
-
     ENV FELDERA_VERSION=latest
 
     TRY
@@ -640,6 +648,7 @@ ui-playwright-tests:
                     --compose ../docker-compose.yml \
                     --service db \
                     --service pipeline-manager
+            # We zip artifacts regardless of test success or error, and then we complete the command preserving test's exit_code
             RUN if yarn playwright test; then exit_code=0; else exit_code=$?; fi \
                 && cd /dbsp \
                 && zip -r playwright-report.zip playwright-report \
diff --git a/web-console/playwright-snapshots b/web-console/playwright-snapshots

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# File used by earthly`
	`2`	`+PLAYWRIGHT_SNAPSHOTS_COMMIT=4cd8430`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +0,0 @@`
`1`		`-[submodule "web-console/playwright-snapshots"]`
`2`		`- path = web-console/playwright-snapshots`
`3`		`- url = https://github.com/feldera/playwright-snapshots.git`