Updated to enum, added examples and error msg

Signed-off-by: Aayush Chouhan <[email protected]>

Author: aayushchouhan09

src/manage_nsfs/manage_nsfs_validations.js

@@ -89,7 +89,7 @@ async function validate_input_types(type, action, argv) {
 function validate_no_leading_space(argv_) {
     // checking if 'argv_' contains more then 2 values (i.e, type and action)
     if (argv_.length > 2) {
-        const details = 'flag value is invalid - leading spaces or an empty value detected, ensure flag values are properly formatted.';
+        const details = `flag value is invalid - leading spaces detected in: ${JSON.stringify(argv_.slice(2))}, ensure flag values are properly formatted.`;
         throw_cli_error(ManageCLIError.InvalidArgument, details);
     }
 }

src/test/unit_tests/jest_tests/test_nc_account_cli.test.js

@@ -23,6 +23,13 @@ const timeout = 50000;
 const config = require('../../../../config');
 const config_fs_account_options = { show_secrets: true, decrypt_secret_key: true };
 
+const quoted_type = Object.freeze({
+    SPACE_ONLY: "s", // space only
+    QUOTE_SPACE: "qs", // quote then space
+    SPACE_QUOTE: "sq", // space then quote
+    NONE: "none" // none
+});
+
 // eslint-disable-next-line max-lines-per-function
 describe('manage nsfs cli account flow', () => {
     describe('cli create account', () => {
@@ -108,7 +115,7 @@ describe('manage nsfs cli account flow', () => {
             const account_options = { config_root, name, uid, gid}; // will add new_buckets_path with leading space later
             const action = ACTIONS.ADD;
             const command = create_command(type, action, account_options);
-            const res = await exec_manage_cli_add_leading_space_option(command, 'new_buckets_path', new_buckets_path, 's'); // only space
+            const res = await exec_manage_cli_add_leading_space_option(command, 'new_buckets_path', new_buckets_path, quoted_type.SPACE_ONLY); // only space
             expect(JSON.parse(res.stdout).error.code).toBe(ManageCLIError.InvalidArgument.code);
         });
 
@@ -117,7 +124,7 @@ describe('manage nsfs cli account flow', () => {
             const account_options = { config_root, name, uid, gid}; // will add quoted new_buckets_path with leading space later
             const action = ACTIONS.ADD;
             const command = create_command(type, action, account_options);
-            const res = await exec_manage_cli_add_leading_space_option(command, 'new_buckets_path', new_buckets_path, 'sq'); // space then quote
+            const res = await exec_manage_cli_add_leading_space_option(command, 'new_buckets_path', new_buckets_path, quoted_type.SPACE_QUOTE); // space then quote
             expect(JSON.parse(res.stdout).error.code).toBe(ManageCLIError.InvalidArgument.code);
         });
 
@@ -126,7 +133,7 @@ describe('manage nsfs cli account flow', () => {
             const account_options = { config_root, name, uid, gid}; // will add new_buckets_path with quoted leading space later
             const action = ACTIONS.ADD;
             const command = create_command(type, action, account_options);
-            const res = await exec_manage_cli_add_leading_space_option(command, 'new_buckets_path', new_buckets_path, 'qs'); // quote then space
+            const res = await exec_manage_cli_add_leading_space_option(command, 'new_buckets_path', new_buckets_path, quoted_type.QUOTE_SPACE); // quote then space
             expect(JSON.parse(res.stdout).error.code).toBe(ManageCLIError.InvalidAccountNewBucketsPath.code);
         });
 
@@ -2250,19 +2257,36 @@ async function exec_manage_cli_add_empty_option(command, option) {
  * @param {string} command
  * @param {string} option
  * @param {string} value
- * @param {string} quoted
+ * @param {"s" | "qs" | "sq" | "none"} quoted
+ *
+ * @examples
+ * - await exec_manage_cli_add_leading_space_option("cli_command", "flag", "val", quoted_type.SPACE_ONLY);
+ *   // cli_command --flag= val  (Space before value)
+ *
+ * - await exec_manage_cli_add_leading_space_option("cli_command", "flag", "val", quoted_type.QUOTE_SPACE);
+ *   // cli_command --flag=" val"  (quote then space)
+ *
+ * - await exec_manage_cli_add_leading_space_option("cli_command", "flag", "val", quoted_type.SPACE_QUOTE);
+ *   // cli_command --flag= "val"  (space then quote)
+ *
+ * - await exec_manage_cli_add_leading_space_option("cli_command", "flag", "val", quoted_type.NONE);
+ *   // cli_command --flag=val  (No special formatting)
  */
 async function exec_manage_cli_add_leading_space_option(command, option, value, quoted) {
     let changed_command;
 
-    if (quoted === 's') { // only space
-        changed_command = command + ` --${option}= ${value}`;
-    } else if (quoted === 'qs') { // quote then space
-        changed_command = command + ` --${option}=" ${value}"`;
-    } else if (quoted === 'sq') { // space then quote
-        changed_command = command + ` --${option}= "${value}"`;
-    } else {
-        changed_command = command + ` --${option}=${value}`;
+    switch (quoted) {
+        case quoted_type.SPACE_ONLY:
+            changed_command = `${command} --${option}= ${value}`;
+            break;
+        case quoted_type.QUOTE_SPACE:
+            changed_command = `${command} --${option}=" ${value}"`;
+            break;
+        case quoted_type.SPACE_QUOTE:
+            changed_command = `${command} --${option}= "${value}"`;
+            break;
+        default:
+            changed_command = `${command} --${option}=${value}`;
     }
 
     let res;