e2e: create basic background & cleanup steps

Add 'basic.feature' to test common workflows using the bundle server.
Initially, add a common "Background" step starting the bundle web server at
the specified port, and a common "After" step run when a test ends
(successful or not) stopping that web server process.

Signed-off-by: Victoria Dye <vdye@github.com>

Author: vdye

test/e2e/cucumber.js

@@ -7,5 +7,8 @@ module.exports = {
     formatOptions: {
       snippetInterface: 'async-await'
     },
+    worldParameters: {
+      bundleWebServerCommand: '../../bin/git-bundle-web-server',
+    }
   }
 }

test/e2e/features/basic.feature

@@ -0,0 +1,4 @@
+Feature: Basic bundle server usage
+
+  Background: The bundle web server is running
+    Given the bundle web server was started at port 8080

test/e2e/features/classes/bundleServer.ts

@@ -0,0 +1,28 @@
+import * as child_process from 'child_process'
+
+export class BundleServer {
+  private bundleWebServerCmd: string
+
+  // Web server
+  private webServerProcess: child_process.ChildProcess | undefined
+
+  constructor(bundleWebServerCmd: string) {
+    this.bundleWebServerCmd = bundleWebServerCmd
+  }
+
+  startWebServer(port: number): void {
+    if (this.webServerProcess) {
+      throw new Error("Tried to start web server, but web server is already running")
+    }
+    this.webServerProcess = child_process.spawn(this.bundleWebServerCmd, ["--port", String(port)])
+  }
+
+  cleanup(): void {
+    if (this.webServerProcess) {
+      const killed = this.webServerProcess.kill('SIGINT')
+      if (!killed) {
+        console.warn("Web server process was not successfully stopped")
+      }
+    }
+  }
+}

test/e2e/features/step_definitions/bundleServer.ts

@@ -0,0 +1,6 @@
+import { BundleServerWorld, } from '../support/world'
+import { Given } from '@cucumber/cucumber'
+
+Given('the bundle web server was started at port {int}', async function (this: BundleServerWorld, port: number) {
+  this.bundleServer.startWebServer(port)
+})

test/e2e/features/step_definitions/shared.ts

@@ -0,0 +1,10 @@
+import { BundleServerWorld } from '../support/world'
+import { After } from '@cucumber/cucumber'
+
+/**
+ * Steps handling operations that are common across tests.
+ */
+
+After(function (this: BundleServerWorld) {
+  this.cleanup()
+});

test/e2e/features/support/utils.ts

@@ -0,0 +1,11 @@
+import * as path from 'path'
+
+export function absPath(pathParam: string): string {
+  // Convert a given path (either relative to 'test/e2e/' or absolute) to an
+  // absolute path
+  if (!path.isAbsolute(pathParam)) {
+    return path.resolve(__dirname, "../..", pathParam)
+  } else {
+    return pathParam
+  }
+}

test/e2e/features/support/world.ts

@@ -0,0 +1,25 @@
+import { setWorldConstructor, World, IWorldOptions } from '@cucumber/cucumber'
+import * as utils from './utils'
+import { BundleServer } from '../classes/bundleServer'
+
+interface BundleServerParameters {
+  bundleWebServerCommand: string
+}
+
+export class BundleServerWorld extends World<BundleServerParameters> {
+  // Bundle server
+  bundleServer: BundleServer
+
+  constructor(options: IWorldOptions<BundleServerParameters>) {
+    super(options)
+
+    // Set up the bundle server
+    this.bundleServer = new BundleServer(utils.absPath(this.parameters.bundleWebServerCommand))
+  }
+
+  cleanup(): void {
+    this.bundleServer.cleanup()
+  }
+}
+
+setWorldConstructor(BundleServerWorld)