Added CI for validation and testing.

Author: RobertWesner

.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Test with puppeteer
+on:
+    pull_request:
+    push:
+        branches: [ development, main ]
+    workflow_dispatch:
+
+jobs:
+    docker-test:
+        runs-on: ubuntu-22.04
+
+        steps:
+            - name: Checkout repo
+              uses: actions/checkout@v4
+
+            - name: Build and run Containerfile
+              run: |
+                  IMAGE_ID=$(docker build -q -f Containerfile .)
+                  echo "Built image: $IMAGE_ID"
+                  docker run --rm "$IMAGE_ID"

.github/workflows/verify.yml

@@ -0,0 +1,46 @@
+name: Verify with eslint and semgrep
+on:
+    pull_request:
+    push:
+        branches: [ development, main ]
+
+jobs:
+    verify:
+        runs-on: ubuntu-22.04
+
+        steps:
+            -   name: Checkout repo
+                uses: actions/checkout@v4
+
+            -   name: Setup Node
+                uses: actions/setup-node@v4
+                with:
+                    node-version: '25'
+
+            -   name: Setup Python
+                uses: actions/setup-python@v5
+                with:
+                    python-version: '3.12'
+
+            -   name: Install ESLint deps
+                working-directory: ./linting
+                run: npm ci
+
+            -   name: Create Python venv and install Semgrep
+                working-directory: ./linting
+                run: |
+                    python -m venv .venv
+                    . .venv/bin/activate
+                    pip install --upgrade pip
+                    pip install semgrep
+
+            -   name: Run ESLint
+                working-directory: ./linting
+                run: |
+                    npx eslint ../script.user.js
+
+            -   name: Run Semgrep
+                working-directory: ./linting
+                run: |
+                    . .venv/bin/activate
+                    semgrep -c ../.semgrep.yml ../script.user.js

.semgrep.yml

@@ -21,13 +21,13 @@ rules:
 
     -   id: js-no-websocket
         message: "WebSockets are not expected in this userscript. Review necessity."
-        severity: WARNING
+        severity: ERROR
         languages: [ javascript ]
         pattern: new WebSocket(...)
 
     -   id: js-fetch-non-whitelisted-domain
         message: "fetch() URL should be YouTube only. Review this call."
-        severity: WARNING
+        severity: ERROR
         languages: [ javascript ]
         patterns:
             -   pattern: fetch($URL, ...)
@@ -37,15 +37,15 @@ rules:
 
     -   id: js-no-cross-window-postmessage
         message: "window.postMessage is not expected in this userscript. Review necessity."
-        severity: WARNING
+        severity: ERROR
         languages: [ javascript ]
         pattern: $OBJ.postMessage(...)
         metavariables:
             OBJ: window
 
     -   id: js-no-location-rewrite-to-non-youtube
         message: "Changing window.location to non-YouTube domains is suspicious. Review."
-        severity: WARNING
+        severity: ERROR
         languages: [ javascript ]
         patterns:
             -   pattern: window.location = $URL
@@ -55,7 +55,7 @@ rules:
 
     -   id: js-no-location-href-rewrite-to-non-youtube
         message: "Changing window.location to non-YouTube domains is suspicious. Review."
-        severity: WARNING
+        severity: ERROR
         languages: [ javascript ]
         patterns:
             -   pattern: window.location.href = $URL
@@ -65,7 +65,7 @@ rules:
 
     -   id: js-no-open-non-youtube
         message: "window.open to non-YouTube domains should be reviewed."
-        severity: WARNING
+        severity: ERROR
         languages: [ javascript ]
         patterns:
             -   pattern: window.open($URL, ...)

testing/spago.lock

@@ -9,6 +9,7 @@
             "console",
             "effect",
             "node-fs",
+            "node-process",
             "prelude",
             "strings",
             "toppokki"
@@ -55,6 +56,7 @@
             "node-http",
             "node-net",
             "node-path",
+            "node-process",
             "node-streams",
             "node-tls",
             "node-url",
@@ -67,6 +69,7 @@
             "orders",
             "parallel",
             "partial",
+            "posix-types",
             "prelude",
             "profunctor",
             "quickcheck",
@@ -1233,6 +1236,22 @@
         "effect"
       ]
     },
+    "node-process": {
+      "type": "registry",
+      "version": "11.2.0",
+      "integrity": "sha256-+2MQDYChjGbVbapCyJtuWYwD41jk+BntF/kcOTKBMVs=",
+      "dependencies": [
+        "effect",
+        "foreign",
+        "foreign-object",
+        "maybe",
+        "node-event-emitter",
+        "node-streams",
+        "posix-types",
+        "prelude",
+        "unsafe-coerce"
+      ]
+    },
     "node-streams": {
       "type": "registry",
       "version": "9.0.1",
@@ -1390,6 +1409,15 @@
       "integrity": "sha256-fwXerld6Xw1VkReh8yeQsdtLVrjfGiVuC5bA1Wyo/J4=",
       "dependencies": []
     },
+    "posix-types": {
+      "type": "registry",
+      "version": "6.0.0",
+      "integrity": "sha256-ZfFz8RR1lee/o/Prccyeut3Q+9tYd08mlR72sIh6GzA=",
+      "dependencies": [
+        "maybe",
+        "prelude"
+      ]
+    },
     "prelude": {
       "type": "registry",
       "version": "6.0.2",

testing/spago.yaml

@@ -4,10 +4,11 @@ package:
     - aff
     - console
     - effect
+    - node-fs
+    - node-process
     - prelude
     - strings
     - toppokki
-    - node-fs
   test:
     main: Test.Main
     dependencies: []

testing/src/Script.purs

@@ -9,6 +9,8 @@ import Data.Time.Duration (Milliseconds(Milliseconds))
 import Foreign (isNull, isUndefined, readString)
 import Control.Monad.Except (runExcept)
 import Data.Either (Either(..))
+import Effect.Class (liftEffect)
+import Node.Process (exit') as Process
 
 step :: String -> String -> T.Page -> (T.Page -> Aff Unit) -> Boolean -> Aff Boolean
 step label expected page setup prev = do
@@ -180,10 +182,12 @@ script = do
                 delay (Milliseconds 500.0)
         )
 
-    if result == true
-        then info "ALL TESTS PASSED!"
-        else info "UNFORTUNATE FAILURE..."
-
     -- Shutdown
 
     T.close browser
+
+    if result == true
+        then  info "ALL TESTS PASSED!"
+        else do
+            info "UNFORTUNATE FAILURE..."
+            liftEffect $ Process.exit' 1