From f889f40f2cede39a29f9c733861a0dd122c3f21a Mon Sep 17 00:00:00 2001
From: Philip Harrison <philip@mailharrison.com>
Date: Tue, 27 Jul 2021 18:51:20 +0100
Subject: [PATCH] Add some comments

---
 __tests__/fixtures/job-details/npm.json | 46 -------------------------
 __tests__/helpers.ts                    |  5 ++-
 __tests__/server/server.js              | 11 ++++--
 3 files changed, 12 insertions(+), 50 deletions(-)
 delete mode 100644 __tests__/fixtures/job-details/npm.json

diff --git a/__tests__/fixtures/job-details/npm.json b/__tests__/fixtures/job-details/npm.json
deleted file mode 100644
index c4b5ed6..0000000
--- a/__tests__/fixtures/job-details/npm.json
+++ /dev/null
@@ -1,46 +0,0 @@
-{
-  "data": {
-    "attributes": {
-      "allowed-updates": [
-        {
-          "dependency-type": "direct",
-          "update-type": "all"
-        }
-      ],
-      "credentials-metadata": [
-        {
-          "type": "git_source", "host": "github.com"
-        }
-      ],
-      "dependencies": null,
-      "existing-pull-requests": [],
-      "ignore-conditions": [],
-      "lockfile-only": false,
-      "max-updater-run-time": 2700,
-      "package-manager": "npm_and_yarn",
-      "source": {
-        "provider": "github",
-        "repo": "dsp-testing/dependabot-all-updates-test",
-        "directory": "/",
-        "branch": null,
-        "api-endpoint": "https://api.github.com/",
-        "hostname": "github.com"
-      },
-      "updating-a-pull-request": false,
-      "update-subdependencies": false,
-      "requirements-update-strategy": null,
-      "security-advisories": [],
-      "security-updates-only": false,
-      "vendor-dependencies": false,
-      "reject-external-code": false,
-      "experiments": { "build-pull-request-message": true },
-      "commit-message-options": {
-        "include-scope": null,
-        "prefix": null,
-        "prefix-development": null
-      }
-    },
-    "id": "1",
-    "type": "update-jobs"
-  }
-}
diff --git a/__tests__/helpers.ts b/__tests__/helpers.ts
index bc9ded0..0fceeba 100644
--- a/__tests__/helpers.ts
+++ b/__tests__/helpers.ts
@@ -20,15 +20,18 @@ export const removeDanglingUpdaterContainers = async (): Promise<void> => {
 }
 
 export const runFakeDependabotApi = async (port: number): Promise<Function> => {
-  const server = spawn(`${path.join(__dirname, 'server/server.js')}`, [
+  const server = spawn('node', [
+    `${path.join(__dirname, 'server/server.js')}`,
     `${port}`
   ])
+
   server.stdout.on('data', (data: any) => {
     console.log(`json-server log: ${data}`) // eslint-disable-line no-console
   })
   server.stderr.on('data', (data: any) => {
     console.error(`json-server error: ${data}`) // eslint-disable-line no-console
   })
+
   await waitPort({port})
 
   return (): void => {
diff --git a/__tests__/server/server.js b/__tests__/server/server.js
index 8027ef1..d60921b 100755
--- a/__tests__/server/server.js
+++ b/__tests__/server/server.js
@@ -1,5 +1,3 @@
-#!/usr/bin/env node
-
 const jsonServer = require('json-server')
 const path = require('path')
 const fs = require('fs')
@@ -7,9 +5,16 @@ const server = jsonServer.create()
 const db = JSON.parse(fs.readFileSync(path.join(__dirname, 'db.json')))
 const router = jsonServer.router(db)
 const middlewares = jsonServer.defaults()
-
 const SERVER_PORT = process.argv.slice(2)[0] || 9000
 
+// Sets up a fake dependabot-api using json-server
+//
+// Test it locally by running this script directly:
+// $ node __tests__/server/server.js
+// Running on http://localhost:9000
+//
+// Verify it works: curl http://localhost:9000/update_jobs/1/details
+
 // NOTE: Serialise the response like dependabot-api
 router.render = (_, res) => {
   const id = res.locals.data.id