feat: add support for checkboxes in issue form

redhat-plumbers-in-action · Apr 30, 2024 · 824aa5f · 824aa5f
1 parent 3cba48b
commit 824aa5f
Show file tree

Hide file tree

Showing 10 changed files with 76 additions and 27 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/issue-form.js b/dist/issue-form.js
diff --git a/dist/issue-form.js.map b/dist/issue-form.js.map
diff --git a/src/issue-form.ts b/src/issue-form.ts
@@ -14,15 +14,16 @@ export class IssueForm {
   }
 
   listKeywords(key: string, blockList: string[]) {
-    const propertySection = this.getSafeProperty(key);
+    let propertySection = this.getSafeProperty(key);
 
     if (!propertySection) return undefined;
-    // Array can be only checkbox type - currently unsupported
-    if (Array.isArray(propertySection)) return undefined;
 
-    return propertySection
-      .split(', ', 25)
-      .filter(label => !this.isCompliant(blockList, label));
+    // Only Checkboxes are in form of array, dropdowns are strings separated by ', '
+    if (!Array.isArray(propertySection)) {
+      propertySection = propertySection.split(', ', 25);
+    }
+
+    return propertySection.filter(label => !this.isCompliant(blockList, label));
   }
 
   isCompliant(policy: string[], keyword: string) {

diff --git a/test/action.test.ts b/test/action.test.ts
@@ -268,10 +268,10 @@ describe('Integration test', () => {
 
     // Check outputs
     expect(process.env['OUTPUT_LABELS']).toMatchInlineSnapshot(
-      `"["bug 🐛","RFE 🎁","high"]"`
+      `"["bug 🐛","RFE 🎁","high","type: two","type: three"]"`
     );
     expect(process.env['OUTPUT_POLICY']).toMatchInlineSnapshot(
-      `"{"template":"bug.yml","section":{"type":["bug 🐛","RFE 🎁"],"severity":["high"]}}"`
+      `"{"template":"bug.yml","section":{"type":["bug 🐛","RFE 🎁"],"severity":["high"],"checkList":["type: two","type: three"]}}"`
     );
 
     // Check if the action has set the labels
@@ -282,7 +282,7 @@ describe('Integration test', () => {
         owner: 'redhat-plumbers-in-action',
         repo: 'advanced-issue-labeler',
         issue_number: 1,
-        labels: ['bug 🐛', 'RFE 🎁', 'high'],
+        labels: ['bug 🐛', 'RFE 🎁', 'high', 'type: two', 'type: three'],
       }
     );
   });

diff --git a/test/unit/config.fixture.ts b/test/unit/config.fixture.ts
@@ -38,6 +38,15 @@ export const templateConfig = {
             { name: 'low', keys: ['Low'] },
           ],
         },
+        {
+          id: ['checkList'],
+          'block-list': ['one'],
+          label: [
+            { name: 'type: one', keys: ['one'] },
+            { name: 'type: two', keys: ['two'] },
+            { name: 'type: three', keys: ['three'] },
+          ],
+        },
       ],
     },
     {

diff --git a/test/unit/config.test.ts b/test/unit/config.test.ts
@@ -187,6 +187,34 @@ describe('Test Config class', () => {
                 },
               ],
             },
+            {
+              "block-list": [
+                "one",
+              ],
+              "id": [
+                "checkList",
+              ],
+              "label": [
+                {
+                  "keys": [
+                    "one",
+                  ],
+                  "name": "type: one",
+                },
+                {
+                  "keys": [
+                    "two",
+                  ],
+                  "name": "type: two",
+                },
+                {
+                  "keys": [
+                    "three",
+                  ],
+                  "name": "type: three",
+                },
+              ],
+            },
           ],
           "template": [
             "bug.yml",

diff --git a/test/unit/issue-form.test.ts b/test/unit/issue-form.test.ts
@@ -52,8 +52,13 @@ describe('Test IssueForm class', () => {
         ]
       `);
 
-    // Checklists are unsupported at the moment
-    expect(issueForm.listKeywords('checkList', [])).toBeUndefined();
+    expect(issueForm.listKeywords('checkList', ['one'])).toMatchInlineSnapshot(`
+      [
+        "two",
+        "three",
+      ]
+    `);
+
     expect(issueForm.listKeywords('nonexistent', ['none'])).toBeUndefined();
   });
 });
diff --git a/test/unit/labeler.test.ts b/test/unit/labeler.test.ts
@@ -152,6 +152,8 @@ describe('Test Labeler class', () => {
           "bug 🐛",
           "RFE 🎁",
           "high",
+          "type: two",
+          "type: three",
         ]
       `);
     });
@@ -163,6 +165,10 @@ describe('Test Labeler class', () => {
         expect(labeler.outputPolicy).toMatchInlineSnapshot(`
           {
             "section": {
+              "checkList": [
+                "type: two",
+                "type: three",
+              ],
               "severity": [
                 "high",
               ],
@@ -179,6 +185,8 @@ describe('Test Labeler class', () => {
             "bug 🐛",
             "RFE 🎁",
             "high",
+            "type: two",
+            "type: three",
           ]
         `);
       });