feat: config nested array up to 10 level deep (#1386)

Author: ANGkeith

src/data-expander.ts

@@ -227,9 +227,10 @@ export function globalVariables (gitlabData: any) {
 }
 
 export function flattenLists (gitlabData: any) {
-    traverse(gitlabData, ({parent, key, value}) => {
+    traverse(gitlabData, ({parent, key, value, meta}) => {
         if (parent != null && key != null && Array.isArray(value)) {
-            parent[key] = value.flat(5);
+            parent[key] = value.flat(9);
+            assert(!parent[key].some(Array.isArray), chalk`This Gitlab CI configuration is invalid: {blueBright ${meta.nodePath}} config should be string or a nested array of strings up to 10 level deep`);
         }
-    }, {cycleHandling: false});
+    }, {cycleHandling: true});
 }

tests/test-cases/reference/.gitlab-ci-10-level-deep.yml

@@ -0,0 +1,23 @@
+---
+.script1:
+  - echo test
+.script2:
+  - !reference [.script1]
+.script3:
+  - !reference [.script2]
+.script4:
+  - !reference [.script3]
+.script5:
+  - !reference [.script4]
+.script6:
+  - !reference [.script5]
+.script7:
+  - !reference [.script6]
+.script8:
+  - !reference [.script7]
+.script9:
+  - !reference [.script8]
+test:
+  image: alpine
+  script:
+    - !reference [.script9]

tests/test-cases/reference/.gitlab-ci-11-level-deep.yml

@@ -0,0 +1,25 @@
+---
+.script1:
+  - echo test
+.script2:
+  - !reference [.script1]
+.script3:
+  - !reference [.script2]
+.script4:
+  - !reference [.script3]
+.script5:
+  - !reference [.script4]
+.script6:
+  - !reference [.script5]
+.script7:
+  - !reference [.script6]
+.script8:
+  - !reference [.script7]
+.script9:
+  - !reference [.script8]
+.script10:
+  - !reference [.script9]
+test:
+  image: alpine
+  script:
+    - !reference [.script10]

tests/test-cases/reference/integration.reference.test.ts

@@ -110,3 +110,45 @@ normal_job:
     - echo Hello from \${CI_JOB_NAME}`;
     expect(writeStreams.stdoutLines[0]).toEqual(expected);
 });
+
+
+test("should support 10 level deep", async () => {
+    const writeStreams = new WriteStreamsMock();
+    await handler({
+        preview: true,
+        file: ".gitlab-ci-10-level-deep.yml",
+        cwd: "tests/test-cases/reference",
+    }, writeStreams);
+
+    const expected = `
+---
+stages:
+  - .pre
+  - build
+  - test
+  - deploy
+  - .post
+test:
+  image:
+    name: alpine
+  script:
+    - echo test
+`;
+
+    expect(writeStreams.stdoutLines.join("\n")).toEqual(expected.trim());
+});
+
+test("should not support 11 level deep", async () => {
+    try {
+        const writeStreams = new WriteStreamsMock();
+        await handler({
+            noColor: true,
+            file: ".gitlab-ci-11-level-deep.yml",
+            cwd: "tests/test-cases/reference",
+        }, writeStreams);
+    } catch (e: any) {
+        expect(e.message).toEqual("This Gitlab CI configuration is invalid: test.script config should be string or a nested array of strings up to 10 level deep");
+        return;
+    }
+    throw new Error("Error is expected but not thrown/caught");
+});

tests/test-cases/script-multidimension/.gitlab-ci-10-level-deep.yml

@@ -0,0 +1,13 @@
+---
+test-job:
+  script:
+    - echo 1
+    - - echo 2
+    - - - echo 3
+    - - - - echo 4
+    - - - - - echo 5
+    - - - - - - echo 6
+    - - - - - - - echo 7
+    - - - - - - - - echo 8
+    - - - - - - - - - echo 9
+    - - - - - - - - - - echo 10

tests/test-cases/script-multidimension/.gitlab-ci-11-level-deep.yml

@@ -0,0 +1,14 @@
+---
+test-job:
+  script:
+    - echo 1
+    - - echo 2
+    - - - echo 3
+    - - - - echo 4
+    - - - - - echo 5
+    - - - - - - echo 6
+    - - - - - - - echo 7
+    - - - - - - - - echo 8
+    - - - - - - - - - echo 9
+    - - - - - - - - - - echo 10
+    - - - - - - - - - - - echo 11

tests/test-cases/script-multidimension/.gitlab-ci.yml

@@ -1,23 +1,56 @@
 import {WriteStreamsMock} from "../../../src/write-streams.js";
 import {handler} from "../../../src/handler.js";
-import chalk from "chalk";
 import {initSpawnSpy} from "../../mocks/utils.mock.js";
 import {WhenStatics} from "../../mocks/when-statics.js";
 
 beforeAll(() => {
     initSpawnSpy(WhenStatics.all);
 });
 
-test("script-multidimension <test-job>", async () => {
+test("should support 10 level deep", async () => {
     const writeStreams = new WriteStreamsMock();
     await handler({
+        preview: true,
+        file: ".gitlab-ci-10-level-deep.yml",
         cwd: "tests/test-cases/script-multidimension",
-        job: ["test-job"],
     }, writeStreams);
 
-    const expected = [
-        chalk`{blueBright test-job} {greenBright >} Test something`,
-        chalk`{blueBright test-job} {greenBright >} Test something else`,
-    ];
-    expect(writeStreams.stdoutLines).toEqual(expect.arrayContaining(expected));
+    const expected = `
+---
+stages:
+  - .pre
+  - build
+  - test
+  - deploy
+  - .post
+test-job:
+  script:
+    - echo 1
+    - echo 2
+    - echo 3
+    - echo 4
+    - echo 5
+    - echo 6
+    - echo 7
+    - echo 8
+    - echo 9
+    - echo 10
+`;
+
+    expect(writeStreams.stdoutLines.join("\n")).toEqual(expected.trim());
+});
+
+test("should not support 11 level deep", async () => {
+    try {
+        const writeStreams = new WriteStreamsMock();
+        await handler({
+            noColor: true,
+            file: ".gitlab-ci-11-level-deep.yml",
+            cwd: "tests/test-cases/script-multidimension",
+        }, writeStreams);
+    } catch (e: any) {
+        expect(e.message).toEqual("This Gitlab CI configuration is invalid: test-job.script config should be string or a nested array of strings up to 10 level deep");
+        return;
+    }
+    throw new Error("Error is expected but not thrown/caught");
 });