Make sure that include:remote's aren't fetched during bash completion

firecow · firecow · commit ed046744f324 · 2020-10-18T16:33:21.000+02:00
diff --git a/src/commander.ts b/src/commander.ts
@@ -1,7 +1,7 @@
 import * as c from "ansi-colors";
 
-import { Job } from "./job";
-import { Parser } from "./parser";
+import {Job} from "./job";
+import {Parser} from "./parser";
 
 export class Commander {
 
@@ -83,23 +83,22 @@ export class Commander {
             return whenPrio.indexOf(b.when) - whenPrio.indexOf(a.when);
         });
 
-
         let whenPadEnd = 0;
         parser.getJobs().forEach(j => whenPadEnd = Math.max(j.when.length, whenPadEnd));
 
         let stagePadEnd = 0;
-        parser.getStageNames().forEach(s => stagePadEnd = Math.max(s.length , stagePadEnd));
+        parser.getStageNames().forEach(s => stagePadEnd = Math.max(s.length, stagePadEnd));
 
         let descriptionPadEnd = 0;
         parser.getJobs().forEach(j => descriptionPadEnd = Math.max(j.getDescription().length, descriptionPadEnd));
 
         for (const job of jobs) {
             const needs = job.needs;
-            const allowFailure = job.allowFailure ? 'warning' : ''
+            const allowFailure = job.allowFailure ? 'warning' : '';
             let jobLine = `${job.getJobNameString()}  ${job.getDescription().padEnd(descriptionPadEnd)}`;
-            jobLine += `  ${c.yellow(`${job.stage.padEnd(stagePadEnd)}`)}  ${job.when.padEnd(whenPadEnd)}  ${allowFailure.padEnd(7)}`
+            jobLine += `  ${c.yellow(`${job.stage.padEnd(stagePadEnd)}`)}  ${job.when.padEnd(whenPadEnd)}  ${allowFailure.padEnd(7)}`;
             if (needs) {
-                jobLine += `  [${c.blueBright(`${needs.join(',')}`)}]`
+                jobLine += `  [${c.blueBright(`${needs.join(',')}`)}]`;
             }
             process.stdout.write(`${jobLine}\n`);
         }
@@ -112,15 +111,19 @@ export class Commander {
         jobs.push(foundJob);
 
         if (needs) {
-            // Recursive backwards traversal to find parant needs.
+            // Recursive backwards traversal to find parent needs.
             let needed: string[] = [];
-            if (foundJob.needs) needed = needed.concat(foundJob.needs);
+            if (foundJob.needs) {
+                needed = needed.concat(foundJob.needs);
+            }
             while (needed.length > 0) {
                 const need = needed.pop();
                 if (need) {
                     const needJob = parser.getJobByName(need);
                     jobs.unshift(needJob);
-                    if (needJob.needs) needed = needed.concat(needJob.needs);
+                    if (needJob.needs) {
+                        needed = needed.concat(needJob.needs);
+                    }
                 }
             }
         }
@@ -152,7 +155,7 @@ export class Commander {
         };
         const afterScripts: any = {
             warned: []
-        }
+        };
 
         for (const job of jobs) {
             if (job.isStarted() && job.getAfterPrescriptsExitCode() !== 0) {
@@ -184,7 +187,7 @@ export class Commander {
             } else {
                 process.stdout.write(`${c.blueBright(`${job.name}`)}, `);
             }
-        }
+        };
 
         if (preScripts.never.length !== 0) {
             process.stdout.write(`${c.magenta("not started")} `);
diff --git a/src/index.ts b/src/index.ts
@@ -1,8 +1,8 @@
-import {CommandModule} from "yargs";
 import * as yargs from "yargs";
+import {CommandModule} from "yargs";
+import * as defaultCmd from "./default_cmd";
 
 import {Parser} from "./parser";
-import * as defaultCmd from "./default_cmd";
 import * as predefinedVariables from "./predefined_variables";
 
 process.on('uncaughtException', (err) => {
@@ -43,7 +43,7 @@ const argv = yargs
     .completion("completion", false, async (current, a) => {
         const cwd = a.cwd as string || process.cwd();
         const pipelineIid = predefinedVariables.getPipelineIid(cwd);
-        const parser = new Parser(cwd, pipelineIid);
+        const parser = new Parser(cwd, pipelineIid, true);
         return parser.getJobNames();
     })
     .argv;
diff --git a/src/job.ts b/src/job.ts
@@ -1,5 +1,5 @@
 import * as c from "ansi-colors";
-import { spawn } from "child_process";
+import {spawn} from "child_process";
 import * as deepExtend from "deep-extend";
 import * as fs from "fs-extra";
 import * as glob from "glob";
@@ -236,7 +236,7 @@ export class Job {
         const outputFilesPath = this.getOutputFilesPath();
 
         return new Promise((resolve, reject) => {
-            const bash = spawn("bash", { cwd: this.cwd, env: this.getEnvs() });
+            const bash = spawn("bash", {cwd: this.cwd, env: this.getEnvs()});
             bash.on("error", (err) => {
                 reject(err);
             });
@@ -293,7 +293,7 @@ export class Job {
     }
 
     private getEnvs(): { [key: string]: string } {
-        const envs: {[key: string]: string} = {...this.globals.variables || {}, ...this.variables, ...process.env, ...this.predefinedVariables};
+        const envs: { [key: string]: string } = {...this.globals.variables || {}, ...this.variables, ...process.env, ...this.predefinedVariables};
         const regex = /\${(.*?)}/g;
         let exec;
 
diff --git a/src/parser.ts b/src/parser.ts
@@ -1,50 +1,30 @@
 import * as c from "ansi-colors";
+import {execSync} from "child_process";
 import * as deepExtend from "deep-extend";
 import * as fs from "fs-extra";
 import * as yaml from "yaml";
-
-import { execSync } from "child_process";
+import {Job} from "./job";
 import * as predefinedVariables from "./predefined_variables";
-import { Job } from "./job";
-import { Stage } from "./stage";
+import {Stage} from "./stage";
 
 export class Parser {
 
-    public static loadYaml(filePath: string): any {
-        const gitlabCiLocalYmlPath = `${filePath}`;
-        if (!fs.existsSync(gitlabCiLocalYmlPath)) {
-            return {};
-        }
-
-        const fileContent = fs.readFileSync(`${filePath}`, "utf8");
-        const descRegEx = /#.*?@Description\s?(.*)\s(.*)?:/gm
-        const parse = yaml.parse(fileContent) || {};
-
-        let match;
-        while (match = descRegEx.exec(fileContent)) {
-            if (match[1] && match[2]) {
-                parse[match[2]].description = match[1]
-            }
-        }
-
-        return parse;
-    }
-
+    public readonly maxJobNameLength: number = 0;
     private readonly illigalJobNames = [
         "include", "local_configuration", "image", "services",
         "stages", "pages", "types", "before_script", "default",
         "after_script", "variables", "cache", "include",
     ];
     private readonly jobs: Map<string, Job> = new Map();
-
-    public readonly maxJobNameLength: number = 0;
     private readonly stages: Map<string, Stage> = new Map();
     private readonly cwd: string;
+    private readonly bashCompletionPhase: boolean;
 
-    public constructor(cwd: any, pipelineIid: number) {
+    public constructor(cwd: any, pipelineIid: number, bashCompletionPhase: boolean = false) {
         let path = '';
         let yamlDataList: any[] = [];
 
+        this.bashCompletionPhase = bashCompletionPhase;
         this.cwd = cwd;
 
         path = `${cwd}/.gitlab-ci.yml`;
@@ -107,41 +87,24 @@ export class Parser {
         }
     }
 
-    private prepareIncludes(doc: any): any[] {
-        let includeDatas: any[] = [];
-        const cwd = this.cwd;
-
-        for (const value of doc["include"] || []) {
-            if (value["local"]) {
-                const localDoc = Parser.loadYaml(`${this.cwd}/${value.local}`);
-                includeDatas = includeDatas.concat(this.prepareIncludes(localDoc));
-            } else if (value["file"]) {
-                const ref = value["ref"] || "master";
-                const file = value["file"];
-                const project = value["project"];
-                const gitlabCiLocalPath = `${cwd}/.gitlab-ci-local/includes/${project}/${ref}/`;
-
-                const domainRegExp = /^.*@(.*):.*\(fetch\)/;
-                const output = execSync(`git remote -v`, {
-                    cwd: `${this.cwd}`
-                });
-                const exec = domainRegExp.exec(`${output}`);
-                const gitDomain = exec ? exec[1] : null;
-                fs.ensureDirSync(gitlabCiLocalPath);
-                execSync(`git archive --remote=git@${gitDomain}:${project}.git ${ref} --format=zip ${file} | gunzip -c - > ${file}`, {
-                    cwd: gitlabCiLocalPath
-                });
+    public static loadYaml(filePath: string): any {
+        const gitlabCiLocalYmlPath = `${filePath}`;
+        if (!fs.existsSync(gitlabCiLocalYmlPath)) {
+            return {};
+        }
 
-                const fileDoc = Parser.loadYaml(`${cwd}/.gitlab-ci-local/includes/${project}/${ref}/${file}`);
-                includeDatas = includeDatas.concat(this.prepareIncludes(fileDoc));
+        const fileContent = fs.readFileSync(`${filePath}`, "utf8");
+        const descRegEx = /#.*?@Description\s?(.*)\s(.*)?:/gm;
+        const parse = yaml.parse(fileContent) || {};
 
-            } else {
-                process.stderr.write(`Didn't understand include ${JSON.stringify(value)}\n`);
+        let match;
+        while (match = descRegEx.exec(fileContent)) {
+            if (match[1] && match[2]) {
+                parse[match[2]].description = match[1];
             }
         }
 
-        includeDatas.push(doc);
-        return includeDatas;
+        return parse;
     }
 
     public getJobByName(name: string): Job {
@@ -192,4 +155,42 @@ export class Parser {
 
         }
     }
+
+    private prepareIncludes(doc: any): any[] {
+        let includeDatas: any[] = [];
+        const cwd = this.cwd;
+
+        for (const value of doc["include"] || []) {
+            if (value["local"]) {
+                const localDoc = Parser.loadYaml(`${this.cwd}/${value.local}`);
+                includeDatas = includeDatas.concat(this.prepareIncludes(localDoc));
+            } else if (value["file"]) {
+                const ref = value["ref"] || "master";
+                const file = value["file"];
+                const project = value["project"];
+                const gitlabCiLocalPath = `${cwd}/.gitlab-ci-local/includes/${project}/${ref}/`;
+
+                const domainRegExp = /^.*@(.*):.*\(fetch\)/;
+                const output = execSync(`git remote -v`, {
+                    cwd: `${this.cwd}`
+                });
+                const exec = domainRegExp.exec(`${output}`);
+                const gitDomain = exec ? exec[1] : null;
+                fs.ensureDirSync(gitlabCiLocalPath);
+                if (!this.bashCompletionPhase || !fs.existsSync(`${cwd}/.gitlab-ci-local/includes/${project}/${ref}/${file}`)) {
+                    execSync(`git archive --remote=git@${gitDomain}:${project}.git ${ref} --format=zip ${file} | gunzip -c - > ${file}`, {
+                        cwd: gitlabCiLocalPath
+                    });
+                }
+                const fileDoc = Parser.loadYaml(`${cwd}/.gitlab-ci-local/includes/${project}/${ref}/${file}`);
+                includeDatas = includeDatas.concat(this.prepareIncludes(fileDoc));
+
+            } else {
+                process.stderr.write(`Didn't understand include ${JSON.stringify(value)}\n`);
+            }
+        }
+
+        includeDatas.push(doc);
+        return includeDatas;
+    }
 }
diff --git a/src/stage.ts b/src/stage.ts
@@ -1,4 +1,4 @@
-import { Job } from "./job";
+import {Job} from "./job";
 
 export class Stage {
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Job } from "./job";`
	`1`	`+import {Job} from "./job";`
`2`	`2`
`3`	`3`	`export class Stage {`
`4`	`4`