cr

Signed-off-by: Romy <[email protected]>

Author: romayalon

src/manage_nsfs/manage_nsfs_constants.js

@@ -1,42 +1,41 @@
 /* Copyright (C) 2024 NooBaa */
 'use strict';
 
-const TYPES = {
+const TYPES = Object.freeze({
     ACCOUNT: 'account',
     BUCKET: 'bucket',
     IP_WHITELIST: 'whitelist',
     GLACIER: 'glacier',
     LOGGING: 'logging',
     DIAGNOSE: 'diagnose',
     UPGRADE: 'upgrade'
-};
+});
 
-const ACTIONS = {
+const ACTIONS = Object.freeze({
     ADD: 'add',
     UPDATE: 'update',
     DELETE: 'delete',
     LIST: 'list',
     STATUS: 'status'
-};
+});
 
-const GLACIER_ACTIONS = {
+const GLACIER_ACTIONS = Object.freeze({
     MIGRATE: 'migrate',
     RESTORE: 'restore',
     EXPIRY: 'expiry',
-};
+});
 
-const DIAGNOSE_ACTIONS = {
+const DIAGNOSE_ACTIONS = Object.freeze({
     HEALTH: 'health',
     GATHER_LOGS: 'gather-logs',
     METRICS: 'metrics'
-};
+});
 
-const UPGRADE_ACTIONS = {
+const UPGRADE_ACTIONS = Object.freeze({
     START: 'start',
     STATUS: 'status',
     HISTORY: 'history'
-};
-
+});
 
 const CONFIG_ROOT_FLAG = 'config_root';
 const CLI_MUTUAL_OPTIONS = new Set([CONFIG_ROOT_FLAG, 'config_root_backend', 'debug']);

src/manage_nsfs/manage_nsfs_help_utils.js

@@ -283,10 +283,6 @@ Usage:
 
 
 const UPGRADE_OPTIONS = `
-Usage:
-
-'upgrade' is a noobaa-core command that will return the exported metrics of the deployed NooBaa system.
-
 Usage:
 
     noobaa-cli upgrade <action> [flags]
@@ -300,19 +296,24 @@ List of actions supported:
 `;
 
 const UPGRADE_START_OPTIONS = `
-'upgrade start' is a noobaa-core command that will start config directory upgrade run.
+'upgrade start' is a noobaa-cli command that will start config directory upgrade run.
 Run upgrade start after upgrading NooBaa RPMs on all the cluster nodes, after starting an upgrade of the config directory,
 S3 I/O, S3 Buckets getters and NooBaa CLI Account/Buckets/Whitelist getters operations will still be working
 But updates of the config directory will be blocked during the upgrade of the config directory.
+Upgrade start should be executed on one node, the config directory changes will be available for all the nodes of the cluster.
 `;
 
 const UPGRADE_STATUS_OPTIONS = `
-'upgrade status' is a noobaa-core command that will return the status of an ongoing upgrade run.
+'upgrade status' is a noobaa-cli command that will return the status of an ongoing upgrade run,
+the available status information is upgrade start timestmp, from_version, to_version, config_dir_from_version,
+config_dir_to_version, running_host etc.
 
 `;
 
 const UPGRADE_HISTORY_OPTIONS = `
-'upgrade history' is a noobaa-core command that will return the history of past upgrades.
+'upgrade history' is a noobaa-cli command that will return the history of past upgrades,
+the available history information is an array of upgrade information - upgrade start timestmp, from_version, to_version, config_dir_from_version,
+config_dir_to_version, running_host etc.
 
 `;
 

src/manage_nsfs/upgrade.js

@@ -38,7 +38,7 @@ async function exec_config_dir_upgrade() {
         throw new Error('Upgrade Config Directory is not implemented yet');
     } catch (err) {
         dbg.warn('could not upgrade config directory successfully - err', err);
-        throw_cli_error({ ...ManageCLIError.UpgradeFailed, cause: err?.errors?.[0] || err });
+        throw_cli_error({ ...ManageCLIError.UpgradeFailed, cause: err });
     }
 }
 
@@ -49,13 +49,13 @@ async function exec_config_dir_upgrade() {
  */
 async function get_upgrade_status(config_fs) {
     try {
-        const system_config = await config_fs.get_system_config_file();
-        const upgrade_status = system_config?.config_directory?.in_progress_upgrade;
-        if (!upgrade_status) throw new Error('Config directory upgrade status is empty, there is no ongoing config directory upgrade or there is an error', { cause: system_config });
+        const system_config = await config_fs.get_system_config_file({ silent_if_missing: true });
+        let upgrade_status = system_config?.config_directory?.in_progress_upgrade;
+        if (!upgrade_status) upgrade_status = { message: 'Config directory upgrade status is empty, there is no ongoing config directory upgrade' };
         write_stdout_response(ManageCLIResponse.UpgradeStatus, upgrade_status);
     } catch (err) {
         dbg.warn('could not get upgrade status response', err);
-        throw_cli_error({ ...ManageCLIError.UpgradeStatusFailed, cause: err?.errors?.[0] || err });
+        throw_cli_error({ ...ManageCLIError.UpgradeStatusFailed, cause: err });
     }
 }
 
@@ -66,13 +66,13 @@ async function get_upgrade_status(config_fs) {
  */
 async function get_upgrade_history(config_fs) {
     try {
-        const system_config = await config_fs.get_system_config_file();
-        const upgrade_history = system_config?.config_directory?.upgrade_history;
-        if (!upgrade_history) throw new Error('Config directory upgrade history is empty', { cause: system_config });
+        const system_config = await config_fs.get_system_config_file({ silent_if_missing: true });
+        let upgrade_history = system_config?.config_directory?.upgrade_history;
+        if (!upgrade_history) upgrade_history = { message: 'Config directory upgrade history is empty' };
         write_stdout_response(ManageCLIResponse.UpgradeHistory, upgrade_history);
     } catch (err) {
         dbg.warn('could not get upgrade history response', err);
-        throw_cli_error({ ...ManageCLIError.UpgradeHistoryFailed, cause: err?.errors?.[0] || err });
+        throw_cli_error({ ...ManageCLIError.UpgradeHistoryFailed, cause: err });
     }
 }
 

src/sdk/config_fs.js

@@ -844,10 +844,11 @@ class ConfigFS {
 
     /**
      * get_system_config_file read system.json file
+     * @param {{silent_if_missing?: boolean}} options 
      * @returns {Promise<Object>}
      */
-    async get_system_config_file() {
-        const system_data = await this.get_config_data(this.system_json_path);
+    async get_system_config_file(options) {
+        const system_data = await this.get_config_data(this.system_json_path, options);
         return system_data;
     }
 

src/test/unit_tests/jest_tests/test_cli_upgrade.test.js

@@ -48,7 +48,7 @@ const expected_system_json = {
 };
 
 describe('noobaa cli - upgrade', () => {
-    afterAll(async () => await fs_utils.file_delete(config_fs.system_json_path));
+    afterEach(async () => await fs_utils.file_delete(config_fs.system_json_path));
 
     it('upgrade start - should fail with not implemented', async () => {
         const res = await exec_manage_cli(TYPES.UPGRADE, UPGRADE_ACTIONS.START, { config_root }, true);
@@ -57,7 +57,9 @@ describe('noobaa cli - upgrade', () => {
 
     it('upgrade status - should fail - there is no ongoing upgrade', async () => {
         const res = await exec_manage_cli(TYPES.UPGRADE, UPGRADE_ACTIONS.STATUS, { config_root }, true);
-        expect(JSON.parse(res.stdout).error.message).toBe(ManageCLIError.UpgradeStatusFailed.message);
+        const parsed_res = JSON.parse(res);
+        expect(parsed_res.response.code).toBe(ManageCLIResponse.UpgradeStatus.code);
+        expect(parsed_res.response.reply.message).toEqual('Config directory upgrade status is empty, there is no ongoing config directory upgrade');
     });
 
     it('upgrade status', async () => {
@@ -66,12 +68,13 @@ describe('noobaa cli - upgrade', () => {
         const parsed_res = JSON.parse(res);
         expect(parsed_res.response.code).toBe(ManageCLIResponse.UpgradeStatus.code);
         expect(parsed_res.response.reply).toEqual(expected_system_json.config_directory.in_progress_upgrade);
-        await fs_utils.file_delete(config_fs.system_json_path);
     });
 
     it('upgrade history - should fail - there is no config directory upgrade history', async () => {
         const res = await exec_manage_cli(TYPES.UPGRADE, UPGRADE_ACTIONS.HISTORY, { config_root }, true);
-        expect(JSON.parse(res.stdout).error.message).toBe(ManageCLIError.UpgradeHistoryFailed.message);
+        const parsed_res = JSON.parse(res);
+        expect(parsed_res.response.code).toBe(ManageCLIResponse.UpgradeHistory.code);
+        expect(parsed_res.response.reply.message).toEqual('Config directory upgrade history is empty');
     });
 
     it('upgrade history', async () => {