Add a standalone per-platform server test step in CI

Author: pimterry

.github/workflows/ci.yml

@@ -55,11 +55,57 @@ jobs:
           name: distributables
           path: build/dist/*
           if-no-files-found: error
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: test-scripts
+          path: test/distributables-test
+          if-no-files-found: error
+
+  test-distributables:
+    needs: build
+    strategy:
+      matrix:
+        include:
+          - platform: Linux
+            os: "ubuntu-20.04"
+            test-script: "./unix.sh linux"
+          - platform: Mac 10.15
+            os: "macos-10.15"
+            test-script: "./unix.sh darwin"
+          - platform: Windows
+            os: "windows-2019"
+            test-script: ".\\windows.bat"
+      fail-fast: false
+    name: Test on ${{ matrix.platform }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Get our distributables
+        uses: actions/download-artifact@v2
+        with:
+          name: distributables
+          path: distributables
+
+      - name: Get the test scripts
+        uses: actions/download-artifact@v2
+        with:
+          name: test-scripts
+          path: .
+
+      - name: Make the test script executable
+        if: matrix.platform != 'Windows'
+        run: chmod +x unix.sh
+
+      - name: Test the server build
+        run: ${{ matrix.test-script }}
+
   publish:
     name: Publish a release
     runs-on: "ubuntu-18.04"
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
-    needs: build
+    needs:
+      - build
+      - test-distributables
     steps:
       - name: Get our distributables
         uses: actions/download-artifact@v2

test/distributables-test/unix.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+set -e
+
+ls -la *
+
+tar -xvzf ./distributables/v*/httptoolkit-server-*-$1-x64.tar.gz
+
+./httptoolkit-server/bin/httptoolkit-server start &
+SERVER_PID=$!
+
+sleep 5
+
+# CSRF protection fully blocks unrecognized/missing origin requests:
+WITH_ORIGIN="-HOrigin: https://app.httptoolkit.tech"
+AS_JSON="-HContent-Type: application/json"
+
+# Can start a Mockttp server:
+curl "$WITH_ORIGIN" "$AS_JSON" -v --fail 'http://127.0.0.1:45456/start?port=\{"startPort":8000,"endPort":65535\}' -d '{}'
+
+# Can query the API server version:
+curl "$WITH_ORIGIN" "$AS_JSON" -v --fail http://127.0.0.1:45457/ -d '{"query": "query getVersion { version }"}'
+
+# Can get config
+curl "$WITH_ORIGIN" "$AS_JSON" -v --fail http://127.0.0.1:45457/ -d '{"query": "query getConfig { config { certificateContent certificatePath certificateFingerprint } }"}'
+
+# Can query interceptors
+curl "$WITH_ORIGIN" "$AS_JSON" -v --fail http://127.0.0.1:45457/ -d '{"query": "query getInterceptors { interceptors { id version, metadata isActivable isActive(proxyPort: 8000) } }"}'
+
+# ^ This will fail if they receive anything but a 200 result.
+# This ensures that the server is startable, and has minimal functionality for launch.

test/distributables-test/windows.bat

@@ -0,0 +1,47 @@
+@echo off
+
+REM Extract the tarball. Tar doesn't support wildcards on windows, DIR only supports one wildcard, so we have to do this mess:
+cd distributables\v*\
+set GET_TAR="dir /b httptoolkit-server-*-win32-x64.tar.gz"
+FOR /F "tokens=*" %%i IN (' %GET_TAR% ') DO SET TAR_PATH=%%i
+
+tar -xvzf %TAR_PATH%
+
+START "server" .\httptoolkit-server\bin\httptoolkit-server start
+
+REM The closest we can get to a 10 second delay on Windows in CI, ick:
+ping -n 10 127.0.0.1 >NUL
+
+REM CSRF protection fully blocks unrecognized/missing origin requests:
+set WITH_ORIGIN="-HOrigin: https://app.httptoolkit.tech"
+set AS_JSON="-HContent-Type: application/json"
+
+REM Can start a Mockttp server:
+curl %WITH_ORIGIN% %AS_JSON% -v --fail -X POST "http://127.0.0.1:45456/start?port=\{\"startPort\":8000,\"endPort\":65535\}" || goto :error
+
+REM Can query the API server version:
+curl %WITH_ORIGIN% %AS_JSON% -v --fail http://127.0.0.1:45457/ -d "{\"query\": \"query getVersion { version }\"}" || goto :error
+
+REM Can get config
+curl %WITH_ORIGIN% %AS_JSON% -v --fail http://127.0.0.1:45457/ -d "{\"query\": \"query getConfig { config { certificateContent certificatePath certificateFingerprint } }\"}" || goto :error
+
+REM Can query interceptors
+curl %WITH_ORIGIN% %AS_JSON% -v --fail http://127.0.0.1:45457/ -d "{\"query\": \"query getInterceptors { interceptors { id version, metadata isActivable isActive(proxyPort: 8000) } }\"}" || goto :error
+
+REM ^ This will fail if they receive anything but a 200 result.
+REM This ensures that the server is startable, and has minimal functionality for launch.
+
+goto :success
+
+:error
+set err=%errorlevel%
+
+taskkill /FI "WindowTitle eq server*" /T /F
+echo Test failed with error #%err%.
+exit /b %err%
+
+:success
+echo All good.
+
+REM Shut down by matching title passed to START to run in the background
+taskkill /FI "WindowTitle eq server*" /T /F