Array with allowable values

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- Add allowableValues support for array
+
 ## `4.7.4`
 
 - Fix update profile API storing secure fields incorrectly when called without CLI args

__tests__/__integration__/cmd/__tests__/integration/cli/validate/__snapshots__/Cmd.cli.validate.test.ts.snap

@@ -37,7 +37,7 @@ exports[`cmd-cli should display proper messages when missing positional paramete
 "
 Syntax Error:
 You must specify one of the following options for this command:
-[--option-to-specify-1, --option-to-specify-2, --option-to-specify-3]
+[--option-to-specify-1, --option-to-specify-2, --option-to-specify-3, --option-to-specify-4]
 
 Syntax Error:
 If you do not specify the following option:

__tests__/__integration__/cmd/src/cli/validate/syntax/Syntax.definition.ts

@@ -51,6 +51,12 @@ export const syntaxTestCommand: ICommandDefinition = {
                 type: "string",
                 allowableValues: {values: ["allowableA", "allowableB", "^allowableC\\$"], caseSensitive: false}
             },
+            {
+                name: "option-to-specify-4",
+                description: "Part of must specify one group",
+                type: "array",
+                allowableValues: {values: ["allowableA", "allowableB"], caseSensitive: false}
+            },
             {
                 name: "conflicts-with-1",
                 description: "Conflicts with option-to-specify-2",
@@ -161,5 +167,5 @@ export const syntaxTestCommand: ICommandDefinition = {
                 options: `"file.txt" "ibmuser.ps" --mr wait`
             },
         ],
-    mustSpecifyOne: ["option-to-specify-1", "option-to-specify-2", "option-to-specify-3"]
+    mustSpecifyOne: ["option-to-specify-1", "option-to-specify-2", "option-to-specify-3", "option-to-specify-4"]
 };

__tests__/src/packages/cmd/SyntaxValidator.integration.test.ts

@@ -195,6 +195,20 @@ describe("Imperative should provide advanced syntax validation rules", function
                         alwaysRequired, true, [])()
                 ]);
             });
+        it("If we specify an option whose type is array and which has a set of allowable string values," +
+            " and specify multiple values each of which matches one of the allowable values," +
+            " the command should succeed ",
+            function() {
+                return tryOptions.bind(this, "--option-to-specify-4 allowableA --option-to-specify-4 allowableB " +
+                    "--absence-implies " + alwaysRequired, true, [])();
+            });
+        it("If we specify an option whose type is array and which has a set of allowable string values," +
+            " and specify multiple values one of which doesn't match one of the allowable values," +
+            " the command should fail ",
+            function() {
+                return tryOptions.bind(this, "--option-to-specify-4 allowableA --option-to-specify-4 notAllowable " +
+                    "--absence-implies " + alwaysRequired, false, ["must match"])();
+            });
         it("If we don't specify an option, and the absence of that option implies " +
             "the presence of another option, and we omit that option as well, the command should fail ",
             function () {

__tests__/src/packages/cmd/ValidationTestCommand.ts

@@ -36,6 +36,12 @@ export const ValidationTestCommand: ICommandDefinition = {
                 type: "string",
                 allowableValues: {values: ["allowableA", "allowableB", "^allowableC\\$"], caseSensitive: false}
             },
+            {
+                name: "option-to-specify-4",
+                description: "Part of must specify one group",
+                type: "array",
+                allowableValues: {values: ["allowableA", "allowableB"], caseSensitive: false}
+            },
             {
                 name: "conflicts-with-1",
                 description: "Conflicts with option-to-specify-2",
@@ -132,5 +138,5 @@ export const ValidationTestCommand: ICommandDefinition = {
                 required: true
             },
         ],
-    mustSpecifyOne: ["option-to-specify-1", "option-to-specify-2", "option-to-specify-3"]
+    mustSpecifyOne: ["option-to-specify-1", "option-to-specify-2", "option-to-specify-3", "option-to-specify-4"]
 };

packages/cmd/src/syntax/SyntaxValidator.ts

@@ -310,10 +310,14 @@ export class SyntaxValidator {
 
                         return regex;
                     });
-                    if (!this.checkIfAllowable(optionDefCopy.allowableValues, commandArguments[optionName])) {
-                        this.invalidOptionError(optionDefCopy, responseObject, commandArguments[optionName]);
-                        valid = false;
-                    }
+
+                    const optionValue = commandArguments[optionName];
+                    const optionValueArray = Array.isArray(optionValue) ? optionValue : [optionValue];
+                    optionValueArray.filter(value => !this.checkIfAllowable(optionDefCopy.allowableValues, value))
+                        .forEach(value => {
+                            this.invalidOptionError(optionDefCopy, responseObject, value);
+                            valid = false;
+                        });
                 }
 
                 if (!isNullOrUndefined(optionDef.conflictsWith) && optionDef.conflictsWith.length > 0) {

packages/cmd/src/syntax/__tests__/SyntaxValidator.test.ts

@@ -142,6 +142,20 @@ describe("Imperative should provide advanced syntax validation rules", () => {
                         alwaysRequired, true, [])()
                 ]);
             });
+        it("If we specify an option whose type is array and which has a set of allowable string values," +
+            " and specify multiple values each of which matches one of the allowable values," +
+            " the command should succeed ",
+            function() {
+                return tryOptions.bind(this, "--option-to-specify-4 allowableA --option-to-specify-4 allowableB " +
+                    "--absence-implies " + alwaysRequired, true, [])();
+            });
+        it("If we specify an option whose type is array and which has a set of allowable string values," +
+            " and specify multiple values one of which doesn't match one of the allowable values," +
+            " the command should fail ",
+            function() {
+                return tryOptions.bind(this, "--option-to-specify-4 allowableA --option-to-specify-4 notAllowable " +
+                    "--absence-implies " + alwaysRequired, false, ["must match"])();
+            });
         it("If we don't specify an option, and the absence of that option implies " +
             "the presence of another option, and we omit that option as well, the command should fail ",
             function () {