CLI Controller

.eslintrc.json

@@ -31,7 +31,8 @@
 		"jest/consistent-test-it": "error",
 		"jest/prefer-spy-on": "error",
 		"jest/prefer-todo": "error",
-		"jest/require-top-level-describe": "error"
+		"jest/require-top-level-describe": "error",
+		"prefer-destructuring": ["error", { "array": false }]
 	},
 	"env": {
 		"node": true,

bin/controller.ts

@@ -24,9 +24,9 @@ function clientDone() {
 
 const job3: Job = new NormalJob('third')
 const job4: Job = new NormalJob('fourth')
-const job2: Job = new NormalJob('second', new Set([job3]))
-const job1: Job = new NormalJob('first', new Set([job4, job2]))
-const job5: Job = new NormalJob('fifth', new Set([job1]))
+const job2: Job = new NormalJob('second', [], new Set([job3]))
+const job1: Job = new NormalJob('first', [], new Set([job4, job2]))
+const job5: Job = new NormalJob('fifth', [], new Set([job1]))
 
 const client: Client = new Http2Client(new HeapJobOrderer([job5]))
 client.on('progress', console.log)

src/Client/Http2Client.ts

@@ -110,7 +110,7 @@ export class Http2Client extends EventEmitter implements Client {
 	 */
 	private assignJobToDaemon(job: Job, daemon: ClientHttp2Session) {
 		this.availableDaemons.delete(daemon)
-		const request = daemon.request({ ':path': `/${job.getName()}` })
+		const request = daemon.request({ ':path': `/${job.getTarget()}` })
 		daemon.on('error', () => this.jobOrderer.reportFailedJob(job))
 
 		let data = ''

src/Controller/CommandLineController.ts

@@ -0,0 +1,49 @@
+import * as yargs from 'yargs'
+
+export interface JunknetArguments {
+	makefile: string
+	docker_image: string
+	target: string | null
+}
+
+/**
+ * Interpret a list of arguments, returning the relevant ones in the f
+ *
+ * @param argv - the invoking process's command-line arguments.
+ * @returns JunknetInterface object containing option values.
+ */
+export function interpretArgv(argv: readonly string[]): JunknetArguments {
+	// Use only the first two elements; Node.js appends extra elements to process.argv.
+	const yargsArgv = yargs(argv.slice(2))
+		.options({
+			f: {
+				alias: 'makefile',
+				type: 'string',
+				default: 'Makefile',
+				desc: 'The Makefile to process',
+			},
+			i: {
+				alias: 'docker-image',
+				type: 'string',
+				default: 'ubuntu:18.04',
+				desc: 'The Docker Image to run',
+			},
+			t: {
+				alias: 'target',
+				type: 'string',
+				desc: 'The Makefile target to build',
+			},
+		})
+		.strict().argv
+
+	let target = null
+	if (yargsArgv.t !== undefined) {
+		target = yargsArgv.t
+	}
+
+	return {
+		makefile: yargsArgv.f,
+		docker_image: yargsArgv.i,
+		target,
+	}
+}

src/Job/Job.ts

@@ -3,14 +3,13 @@
  */
 export interface Job {
 	/**
-	 * Get this job's name.
+	 * Get this job's target.
 	 *
-	 * This method may be removed in the future because Jobs may no longer have names.
+	 * The target is the resulting file.
 	 *
-	 * @experimental
-	 * @returns This job's name.
+	 * @returns This target.
 	 */
-	getName(): string
+	getTarget(): string
 
 	/**
 	 * Gets this Job's prerequisites as an iterable.
@@ -27,4 +26,9 @@ export interface Job {
 	 * @returns The number of prerequisites.
 	 */
 	getNumPrerequisites(): number
+
+	/**
+	 * Returns the commands to run (in-order and synchronously) that will result.
+	 */
+	getCommands(): string[]
 }

src/Job/NormalJob.ts

@@ -7,11 +7,12 @@ export class NormalJob implements Job {
 	private prerequisites: Set<Job>
 
 	/**
-	 * @param name - The job's name. Must be unique between jobs in the same dependency graph.
+	 * @param target - The job's name. Must be unique between jobs in the same dependency graph.
 	 * @param prerequisites - An optional set containing all of this job's prerequisites. Defaults to no prerequisites.
 	 */
 	constructor(
-		private readonly name: string,
+		private readonly target: string,
+		private readonly commands: string[] = [],
 		prerequisites: Set<Job> = new Set(),
 	) {
 		this.prerequisites = new Set(prerequisites) // Make a copy so the caller can't directly access prerequisites. Encapsulation!
@@ -20,8 +21,8 @@ export class NormalJob implements Job {
 	/**
 	 * @returns The job's name.
 	 */
-	public getName(): string {
-		return this.name
+	public getTarget(): string {
+		return this.target
 	}
 
 	/**
@@ -47,11 +48,15 @@ export class NormalJob implements Job {
 	 */
 	public toString(): string {
 		if (this.prerequisites.size === 0) {
-			return `Source job ${this.name}.`
+			return `Source job ${this.target}.`
 		}
 
-		return `Job "${this.name}" depending on ${Array.from(this.prerequisites)
-			.map((prerequisite) => prerequisite.getName())
+		return `Job "${this.target}" depending on ${Array.from(this.prerequisites)
+			.map((prerequisite) => prerequisite.getTarget())
 			.join(', ')}.`
 	}
+
+	public getCommands(): string[] {
+		return this.commands
+	}
 }

test/unit/CommandLineController.test.ts

@@ -0,0 +1,77 @@
+/**
+ * Tests for the Command-Line Argument Parser
+ */
+
+// When yargs encounters an invalid option, it'll automatically invoke process.exit().
+// This is a problem, because it would muck up our testing framework.
+// We could handle this by explicitly passing a fail() callback to yargs,
+// but this would override the very-nice default handler. In short, testing
+// this scenario would require a lot of code.
+//
+// I don't think that the effort is worth it, because our code is just a
+// wrapper around yargs anyways (I trust their tests).
+
+import * as cli from '../../src/Controller/CommandLineController'
+
+describe('Parser', () => {
+	it('interprets short options', () => {
+		const argv: readonly string[] = [
+			'0',
+			'1',
+			'2',
+			'-f',
+			'mf',
+			'-i',
+			'di',
+			'-t',
+			't',
+		]
+		const results = cli.interpretArgv(argv)
+		expect(results.makefile).toBe('mf')
+		expect(results.docker_image).toBe('di')
+		expect(results.target).toBe('t')
+	})
+
+	it('interprets --option=var style long options', () => {
+		const argv: readonly string[] = [
+			'0',
+			'1',
+			'2',
+			'3',
+			'--makefile=mf',
+			'--docker-image=di',
+			'--target=t',
+		]
+		const results = cli.interpretArgv(argv)
+		expect(results.makefile).toBe('mf')
+		expect(results.docker_image).toBe('di')
+		expect(results.target).toBe('t')
+	})
+
+	it('interprets "--option var" style long options', () => {
+		const argv: readonly string[] = [
+			'0',
+			'1',
+			'2',
+			'3',
+			'--makefile',
+			'mf',
+			'--docker-image',
+			'di',
+			'--target',
+			't',
+		]
+		const results = cli.interpretArgv(argv)
+		expect(results.makefile).toBe('mf')
+		expect(results.docker_image).toBe('di')
+		expect(results.target).toBe('t')
+	})
+
+	it('sets correct default options', () => {
+		const argv: readonly string[] = ['0', '1']
+		const results = cli.interpretArgv(argv)
+		expect(results.makefile).toBe('Makefile')
+		expect(results.docker_image).toBe('ubuntu:18.04')
+		expect(results.target).toBeNull()
+	})
+})

test/unit/HeapJobOrderer.test.ts

@@ -10,14 +10,20 @@ describe('HeapJobOrderer', () => {
 		const sourceJob: Job = new NormalJob('sourceJob')
 		const intermediateJob1: Job = new NormalJob(
 			'intermediateJob1',
+			[''],
 			new Set([sourceJob]),
 		)
 		const intermediateJob2: Job = new NormalJob(
 			'intermediateJob2',
+			[''],
 			new Set([sourceJob, intermediateJob1]),
 		)
-		const rootJob1: Job = new NormalJob('rootJob1', new Set([sourceJob]))
-		const rootJob2: Job = new NormalJob('rootJob2', new Set([intermediateJob2]))
+		const rootJob1: Job = new NormalJob('rootJob1', [''], new Set([sourceJob]))
+		const rootJob2: Job = new NormalJob(
+			'rootJob2',
+			[''],
+			new Set([intermediateJob2]),
+		)
 
 		const rootJobs: Job[] = [rootJob1, rootJob2]
 		const jobOrderer = new HeapJobOrderer(rootJobs)

test/unit/NormalJob.test.ts

@@ -5,17 +5,18 @@ describe('NormalJob', () => {
 	it('returns the correct name', () => {
 		const expectedName = 'jobName'
 		const job = new NormalJob(expectedName)
-		expect(job.getName()).toEqual(expectedName)
+		expect(job.getTarget()).toEqual(expectedName)
 	})
 
 	it('returns the correct number of prerequisites for sources', () => {
-		const sourceJob = new NormalJob('', new Set([]))
+		const sourceJob = new NormalJob('')
 		expect(sourceJob.getNumPrerequisites()).toEqual(0)
 	})
 
 	it('returns the correct number of prerequisites for nonsources', () => {
 		const nonsourceJob = new NormalJob(
 			'',
+			[''],
 			new Set([new NormalJob(''), new NormalJob(''), new NormalJob('')]),
 		)
 		expect(nonsourceJob.getNumPrerequisites()).toEqual(3)
@@ -25,7 +26,7 @@ describe('NormalJob', () => {
 		const toDelete = new NormalJob('asd')
 		const prerequisites = new Set([toDelete])
 
-		const job = new NormalJob('job', prerequisites)
+		const job = new NormalJob('job', [''], prerequisites)
 		prerequisites.delete(toDelete)
 		expect(job.getNumPrerequisites()).toEqual(1)
 	})
@@ -36,7 +37,7 @@ describe('NormalJob', () => {
 			new NormalJob('2'),
 			new NormalJob('3'),
 		])
-		const job = new NormalJob('job', prerequisites)
+		const job = new NormalJob('job', [''], prerequisites)
 
 		expect(new Set(job.getPrerequisitesIterable())).toEqual(prerequisites)
 	})