2 Copyright 2020 TATA ELXSI
4 Licensed under the Apache License, Version 2.0 (the 'License');
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
8 http://www.apache.org/licenses/LICENSE-2.0
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
16 Author: KUMARAN M (kumaran.m@tataelxsi.co.in), RAJESH S (rajesh.s@tataelxsi.co.in), BARATH KUMAR R (barath.r@tataelxsi.co.in)
19 * @file Info Compose Package Model
21 import { HttpClient, HttpHeaders } from '@angular/common/http';
22 import { Component, Injector, Input, OnInit } from '@angular/core';
23 import { FormBuilder, FormGroup, Validators } from '@angular/forms';
24 import { Router } from '@angular/router';
25 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap';
26 import { TranslateService } from '@ngx-translate/core';
27 import { NotifierService } from 'angular-notifier';
28 import { APIURLHEADER, ERRORDATA, URLPARAMS } from 'CommonModel';
29 import { DataService } from 'DataService';
30 import { environment } from 'environment';
31 import * as jsyaml from 'js-yaml';
32 import * as pako from 'pako';
33 import { RestService } from 'RestService';
34 import { SharedService } from 'SharedService';
36 /** This is added globally by the tar.js library */
37 // eslint-disable-next-line @typescript-eslint/no-explicit-any
38 declare const Tar: any;
42 * @Component takes ComposePackages.html as template url
45 templateUrl: './ComposePackages.html',
46 styleUrls: ['./ComposePackages.scss']
48 /** Exporting a class @exports ComposePackages */
49 // eslint-disable-next-line @angular-eslint/component-class-suffix
50 export class ComposePackages implements OnInit {
51 /** Invoke service injectors @public */
52 public injector: Injector;
54 /** dataService to pass the data from one component to another @public */
55 public dataService: DataService;
57 /** Varaibles to hold http client @public */
58 public httpClient: HttpClient;
60 /** Instance for active modal service @public */
61 public activeModal: NgbActiveModal;
63 /** FormGroup instance added to the form @ html @public */
64 public packagesForm: FormGroup;
66 /** Form submission Add */
67 public submitted: boolean = false;
69 /** To handle loader status for API call @public */
70 public isLoadingResults: boolean = false;
72 /** Give the message for the loading @public */
73 public message: string = 'PLEASEWAIT';
75 /** FormBuilder instance added to the formBuilder @private */
76 private formBuilder: FormBuilder;
78 /** Instance of the rest service @private */
79 private restService: RestService;
81 /** Notifier service to popup notification @private */
82 private notifierService: NotifierService;
84 /** Controls the header form @private */
85 private headers: HttpHeaders;
87 /** Create URL holds the end point of any packages @private */
88 private createURL: string;
90 /** Input contains component objects @private */
91 @Input() private params: URLPARAMS;
93 /** Holds the end point @private */
94 private endPoint: string;
96 /** Contains all methods related to shared @private */
97 private sharedService: SharedService;
99 /** Holds teh instance of AuthService class of type AuthService @private */
100 private router: Router;
102 /** Contains tranlsate instance @private */
103 private translateService: TranslateService;
105 constructor(injector: Injector) {
106 this.injector = injector;
107 this.dataService = this.injector.get(DataService);
108 this.restService = this.injector.get(RestService);
109 this.activeModal = this.injector.get(NgbActiveModal);
110 this.notifierService = this.injector.get(NotifierService);
111 this.formBuilder = this.injector.get(FormBuilder);
112 this.router = this.injector.get(Router);
113 this.translateService = this.injector.get(TranslateService);
114 this.sharedService = this.injector.get(SharedService);
117 /** convenience getter for easy access to form fields */
118 get f(): FormGroup['controls'] { return this.packagesForm.controls; }
121 * Lifecyle Hooks the trigger before component is instantiate
123 public ngOnInit(): void {
124 this.headers = new HttpHeaders({
125 'Content-Type': 'application/gzip',
126 Accept: 'application/json',
127 'Cache-Control': 'no-cache, no-store, must-revalidate, max-age=0'
129 this.initializeForm();
132 /** initialize Forms @public */
133 public initializeForm(): void {
134 this.packagesForm = this.formBuilder.group({
135 name: ['', [Validators.required]]
139 /** Create packages @public */
140 public createPackages(): void {
141 this.submitted = true;
142 this.sharedService.cleanForm(this.packagesForm);
143 if (!this.packagesForm.invalid) {
144 this.isLoadingResults = true;
145 if (this.params.page === 'ns-package') {
146 this.endPoint = environment.NSDESCRIPTORSCONTENT_URL;
147 } else if (this.params.page === 'vnf-package') {
148 this.endPoint = environment.VNFPACKAGESCONTENT_URL;
150 const descriptor: string = this.packageYaml(this.params.page);
152 // eslint-disable-next-line @typescript-eslint/no-explicit-any
153 const tar: any = new Tar();
154 const out: Uint8Array = tar.append(this.packagesForm.value.name + '/' + this.packagesForm.value.name + '.yaml',
155 descriptor, { type: '0' });
156 const gzipContent: Uint8Array = pako.gzip(out);
157 this.createPackageApi(gzipContent.buffer);
159 this.isLoadingResults = false;
160 this.notifierService.notify('error', this.translateService.instant('ERROR'));
164 /** Create packages @public */
165 private createPackageApi(packageContent: ArrayBuffer | SharedArrayBuffer): void {
166 const apiURLHeader: APIURLHEADER = {
168 httpOptions: { headers: this.headers }
170 this.restService.postResource(apiURLHeader, packageContent).subscribe((result: { id: string }): void => {
171 this.isLoadingResults = false;
172 this.activeModal.close();
173 this.composeNSPackages(result.id);
174 }, (error: ERRORDATA): void => {
175 this.isLoadingResults = false;
176 this.restService.handleError(error, 'post');
179 /** Compose NS Packages @private */
180 private composeNSPackages(id: string): void {
181 let packageUrl: string;
182 if (this.params.page === 'ns-package') {
183 packageUrl = '/packages/ns/compose/';
184 this.notifierService.notify('success', this.packagesForm.value.name + ' ' +
185 this.translateService.instant('PAGE.NSPACKAGE.CREATEDSUCCESSFULLY'));
186 } else if (this.params.page === 'vnf-package') {
187 packageUrl = '/packages/vnf/compose/';
188 this.notifierService.notify('success', this.packagesForm.value.name + ' ' +
189 this.translateService.instant('PAGE.VNFPACKAGE.CREATEDSUCCESSFULLY'));
191 this.router.navigate([packageUrl, id]).catch((): void => {
192 // Catch Navigation Error
195 /** Deafult template for NS and VNF Packages @private */
196 private packageYaml(descriptorType: string): string {
197 let packageYaml: {} = {};
198 const composerName: string = 'NGUI Composer';
199 const composerDefaultVersion: string = '1.0';
200 if (descriptorType === 'ns-package') {
205 id: this.packagesForm.value.name,
206 name: this.packagesForm.value.name,
207 version: composerDefaultVersion,
208 description: this.packagesForm.value.name + ' descriptor',
209 designer: composerName,
223 id: this.packagesForm.value.name,
224 'product-name': this.packagesForm.value.name,
225 version: composerDefaultVersion,
226 description: this.packagesForm.value.name + ' descriptor',
227 provider: composerName,
231 'instantiation-level': [],
238 'virtual-storage-desc': []
242 return jsyaml.dump(packageYaml, { sortKeys: true });