Merge pull request #8806 from naveenpaul1/bucket_name_suffix

NC | CLI | List bucket dose not return full bucket name with `.json` suffix

Author: naveenpaul1

docs/NooBaaNonContainerized/NooBaaCLI.md

@@ -838,4 +838,57 @@ sudo noobaa-cli connection add --from_file <options_connection_JSON_file_path>
 ### White List Server IP command example
 ```
 sudo noobaa-cli whitelist --ips ["127.0.0.1", "192.0.10.0", "3002:0bd6:0000:0000:0000:ee00:0033:6778"]'
-```
+```
+
+### Known issues
+
+1. Bucket with suffix `.json`
+    
+    When the customer creates a bucket with the suffix `.json`, suffix is removed from the bucket config file name. 
+    
+    For example 
+    ```
+    sudo noobaa-cli bucket add --name my-bucket1.json --owner <owner_name> --path <path>
+    ```
+    Actual file name : `{config_root}\buckets\my-test-bucket.json`
+
+    Expected file name : `{config_root}\buckets\my-test-bucket.json.json`
+    
+    I/O is not possible in this bucket. This issue is only reproducible in older versions(5.18.0 and older).
+    Issue fixed version is <TBD>
+    
+    solution :
+    * Recreate the bucket with same name in new version
+    ```
+    sudo noobaa-cli bucket add --name my-bucket1.json --owner <owner_name> --path <path> 
+    ```
+    * Delete invalid bucket
+    ```
+    bucket delete --name my-bucket1 (bucket name without suffix `.json`)
+    ```
+
+2. Account with suffix `.symlink`
+    
+    When the customer creates an account with the suffix `.symlink`, suffix is removed from the account config file name. 
+    
+    For example 
+    ```
+    sudo noobaa-cli account add --name acc_symlink.symlink --new_buckets_path <path> --uid <uid> --gid <gid>
+    ```
+    Actual file name : `{config_root}\accounts_by_name\acc_symlink.symlink`
+    
+    Expected file name : `{config_root}\accounts_by_name\acc_symlink.symlink.symlink`
+    
+    This issue is only reproducible in older versions(5.18.0 and older).
+    Issue fixed version is <TBD>
+    
+    solution :
+    * Recreate the account with same name in new version
+    ```
+    sudo noobaa-cli account add --name acc_symlink.symlink --new_buckets_path <path> --uid <uid> --gid <gid>
+    ```
+    * Delete invalid account
+    ```
+    sudo noobaa-cli account delete --name acc_symlink (account name without suffix `.symlink`)
+    ```
+

src/sdk/config_fs.js

@@ -103,13 +103,13 @@ class ConfigFS {
 
     /**
      * add_config_file_suffix returns the config_file_name follwed by the given suffix
+     * Bucket name can have suffix `.json`. This will make sure the bucket name and bucket config file have the same name.
      * @param {string} config_file_name
      * @param {string} suffix
      * @returns {string} 
      */
     add_config_file_suffix(config_file_name, suffix) {
         if (!config_file_name) dbg.warn(`Config file name is missing - ${config_file_name}`);
-        if (String(config_file_name).endsWith(suffix)) return config_file_name;
         return config_file_name + suffix;
     }
 

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

@@ -603,6 +603,46 @@ describe('manage nsfs cli account flow', () => {
             const res = await exec_manage_cli(type, action, account_options);
             expect(JSON.parse(res.stdout).error.code).toBe(ManageCLIError.InvalidSupplementalGroupsList.code);
         });
+
+        it('cli account add - with account name suffix `.json`', async function() {
+            const action = ACTIONS.ADD;
+            const { type, new_buckets_path, uid, gid } = defaults;
+            await fs_utils.create_fresh_path(new_buckets_path);
+            await fs_utils.file_must_exist(new_buckets_path);
+            const name = 'account_suffix.json';
+            const account_options = { config_root, name, new_buckets_path, uid, gid };
+            const res = await exec_manage_cli(type, action, account_options);
+            const parse_res = JSON.parse(res);
+            expect(parse_res.response.code).toEqual(ManageCLIResponse.AccountCreated.code);
+            expect(parse_res.response.reply.name).toEqual(name);
+            const account = await config_fs.get_account_by_name(name);
+            expect(account.name).toBe(name);
+            const res1 = await exec_manage_cli(TYPES.ACCOUNT, ACTIONS.STATUS, { name, config_root });
+            expect(JSON.parse(res1).response.reply.name).toBe(name);
+            const res_list = await exec_manage_cli(TYPES.ACCOUNT, ACTIONS.LIST, { config_root });
+            expect(JSON.parse(res_list).response.reply.map(item => item.name))
+                .toEqual(expect.arrayContaining([name]));
+        });
+
+        it('cli account add - with account name suffix `.symlink`', async function() {
+            const action = ACTIONS.ADD;
+            const { type, new_buckets_path, uid, gid } = defaults;
+            await fs_utils.create_fresh_path(new_buckets_path);
+            await fs_utils.file_must_exist(new_buckets_path);
+            const name = 'account_suffix.symlink';
+            const account_options = { config_root, name, new_buckets_path, uid, gid };
+            const res = await exec_manage_cli(type, action, account_options);
+            const parse_res = JSON.parse(res);
+            expect(parse_res.response.code).toEqual(ManageCLIResponse.AccountCreated.code);
+            expect(parse_res.response.reply.name).toEqual(name);
+            const account = await config_fs.get_account_by_name(name);
+            expect(account.name).toBe(name);
+            const res1 = await exec_manage_cli(TYPES.ACCOUNT, ACTIONS.STATUS, { name, config_root });
+            expect(JSON.parse(res1).response.reply.name).toBe(name);
+            const res_list = await exec_manage_cli(TYPES.ACCOUNT, ACTIONS.LIST, { config_root });
+            expect(JSON.parse(res_list).response.reply.map(item => item.name))
+                .toEqual(expect.arrayContaining([name]));
+        });
     });
 
     describe('cli update account', () => {

src/test/unit_tests/jest_tests/test_nc_bucket_cli.test.js

@@ -27,7 +27,8 @@ describe('manage nsfs cli bucket flow', () => {
         const config_root = path.join(tmp_fs_path, 'config_root_manage_nsfs');
         const config_fs = new ConfigFS(config_root);
         const root_path = path.join(tmp_fs_path, 'root_path_manage_nsfs/');
-        const bucket_storage_path = path.join(tmp_fs_path, 'root_path_manage_nsfs', 'bucket1');
+        const bucket_storage_path = path.join(root_path, 'bucket1');
+        const bucket_json_storage_path = path.join(root_path, 'bucket3.json');
         set_nc_config_dir_in_config(config_root);
 
         const account_defaults = {
@@ -54,6 +55,12 @@ describe('manage nsfs cli bucket flow', () => {
             path: bucket_storage_path,
         };
 
+        const bucket_suffix_json = {
+            name: 'bucket3.json',
+            owner: account_defaults.name,
+            path: bucket_json_storage_path,
+        };
+
         beforeEach(async () => {
             await fs_utils.create_fresh_path(root_path);
             await fs_utils.create_fresh_path(bucket_storage_path);
@@ -242,6 +249,22 @@ describe('manage nsfs cli bucket flow', () => {
             await assert_bucket(bucket, bucket_options, config_fs);
             expect(bucket.s3_policy).toStrictEqual(bucket_policy);
         });
+
+        it('cli create bucket - with bucket name suffix `.json`', async () => {
+            await fs_utils.create_fresh_path(bucket_json_storage_path);
+            await fs_utils.file_must_exist(bucket_json_storage_path);
+            const action = ACTIONS.ADD;
+            const bucket_options = { config_root, ...bucket_suffix_json };
+            await exec_manage_cli(TYPES.BUCKET, action, bucket_options);
+            const bucket = await config_fs.get_bucket_by_name(bucket_suffix_json.name);
+            expect(bucket).toBeDefined();
+            expect(bucket.name).toBe(bucket_options.name);
+            const res = await exec_manage_cli(TYPES.BUCKET, ACTIONS.STATUS, { name: bucket_suffix_json.name, config_root });
+            expect(JSON.parse(res).response.reply.name).toBe(bucket_options.name);
+            const res_list = await exec_manage_cli(TYPES.BUCKET, ACTIONS.LIST, { config_root });
+            expect(JSON.parse(res_list).response.reply.map(item => item.name))
+                .toEqual(expect.arrayContaining([bucket_options.name]));
+        });
     });
 
     describe('cli create bucket using from_file', () => {