Merge pull request #8929 from romayalon/romy-nc-lifecycle-class

NC | Lifecycle | Convert NCLifecycle to a class

Author: romayalon

src/cmd/manage_nsfs.js

@@ -27,7 +27,7 @@ const { account_id_cache } = require('../sdk/accountspace_fs');
 const ManageCLIError = require('../manage_nsfs/manage_nsfs_cli_errors').ManageCLIError;
 const ManageCLIResponse = require('../manage_nsfs/manage_nsfs_cli_responses').ManageCLIResponse;
 const manage_nsfs_glacier = require('../manage_nsfs/manage_nsfs_glacier');
-const noobaa_cli_lifecycle = require('../manage_nsfs/nc_lifecycle');
+const { NCLifecycle } = require('../manage_nsfs/nc_lifecycle');
 const manage_nsfs_logging = require('../manage_nsfs/manage_nsfs_logging');
 const noobaa_cli_diagnose = require('../manage_nsfs/diagnose');
 const noobaa_cli_upgrade = require('../manage_nsfs/upgrade');
@@ -892,7 +892,8 @@ async function lifecycle_management(args) {
     const should_continue_last_run = get_boolean_or_string_value(args.continue);
     try {
         const options = { disable_service_validation, disable_runtime_validation, short_status, should_continue_last_run };
-        const { should_run, lifecycle_run_status } = await noobaa_cli_lifecycle.run_lifecycle_under_lock(config_fs, options);
+        const nc_lifecycle = new NCLifecycle(config_fs, options);
+        const { should_run, lifecycle_run_status } = await nc_lifecycle.run_lifecycle_under_lock();
         if (should_run) {
             write_stdout_response(ManageCLIResponse.LifecycleSuccessful, lifecycle_run_status);
         } else {

src/manage_nsfs/manage_nsfs_cli_utils.js

@@ -124,7 +124,7 @@ async function get_options_from_file(file_path) {
     // we don't pass neither config_root_backend nor fs_backend
     const fs_context = native_fs_utils.get_process_fs_context();
     try {
-        const input_options_with_data = await native_fs_utils.read_file(fs_context, file_path);
+        const input_options_with_data = await native_fs_utils.read_file(fs_context, file_path, { parse_json: true });
         return input_options_with_data;
     } catch (err) {
         if (err.code === 'ENOENT') throw_cli_error(ManageCLIError.InvalidFilePath, file_path);

src/manage_nsfs/nc_lifecycle.js

@@ -140,7 +140,7 @@ class NCMasterKeysManager {
             try {
                 const stat = await nb_native().fs.stat(fs_context, master_keys_path);
                 if (stat.ctime.getTime() === this.last_init_time) return;
-                const master_keys = await native_fs_utils.read_file(fs_context, master_keys_path);
+                const master_keys = await native_fs_utils.read_file(fs_context, master_keys_path, { parse_json: true });
 
                 this._set_keys(master_keys);
                 this.last_init_time = stat.ctime.getTime();

src/manage_nsfs/nc_master_key_manager.js

@@ -737,12 +737,15 @@ async function clean_config_dir(config_fs, custom_config_dir_path) {
  * @param {nb.NativeFSContext} fs_context 
  * @param {String} file_path 
  * @param {Object} file_data 
+ * @param {{stringify_json?: Boolean}} [options={}] 
  */
-async function create_file(fs_context, file_path, file_data) {
+async function create_file(fs_context, file_path, file_data, options = {}) {
+    const buf = Buffer.from(options?.stringify_json ? JSON.stringify(file_data) : file_data);
     await nb_native().fs.writeFile(
         fs_context,
         file_path,
-        Buffer.from(JSON.stringify(file_data)), {
+        buf,
+        {
             mode: native_fs_utils.get_umasked_mode(config.BASE_MODE_FILE)
         }
     );

src/test/system_tests/test_utils.js

@@ -101,7 +101,7 @@ describe('move_old_accounts_dir', () => {
             account_names_obj[account_data.name] = account_data;
             if (account_id % 2 === 0) {
                 const backup_file_path = path.join(hidden_old_accounts_path, default_config_fs.json(account_data.name));
-                await create_file(default_config_fs.fs_context, backup_file_path, account_data);
+                await create_file(default_config_fs.fs_context, backup_file_path, account_data, { stringify_json: true });
             }
         });
         await move_old_accounts_dir(default_config_fs, Object.keys(account_names_obj), mock_old_version, dbg);
@@ -183,7 +183,7 @@ describe('create_account_access_keys_index_if_missing', () => {
         const mock_id_dir = path.join(default_config_fs.identities_dir_path, 'mock_id_dir');
         const mock_link_id_path = path.join(mock_id_dir, 'identity.json');
         await create_fresh_path(mock_id_dir);
-        await create_file(default_config_fs.fs_context, mock_link_id_path, { mock_key: 'mock_value' });
+        await create_file(default_config_fs.fs_context, mock_link_id_path, { mock_key: 'mock_value' }, { stringify_json: true });
         await symlink_account_access_keys(default_config_fs, account_data.access_keys, mock_link_id_path);
         const identity_path = default_config_fs.get_identity_path_by_id(account_data._id);
         const account_upgrade_params = { ...account_data, identity_path };
@@ -275,7 +275,7 @@ describe('create_account_name_index_if_missing', () => {
         const mock_id_dir = path.join(default_config_fs.identities_dir_path, 'mock_id_dir');
         const mock_link_id_path = path.join(mock_id_dir, 'identity.json');
         await create_fresh_path(mock_id_dir);
-        await create_file(default_config_fs.fs_context, mock_link_id_path, { mock_key: 'mock_value' });
+        await create_file(default_config_fs.fs_context, mock_link_id_path, { mock_key: 'mock_value' }, { stringify_json: true });
         await symlink_account_name(default_config_fs, account_data.name, mock_link_id_path);
         const identity_path = default_config_fs.get_identity_path_by_id(account_data._id);
         const account_upgrade_params = { ...account_data, account_name: account_data.name, identity_path };

src/test/unit_tests/jest_tests/test_config_dir_restructure_upgrade_script.test.js

@@ -739,6 +739,7 @@ describe('noobaa cli - lifecycle notifications', () => {
         config.NOTIFICATION_CONNECT_DIR = tmp_conn_dir_path;
         fs.writeFileSync(http_connect_path, JSON.stringify(http_connect));
         await object_sdk.put_bucket_notification(notifications_json);
+        await config_fs.create_config_json_file(JSON.stringify({ NOTIFICATION_LOG_DIR: tmp_lifecycle_logs_dir_path }));
     });
 
     afterEach(async () => {
@@ -754,12 +755,10 @@ describe('noobaa cli - lifecycle notifications', () => {
 
     it('lifecycle_cli - lifecycle rule with Delete notification', async () => {
         await object_sdk.set_bucket_lifecycle_configuration_rules({ name: test_bucket, rules: lifecycle_rule_delete_all });
-
         await create_object(object_sdk, test_bucket, test_key1, 100, true);
         await create_object(object_sdk, test_bucket, test_key2, 100, true);
+        await exec_manage_cli(TYPES.LIFECYCLE, '', { disable_service_validation: 'true', disable_runtime_validation: 'true', config_root }, true);
 
-        await exec_manage_cli(TYPES.LIFECYCLE, '', {disable_service_validation: 'true', disable_runtime_validation: 'true', config_root}, undefined,
-            {NOTIFICATION_LOG_DIR: tmp_lifecycle_logs_dir_path});
         const object_list = await object_sdk.list_objects({bucket: test_bucket});
         expect(object_list.objects.length).toBe(0);
 
@@ -781,9 +780,7 @@ describe('noobaa cli - lifecycle notifications', () => {
 
         await create_object(object_sdk, test_bucket, test_key1, 100, false);
         await create_object(object_sdk, test_bucket, test_key2, 100, false);
-
-        await exec_manage_cli(TYPES.LIFECYCLE, '', {disable_service_validation: 'true', disable_runtime_validation: 'true', config_root}, undefined,
-            {NOTIFICATION_LOG_DIR: tmp_lifecycle_logs_dir_path});
+        await exec_manage_cli(TYPES.LIFECYCLE, '', { disable_service_validation: 'true', disable_runtime_validation: 'true', config_root }, true);
 
         const object_list = await object_sdk.list_object_versions({bucket: test_bucket});
         expect(object_list.objects.length).toBe(4);
@@ -809,8 +806,8 @@ describe('noobaa cli - lifecycle notifications', () => {
         await create_object(object_sdk, test_bucket, test_key1, 100, false);
         await create_object(object_sdk, test_bucket, test_key2, 100, false);
 
-        await exec_manage_cli(TYPES.LIFECYCLE, '', {disable_service_validation: 'true', disable_runtime_validation: 'true', config_root}, undefined,
-            {NOTIFICATION_LOG_DIR: tmp_lifecycle_logs_dir_path});
+        await exec_manage_cli(TYPES.LIFECYCLE, '', { disable_service_validation: 'true', disable_runtime_validation: 'true', config_root }, true);
+        await config_fs.delete_config_json_file();
 
         const object_list = await object_sdk.list_object_versions({bucket: test_bucket});
         expect(object_list.objects.length).toBe(4);

src/test/unit_tests/jest_tests/test_nc_lifecycle_cli.test.js

@@ -552,7 +552,7 @@ mocha.describe('bucketspace_fs', function() {
             assert.equal(objects.buckets.length, 1);
             assert.equal(objects.buckets[0].name.unwrap(), expected_bucket_name);
             const bucket_config_path = get_config_file_path(CONFIG_SUBDIRS.BUCKETS, expected_bucket_name);
-            const bucket_data = await read_file(process_fs_context, bucket_config_path);
+            const bucket_data = await read_file(process_fs_context, bucket_config_path, { parse_json: true });
             assert.equal(objects.buckets[0].creation_date, bucket_data.creation_date);
         });
     });
@@ -715,7 +715,7 @@ mocha.describe('bucketspace_fs', function() {
             const param = { name: test_bucket, versioning: 'ENABLED' };
             await bucketspace_fs.set_bucket_versioning(param, dummy_object_sdk);
             const bucket_config_path = get_config_file_path(CONFIG_SUBDIRS.BUCKETS, param.name);
-            const bucket = await read_file(process_fs_context, bucket_config_path);
+            const bucket = await read_file(process_fs_context, bucket_config_path, { parse_json: true });
             assert.equal(bucket.versioning, 'ENABLED');
 
         });

src/test/unit_tests/test_bucketspace_fs.js

@@ -663,12 +663,14 @@ async function folder_delete(dir, fs_context, is_temp, silent_if_missing) {
  * read_file reads file and returns the parsed file data as object
  * @param {nb.NativeFSContext} fs_context
  * @param {string} _path 
+ * @param {{parse_json?: Boolean}} [options]
  * @return {Promise<object>} 
  */
-async function read_file(fs_context, _path) {
+async function read_file(fs_context, _path, options = {}) {
     const { data } = await nb_native().fs.readFile(fs_context, _path);
-    const data_parsed = JSON.parse(data.toString());
-    return data_parsed;
+    let data_parsed;
+    if (options?.parse_json) data_parsed = JSON.parse(data.toString());
+    return data_parsed || data.toString();
 }