mgr/dashboard: remove hardcoded strings in About component

Replaced inline values for user role, version prefix, and
localStorage keys with shared constants (`USER`, `VERSION_PREFIX`,
and `LocalStorage.DASHBOARD_USERNAME`). This keeps things DRY and
makes future updates easier.

Addresses part of the constant reuse cleanup in the dashboard.

Fixes: https://tracker.ceph.com/issues/70947

Signed-off-by: prik73 <[email protected]>
Signed-off-by: Afreen Misbah <[email protected]>

Author: prik73

src/pybind/mgr/dashboard/frontend/cypress/support/commands.ts

@@ -18,11 +18,12 @@ declare global {
 import { CdHelperClass } from '../../src/app/shared/classes/cd-helper.class';
 import { Permissions } from '../../src/app/shared/models/permissions';
 import { table } from 'table';
+import { LocalStorage } from '~/app/shared/enum/local-storage-enum';
 /* tslint:enable*/
 let auth: any;
 
 const fillAuth = () => {
-  window.localStorage.setItem('dashboard_username', auth.username);
+  window.localStorage.setItem(LocalStorage.DASHBOARD_USRENAME, auth.username);
   window.localStorage.setItem('dashboard_permissions', auth.permissions);
   window.localStorage.setItem('user_pwd_expiration_date', auth.pwdExpirationDate);
   window.localStorage.setItem('user_pwd_update_required', auth.pwdUpdateRequired);
@@ -64,7 +65,7 @@ Cypress.Commands.add('ceph2Login', (username, password) => {
         url,
         { args },
         ({ uname, permissions, pwdExpirationDate, pwdUpdateRequired, sso }: any) => {
-          window.localStorage.setItem('dashboard_username', uname);
+          window.localStorage.setItem(LocalStorage.DASHBOARD_USRENAME, uname);
           window.localStorage.setItem('dashboard_permissions', permissions);
           window.localStorage.setItem('user_pwd_expiration_date', pwdExpirationDate);
           window.localStorage.setItem('user_pwd_update_required', pwdUpdateRequired);

src/pybind/mgr/dashboard/frontend/src/app/ceph/block/iscsi-target-details/iscsi-target-details.component.spec.ts

@@ -6,6 +6,7 @@ import { TreeviewModule } from 'carbon-components-angular';
 import { SharedModule } from '~/app/shared/shared.module';
 import { configureTestBed } from '~/testing/unit-test-helper';
 import { IscsiTargetDetailsComponent } from './iscsi-target-details.component';
+import { USER } from '~/app/shared/constants/app.constants';
 
 describe('IscsiTargetDetailsComponent', () => {
   let component: IscsiTargetDetailsComponent;
@@ -234,7 +235,7 @@ describe('IscsiTargetDetailsComponent', () => {
       );
       component.onNodeSelected(node);
       expect(component.data).toEqual([
-        { current: 'myiscsiusername', default: undefined, displayName: 'user' },
+        { current: 'myiscsiusername', default: undefined, displayName: USER },
         { current: 'myhost', default: undefined, displayName: 'alias' },
         { current: ['192.168.200.1'], default: undefined, displayName: 'ip_address' },
         { current: ['node1'], default: undefined, displayName: 'logged_in' }

src/pybind/mgr/dashboard/frontend/src/app/ceph/block/iscsi-target-details/iscsi-target-details.component.ts

@@ -2,6 +2,7 @@ import { Component, Input, OnChanges, OnInit, TemplateRef, ViewChild } from '@an
 
 import { Node } from 'carbon-components-angular/treeview/tree-node.types';
 import _ from 'lodash';
+import { USER } from '~/app/shared/constants/app.constants';
 
 import { TableComponent } from '~/app/shared/datatable/table/table.component';
 import { Icons } from '~/app/shared/enum/icons.enum';
@@ -322,7 +323,7 @@ export class IscsiTargetDetailsComponent implements OnChanges, OnInit {
         });
         // Target level authentication was introduced in ceph-iscsi config v11
         if (this.cephIscsiConfigVersion > 10) {
-          ['user', 'password', 'mutual_user', 'mutual_password'].forEach((key) => {
+          [USER, 'password', 'mutual_user', 'mutual_password'].forEach((key) => {
             this.data.push({
               displayName: key,
               default: null,

src/pybind/mgr/dashboard/frontend/src/app/ceph/block/iscsi-target-discovery-modal/iscsi-target-discovery-modal.component.spec.ts

@@ -15,6 +15,7 @@ import { Permission } from '~/app/shared/models/permissions';
 import { SharedModule } from '~/app/shared/shared.module';
 import { configureTestBed, FormHelper, IscsiHelper } from '~/testing/unit-test-helper';
 import { IscsiTargetDiscoveryModalComponent } from './iscsi-target-discovery-modal.component';
+import { USER } from '~/app/shared/constants/app.constants';
 
 describe('IscsiTargetDiscoveryModalComponent', () => {
   let component: IscsiTargetDiscoveryModalComponent;
@@ -125,7 +126,7 @@ describe('IscsiTargetDiscoveryModalComponent', () => {
     const formHelper = new FormHelper(control);
     formHelper.expectValid(control);
 
-    IscsiHelper.validateUser(formHelper, 'user');
+    IscsiHelper.validateUser(formHelper, USER);
     IscsiHelper.validatePassword(formHelper, 'password');
     IscsiHelper.validateUser(formHelper, 'mutual_user');
     IscsiHelper.validatePassword(formHelper, 'mutual_password');

src/pybind/mgr/dashboard/frontend/src/app/ceph/block/iscsi-target-discovery-modal/iscsi-target-discovery-modal.component.ts

@@ -4,7 +4,7 @@ import { UntypedFormControl, Validators } from '@angular/forms';
 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap';
 
 import { IscsiService } from '~/app/shared/api/iscsi.service';
-import { ActionLabelsI18n } from '~/app/shared/constants/app.constants';
+import { ActionLabelsI18n, USER } from '~/app/shared/constants/app.constants';
 import { NotificationType } from '~/app/shared/enum/notification-type.enum';
 import { CdFormGroup } from '~/app/shared/forms/cd-form-group';
 import { CdValidators } from '~/app/shared/forms/cd-validators';
@@ -52,7 +52,7 @@ export class IscsiTargetDiscoveryModalComponent implements OnInit {
     });
 
     CdValidators.validateIf(
-      this.discoveryForm.get('user'),
+      this.discoveryForm.get(USER),
       () =>
         this.discoveryForm.getValue('password') ||
         this.discoveryForm.getValue('mutual_user') ||
@@ -69,13 +69,13 @@ export class IscsiTargetDiscoveryModalComponent implements OnInit {
     CdValidators.validateIf(
       this.discoveryForm.get('password'),
       () =>
-        this.discoveryForm.getValue('user') ||
+        this.discoveryForm.getValue(USER) ||
         this.discoveryForm.getValue('mutual_user') ||
         this.discoveryForm.getValue('mutual_password'),
       [Validators.required],
       [Validators.pattern(this.PASSWORD_REGEX)],
       [
-        this.discoveryForm.get('user'),
+        this.discoveryForm.get(USER),
         this.discoveryForm.get('mutual_user'),
         this.discoveryForm.get('mutual_password')
       ]
@@ -87,7 +87,7 @@ export class IscsiTargetDiscoveryModalComponent implements OnInit {
       [Validators.required],
       [Validators.pattern(this.USER_REGEX)],
       [
-        this.discoveryForm.get('user'),
+        this.discoveryForm.get(USER),
         this.discoveryForm.get('password'),
         this.discoveryForm.get('mutual_password')
       ]
@@ -99,7 +99,7 @@ export class IscsiTargetDiscoveryModalComponent implements OnInit {
       [Validators.required],
       [Validators.pattern(this.PASSWORD_REGEX)],
       [
-        this.discoveryForm.get('user'),
+        this.discoveryForm.get(USER),
         this.discoveryForm.get('password'),
         this.discoveryForm.get('mutual_user')
       ]

src/pybind/mgr/dashboard/frontend/src/app/ceph/block/iscsi-target-form/iscsi-target-form.component.ts

@@ -10,7 +10,7 @@ import { IscsiService } from '~/app/shared/api/iscsi.service';
 import { RbdService } from '~/app/shared/api/rbd.service';
 import { SelectMessages } from '~/app/shared/components/select/select-messages.model';
 import { SelectOption } from '~/app/shared/components/select/select-option.model';
-import { ActionLabelsI18n } from '~/app/shared/constants/app.constants';
+import { ActionLabelsI18n, USER } from '~/app/shared/constants/app.constants';
 import { Icons } from '~/app/shared/enum/icons.enum';
 import { CdForm } from '~/app/shared/forms/cd-form';
 import { CdFormGroup } from '~/app/shared/forms/cd-form-group';
@@ -460,7 +460,7 @@ export class IscsiTargetFormComponent extends CdForm implements OnInit {
 
   setAuthValidator(fg: CdFormGroup) {
     CdValidators.validateIf(
-      fg.get('user'),
+      fg.get(USER),
       () => fg.getValue('password') || fg.getValue('mutual_user') || fg.getValue('mutual_password'),
       [Validators.required],
       [Validators.pattern(this.USER_REGEX)],
@@ -469,26 +469,26 @@ export class IscsiTargetFormComponent extends CdForm implements OnInit {
 
     CdValidators.validateIf(
       fg.get('password'),
-      () => fg.getValue('user') || fg.getValue('mutual_user') || fg.getValue('mutual_password'),
+      () => fg.getValue(USER) || fg.getValue('mutual_user') || fg.getValue('mutual_password'),
       [Validators.required],
       [Validators.pattern(this.PASSWORD_REGEX)],
-      [fg.get('user'), fg.get('mutual_user'), fg.get('mutual_password')]
+      [fg.get(USER), fg.get('mutual_user'), fg.get('mutual_password')]
     );
 
     CdValidators.validateIf(
       fg.get('mutual_user'),
       () => fg.getValue('mutual_password'),
       [Validators.required],
       [Validators.pattern(this.USER_REGEX)],
-      [fg.get('user'), fg.get('password'), fg.get('mutual_password')]
+      [fg.get(USER), fg.get('password'), fg.get('mutual_password')]
     );
 
     CdValidators.validateIf(
       fg.get('mutual_password'),
       () => fg.getValue('mutual_user'),
       [Validators.required],
       [Validators.pattern(this.PASSWORD_REGEX)],
-      [fg.get('user'), fg.get('password'), fg.get('mutual_user')]
+      [fg.get(USER), fg.get('password'), fg.get('mutual_user')]
     );
   }
 
@@ -658,8 +658,8 @@ export class IscsiTargetFormComponent extends CdForm implements OnInit {
     // Target level authentication was introduced in ceph-iscsi config v11
     if (this.cephIscsiConfigVersion > 10) {
       const targetAuth: CdFormGroup = this.targetForm.get('auth') as CdFormGroup;
-      if (!targetAuth.getValue('user')) {
-        targetAuth.get('user').setValue('');
+      if (!targetAuth.getValue(USER)) {
+        targetAuth.get(USER).setValue('');
       }
       if (!targetAuth.getValue('password')) {
         targetAuth.get('password').setValue('');
@@ -672,7 +672,7 @@ export class IscsiTargetFormComponent extends CdForm implements OnInit {
       }
       const acl_enabled = this.targetForm.getValue('acl_enabled');
       request['auth'] = {
-        user: acl_enabled ? '' : targetAuth.getValue('user'),
+        user: acl_enabled ? '' : targetAuth.getValue(USER),
         password: acl_enabled ? '' : targetAuth.getValue('password'),
         mutual_user: acl_enabled ? '' : targetAuth.getValue('mutual_user'),
         mutual_password: acl_enabled ? '' : targetAuth.getValue('mutual_password')

src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-snapshot-list/rbd-snapshot-list.component.spec.ts

@@ -10,7 +10,7 @@ import { Subject, throwError as observableThrowError } from 'rxjs';
 
 import { RbdService } from '~/app/shared/api/rbd.service';
 import { ComponentsModule } from '~/app/shared/components/components.module';
-import { ActionLabelsI18n } from '~/app/shared/constants/app.constants';
+import { ActionLabelsI18n, USER } from '~/app/shared/constants/app.constants';
 import { DataTableModule } from '~/app/shared/datatable/datatable.module';
 import { TableActionsComponent } from '~/app/shared/datatable/table-actions/table-actions.component';
 import { CdTableSelection } from '~/app/shared/models/cd-table-selection';
@@ -120,7 +120,7 @@ describe('RbdSnapshotListComponent', () => {
       rbdService = new RbdService(null, null);
       notificationService = new NotificationService(null, null, null);
       authStorageService = new AuthStorageService();
-      authStorageService.set('user', { 'rbd-image': ['create', 'read', 'update', 'delete'] });
+      authStorageService.set(USER, { 'rbd-image': ['create', 'read', 'update', 'delete'] });
       component = new RbdSnapshotListComponent(
         authStorageService,
         null,

src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/multi-cluster/multi-cluster-form/multi-cluster-form.component.ts

@@ -4,7 +4,7 @@ import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap';
 import _ from 'lodash';
 import { Subscription } from 'rxjs';
 import { MultiClusterService } from '~/app/shared/api/multi-cluster.service';
-import { ActionLabelsI18n } from '~/app/shared/constants/app.constants';
+import { ActionLabelsI18n, USER } from '~/app/shared/constants/app.constants';
 import { NotificationType } from '~/app/shared/enum/notification-type.enum';
 import { CdFormGroup } from '~/app/shared/forms/cd-form-group';
 import { CdValidators } from '~/app/shared/forms/cd-validators';
@@ -66,7 +66,7 @@ export class MultiClusterFormComponent implements OnInit, OnDestroy {
     [this.clusterAliasNames, this.clusterUrls, this.clusterUsers] = [
       'cluster_alias',
       'url',
-      'user'
+      USER
     ].map((prop) => this.clustersData?.map((cluster) => cluster[prop]));
   }
 

src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/multi-cluster/multi-cluster.component.ts

@@ -8,6 +8,8 @@ import { MultiClusterFormComponent } from './multi-cluster-form/multi-cluster-fo
 import { PrometheusService } from '~/app/shared/api/prometheus.service';
 import { CdTableColumn } from '~/app/shared/models/cd-table-column';
 import { CellTemplate } from '~/app/shared/enum/cell-template.enum';
+import { VERSION_PREFIX } from '~/app/shared/constants/app.constants';
+
 import { Router } from '@angular/router';
 
 import {
@@ -491,8 +493,8 @@ export class MultiClusterComponent implements OnInit, OnDestroy {
   }
 
   getVersion(fullVersion: string) {
-    const version = fullVersion.replace('ceph version ', '').split(' ');
-    return version[0] + ' ' + version.slice(2, version.length).join(' ');
+    const version = fullVersion.replace(`${VERSION_PREFIX} `, '').split(' ');
+    return version[0] + ' ' + version.slice(2).join(' ');
   }
 
   generateQueryLabel(query: any, name = false, count = this.COUNT_OF_UTILIZATION_CHARTS) {

src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/services/service-form/service-form.component.spec.ts

@@ -16,6 +16,7 @@ import { SharedModule } from '~/app/shared/shared.module';
 import { configureTestBed, FormHelper, Mocks } from '~/testing/unit-test-helper';
 import { ServiceFormComponent } from './service-form.component';
 import { PoolService } from '~/app/shared/api/pool.service';
+import { USER } from '~/app/shared/constants/app.constants';
 
 // for 'nvmeof' service
 const mockPools = [
@@ -314,7 +315,7 @@ x4Ea7kGVgx9kWh5XjWz9wjZvY49UKIT5ppIAWPMbLl3UpfckiuNhTA==
       beforeEach(() => {
         formHelper.setValue('service_type', 'iscsi');
         formHelper.setValue('pool', 'xyz');
-        formHelper.setValue('api_user', 'user');
+        formHelper.setValue('api_user', USER);
         formHelper.setValue('api_password', 'password');
         formHelper.setValue('ssl', false);
       });
@@ -326,7 +327,7 @@ x4Ea7kGVgx9kWh5XjWz9wjZvY49UKIT5ppIAWPMbLl3UpfckiuNhTA==
           placement: {},
           unmanaged: false,
           pool: 'xyz',
-          api_user: 'user',
+          api_user: USER,
           api_password: 'password',
           api_secure: false
         });
@@ -341,7 +342,7 @@ x4Ea7kGVgx9kWh5XjWz9wjZvY49UKIT5ppIAWPMbLl3UpfckiuNhTA==
           placement: {},
           unmanaged: false,
           pool: 'xyz',
-          api_user: 'user',
+          api_user: USER,
           api_password: 'password',
           api_secure: true,
           ssl_cert: '',
@@ -358,7 +359,7 @@ x4Ea7kGVgx9kWh5XjWz9wjZvY49UKIT5ppIAWPMbLl3UpfckiuNhTA==
           placement: {},
           unmanaged: false,
           pool: 'xyz',
-          api_user: 'user',
+          api_user: USER,
           api_password: 'password',
           api_secure: false,
           api_port: 456