Skip to content

Commit

Permalink
Merge pull request #10220 from AllForNothing/release-1.10.0
Browse files Browse the repository at this point in the history
Add links to view doc for scanners ui
  • Loading branch information
AllForNothing committed Dec 11, 2019
2 parents af73efb + 890c6ac commit 44b9805
Show file tree
Hide file tree
Showing 14 changed files with 129 additions and 11 deletions.
15 changes: 14 additions & 1 deletion src/portal/src/app/base/harbor-shell/harbor-shell.component.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
<clr-main-container>
<global-message [isAppLevel]="true"></global-message>
<div class="clr-row scanner-info" *ngIf="showScannerInfo && isSystemAdmin ">
<div class="clr-col-2"></div>
<div class="clr-col text-center">
<clr-icon shape="info-standard" size="20"></clr-icon>
<span class="ml-05">{{'SCANNER.HELP_INFO_1' | translate }}
<a target="_blank" href="{{scannerDocUrl}}">{{'SCANNER.HELP_INFO_2' | translate }}</a>
</span>
</div>
<div class="clr-col-2 right">
<a class="all-scanners" href="#" routerLink="/harbor/interrogation-services/scanners">{{'SCANNER.ALL_SCANNERS' | translate }}</a>
<clr-icon (click)="closeInfo()" class="close-icon" shape="times" size="24"></clr-icon>
</div>
</div>
<global-message [isAppLevel]="true"></global-message>
<navigator (showAccountSettingsModal)="openModal($event)" (showDialogModalAction)="openModal($event)"></navigator>
<div class="content-container">
<div class="content-area" [class.container-override]="showSearch"
Expand Down
29 changes: 29 additions & 0 deletions src/portal/src/app/base/harbor-shell/harbor-shell.component.scss
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,32 @@ clr-vertical-nav {
}
}

.scanner-info {
margin-right: 0;
margin-left: 0;
background-color: #0079b8;
height: 2rem;
color: #fff;
align-items: center;
font-size: 0.5rem;
a {
cursor: pointer;
text-decoration: #bababa underline;
font-weight: 600;
}
a:hover, a:visited, a:link {
color: #fff;
}
}
.all-scanners {
margin-right: 1.5rem;
}
.close-icon {
margin-right: 1rem;
}
.ml-05 {
margin-left: 0.5rem;
}
.right {
text-align: right;
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { SearchTriggerService } from '../global-search/search-trigger.service';
import { HarborShellComponent } from './harbor-shell.component';
import { ClarityModule } from "@clr/angular";
import { of } from 'rxjs';
import { ConfigScannerService } from "../../config/scanner/config-scanner.service";

describe('HarborShellComponent', () => {
let component: HarborShellComponent;
Expand Down Expand Up @@ -44,7 +45,11 @@ describe('HarborShellComponent', () => {
};
}
};

let fakeConfigScannerService = {
getScanners() {
return of(true);
}
};
beforeEach(async(() => {
TestBed.configureTestingModule({
imports: [
Expand All @@ -58,7 +63,8 @@ describe('HarborShellComponent', () => {
TranslateService,
{ provide: SessionService, useValue: fakeSessionService },
{ provide: SearchTriggerService, useValue: fakeSearchTriggerService },
{ provide: AppConfigService, useValue: fakeAppConfigService }
{ provide: AppConfigService, useValue: fakeAppConfigService },
{ provide: ConfigScannerService, useValue: fakeConfigScannerService }
],
schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA]
}).compileComponents();
Expand All @@ -67,6 +73,7 @@ describe('HarborShellComponent', () => {
beforeEach(() => {
fixture = TestBed.createComponent(HarborShellComponent);
component = fixture.componentInstance;
component.showScannerInfo = true;
fixture.detectChanges();
});

Expand Down
26 changes: 25 additions & 1 deletion src/portal/src/app/base/harbor-shell/harbor-shell.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ import { SessionService } from '../../shared/session.service';
import { AboutDialogComponent } from '../../shared/about-dialog/about-dialog.component';
import { SearchTriggerService } from '../global-search/search-trigger.service';
import { CommonRoutes } from '@harbor/ui';
import { ConfigScannerService, SCANNERS_DOC } from "../../config/scanner/config-scanner.service";

const HAS_SHOWED_SCANNER_INFO: string = 'hasShowScannerInfo';
const YES: string = 'yes';

@Component({
selector: 'harbor-shell',
Expand Down Expand Up @@ -57,13 +61,16 @@ export class HarborShellComponent implements OnInit, OnDestroy {
isLdapMode: boolean;
isOidcMode: boolean;
isHttpAuthMode: boolean;
showScannerInfo: boolean = false;
scannerDocUrl: string = SCANNERS_DOC;

constructor(
private route: ActivatedRoute,
private router: Router,
private session: SessionService,
private searchTrigger: SearchTriggerService,
private appConfigService: AppConfigService) { }
private appConfigService: AppConfigService,
private scannerService: ConfigScannerService) { }

ngOnInit() {
if (this.appConfigService.isLdapMode()) {
Expand All @@ -82,8 +89,25 @@ export class HarborShellComponent implements OnInit, OnDestroy {
this.searchCloseSub = this.searchTrigger.searchCloseChan$.subscribe(close => {
this.isSearchResultsOpened = false;
});
if (!(localStorage && localStorage.getItem(HAS_SHOWED_SCANNER_INFO) === YES)) {
this.getDefaultScanner();
}
}
closeInfo() {
if (localStorage) {
localStorage.setItem(HAS_SHOWED_SCANNER_INFO, YES);
}
this.showScannerInfo = false;
}

getDefaultScanner() {
this.scannerService.getScanners()
.subscribe(scanners => {
if (scanners && scanners.length) {
this.showScannerInfo = scanners.some(scanner => scanner.is_default);
}
});
}
ngOnDestroy(): void {
if (this.searchSub) {
this.searchSub.unsubscribe();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
<div class="row">
<div>
<h4 class="mt-1">{{'SCANNER.IMAGE_SCANNERS' | translate }}
<clr-signpost>
<clr-signpost-content *clrIfOpen>
<a class="doc" target="_blank"
href="{{scannerDocUrl}}">{{'SCANNER.VIEW_DOC' | translate }}</a>
</clr-signpost-content>
</clr-signpost>
</h4>
<clr-datagrid [clrDgLoading]="onGoing" [(clrDgSingleSelected)]="selectedRow">
<clr-dg-action-bar>
<div class="clr-row">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,6 @@
.margin-left-10 {
margin-left: 10px;
}
.doc {
font-size: 0.7rem;
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Component, ViewChild, OnInit, OnDestroy } from "@angular/core";
import { Scanner } from "./scanner";
import { NewScannerModalComponent } from "./new-scanner-modal/new-scanner-modal.component";
import { ConfigScannerService } from "./config-scanner.service";
import { ConfigScannerService, SCANNERS_DOC } from "./config-scanner.service";
import { clone, ErrorHandler } from "@harbor/ui";
import { finalize } from "rxjs/operators";
import { MessageHandlerService } from "../../shared/message-handler/message-handler.service";
Expand All @@ -21,6 +21,7 @@ export class ConfigurationScannerComponent implements OnInit, OnDestroy {
@ViewChild(NewScannerModalComponent, {static: false})
newScannerDialog: NewScannerModalComponent;
deletionSubscription: any;
scannerDocUrl: string = SCANNERS_DOC;
constructor(
private configScannerService: ConfigScannerService,
private errorHandler: ErrorHandler,
Expand Down
2 changes: 2 additions & 0 deletions src/portal/src/app/config/scanner/config-scanner.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { catchError, map } from "rxjs/operators";
import { HttpClient } from "@angular/common/http";
import { ScannerMetadata } from "./scanner-metadata";

export const SCANNERS_DOC: string = "https://github.com/goharbor/harbor/blob/master/docs/harbor_compatibility_list.md";

@Injectable()
export class ConfigScannerService {

Expand Down
8 changes: 7 additions & 1 deletion src/portal/src/i18n/lang/en-us-lang.json
Original file line number Diff line number Diff line change
Expand Up @@ -1345,6 +1345,12 @@
"CONFIRM_DELETION": "Confirm Scanner deletion",
"NO_PROJECT_SCANNER": "No Scanner",
"SET_UNHEALTHY_SCANNER": "Selected scanner:{{name}} is unhealthy",
"SCANNED_BY": "Scanned by:"
"SCANNED_BY": "Scanned by:",
"IMAGE_SCANNERS": "Image Scanners",
"VIEW_DOC": "view documentation",
"ALL_SCANNERS": "All scanners",
"HELP_INFO_1": "The default scanner has been installed. To install other scanners refer to the ",
"HELP_INFO_2": "documentation."

}
}
7 changes: 6 additions & 1 deletion src/portal/src/i18n/lang/es-es-lang.json
Original file line number Diff line number Diff line change
Expand Up @@ -1342,6 +1342,11 @@
"CONFIRM_DELETION": "Confirm Scanner deletion",
"NO_PROJECT_SCANNER": "No Scanner",
"SET_UNHEALTHY_SCANNER": "Selected scanner:{{name}} is unhealthy",
"SCANNED_BY": "Scanned by:"
"SCANNED_BY": "Scanned by:",
"IMAGE_SCANNERS": "Image Scanners",
"VIEW_DOC": "view documentation",
"ALL_SCANNERS": "All scanners",
"HELP_INFO_1": "The default scanner has been installed. To install other scanners refer to the ",
"HELP_INFO_2": "documentation."
}
}
7 changes: 6 additions & 1 deletion src/portal/src/i18n/lang/fr-fr-lang.json
Original file line number Diff line number Diff line change
Expand Up @@ -1314,6 +1314,11 @@
"CONFIRM_DELETION": "Confirm Scanner deletion",
"NO_PROJECT_SCANNER": "No Scanner",
"SET_UNHEALTHY_SCANNER": "Selected scanner:{{name}} is unhealthy",
"SCANNED_BY": "Scanned by:"
"SCANNED_BY": "Scanned by:",
"IMAGE_SCANNERS": "Image Scanners",
"VIEW_DOC": "view documentation",
"ALL_SCANNERS": "All scanners",
"HELP_INFO_1": "The default scanner has been installed. To install other scanners refer to the ",
"HELP_INFO_2": "documentation."
}
}
7 changes: 6 additions & 1 deletion src/portal/src/i18n/lang/pt-br-lang.json
Original file line number Diff line number Diff line change
Expand Up @@ -1339,7 +1339,12 @@
"CONFIRM_DELETION": "Confirm Scanner deletion",
"NO_PROJECT_SCANNER": "No Scanner",
"SET_UNHEALTHY_SCANNER": "Selected scanner:{{name}} is unhealthy",
"SCANNED_BY": "Scanned by:"
"SCANNED_BY": "Scanned by:",
"IMAGE_SCANNERS": "Image Scanners",
"VIEW_DOC": "view documentation",
"ALL_SCANNERS": "All scanners",
"HELP_INFO_1": "The default scanner has been installed. To install other scanners refer to the ",
"HELP_INFO_2": "documentation."
}

}
7 changes: 6 additions & 1 deletion src/portal/src/i18n/lang/tr-tr-lang.json
Original file line number Diff line number Diff line change
Expand Up @@ -1344,6 +1344,11 @@
"CONFIRM_DELETION": "Confirm Scanner deletion",
"NO_PROJECT_SCANNER": "No Scanner",
"SET_UNHEALTHY_SCANNER": "Selected scanner:{{name}} is unhealthy",
"SCANNED_BY": "Scanned by:"
"SCANNED_BY": "Scanned by:",
"IMAGE_SCANNERS": "Image Scanners",
"VIEW_DOC": "view documentation",
"ALL_SCANNERS": "All scanners",
"HELP_INFO_1": "The default scanner has been installed. To install other scanners refer to the ",
"HELP_INFO_2": "documentation."
}
}
7 changes: 6 additions & 1 deletion src/portal/src/i18n/lang/zh-cn-lang.json
Original file line number Diff line number Diff line change
Expand Up @@ -1341,6 +1341,11 @@
"CONFIRM_DELETION": "删除扫描器确认",
"NO_PROJECT_SCANNER": "无扫描器",
"SET_UNHEALTHY_SCANNER": "选择的扫描器:{{name}}是不健康的",
"SCANNED_BY": "扫描器:"
"SCANNED_BY": "扫描器:",
"IMAGE_SCANNERS": "镜像扫描器",
"VIEW_DOC": "查看文档",
"ALL_SCANNERS": "全部扫描器",
"HELP_INFO_1": "默认扫描器已安装。获取扫描器安装帮助,请查看",
"HELP_INFO_2": "文档。"
}
}

0 comments on commit 44b9805

Please sign in to comment.