Merge pull request #1543 from GNS3/idlepc

Idle-PC configuration support

src/app/app.module.ts

@@ -119,6 +119,8 @@ import { EditTextActionComponent } from './components/project-map/context-menu/a
 import { ExportConfigActionComponent } from './components/project-map/context-menu/actions/export-config/export-config-action.component';
 import { HttpConsoleNewTabActionComponent } from './components/project-map/context-menu/actions/http-console-new-tab/http-console-new-tab-action.component';
 import { HttpConsoleActionComponent } from './components/project-map/context-menu/actions/http-console/http-console-action.component';
+import { IdlePcActionComponent } from "./components/project-map/context-menu/actions/idle-pc-action/idle-pc-action.component";
+import { AutoIdlePcActionComponent } from "./components/project-map/context-menu/actions/auto-idle-pc-action/auto-idle-pc-action.component";
 import { ImportConfigActionComponent } from './components/project-map/context-menu/actions/import-config/import-config-action.component';
 import { LockActionComponent } from './components/project-map/context-menu/actions/lock-action/lock-action.component';
 import { MoveLayerDownActionComponent } from './components/project-map/context-menu/actions/move-layer-down-action/move-layer-down-action.component';
@@ -134,11 +136,12 @@ import { StartNodeActionComponent } from './components/project-map/context-menu/
 import { StopCaptureActionComponent } from './components/project-map/context-menu/actions/stop-capture/stop-capture-action.component';
 import { IsolateNodeActionComponent } from './components/project-map/context-menu/actions/isolate-node-action/isolate-node-action.component';
 import { UnisolateNodeActionComponent } from './components/project-map/context-menu/actions/unisolate-node-action/unisolate-node-action.component';
-import {StopNodeActionComponent } from './components/project-map/context-menu/actions/stop-node-action/stop-node-action.component';
+import { StopNodeActionComponent } from './components/project-map/context-menu/actions/stop-node-action/stop-node-action.component';
 import { SuspendLinkActionComponent } from './components/project-map/context-menu/actions/suspend-link/suspend-link-action.component';
 import { SuspendNodeActionComponent } from './components/project-map/context-menu/actions/suspend-node-action/suspend-node-action.component';
 import { ContextMenuComponent } from './components/project-map/context-menu/context-menu.component';
 import { ConfigDialogComponent } from './components/project-map/context-menu/dialogs/config-dialog/config-dialog.component';
+import { IdlePCDialogComponent } from "./components/project-map/context-menu/dialogs/idle-pc-dialog/idle-pc-dialog.component";
 import { DrawLinkToolComponent } from './components/project-map/draw-link-tool/draw-link-tool.component';
 import { StyleEditorDialogComponent } from './components/project-map/drawings-editors/style-editor/style-editor.component';
 import { LinkStyleEditorDialogComponent } from './components/project-map/drawings-editors/link-style-editor/link-style-editor.component';
@@ -494,6 +497,7 @@ import { DeleteResourceConfirmationDialogComponent } from './components/resource
         AlignVerticallyActionComponent,
         ConfirmationBottomSheetComponent,
         ConfigDialogComponent,
+        IdlePCDialogComponent,
         ImportApplianceComponent,
         DirectLinkComponent,
         SystemStatusComponent,
@@ -501,6 +505,8 @@ import { DeleteResourceConfirmationDialogComponent } from './components/resource
         StatusChartComponent,
         OpenFileExplorerActionComponent,
         HttpConsoleActionComponent,
+        IdlePcActionComponent,
+        AutoIdlePcActionComponent,
         WebConsoleComponent,
         ConsoleWrapperComponent,
         HttpConsoleNewTabActionComponent,

src/app/components/preferences/dynamips/ios-template-details/ios-template-details.component.html

@@ -243,6 +243,7 @@
               placeholder="Idle-PC"
             />
           </mat-form-field>
+          <button mat-button class="idlePCFinderButton" (click)="findIdlePC()">Idle-PC finder</button><br /><br />
           <mat-form-field class="form-field">
             <input
               matInput

src/app/components/preferences/dynamips/ios-template-details/ios-template-details.component.scss

@@ -0,0 +1,3 @@
+.idlePCFinderButton {
+  width: 100%;
+}

src/app/components/preferences/dynamips/ios-template-details/ios-template-details.component.spec.ts

@@ -20,6 +20,8 @@ import { ToasterService } from '../../../../services/toaster.service';
 import { MockedToasterService } from '../../../../services/toaster.service.spec';
 import { MockedActivatedRoute } from '../../preferences.component.spec';
 import { IosTemplateDetailsComponent } from './ios-template-details.component';
+import { MockedProgressService } from "@components/project-map/project-map.component.spec";
+import {ProgressService} from "../../../../common/progress/progress.service";
 
 export class MockedIosService {
   public getTemplate(controller:Controller , template_id: string) {
@@ -38,6 +40,7 @@ describe('IosTemplateDetailsComponent', () => {
   let mockedControllerService = new MockedControllerService();
   let mockedIosService = new MockedIosService();
   let mockedToasterService = new MockedToasterService();
+  let mockedProgressService = new MockedProgressService()
   let activatedRoute = new MockedActivatedRoute().get();
 
   beforeEach(async() => {
@@ -61,6 +64,7 @@ describe('IosTemplateDetailsComponent', () => {
         { provide: ControllerService, useValue: mockedControllerService },
         { provide: IosService, useValue: mockedIosService },
         { provide: ToasterService, useValue: mockedToasterService },
+        { provide: ProgressService, useValue: mockedProgressService },
         { provide: IosConfigurationService, useClass: IosConfigurationService },
       ],
       declarations: [IosTemplateDetailsComponent],

src/app/components/preferences/dynamips/ios-template-details/ios-template-details.component.ts

@@ -7,6 +7,7 @@ import { IosConfigurationService } from '../../../../services/ios-configuration.
 import { IosService } from '../../../../services/ios.service';
 import { ControllerService } from '../../../../services/controller.service';
 import { ToasterService } from '../../../../services/toaster.service';
+import { ProgressService } from "../../../../common/progress/progress.service";
 
 @Component({
   selector: 'app-ios-template-details',
@@ -14,7 +15,7 @@ import { ToasterService } from '../../../../services/toaster.service';
   styleUrls: ['./ios-template-details.component.scss', '../../preferences.component.scss'],
 })
 export class IosTemplateDetailsComponent implements OnInit {
-  controller:Controller ;
+  controller: Controller;
   iosTemplate: IosTemplate;
   isSymbolSelectionOpened: boolean = false;
   platforms: string[] = [];
@@ -41,6 +42,7 @@ export class IosTemplateDetailsComponent implements OnInit {
     private toasterService: ToasterService,
     private formBuilder: UntypedFormBuilder,
     private iosConfigurationService: IosConfigurationService,
+    private progressService: ProgressService,
     private router: Router
   ) {
     this.generalSettingsForm = this.formBuilder.group({
@@ -95,6 +97,27 @@ export class IosTemplateDetailsComponent implements OnInit {
     this.wicMatrix = this.iosConfigurationService.getWicMatrix();
   }
 
+  findIdlePC() {
+    let data = {
+      "image": this.iosTemplate.image,
+      "platform": this.iosTemplate.platform,
+      "ram": this.iosTemplate.ram
+    };
+    this.progressService.activate();
+    this.iosService.findIdlePC(this.controller, data).subscribe((result: any) => {
+      this.progressService.deactivate();
+      if (result.idlepc !== null) {
+        this.iosTemplate.idlepc = result.idlepc;
+        this.toasterService.success(`Idle-PC value found: ${result.idlepc}`);
+      }
+    },
+      (error) => {
+        this.progressService.deactivate();
+        this.toasterService.error(`Error while finding an idle-PC value`);
+      }
+      );
+  }
+
   fillSlotsData() {
 
     // load network adapters

src/app/components/project-map/context-menu/actions/auto-idle-pc-action/auto-idle-pc-action.component.html

@@ -0,0 +1,9 @@
+<button
+  mat-menu-item
+  *ngIf="node.node_type === 'dynamips'"
+  (click)="autoIdlePC()"
+>
+  <mat-icon>query_builder</mat-icon>
+  <span>Auto Idle-PC</span>
+</button>
+

src/app/components/project-map/context-menu/actions/auto-idle-pc-action/auto-idle-pc-action.component.ts

@@ -0,0 +1,36 @@
+import { Component, Input } from '@angular/core';
+import { Node } from '../../../../../cartography/models/node';
+import { Controller } from '../../../../../models/controller';
+import { NodeService } from "@services/node.service";
+import { ToasterService } from "@services/toaster.service";
+import { ProgressService } from "../../../../../common/progress/progress.service";
+
+@Component({
+  selector: 'app-auto-idle-pc-action',
+  templateUrl: './auto-idle-pc-action.component.html',
+})
+export class AutoIdlePcActionComponent {
+  @Input() controller:Controller ;
+  @Input() node: Node;
+
+  constructor(
+    private nodeService: NodeService,
+    private toasterService: ToasterService,
+    private progressService: ProgressService,
+  ) {}
+
+  autoIdlePC() {
+    this.progressService.activate();
+    this.nodeService.getAutoIdlePC(this.controller, this.node).subscribe((result: any) => {
+      this.progressService.deactivate();
+      if (result.idlepc !== null) {
+        this.toasterService.success(`Node ${this.node.name} updated with idle-PC value ${result.idlepc}`);
+      }
+    },
+      (error) => {
+        this.progressService.deactivate();
+        this.toasterService.error(`Error while updating idle-PC value for node ${this.node.name}`);
+      }
+    );
+  }
+}

src/app/components/project-map/context-menu/actions/idle-pc-action/idle-pc-action.component.html

@@ -0,0 +1,8 @@
+<button
+  mat-menu-item
+  *ngIf="node.node_type === 'dynamips'"
+  (click)="idlePC()"
+>
+  <mat-icon>query_builder</mat-icon>
+  <span>Idle-PC</span>
+</button>

src/app/components/project-map/context-menu/actions/idle-pc-action/idle-pc-action.component.ts

@@ -0,0 +1,28 @@
+import { Component, Input } from '@angular/core';
+import { MatDialog } from '@angular/material/dialog';
+import { Node } from '../../../../../cartography/models/node';
+import { Controller } from '../../../../../models/controller';
+import { IdlePCDialogComponent } from "@components/project-map/context-menu/dialogs/idle-pc-dialog/idle-pc-dialog.component";
+import { NodeService } from "@services/node.service";
+
+@Component({
+  selector: 'app-idle-pc-action',
+  templateUrl: './idle-pc-action.component.html',
+})
+export class IdlePcActionComponent {
+  @Input() controller:Controller ;
+  @Input() node: Node;
+
+  constructor(private nodeService: NodeService, private dialog: MatDialog) {}
+
+  idlePC() {
+    const dialogRef = this.dialog.open(IdlePCDialogComponent, {
+      width: '500px',
+      autoFocus: false,
+      disableClose: true,
+    });
+    let instance = dialogRef.componentInstance;
+    instance.controller = this.controller;
+    instance.node = this.node;
+  }
+}

src/app/components/project-map/context-menu/context-menu.component.html

@@ -94,6 +94,16 @@
       [controller]="controller"
       [node]="nodes[0]"
     ></app-import-config-action>
+    <app-idle-pc-action
+      *ngIf="nodes.length === 1 && nodes[0].node_type === 'dynamips'"
+      [controller]="controller"
+      [node]="nodes[0]"
+    ></app-idle-pc-action>
+    <app-auto-idle-pc-action
+      *ngIf="nodes.length === 1 && nodes[0].node_type === 'dynamips'"
+      [controller]="controller"
+      [node]="nodes[0]"
+    ></app-auto-idle-pc-action>
     <app-move-layer-up-action
       *ngIf="!projectService.isReadOnly(project) && (drawings.length || nodes.length)"
       [controller]="controller"

src/app/components/project-map/context-menu/dialogs/idle-pc-dialog/idle-pc-dialog.component.html

@@ -0,0 +1,25 @@
+<div *ngIf="isComputing">
+  <h6 align="center">Computing Idle-PC values, please wait...</h6>
+  <div mat-dialog-content align="center">
+    <mat-spinner color="accent"></mat-spinner>
+  </div>
+</div>
+<div *ngIf="!isComputing">
+<h1 mat-dialog-title>Choose an Idle-PC value</h1>
+  <mat-form-field class="form-field">
+    <mat-select
+      placeholder="Idle-PC"
+      [ngModelOptions]="{standalone: true}"
+      [(ngModel)]="idlePC"
+      [matTooltip]="getTooltip()"
+      matTooltipClass="multiline-tooltip"
+    >
+      <mat-option *ngFor="let idlepc of idlepcs" [value]="idlepc.key"> {{ idlepc.name }} </mat-option>
+    </mat-select>
+  </mat-form-field>
+</div>
+<div mat-dialog-actions>
+  <button mat-button *ngIf="!isComputing" (click)="onCompute()" color="accent">Compute</button>
+  <button mat-button *ngIf="!isComputing" (click)="onApply()" color="accent">Apply</button>
+  <button mat-button (click)="onClose()" color="accent">Close</button>
+</div>

src/app/components/project-map/context-menu/dialogs/idle-pc-dialog/idle-pc-dialog.component.scss

@@ -0,0 +1,11 @@
+.container {
+  width: 100%;
+  display: flex;
+  justify-content: space-between;
+}
+
+.multiline-tooltip {
+  background-color: grey;
+  color: #ffffff;
+  white-space: pre-line;
+}

src/app/components/project-map/context-menu/dialogs/idle-pc-dialog/idle-pc-dialog.component.ts

@@ -0,0 +1,72 @@
+import {Component, Input, OnInit, ViewEncapsulation} from '@angular/core';
+import {MatDialogRef} from '@angular/material/dialog';
+import {Controller} from "@models/controller";
+import {Node} from '../../../../../cartography/models/node';
+import {NodeService} from "@services/node.service";
+import {ToasterService} from "@services/toaster.service";
+
+@Component({
+  selector: 'app-idle-pc-dialog',
+  templateUrl: './idle-pc-dialog.component.html',
+  styleUrls: ['./idle-pc-dialog.component.scss'],
+  encapsulation: ViewEncapsulation.None
+})
+export class IdlePCDialogComponent implements OnInit {
+  @Input() controller: Controller;
+  @Input() node: Node;
+
+  idlepcs = [];
+  idlePC: string = '';
+  isComputing: boolean = false;
+
+  constructor(
+    private nodeService: NodeService,
+    public dialogRef: MatDialogRef<IdlePCDialogComponent>,
+    private toasterService: ToasterService
+  ) {}
+
+  ngOnInit() {
+    this.onCompute();
+  }
+
+  getTooltip(){
+    return "Best Idle-PC values are obtained when IOS is in idle state, after the 'Press RETURN to get started' message has appeared on the console, messages have finished displaying on the console and you have have actually pressed the RETURN key.\n\nFinding the right idle-pc value is a trial and error process, consisting of applying different Idle-PC values and monitoring the CPU usage.\n\nSelect each value that appears in the list and click Apply, and note the CPU usage a few moments later. When you have found the value that minimises the CPU usage, apply that value.";
+  }
+
+  onCompute() {
+    this.isComputing = true;
+    this.nodeService.getIdlePCProposals(this.controller, this.node).subscribe((idlepcs: any) => {
+      let idlepcs_values = [];
+      for (let value of idlepcs) {
+        // validate idle-pc format, e.g. 0x60c09aa0
+        const match = value.match(/^(0x[0-9a-f]{8})\s+\[(\d+)\]$/);
+        if (match) {
+          const idlepc = match[1];
+          const count = parseInt(match[2], 10);
+          if (50 <= count && count <= 60) {
+            value += "*";
+          }
+          idlepcs_values.push({'key': idlepc, 'name': value})
+        }
+      }
+      this.idlepcs = idlepcs_values;
+      if (this.idlepcs.length > 0) {
+        this.idlePC = this.idlepcs[0].key;
+      }
+      this.isComputing = false;
+    });
+  }
+
+  onClose() {
+    this.dialogRef.close();
+  }
+
+  onApply() {
+    if (this.idlePC && this.idlePC !== '0x0') {
+      this.node.properties.idlepc = this.idlePC;
+      this.nodeService.updateNode(this.controller, this.node).subscribe(() => {
+        this.toasterService.success(`Node ${this.node.name} updated with idle-PC value ${this.idlePC}`);
+      });
+    }
+  }
+}

src/app/components/projects/choose-name-dialog/choose-name-dialog.component.ts

@@ -10,7 +10,7 @@ import { ProjectService } from '../../../services/project.service';
   styleUrls: ['./choose-name-dialog.component.scss'],
 })
 export class ChooseNameDialogComponent implements OnInit {
-  @Input() controller:Controller ;
+  @Input() controller: Controller;
   @Input() project: Project;
   name: string;
 

src/app/services/ios.service.ts

@@ -37,4 +37,9 @@ export class IosService {
       iosTemplate
     ) as Observable<IosTemplate>;
   }
+
+  findIdlePC(controller:Controller, body: any) {
+    return this.httpController.post(controller, `/computes/${environment.compute_id}/dynamips/auto_idlepc`, body);
+  }
+
 }

src/app/services/node.service.ts

@@ -232,4 +232,12 @@ export class NodeService {
 
     return this.httpController.post(controller, urlPath, configuration);
   }
+
+  getIdlePCProposals(controller:Controller, node: Node) {
+    return this.httpController.get(controller, `/projects/${node.project_id}/nodes/${node.node_id}/dynamips/idlepc_proposals`);
+  }
+
+  getAutoIdlePC(controller:Controller, node: Node) {
+    return this.httpController.get(controller, `/projects/${node.project_id}/nodes/${node.node_id}/dynamips/auto_idlepc`);
+  }
 }