refactor: use asserts instead of process.exit (#1290)

Author: ANGkeith

src/parser.ts

@@ -80,7 +80,6 @@ export class Parser {
         if (parser.argv.jsonSchemaValidation) {
             const time = process.hrtime();
             Validator.jsonSchemaValidation({
-                writeStreams,
                 pathToExpandedGitLabCi,
                 gitLabCiConfig: parser.gitlabData,
             });

src/validator.ts

@@ -4,14 +4,12 @@ import assert from "assert";
 import chalk from "chalk";
 import schema from "./schema";
 import {betterAjvErrors} from "./schema-error";
-import {WriteStreams} from "./write-streams";
 import terminalLink from "terminal-link";
 
 const MAX_ERRORS = 5;
 
 export class Validator {
-    static jsonSchemaValidation ({writeStreams, pathToExpandedGitLabCi, gitLabCiConfig}: {
-        writeStreams: WriteStreams;
+    static jsonSchemaValidation ({pathToExpandedGitLabCi, gitLabCiConfig}: {
         pathToExpandedGitLabCi: string;
         gitLabCiConfig: object;
     }) {
@@ -26,24 +24,28 @@ export class Validator {
         const validate = ajv.compile(schema);
         const valid = validate(gitLabCiConfig);
         if (!valid) {
-            writeStreams.stderr(chalk`Invalid .gitlab-ci.yml configuration!\n`);
-
             const betterErrors = betterAjvErrors({
                 data: gitLabCiConfig,
                 errors: validate.errors,
             });
 
-            const errors = betterErrors.map((e => (chalk`\t• {redBright ${e.message}} at {blueBright ${e.path}}`)));
-            writeStreams.stderr(errors.splice(0, MAX_ERRORS).join("\n"));
-            if (errors.length > MAX_ERRORS) {
-                writeStreams.stderr(`\t... and ${errors.length - MAX_ERRORS} more`);
+            let e: string = "";
+            for (let i = 0, len = betterErrors.length; i < len; i++) {
+                if (i + 1 > MAX_ERRORS) {
+                    e += `\t... and ${len - MAX_ERRORS} more`;
+                    break;
+                }
+                e += chalk`\t• {redBright ${betterErrors[i].message}} at {blueBright ${betterErrors[i].path}}\n`;
             }
 
-            writeStreams.stderr(chalk`\n\nFor further troubleshooting, consider either of the following:
+            assert(valid, chalk`
+{reset Invalid .gitlab-ci.yml configuration!
+${e.trimEnd()}
+
+For further troubleshooting, consider either of the following:
 \t• Copy the content of {blueBright ${terminalLink(".gitlab-ci-local/expanded-gitlab-ci.yml", pathToExpandedGitLabCi)}} to the ${terminalLink("pipeline editor", "https://docs.gitlab.com/ee/ci/pipeline_editor/")} to debug it
-\t• Use --json-schema-validation=false to disable schema validation (not recommended)
+\t• Use --json-schema-validation=false to disable schema validation (not recommended)}
 `);
-            process.exit(1);
         }
     }
 

tests/test-cases/schema-validation/.gitlab-ci-4-errors.yml

@@ -0,0 +1,21 @@
+---
+error1:
+  variables:
+    true
+  script:
+    - echo hello
+error2:
+  variables:
+    true
+  script:
+    - echo hello
+error3:
+  variables:
+    true
+  script:
+    - echo hello
+error4:
+  variables:
+    true
+  script:
+    - echo hello

tests/test-cases/schema-validation/.gitlab-ci-5-errors.yml

@@ -0,0 +1,26 @@
+---
+error1:
+  variables:
+    true
+  script:
+    - echo hello
+error2:
+  variables:
+    true
+  script:
+    - echo hello
+error3:
+  variables:
+    true
+  script:
+    - echo hello
+error4:
+  variables:
+    true
+  script:
+    - echo hello
+error5:
+  variables:
+    true
+  script:
+    - echo hello

tests/test-cases/schema-validation/.gitlab-ci-6-errors.yml

@@ -0,0 +1,31 @@
+---
+error1:
+  variables:
+    true
+  script:
+    - echo hello
+error2:
+  variables:
+    true
+  script:
+    - echo hello
+error3:
+  variables:
+    true
+  script:
+    - echo hello
+error4:
+  variables:
+    true
+  script:
+    - echo hello
+error5:
+  variables:
+    true
+  script:
+    - echo hello
+error6:
+  variables:
+    true
+  script:
+    - echo hello

tests/test-cases/schema-validation/integration.schema-validation.test.ts

@@ -2,28 +2,29 @@ import {WriteStreamsMock} from "../../../src/write-streams";
 import {handler} from "../../../src/handler";
 import {initSpawnSpy} from "../../mocks/utils.mock";
 import {WhenStatics} from "../../mocks/when-statics";
+import assert, {AssertionError} from "assert";
+import {stripAnsi} from "../../utils";
+
 
 beforeAll(() => {
     initSpawnSpy(WhenStatics.all);
 });
 
 test("schema validation <test-job>", async () => {
     const writeStreams = new WriteStreamsMock();
-    const mockExit = jest.spyOn(process, "exit").mockImplementation(() => {
-        // Do nothing
-        return undefined as never;
-    });
-
-    await handler({
-        cwd: "tests/test-cases/schema-validation",
-    }, writeStreams);
-    expect(writeStreams.stderrLines.join("\n")).toContain("Invalid .gitlab-ci.yml configuration!");
-    expect(writeStreams.stderrLines.join("\n")).toContain("property 'script' must not have fewer than 1 characters");
-    expect(writeStreams.stderrLines.join("\n")).toContain("'when' property must be one of [on_success, on_failure, always, never, manual, delayed] (found manual2)");
-    expect(writeStreams.stderrLines.join("\n")).toContain("'junit' property type must be string");
-    expect(writeStreams.stderrLines.join("\n")).toContain("'data' property is not expected to be here");
-
-    expect(mockExit).toHaveBeenCalledWith(1);
+    try {
+        await handler({
+            cwd: "tests/test-cases/schema-validation",
+        }, writeStreams);
+        expect(true).toBe(false);
+    } catch (e: any) {
+        assert(e instanceof AssertionError, "e is not instanceof AssertionError");
+        expect(e.message).toContain("Invalid .gitlab-ci.yml configuration!");
+        expect(e.message).toContain("property 'script' must not have fewer than 1 characters");
+        expect(e.message).toContain("'when' property must be one of [on_success, on_failure, always, never, manual, delayed] (found manual2)");
+        expect(e.message).toContain("'junit' property type must be string");
+        expect(e.message).toContain("'data' property is not expected to be here");
+    }
 });
 
 test("schema validation - default <test-job>", async () => {
@@ -57,3 +58,73 @@ my-job:
     expect(writeStreams.stdoutLines[0]).toEqual(expected);
     expect(writeStreams.stderrLines.join("\n")).toContain("my-job.artifacts is null, ignoring.");
 });
+
+test("schema validation 4 errors", async () => {
+    const writeStreams = new WriteStreamsMock();
+    try {
+        await handler({
+            file: ".gitlab-ci-4-errors.yml",
+            cwd: "tests/test-cases/schema-validation",
+
+        }, writeStreams);
+        expect(true).toBe(false);
+    } catch (e: any) {
+        const expected = `
+Invalid .gitlab-ci.yml configuration!
+\t• 'variables' property type must be object at error1.variables
+\t• 'variables' property type must be object at error2.variables
+\t• 'variables' property type must be object at error3.variables
+\t• 'variables' property type must be object at error4.variables
+
+`;
+        assert(e instanceof AssertionError, "e is not instanceof AssertionError");
+        expect(stripAnsi(e.message)).toContain(expected);
+    }
+});
+
+test("schema validation 5 errors", async () => {
+    const writeStreams = new WriteStreamsMock();
+    try {
+        await handler({
+            file: ".gitlab-ci-5-errors.yml",
+            cwd: "tests/test-cases/schema-validation",
+
+        }, writeStreams);
+        expect(true).toBe(false);
+    } catch (e: any) {
+        const expected = `Invalid .gitlab-ci.yml configuration!
+\t• 'variables' property type must be object at error1.variables
+\t• 'variables' property type must be object at error2.variables
+\t• 'variables' property type must be object at error3.variables
+\t• 'variables' property type must be object at error4.variables
+\t• 'variables' property type must be object at error5.variables
+
+For further troubleshooting, consider either of the following:`;
+        assert(e instanceof AssertionError, "e is not instanceof AssertionError");
+        expect(stripAnsi(e.message)).toContain(expected);
+    }
+});
+
+test("schema validation 6 errors", async () => {
+    const writeStreams = new WriteStreamsMock();
+    try {
+        await handler({
+            file: ".gitlab-ci-6-errors.yml",
+            cwd: "tests/test-cases/schema-validation",
+
+        }, writeStreams);
+        expect(true).toBe(false);
+    } catch (e: any) {
+        const expected = `Invalid .gitlab-ci.yml configuration!
+\t• 'variables' property type must be object at error1.variables
+\t• 'variables' property type must be object at error2.variables
+\t• 'variables' property type must be object at error3.variables
+\t• 'variables' property type must be object at error4.variables
+\t• 'variables' property type must be object at error5.variables
+\t... and 1 more
+
+`;
+        assert(e instanceof AssertionError, "e is not instanceof AssertionError");
+        expect(stripAnsi(e.message)).toContain(expected);
+    }
+});

tests/utils.ts

@@ -8,3 +8,13 @@ export function isSshDirFound () {
         return false;
     }
 }
+
+
+export function stripAnsi (str: string) {
+    // Copied from https://github.com/chalk/ansi-regex/blob/main/index.js#L1-L8
+    const pattern = [
+        "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)",
+        "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))",
+    ].join("|");
+    return str.replace(new RegExp(pattern, "g"), "");
+}