From 4f251edb14a4f525475df18f4f651696152b3b42 Mon Sep 17 00:00:00 2001 From: aribeiro Date: Fri, 4 Sep 2020 10:29:18 +0100 Subject: Make directives options configurable Issue-ID: SDC-3275 Signed-off-by: aribeiro Change-Id: Ia91655f02c45d033ebae45bd6d9f252c2f6d6f47 --- .../templates/default/BE-configuration.yaml.erb | 7 ++ .../sdc/be/servlets/DirectiveServlet.java | 104 +++++++++++++++++++++ .../src/main/resources/config/configuration.yaml | 7 ++ .../resources/config/catalog-be/configuration.yaml | 7 ++ .../componentsInstances/componentInstance.ts | 9 +- catalog-ui/src/app/models/directives.ts | 22 +++++ .../logic/service-dependencies/directive-option.ts | 15 --- .../service-dependencies.component.html | 2 +- .../service-dependencies.component.less | 5 + .../service-dependencies.component.ts | 18 ++-- .../topology-template.service.ts | 7 ++ .../org/openecomp/sdc/be/config/Configuration.java | 9 ++ 12 files changed, 181 insertions(+), 31 deletions(-) create mode 100644 catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java create mode 100644 catalog-ui/src/app/models/directives.ts delete mode 100644 catalog-ui/src/app/ng2/components/logic/service-dependencies/directive-option.ts diff --git a/catalog-be/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb b/catalog-be/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb index 9ad535d32a..20f00954e3 100644 --- a/catalog-be/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb +++ b/catalog-be/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb @@ -1250,3 +1250,10 @@ cadiFilterParams: # This configuration entry lists all node type names prefix that shall be allowed on SDC. definedResourceNamespace: - org.openecomp.resource. + +# This configuration entry lists all Directives values that shall be allowed on SDC. +directives: + - select + - selectable + - substitute + - substitutable diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java new file mode 100644 index 0000000000..adffdaf9d7 --- /dev/null +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java @@ -0,0 +1,104 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.openecomp.sdc.be.servlets; + +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.ArraySchema; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import javax.inject.Inject; +import javax.inject.Singleton; +import javax.servlet.http.HttpServletRequest; +import javax.ws.rs.GET; +import javax.ws.rs.HeaderParam; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.commons.collections.CollectionUtils; +import org.openecomp.sdc.be.components.impl.aaf.AafPermission; +import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed; +import org.openecomp.sdc.be.config.BeEcompErrorManager; +import org.openecomp.sdc.be.config.ConfigurationManager; +import org.openecomp.sdc.be.dao.api.ActionStatus; +import org.openecomp.sdc.be.impl.ComponentsUtils; +import org.openecomp.sdc.be.model.User; +import org.openecomp.sdc.be.user.UserBusinessLogic; +import org.openecomp.sdc.common.api.Constants; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Path("/v1/catalog/directives") +@Singleton +public class DirectiveServlet extends BeGenericServlet { + + private static final Logger LOGGER = LoggerFactory.getLogger(DirectiveServlet.class); + + @Inject + public DirectiveServlet(final UserBusinessLogic userAdminManager, + final ComponentsUtils componentsUtils) { + super(userAdminManager, componentsUtils); + } + + @GET + @Path("/") + @Produces(MediaType.APPLICATION_JSON) + @Operation(description = "Retrieve all Directives values from configuration file", method = "GET", + summary = "Retrieve all Directives", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = User.class)))), + @ApiResponse(responseCode = "200", + description = "Returns Directive values from configuration file Ok"), + @ApiResponse(responseCode = "404", + description = "Directive not found"), + @ApiResponse(responseCode = "500", description = "Internal Server Error")}) + @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE) + public Response getConfCategoriesAndVersion(@Context final HttpServletRequest request, + @HeaderParam(value = Constants.USER_ID_HEADER) String userId) { + + final String url = request.getMethod() + " " + request.getRequestURI(); + LOGGER.debug("Start handle request of {}", url); + + final Map directivesMap = new HashMap<>(); + try { + final List directives = getDirectiveValues(); + if (CollectionUtils.isEmpty(directives)) { + return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.NO_CONTENT)); + } + directivesMap.put("directives", directives); + + } catch (final Exception e) { + BeEcompErrorManager.getInstance().logBeRestApiGeneralError("SDC Failed to retrieve all Directives"); + LOGGER.debug("Method getDirectiveValues failed with unexpected exception", e); + return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR)); + } + + return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), directivesMap); + } + + private List getDirectiveValues() { + return ConfigurationManager.getConfigurationManager().getConfiguration().getDirectives(); + } + +} diff --git a/catalog-be/src/main/resources/config/configuration.yaml b/catalog-be/src/main/resources/config/configuration.yaml index ab89d8f158..298862e79f 100644 --- a/catalog-be/src/main/resources/config/configuration.yaml +++ b/catalog-be/src/main/resources/config/configuration.yaml @@ -914,3 +914,10 @@ cadiFilterParams: # This configuration entry lists all node type names prefix that shall be allowed on SDC. definedResourceNamespace: - org.openecomp.resource. + +# This configuration entry lists all Directives values that shall be allowed on SDC. +directives: + - select + - selectable + - substitute + - substitutable diff --git a/catalog-be/src/test/resources/config/catalog-be/configuration.yaml b/catalog-be/src/test/resources/config/catalog-be/configuration.yaml index 88729d655a..7f75646467 100644 --- a/catalog-be/src/test/resources/config/catalog-be/configuration.yaml +++ b/catalog-be/src/test/resources/config/catalog-be/configuration.yaml @@ -554,6 +554,13 @@ cadiFilterParams: definedResourceNamespace: - org.openecomp.resource. +# This configuration entry lists all Directives values that shall be allowed on SDC. +directives: + - select + - selectable + - substitute + - substitutable + artifacts: - type: CONTROLLER_BLUEPRINT_ARCHIVE categories: diff --git a/catalog-ui/src/app/models/componentsInstances/componentInstance.ts b/catalog-ui/src/app/models/componentsInstances/componentInstance.ts index e91fcc9663..2e0c1a59c8 100644 --- a/catalog-ui/src/app/models/componentsInstances/componentInstance.ts +++ b/catalog-ui/src/app/models/componentsInstances/componentInstance.ts @@ -34,7 +34,6 @@ import { import {ResourceType, ComponentType} from "../../utils/constants"; import {Capability} from "../capability"; import {Requirement} from "../requirement"; -import {DirectivesEnum} from "../../ng2/components/logic/service-dependencies/directive-option"; export interface IComponentInstance { @@ -237,12 +236,8 @@ export class ComponentInstance implements IComponentInstance{ return Array.isArray(this.directives) && this.directives.length > 0; } - public markAsSelect = () : void => { - this.directives.push(DirectivesEnum.SELECT); - } - - public markAsSubstitute = () : void => { - this.directives.push(DirectivesEnum.SUBSTITUTE); + public setDirectiveValue = (selectedDirective: string) : void => { + this.directives.push(selectedDirective); } public unmarkAsDependent = (actualDirectiveValue: string) : void => { diff --git a/catalog-ui/src/app/models/directives.ts b/catalog-ui/src/app/models/directives.ts new file mode 100644 index 0000000000..5293e1f5df --- /dev/null +++ b/catalog-ui/src/app/models/directives.ts @@ -0,0 +1,22 @@ +/* +* ============LICENSE_START======================================================= +* Copyright (C) 2020 Nordix Foundation. All rights reserved. +* ================================================================================ +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +* +* SPDX-License-Identifier: Apache-2.0 +* ============LICENSE_END========================================================= +*/ + +interface ListDirectiveResponse { + directives: string[]; +} diff --git a/catalog-ui/src/app/ng2/components/logic/service-dependencies/directive-option.ts b/catalog-ui/src/app/ng2/components/logic/service-dependencies/directive-option.ts deleted file mode 100644 index f2c4b1f895..0000000000 --- a/catalog-ui/src/app/ng2/components/logic/service-dependencies/directive-option.ts +++ /dev/null @@ -1,15 +0,0 @@ -export enum DirectivesEnum { - SELECT = 'select', - SELECTABLE = 'selectable', - SUBSTITUTE = 'substitute', - SUBSTITUTABLE = 'substitutable', -} - -export namespace DirectiveValue { - - export function values() { - return Object.keys(DirectivesEnum).filter( - (type) => isNaN(type) && type !== 'values' - ); - } -} diff --git a/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.html b/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.html index c3d4817a39..ef5e29b049 100644 --- a/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.html +++ b/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.html @@ -4,7 +4,7 @@ diff --git a/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.less b/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.less index 00be76c8ca..9b1535864e 100644 --- a/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.less +++ b/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.less @@ -113,3 +113,8 @@ } } } + + +.directives-options { + text-transform: uppercase; +} diff --git a/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.ts b/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.ts index 90f82f8983..ff5207bb2c 100644 --- a/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.ts +++ b/catalog-ui/src/app/ng2/components/logic/service-dependencies/service-dependencies.component.ts @@ -29,7 +29,6 @@ import { TranslateService } from 'app/ng2/shared/translator/translate.service'; import { ComponentMetadata } from '../../../../models/component-metadata'; import { ServiceInstanceObject } from '../../../../models/service-instance-properties-and-interfaces'; import { TopologyTemplateService } from '../../../services/component-services/topology-template.service'; -import {DirectivesEnum, DirectiveValue} from "./directive-option"; export class ConstraintObject { servicePropertyName: string; @@ -129,6 +128,7 @@ export class ServiceDependenciesComponent { capabilities: string = 'capabilities'; properties: string = 'properties'; private componentInstancesConstraints: ConstraintObject[] = []; + directiveOptions: string[]; @Input() readonly: boolean; @Input() compositeService: ComponentMetadata; @@ -136,7 +136,7 @@ export class ServiceDependenciesComponent { @Input() selectedInstanceSiblings: ServiceInstanceObject[]; @Input() selectedInstanceConstraints: ConstraintObject[] = []; @Input() selectedInstanceProperties: PropertyBEModel[] = []; - @Input() directiveValues: any = DirectiveValue; + @Output() updateRulesListEvent: EventEmitter = new EventEmitter(); @Output() updateNodeFilterProperties: EventEmitter = new EventEmitter(); @Output() updateNodeFilterCapabilities: EventEmitter = new EventEmitter(); @Output() loadRulesListEvent:EventEmitter = new EventEmitter(); @@ -146,6 +146,7 @@ export class ServiceDependenciesComponent { } ngOnInit() { + this.loadDirectives(); this.isLoading = false; this.operatorTypes = [ {label: '>', value: OPERATOR_TYPES.GREATER_THAN}, @@ -161,6 +162,12 @@ export class ServiceDependenciesComponent { }); } + loadDirectives() { + this.topologyTemplateService.getDirectiveList().subscribe((data: string[]) => { + this.directiveOptions = data; + }) + } + ngOnChanges(changes) { if (changes.currentServiceInstance) { this.currentServiceInstance = changes.currentServiceInstance.currentValue; @@ -239,12 +246,7 @@ export class ServiceDependenciesComponent { if (this.isDependent) { this.openUpdateDependencyModal().instance.open(); } - if (DirectivesEnum.SELECT == newDirectiveValue.toLowerCase() || - DirectivesEnum.SELECTABLE == newDirectiveValue.toLowerCase()) { - this.currentServiceInstance.markAsSelect(); - } else { - this.currentServiceInstance.markAsSubstitute(); - } + this.currentServiceInstance.setDirectiveValue(newDirectiveValue); } updateComponentInstance(isDependentOrigVal: boolean, rulesListOrig: ConstraintObject[]) { diff --git a/catalog-ui/src/app/ng2/services/component-services/topology-template.service.ts b/catalog-ui/src/app/ng2/services/component-services/topology-template.service.ts index a7c8022239..01b8ead595 100644 --- a/catalog-ui/src/app/ng2/services/component-services/topology-template.service.ts +++ b/catalog-ui/src/app/ng2/services/component-services/topology-template.service.ts @@ -63,6 +63,7 @@ import { ConstraintObject } from "../../components/logic/service-dependencies/se import { ComponentMetadata } from "../../../models/component-metadata"; import { PolicyInstance } from "../../../models/graph/zones/policy-instance"; import { PropertyBEModel } from "../../../models/properties-inputs/property-be-model"; +import {map} from "rxjs/operators"; /* we need to use this service from now, we will remove component.service when we finish remove the angular1. The service is duplicated since we can not use downgrades service with NGXS*/ @@ -529,4 +530,10 @@ export class TopologyTemplateService { deleteRequirement(component: Component, reqId: string): Observable { return this.http.delete(this.baseUrl + component.getTypeUrl() + component.uniqueId + '/requirements/' + reqId); } + + getDirectiveList(): Observable { + return this.http.get(this.baseUrl + "directives") + .pipe(map(response => response.directives)); + } + } diff --git a/common-app-api/src/main/java/org/openecomp/sdc/be/config/Configuration.java b/common-app-api/src/main/java/org/openecomp/sdc/be/config/Configuration.java index ddc941de68..2841dfd123 100644 --- a/common-app-api/src/main/java/org/openecomp/sdc/be/config/Configuration.java +++ b/common-app-api/src/main/java/org/openecomp/sdc/be/config/Configuration.java @@ -96,6 +96,7 @@ public class Configuration extends BasicConfiguration { private List licenseTypes; private List definedResourceNamespace; + private List directives; private Integer additionalInformationMaxNumberOfKeys; private HeatDeploymentArtifactTimeout heatArtifactDeploymentTimeout; @@ -557,6 +558,14 @@ public class Configuration extends BasicConfiguration { this.definedResourceNamespace = definedResourceNamespace; } + public List getDirectives() { + return directives; + } + + public void setDirectives(List directives) { + this.directives = directives; + } + public Integer getAdditionalInformationMaxNumberOfKeys() { return additionalInformationMaxNumberOfKeys; } -- cgit 1.2.3-korg