ci: validate Docker Compose overlay merges

Author: archief2910

.github/workflows/checks.yml

@@ -58,13 +58,24 @@ jobs:
         run: npm ci
       - name: Run ESLint
         run: npm run build:check
+  compose-validate:
+    name: Validate Docker Compose overlays (Tor / I2P)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Validate merged compose files
+        env:
+          SECRET: ci_placeholder_not_for_production_use_repeat_to_64chars_aaaaaaaa
+        run: node ./scripts/verify-compose-overlays.mjs
   test-units-and-cover:
     name: Unit Tests And Coverage
     runs-on: ubuntu-latest
     needs:
       - commit-lint
       - lint
       - build-check
+      - compose-validate
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -100,6 +111,7 @@ jobs:
       - commit-lint
       - lint
       - build-check
+      - compose-validate
     steps:
       - name: Checkout
         uses: actions/checkout@v3

package.json

@@ -55,6 +55,10 @@
     "tor:docker:compose:start": "./scripts/start_with_tor",
     "tor:hostname": "./scripts/print_tor_hostname",
     "tor:docker:compose:stop": "./scripts/stop",
+    "i2p:docker:compose:start": "./scripts/start_with_i2p",
+    "i2p:hostname": "./scripts/print_i2p_hostname",
+    "i2p:docker:compose:stop": "./scripts/stop",
+    "compose:validate": "node ./scripts/verify-compose-overlays.mjs",
     "docker:integration:run": "docker compose -f ./test/integration/docker-compose.yml run --rm tests",
     "docker:test:integration": "npm run docker:integration:run -- npm run test:integration",
     "docker:cover:integration": "npm run docker:integration:run -- npm run cover:integration",

scripts/verify-compose-overlays.mjs

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+/**
+ * Validates docker-compose.yml merged with Tor / I2P overlays (config -q).
+ * Requires Docker Desktop / Engine. Does not start containers.
+ */
+import { spawnSync } from 'node:child_process'
+import { existsSync } from 'node:fs'
+import { fileURLToPath } from 'node:url'
+import { dirname, join } from 'node:path'
+
+const root = join(dirname(fileURLToPath(import.meta.url)), '..')
+process.chdir(root)
+
+function resolveDockerExe() {
+  if (process.env.DOCKER_EXE && existsSync(process.env.DOCKER_EXE)) {
+    return process.env.DOCKER_EXE
+  }
+  if (process.platform === 'win32' && process.env.ProgramFiles) {
+    const candidate = join(
+      process.env.ProgramFiles,
+      'Docker',
+      'Docker',
+      'resources',
+      'bin',
+      'docker.exe',
+    )
+    if (existsSync(candidate)) {
+      return candidate
+    }
+  }
+  return 'docker'
+}
+
+const dockerExe = resolveDockerExe()
+
+const dockerCheck = spawnSync(dockerExe, ['compose', 'version'], { encoding: 'utf8' })
+if (dockerCheck.error || dockerCheck.status !== 0) {
+  process.stderr.write(
+    'docker is not installed or not on PATH. Install Docker Desktop / Engine, then run:\n' +
+      '  npm run compose:validate\n' +
+      'On Windows, ensure Docker Desktop is running, or set DOCKER_EXE to the full path to docker.exe.\n',
+  )
+  process.exit(1)
+}
+
+if (!process.env.SECRET || process.env.SECRET.length < 16) {
+  process.env.SECRET =
+    'ci_placeholder_not_for_production_use_repeat_to_64chars_aaaaaaaa'
+}
+
+const runs = [
+  ['docker-compose.yml', 'docker-compose.i2p.yml'],
+  ['docker-compose.yml', 'docker-compose.tor.yml'],
+  ['docker-compose.yml', 'docker-compose.tor.yml', 'docker-compose.i2p.yml'],
+]
+
+for (const files of runs) {
+  const args = ['compose']
+  for (const f of files) {
+    args.push('-f', f)
+  }
+  args.push('config', '-q')
+  const label = files.join(' + ')
+  process.stdout.write(`== ${label} ==\n`)
+  const r = spawnSync(dockerExe, args, { stdio: 'inherit' })
+  if (r.status !== 0) {
+    process.stderr.write(`compose validation failed for: ${label}\n`)
+    process.exit(r.status ?? 1)
+  }
+  process.stdout.write('OK\n')
+}
+
+process.stdout.write('All compose overlay merges validate successfully.\n')

scripts/verify_compose_overlays

@@ -0,0 +1,3 @@
+#!/bin/bash
+# Delegates to Node so the same validation runs on Windows (npm) and Linux/macOS.
+exec node "$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")/verify-compose-overlays.mjs"