Merge pull request ceph#61040 from rhcs-dashboard/smb-module-check

mgr/module: Smb module check

Reviewed-by: Nizamudeen A <[email protected]>
Reviewed-by: Ankush Behl <[email protected]>

Author: Pegonzal

src/pybind/mgr/dashboard/controllers/smb.py

@@ -15,7 +15,7 @@
 
 from .. import mgr
 from ..security import Scope
-from . import APIDoc, APIRouter, ReadPermission, RESTController
+from . import APIDoc, APIRouter, Endpoint, ReadPermission, RESTController, UIRouter
 
 logger = logging.getLogger('controllers.smb')
 
@@ -184,3 +184,18 @@ def delete(self, cluster_id: str, share_id: str):
         resource['share_id'] = share_id
         resource['intent'] = Intent.REMOVED
         return mgr.remote('smb', 'apply_resources', json.dumps(resource)).one().to_simplified()
+
+
+@UIRouter('/smb')
+class SMBStatus(RESTController):
+    @EndpointDoc("Get SMB feature status")
+    @Endpoint()
+    @ReadPermission
+    def status(self):
+        status = {'available': False, 'message': None}
+        try:
+            mgr.remote('smb', 'show', ['ceph.smb.cluster'])
+            status['available'] = True
+        except (ImportError, RuntimeError):
+            status['message'] = 'SMB module is not enabled'
+        return status

src/pybind/mgr/dashboard/frontend/src/app/app-routing.module.ts

@@ -433,7 +433,15 @@ const routes: Routes = [
           },
           {
             path: 'smb',
+            canActivateChild: [ModuleStatusGuardService],
             data: {
+              moduleStatusGuardConfig: {
+                uiApiPath: 'smb',
+                redirectTo: 'error',
+                header: 'SMB module is not enabled',
+                button_to_enable_module: 'smb',
+                navigate_to: 'cephfs/smb'
+              },
               breadcrumbs: 'File/SMB'
             },
             children: [{ path: '', component: SmbClusterListComponent }]

src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/mgr-modules/mgr-module-details/mgr-module-details.component.spec.ts

@@ -4,14 +4,15 @@ import { ComponentFixture, TestBed } from '@angular/core/testing';
 import { SharedModule } from '~/app/shared/shared.module';
 import { configureTestBed } from '~/testing/unit-test-helper';
 import { MgrModuleDetailsComponent } from './mgr-module-details.component';
+import { ToastrModule } from 'ngx-toastr';
 
 describe('MgrModuleDetailsComponent', () => {
   let component: MgrModuleDetailsComponent;
   let fixture: ComponentFixture<MgrModuleDetailsComponent>;
 
   configureTestBed({
     declarations: [MgrModuleDetailsComponent],
-    imports: [HttpClientTestingModule, SharedModule]
+    imports: [HttpClientTestingModule, SharedModule, ToastrModule.forRoot()]
   });
 
   beforeEach(() => {

src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/mgr-modules/mgr-module-list/mgr-module-list.component.spec.ts

@@ -10,7 +10,6 @@ import { of as observableOf, throwError as observableThrowError } from 'rxjs';
 import { MgrModuleService } from '~/app/shared/api/mgr-module.service';
 import { TableActionsComponent } from '~/app/shared/datatable/table-actions/table-actions.component';
 import { CdTableSelection } from '~/app/shared/models/cd-table-selection';
-import { NotificationService } from '~/app/shared/services/notification.service';
 import { SharedModule } from '~/app/shared/shared.module';
 import { configureTestBed, PermissionHelper } from '~/testing/unit-test-helper';
 import { MgrModuleDetailsComponent } from '../mgr-module-details/mgr-module-details.component';
@@ -20,7 +19,6 @@ describe('MgrModuleListComponent', () => {
   let component: MgrModuleListComponent;
   let fixture: ComponentFixture<MgrModuleListComponent>;
   let mgrModuleService: MgrModuleService;
-  let notificationService: NotificationService;
 
   configureTestBed({
     declarations: [MgrModuleListComponent, MgrModuleDetailsComponent],
@@ -32,14 +30,13 @@ describe('MgrModuleListComponent', () => {
       NgbNavModule,
       ToastrModule.forRoot()
     ],
-    providers: [MgrModuleService, NotificationService]
+    providers: [MgrModuleService]
   });
 
   beforeEach(() => {
     fixture = TestBed.createComponent(MgrModuleListComponent);
     component = fixture.componentInstance;
     mgrModuleService = TestBed.inject(MgrModuleService);
-    notificationService = TestBed.inject(NotificationService);
   });
 
   it('should create', () => {
@@ -129,16 +126,13 @@ describe('MgrModuleListComponent', () => {
     });
   });
 
-  describe('should update module state', () => {
+  describe('should update module state and component table', () => {
     beforeEach(() => {
       component.selection = new CdTableSelection();
-      spyOn(notificationService, 'suspendToasties');
-      spyOn(component.blockUI, 'start');
-      spyOn(component.blockUI, 'stop');
       spyOn(component.table, 'refreshBtn');
     });
 
-    it('should enable module', fakeAsync(() => {
+    it('should update selected module and refresh table', fakeAsync(() => {
       spyOn(mgrModuleService, 'enable').and.returnValue(observableThrowError('y'));
       spyOn(mgrModuleService, 'list').and.returnValues(observableThrowError('z'), observableOf([]));
       component.selection.add({
@@ -147,55 +141,11 @@ describe('MgrModuleListComponent', () => {
         always_on: false
       });
       component.updateModuleState();
-      tick(2000);
-      tick(2000);
+      tick(mgrModuleService.REFRESH_INTERVAL);
+      tick(mgrModuleService.REFRESH_INTERVAL);
       expect(mgrModuleService.enable).toHaveBeenCalledWith('foo');
       expect(mgrModuleService.list).toHaveBeenCalledTimes(2);
-      expect(notificationService.suspendToasties).toHaveBeenCalledTimes(2);
-      expect(component.blockUI.start).toHaveBeenCalled();
-      expect(component.blockUI.stop).toHaveBeenCalled();
       expect(component.table.refreshBtn).toHaveBeenCalled();
     }));
-
-    it('should disable module', fakeAsync(() => {
-      spyOn(mgrModuleService, 'disable').and.returnValue(observableThrowError('x'));
-      spyOn(mgrModuleService, 'list').and.returnValue(observableOf([]));
-      component.selection.add({
-        name: 'bar',
-        enabled: true,
-        always_on: false
-      });
-      component.updateModuleState();
-      tick(2000);
-      expect(mgrModuleService.disable).toHaveBeenCalledWith('bar');
-      expect(mgrModuleService.list).toHaveBeenCalledTimes(1);
-      expect(notificationService.suspendToasties).toHaveBeenCalledTimes(2);
-      expect(component.blockUI.start).toHaveBeenCalled();
-      expect(component.blockUI.stop).toHaveBeenCalled();
-      expect(component.table.refreshBtn).toHaveBeenCalled();
-    }));
-
-    it('should not disable module without selecting one', () => {
-      expect(component.getTableActionDisabledDesc()).toBeTruthy();
-    });
-
-    it('should not disable dashboard module', () => {
-      component.selection.selected = [
-        {
-          name: 'dashboard'
-        }
-      ];
-      expect(component.getTableActionDisabledDesc()).toBeTruthy();
-    });
-
-    it('should not disable an always-on module', () => {
-      component.selection.selected = [
-        {
-          name: 'bar',
-          always_on: true
-        }
-      ];
-      expect(component.getTableActionDisabledDesc()).toBe('This Manager module is always on.');
-    });
   });
 });

src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/mgr-modules/mgr-module-list/mgr-module-list.component.ts

@@ -1,8 +1,5 @@
 import { Component, ViewChild } from '@angular/core';
 
-import { BlockUI, NgBlockUI } from 'ng-block-ui';
-import { timer as observableTimer } from 'rxjs';
-
 import { MgrModuleService } from '~/app/shared/api/mgr-module.service';
 import { ListWithDetails } from '~/app/shared/classes/list-with-details.class';
 import { TableComponent } from '~/app/shared/datatable/table/table.component';
@@ -14,7 +11,6 @@ import { CdTableFetchDataContext } from '~/app/shared/models/cd-table-fetch-data
 import { CdTableSelection } from '~/app/shared/models/cd-table-selection';
 import { Permission } from '~/app/shared/models/permissions';
 import { AuthStorageService } from '~/app/shared/services/auth-storage.service';
-import { NotificationService } from '~/app/shared/services/notification.service';
 
 @Component({
   selector: 'cd-mgr-module-list',
@@ -24,8 +20,6 @@ import { NotificationService } from '~/app/shared/services/notification.service'
 export class MgrModuleListComponent extends ListWithDetails {
   @ViewChild(TableComponent, { static: true })
   table: TableComponent;
-  @BlockUI()
-  blockUI: NgBlockUI;
 
   permission: Permission;
   tableActions: CdTableAction[];
@@ -35,8 +29,7 @@ export class MgrModuleListComponent extends ListWithDetails {
 
   constructor(
     private authStorageService: AuthStorageService,
-    private mgrModuleService: MgrModuleService,
-    private notificationService: NotificationService
+    private mgrModuleService: MgrModuleService
   ) {
     super();
     this.permission = this.authStorageService.getPermissions().configOpt;
@@ -147,52 +140,13 @@ export class MgrModuleListComponent extends ListWithDetails {
   }
 
   /**
-   * Update the Ceph Mgr module state to enabled or disabled.
+   * Update the selected Ceph Mgr module state to enabled or disabled.
    */
   updateModuleState() {
     if (!this.selection.hasSelection) {
       return;
     }
-
-    let $obs;
-    const fnWaitUntilReconnected = () => {
-      observableTimer(2000).subscribe(() => {
-        // Trigger an API request to check if the connection is
-        // re-established.
-        this.mgrModuleService.list().subscribe(
-          () => {
-            // Resume showing the notification toasties.
-            this.notificationService.suspendToasties(false);
-            // Unblock the whole UI.
-            this.blockUI.stop();
-            // Reload the data table content.
-            this.table.refreshBtn();
-          },
-          () => {
-            fnWaitUntilReconnected();
-          }
-        );
-      });
-    };
-
-    // Note, the Ceph Mgr is always restarted when a module
-    // is enabled/disabled.
-    const module = this.selection.first();
-    if (module.enabled) {
-      $obs = this.mgrModuleService.disable(module.name);
-    } else {
-      $obs = this.mgrModuleService.enable(module.name);
-    }
-    $obs.subscribe(
-      () => undefined,
-      () => {
-        // Suspend showing the notification toasties.
-        this.notificationService.suspendToasties(true);
-        // Block the whole UI to prevent user interactions until
-        // the connection to the backend is reestablished
-        this.blockUI.start($localize`Reconnecting, please wait ...`);
-        fnWaitUntilReconnected();
-      }
-    );
+    const selected = this.selection.first();
+    this.mgrModuleService.updateModuleState(selected.name, selected.enabled, this.table);
   }
 }

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

@@ -57,7 +57,7 @@ export class SmbClusterListComponent extends ListWithDetails implements OnInit {
 
     this.smbClusters$ = this.subject$.pipe(
       switchMap(() =>
-        this.smbService.listClusters().pipe(
+        this.smbService.listClusters()?.pipe(
           catchError(() => {
             this.context.error();
             return of(null);

src/pybind/mgr/dashboard/frontend/src/app/core/error/error.component.html

@@ -59,9 +59,19 @@ <h3 i18n><b>Page not Found</b></h3>
 </ng-template>
 
 <ng-template #dashboardButton>
-  <div class="mt-4 text-center">
+  <div class="mt-4 text-center"
+       *ngIf="!buttonToEnableModule; else enableButton">
     <button class="btn btn-primary"
             [routerLink]="'/dashboard'"
             i18n>Go To Dashboard</button>
   </div>
 </ng-template>
+
+<ng-template #enableButton>
+  <div class="mt-4 text-center"
+       *ngIf="buttonToEnableModule && !(buttonName && buttonRoute)">
+    <button class="btn btn-primary"
+            (click)="enableModule()"
+            i18n>Enable {{ buttonToEnableModule | upperFirst }} module</button>
+  </div>
+</ng-template>

src/pybind/mgr/dashboard/frontend/src/app/core/error/error.component.ts

@@ -4,6 +4,7 @@ import { NavigationEnd, Router, RouterEvent } from '@angular/router';
 
 import { Subscription } from 'rxjs';
 import { filter } from 'rxjs/operators';
+import { MgrModuleService } from '~/app/shared/api/mgr-module.service';
 
 import { NotificationType } from '~/app/shared/enum/notification-type.enum';
 import { DocService } from '~/app/shared/services/doc.service';
@@ -31,13 +32,16 @@ export class ErrorComponent implements OnDestroy, OnInit {
   secondaryButtonRoute: string;
   secondaryButtonName: string;
   secondaryButtonTitle: string;
+  buttonToEnableModule: string;
+  navigateTo: string;
   component: string;
 
   constructor(
     private router: Router,
     private docService: DocService,
     private http: HttpClient,
-    private notificationService: NotificationService
+    private notificationService: NotificationService,
+    private mgrModuleService: MgrModuleService
   ) {}
 
   ngOnInit() {
@@ -87,6 +91,8 @@ export class ErrorComponent implements OnDestroy, OnInit {
       this.secondaryButtonRoute = history.state.secondary_button_route;
       this.secondaryButtonName = history.state.secondary_button_name;
       this.secondaryButtonTitle = history.state.secondary_button_title;
+      this.buttonToEnableModule = history.state.button_to_enable_module;
+      this.navigateTo = history.state.navigate_to;
       this.component = history.state.component;
       this.docUrl = this.docService.urlGenerator(this.section);
     } catch (error) {
@@ -99,4 +105,13 @@ export class ErrorComponent implements OnDestroy, OnInit {
       this.routerSubscription.unsubscribe();
     }
   }
+
+  enableModule(): void {
+    this.mgrModuleService.updateModuleState(
+      this.buttonToEnableModule,
+      false,
+      null,
+      this.navigateTo
+    );
+  }
 }