Merge pull request #796 from Stuk/ghci

Add Github Actions PR workflow and test with Playwright

Author: Stuk

.github/workflows/pr.yaml

@@ -0,0 +1,42 @@
+name: pull-request
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+
+      - name: Cache Node modules
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-node-modules
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - name: "Install dependencies"
+        run: |
+          npm install
+          sudo npx playwright install-deps
+
+      - name: Lint
+        run: npm run lint
+      - name: Test Node
+        run: npm run test-node
+      - name: Test browsers
+        run: |
+          npm run test-browser

Gruntfile.js

@@ -2,53 +2,9 @@
 "use strict";
 
 module.exports = function(grunt) {
-  // https://wiki.saucelabs.com/display/DOCS/Platform+Configurator
-  // A lot of the browsers seem to time out with Saucelab's unit testing
-  // framework. Here are the browsers that work and get enough coverage for our
-  // needs.
-  var browsers = [
-    {browserName: "chrome"},
-    {browserName: "firefox", platform: "Linux"},
-    {browserName: "internet explorer"}
-  ];
-
-  var tags = [];
-  if (process.env.TRAVIS_PULL_REQUEST && process.env.TRAVIS_PULL_REQUEST != "false") {
-    tags.push("pr" + process.env.TRAVIS_PULL_REQUEST);
-  } else if (process.env.TRAVIS_BRANCH) {
-    tags.push(process.env.TRAVIS_BRANCH);
-  }
-
   var version = require("./package.json").version;
 
   grunt.initConfig({
-    connect: {
-      server: {
-        options: {
-          base: "",
-          port: 8080
-        }
-      }
-    },
-    'saucelabs-qunit': {
-      all: {
-        options: {
-          urls: ["http://127.0.0.1:8080/test/index.html?hidepassed"],
-          build: process.env.TRAVIS_JOB_ID,
-          throttled: 4,
-          "max-duration": 1200, // seconds, IE6 is slow
-          browsers: browsers,
-          testname: "qunit tests",
-          tags: tags,
-          // Tests have statusCheckAttempts * pollInterval seconds to complete
-          pollInterval: 2000,
-          statusCheckAttempts: 240,
-          "max-duration": 1200,
-          browsers: browsers,
-          maxRetries: 2
-        }
-      }
-    },
     jshint: {
       // see https://github.com/gruntjs/grunt-contrib-jshint/issues/198
       // we can't override the options using the jshintrc path
@@ -102,25 +58,10 @@ module.exports = function(grunt) {
     }
   });
 
-  grunt.loadNpmTasks("grunt-contrib-connect");
-  grunt.loadNpmTasks("grunt-saucelabs");
   grunt.loadNpmTasks('grunt-browserify');
   grunt.loadNpmTasks('grunt-contrib-jshint');
   grunt.loadNpmTasks('grunt-contrib-uglify');
 
-  // A task to cause Grunt to sit and wait, keeping the test server running
-  grunt.registerTask("wait", function() {
-    this.async();
-  });
-
-  grunt.registerTask("test-local", ["build", "connect", "wait"]);
-  grunt.registerTask("test-remote", ["build", "connect", "saucelabs-qunit"]);
-
-  if (process.env.SAUCE_USERNAME && process.env.SAUCE_ACCESS_KEY) {
-    grunt.registerTask("test", ["jshint", "test-remote"]);
-  } else {
-    grunt.registerTask("test", ["jshint", "test-local"]);
-  }
   grunt.registerTask("build", ["browserify", "uglify"]);
   grunt.registerTask("default", ["jshint", "build"]);
 };

package-lock.json

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "npm run test-node && npm run test-browser",
     "test-node": "qunit --require ./test/helpers/test-utils.js --require ./test/helpers/node-test-utils.js test/asserts/",
-    "test-browser": "grunt build && grunt test",
+    "test-browser": "grunt build && node test/run.js",
     "lint": "grunt jshint"
   },
   "contributors": [
@@ -43,13 +43,13 @@
     "grunt": "~0.4.1",
     "grunt-browserify": "~5.0.0",
     "grunt-cli": "~1.1.0",
-    "grunt-contrib-connect": "~2.0.0",
     "grunt-contrib-jshint": "~1.0.0",
     "grunt-contrib-uglify": "~4.0.1",
-    "grunt-saucelabs": "Stuk/grunt-saucelabs#v10.0.0",
+    "http-server": "^13.0.2",
     "jshint": "~2.9.1",
     "jszip-utils": "~0.0.2",
     "package-json-versionify": "1.0.2",
+    "playwright": "^1.15.2",
     "qunit": "~2.9.2",
     "tmp": "0.0.28"
   },

package.json

@@ -3,8 +3,8 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <title>JSZip Testing</title>
-<link media="screen" href="//code.jquery.com/qunit/qunit-1.23.0.css" type="text/css" rel="stylesheet">
-<script type="text/javascript" src="//code.jquery.com/qunit/qunit-1.23.0.js"></script>
+<link media="screen" href="../node_modules/qunit/qunit/qunit.css" type="text/css" rel="stylesheet">
+<script type="text/javascript" src="../node_modules/qunit/qunit/qunit.js"></script>
 <script>
 // no CDN, fallback on the npm version
 if(!window.QUnit) {

test/index.html

@@ -0,0 +1,72 @@
+const path = require("path");
+const playwright = require("playwright");
+const createServer = require("http-server").createServer;
+
+/** @typedef {{
+      name: string,
+      message: string,
+      module: string,
+      result: boolean,
+      expected: unknown,
+      actual: unknown,
+      source: string
+    }} Failure
+*/
+
+/**
+ * @typedef {{ passed: number, failed: number, total: number, runtime: number, tests: Failure[] }} Results
+ */
+
+/**
+ * @param {string} browserType
+ * @returns {Promise<[string, Results]>}
+ */
+async function run(browserType) {
+    console.log("Starting", browserType);
+    const browser = await playwright[browserType].launch();
+    const context = await browser.newContext();
+    const page = await context.newPage();
+
+    await page.goto(`http://127.0.0.1:8080/test/index.html?hidepassed`);
+
+    let result;
+    do {
+        result = await page.evaluate(() => {
+            return window.global_test_results;
+        });
+    } while (!result)
+
+    console.log("Closing", browserType);
+    await browser.close();
+
+    return [browserType, result];
+}
+
+async function main() {
+    const browsersTypes = ["chromium", "firefox", "webkit"];
+
+    const server = createServer({root: path.join(__dirname, "..")});
+    await new Promise(resolve => server.listen(8080, "127.0.0.1", resolve));
+    console.log("Server started");
+
+    try {
+        const results = await Promise.all(browsersTypes.map(run));
+
+        let failures = false;
+        for (const result of results) {
+            console.log(...result);
+            failures = failures || result[1].failed > 0;
+        }
+
+        if (failures) {
+            console.log("Tests failed");
+            process.exit(1);
+        } else {
+            console.log("Tests passed!");
+        }
+    } finally {
+        server.close();
+    }
+}
+
+main();