Combine unit and e2e tests into a single GHA workflow + add e2e test reporter (#1281)

A recent pairing session with @longrunningprocess led us to want to try and combine all tests into a single workflow for efficiency and simplicity. Now that I know the status checks can still be separate for a single workflow, it makes sense to combine all tests into a single workflow and have separate reporters / checks.

Author: megahirt

.github/workflows/e2e-tests.yml

@@ -1,4 +1,4 @@
-name: Run Unit Tests
+name: Tests
 
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#on
 on:
@@ -9,6 +9,9 @@ defaults:
     shell: bash
     working-directory: docker
 
+env:
+  DOCKER_BUILDKIT: 1
+
 jobs:
   unit-tests:
     runs-on: ubuntu-latest
@@ -27,5 +30,24 @@ jobs:
         uses: docker://ghcr.io/enricomi/publish-unit-test-result-action:v1
         if: always()
         with:
+          check_name: Unit Test Results
           github_token: ${{ github.token }}
           files: docker/PhpUnitTests.xml
+
+  e2e-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: satackey/action-docker-layer-caching@v0.0.11
+
+      - name: Run E2E Tests
+        run: make e2e-tests-ci
+
+      - name: Publish Test Results
+        uses: docker://ghcr.io/enricomi/publish-unit-test-result-action:v1
+        if: always()
+        with:
+          check_name: E2E Test Results
+          github_token: ${{ github.token }}
+          files: docker/e2e-results.xml

.github/workflows/unit-tests.yml .github/workflows/tests.yml.github/workflows/unit-tests.yml renamed to .github/workflows/tests.yml

@@ -1,4 +1,5 @@
 PhpUnitTests.xml
+docker/e2e-results.xml
 src/assets/*
 !src/assets/.gitkeep
 src/cache/*

.gitignore

@@ -12,25 +12,26 @@ dev: start
 .PHONY: e2e-tests
 e2e-tests: build
 	docker-compose build app-for-e2e test-e2e
-ifeq ($(TEAMCITY_VERSION),$())
-	# developer machine
 	docker-compose restart app-for-e2e || docker-compose up -d app-for-e2e
 	docker-compose run -e TEST_SPECS=$(TEST_SPECS) test-e2e
-else
-	# teamcity CI
-	docker-compose run -e TEAMCITY_VERSION=TEAMCITY_VERSION test-e2e
-endif
+
+.PHONY: e2e-tests-ci
+e2e-tests-ci: build
+	docker-compose build app-for-e2e test-e2e
+    # "-" means continue running commands even if they error (failed tests)
+	-docker-compose run -e GITHUB_ACTIONS=1 --name e2etests test-e2e
+	docker cp e2etests:/data/e2e-output/junitresults.xml e2e-results.xml
+	docker rm e2etests
 
 .PHONY: unit-tests
 unit-tests:
-	docker-compose build test-php
 	docker-compose run test-php
 
 .PHONY: unit-tests-ci
-unit-tests-ci: build
-	docker-compose build test-php
+unit-tests-ci:
 	docker-compose run --name unittests test-php
 	docker cp unittests:/var/www/PhpUnitTests.xml .
+	docker rm unittests
 
 .PHONY: build
 build:

docker/Makefile

@@ -28,34 +28,36 @@ exports.config = {
 
     browser.driver.manage().window().maximize();
 
-    if (process.env.TEAMCITY_VERSION) {
-      var jasmineReporters = require('jasmine-reporters');
-      jasmine.getEnv().addReporter(new jasmineReporters.TeamCityReporter());
-    } else {
-      var SpecReporter = require('jasmine-spec-reporter').SpecReporter;
-      jasmine.getEnv().addReporter(new SpecReporter({
-        spec: {
-          displayStacktrace: true
-        }
-      }));
-      /*
-      jasmine.getEnv().addReporter(new jasmineReporters.TerminalReporter({
-        verbosity: browser.params.verbosity, // [0 to 3, jasmine default 2]
-        color: true,
-        showStack: true
-      }));
-      */
-      var pauseOnFailure = {
-        specDone: function (spec) {
-          if (spec.status === 'failed') {
-            debugger;
-          }
-        }
-      };
+    var jasmineReporters = require('jasmine-reporters');
+    if (process.env.GITHUB_ACTIONS) {
+      // https://github.com/angular/protractor-cookbook/tree/master/jasmine-junit-reports
+      var junitReporter = new jasmineReporters.JUnitXmlReporter({
+        savePath: 'e2e-output/',
+        consolidateAll: true
+
+        // results written to file: e2e-output/junitresults.xml
 
-      // Uncomment to pause tests on first failure
-      // jasmine.getEnv().addReporter(pauseOnFailure);
+      });
+      jasmine.getEnv().addReporter(junitReporter);
     }
+    var SpecReporter = require('jasmine-spec-reporter').SpecReporter;
+    jasmine.getEnv().addReporter(new SpecReporter({
+      spec: {
+        displayStacktrace: true
+      }
+    }));
+
+    // Uncomment to pause tests on first failure
+    /*
+    var pauseOnFailure = {
+      specDone: function (spec) {
+        if (spec.status === 'failed') {
+          debugger;
+        }
+      }
+    };
+    jasmine.getEnv().addReporter(pauseOnFailure);
+    */
   },
   plugins: [failFast.init()],
   afterLaunch: function () {