Made it possible to call docker create --add-host via an --extra-host array option (#140)

firecow · web-flow · commit eba184e4ba7e · 2021-04-18T15:28:20.000+02:00
diff --git a/src/handler.ts b/src/handler.ts
@@ -37,22 +37,28 @@ export async function handler(argv: any, writeStreams: WriteStreams) {
     } else if (argv.list != null) {
         checkFolderAndFile(cwd, argv.file);
         const pipelineIid = await state.getPipelineIid(cwd);
-        parser = await Parser.create(cwd, writeStreams, pipelineIid, false, argv.file, argv.home);
+        parser = await Parser.create({
+            cwd, writeStreams, pipelineIid, tabCompletionPhase: false, file: argv.file, home: argv.home, extraHosts: argv.extraHost,
+        });
         Commander.runList(parser, writeStreams);
     } else if (argv.job) {
         checkFolderAndFile(cwd, argv.file);
         if (argv.needs === true) {
             await state.incrementPipelineIid(cwd);
         }
         const pipelineIid = await state.getPipelineIid(cwd);
-        parser = await Parser.create(cwd, writeStreams, pipelineIid, false, argv.file, argv.home);
+        parser = await Parser.create({
+            cwd, writeStreams, pipelineIid, tabCompletionPhase: false, file: argv.file, home: argv.home, extraHosts: argv.extraHost,
+        });
         await Commander.runSingleJob(parser, writeStreams, argv.job, argv.needs || false, argv.privileged || false);
     } else {
         const time = process.hrtime();
         checkFolderAndFile(cwd, argv.file);
         await state.incrementPipelineIid(cwd);
         const pipelineIid = await state.getPipelineIid(cwd);
-        parser = await Parser.create(cwd, writeStreams, pipelineIid, false, argv.file, argv.home);
+        parser = await Parser.create({
+            cwd, writeStreams, pipelineIid, tabCompletionPhase: false, file: argv.file, home: argv.home, extraHosts: argv.extraHost,
+        });
         await Commander.runPipeline(parser, writeStreams, argv.manual || [], argv.privileged || false);
         writeStreams.stdout(chalk`{grey pipeline finished} in {grey ${prettyHrtime(process.hrtime(time))}}\n`);
     }
diff --git a/src/index.ts b/src/index.ts
@@ -93,11 +93,22 @@ process.on("unhandledRejection", e => {
             description: "Set docker executor to privileged mode",
             requiresArg: false,
         })
+        .option("extra-host", {
+            type: "array",
+            description: "Add extra docker host entries",
+            requiresArg: false,
+        })
         .completion("completion", false, async (_, yargsArgv) => {
             try {
                 const cwd = yargsArgv.cwd || process.cwd();
                 const pipelineIid = await state.getPipelineIid(cwd);
-                const parser = await Parser.create(cwd, new ProcessWriteStreams(), pipelineIid, true, yargsArgv.file);
+                const parser = await Parser.create({
+                    cwd,
+                    writeStreams: new ProcessWriteStreams(),
+                    pipelineIid,
+                    tabCompletionPhase: true,
+                    file: yargsArgv.file,
+                });
                 return parser.getJobs().map((j) => j.name);
             } catch (e) {
                 return ["Parser-Failed!"];
diff --git a/src/job.ts b/src/job.ts
@@ -32,6 +32,7 @@ export class Job {
     private _prescriptsExitCode = 0;
     private readonly jobData: any;
     private readonly writeStreams: WriteStreams;
+    private readonly extraHosts: string[];
     private started = false;
     private finished = false;
     private running = false;
@@ -45,6 +46,7 @@ export class Job {
         const globals = opt.globals;
         const homeVariables = opt.homeVariables;
 
+        this.extraHosts = opt.extraHosts;
         this.writeStreams = opt.writeStreams;
         this.jobNamePad = opt.namePad;
         this.name = opt.name;
@@ -354,6 +356,10 @@ export class Job {
                 dockerCmd += `docker create -u 0:0 -i ${this.generateInjectSSHAgentOptions()} `;
             }
 
+            for (const extraHost of this.extraHosts) {
+                dockerCmd += `--add-host=${extraHost} `;
+            }
+
             if (this.imageEntrypoint) {
                 this.imageEntrypoint.forEach((e) => {
                     dockerCmd += `--entrypoint "${e}" `;
diff --git a/src/parser.ts b/src/parser.ts
@@ -15,46 +15,39 @@ import {Utils} from "./utils";
 import {assert} from "./asserts";
 import * as path from "path";
 import {WriteStreams} from "./types/write-streams";
+import {ParserOptions} from "./types/parser-options";
 
 export class Parser {
 
     private readonly jobs: Map<string, Job> = new Map();
     private readonly stages: Map<string, Stage> = new Map();
-    private readonly cwd: string;
-    private readonly writeStreams: WriteStreams;
-    private readonly file?: string;
-    private readonly home?: string;
-    private readonly pipelineIid: number;
+    private readonly opt: ParserOptions;
 
     private gitRemote: GitRemote | null = null;
     private homeVariables: any;
 
     private gitlabData: any;
     private _jobNamePad = 0;
-    private readonly tabCompletionPhase: boolean;
-
-    private constructor(cwd: string, writeStreams: WriteStreams, pipelineIid: number, tabCompletionPhase: boolean, home?: string, file?: string) {
-        this.cwd = cwd;
-        this.pipelineIid = pipelineIid;
-        this.tabCompletionPhase = tabCompletionPhase;
-        this.file = file;
-        this.home = home;
-        this.writeStreams = writeStreams;
+
+    private constructor(opt: ParserOptions) {
+        this.opt = opt;
     }
 
     get jobNamePad(): number {
         return this._jobNamePad;
     }
 
-    static async create(cwd: string, writeStreams: WriteStreams, pipelineIid: number, tabCompletionPhase: boolean, home?: string, file?: string) {
-        const parser = new Parser(cwd, writeStreams, pipelineIid, tabCompletionPhase, file, home);
+    static async create(opt: ParserOptions) {
+        const writeStreams = opt.writeStreams;
+        const parser = new Parser(opt);
 
         const time = process.hrtime();
         await parser.init();
         await parser.initJobs();
         await parser.validateNeedsTags();
         const parsingTime = process.hrtime(time);
-        if (!tabCompletionPhase) {
+
+        if (!opt.tabCompletionPhase) {
             writeStreams.stdout(chalk`{cyan ${"yml files".padEnd(parser.jobNamePad)}} {magentaBright processed} in {magenta ${prettyHrtime(parsingTime)}}\n`);
         }
 
@@ -146,20 +139,23 @@ export class Parser {
     }
 
     async init() {
-        const cwd = this.cwd;
-        const writeStreams = this.writeStreams;
+        const cwd = this.opt.cwd;
+        const writeStreams = this.opt.writeStreams;
+        const home = this.opt.home;
+        const file = this.opt.file;
+        const tabCompletionPhase = this.opt.tabCompletionPhase;
 
         this.gitRemote = await Parser.initGitRemote(cwd);
-        this.homeVariables = await Parser.initHomeVariables(cwd, this.gitRemote, this.home ?? process.env.HOME ?? "");
+        this.homeVariables = await Parser.initHomeVariables(cwd, this.gitRemote, home ?? process.env.HOME ?? "");
 
         let ymlPath, yamlDataList: any[] = [];
-        ymlPath = this.file ? `${cwd}/${this.file}` : `${cwd}/.gitlab-ci.yml`;
+        ymlPath = file ? `${cwd}/${file}` : `${cwd}/.gitlab-ci.yml`;
         const gitlabCiData = await Parser.loadYaml(ymlPath);
-        yamlDataList = yamlDataList.concat(await Parser.prepareIncludes(gitlabCiData, cwd, writeStreams, this.gitRemote, this.tabCompletionPhase));
+        yamlDataList = yamlDataList.concat(await Parser.prepareIncludes(gitlabCiData, cwd, writeStreams, this.gitRemote, tabCompletionPhase));
 
         ymlPath = `${cwd}/.gitlab-ci-local.yml`;
         const gitlabCiLocalData = await Parser.loadYaml(ymlPath);
-        yamlDataList = yamlDataList.concat(await Parser.prepareIncludes(gitlabCiLocalData, cwd, writeStreams, this.gitRemote, this.tabCompletionPhase));
+        yamlDataList = yamlDataList.concat(await Parser.prepareIncludes(gitlabCiLocalData, cwd, writeStreams, this.gitRemote, tabCompletionPhase));
 
         const gitlabData: any = deepExtend({}, ...yamlDataList);
 
@@ -235,8 +231,10 @@ export class Parser {
     async initJobs() {
         assert(this.gitRemote != null, "GitRemote isn't set in parser initJobs function");
 
-        const pipelineIid = this.pipelineIid;
-        const cwd = this.cwd;
+        const writeStreams = this.opt.writeStreams;
+        const pipelineIid = this.opt.pipelineIid;
+        const cwd = this.opt.cwd;
+        const extraHosts = this.opt.extraHosts || [];
         const gitlabData = this.gitlabData;
 
         const gitUser = await Parser.initGitUser(cwd);
@@ -249,7 +247,8 @@ export class Parser {
 
             const jobId = await state.getJobId(cwd);
             const job = new Job({
-                writeStreams: this.writeStreams,
+                extraHosts,
+                writeStreams,
                 name: jobName,
                 namePad: this.jobNamePad,
                 homeVariables: this.homeVariables,
diff --git a/src/types/job-options.ts b/src/types/job-options.ts
@@ -13,5 +13,6 @@ export interface JobOptions {
     id: number;
     gitRemote: GitRemote;
     gitUser: GitUser;
+    extraHosts: string[];
     homeVariables: { [name: string]: string };
 }
diff --git a/src/types/parser-options.ts b/src/types/parser-options.ts
@@ -0,0 +1,11 @@
+import {WriteStreams} from "./write-streams";
+
+export interface ParserOptions {
+    cwd: string;
+    writeStreams: WriteStreams;
+    pipelineIid: number;
+    tabCompletionPhase: boolean;
+    extraHosts?: string[];
+    home?: string;
+    file?: string;
+}
diff --git a/tests/test-cases/extra-host/.gitconfig b/tests/test-cases/extra-host/.gitconfig
@@ -0,0 +1,2 @@
+[remote "origin"]
+	url = git@gitlab.com/gcl/test-case.git
diff --git a/tests/test-cases/extra-host/.gitlab-ci.yml b/tests/test-cases/extra-host/.gitlab-ci.yml
@@ -0,0 +1,5 @@
+---
+test-job:
+  image: curlimages/curl:7.69.1
+  script:
+    - curl -I http://fake-google.com
diff --git a/tests/test-cases/extra-host/integration.extra-host.test.ts b/tests/test-cases/extra-host/integration.extra-host.test.ts
@@ -0,0 +1,17 @@
+import {MockWriteStreams} from "../../../src/mock-write-streams";
+import {handler} from "../../../src/handler";
+import * as chalk from "chalk";
+
+test("add-host <test-job>", async () => {
+    const writeStreams = new MockWriteStreams();
+    await handler({
+        cwd: "tests/test-cases/extra-host",
+        job: "test-job",
+        extraHost: ["fake-google.com:142.250.185.206"],
+    }, writeStreams);
+
+    const expected = [
+        chalk`{blueBright test-job} {greenBright >} HTTP/1.1 404 Not Found`,
+    ];
+    expect(writeStreams.stdoutLines).toEqual(expect.arrayContaining(expected));
+});

Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,6 @@ export interface JobOptions {`
`13`	`13`	`id: number;`
`14`	`14`	`gitRemote: GitRemote;`
`15`	`15`	`gitUser: GitUser;`
	`16`	`+ extraHosts: string[];`
`16`	`17`	`homeVariables: { [name: string]: string };`
`17`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[remote "origin"]`
	`2`	`+ url = [email protected]/gcl/test-case.git`