aboutsummaryrefslogtreecommitdiffstats
path: root/controlloop/common/actors/actor.appclcm
diff options
context:
space:
mode:
authorJim Hahn <jrh3@att.com>2019-05-08 14:33:57 -0400
committerJim Hahn <jrh3@att.com>2019-05-08 16:24:35 -0400
commit10b21aae2bde224ab7f91f4b5ab1b89369c8fd1c (patch)
tree0417099e379e8be69f90221e8fd066fc40def62b /controlloop/common/actors/actor.appclcm
parent01841878936986bc80a974977ccdeaceaf7f9a78 (diff)
Add payload to vFW policy yaml
Added new "streams" payload to vFW policy yaml files. Removed references to pg-streams. Also deleted directories that were moved to policy/models. Also removed references to trafficgenerator. Updated licenses. Removed some trailing whitespace. Change-Id: I6becaa573628eee677f0959fadf86f9a9f032f88 Issue-ID: POLICY-1752 Signed-off-by: Jim Hahn <jrh3@att.com>
Diffstat (limited to 'controlloop/common/actors/actor.appclcm')
-rw-r--r--controlloop/common/actors/actor.appclcm/pom.xml87
-rw-r--r--controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProvider.java359
-rw-r--r--controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatter.java47
-rw-r--r--controlloop/common/actors/actor.appclcm/src/main/resources/META-INF/services/org.onap.policy.controlloop.actorServiceProvider.spi.Actor1
-rw-r--r--controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProviderTest.java442
-rw-r--r--controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatterTest.java98
6 files changed, 0 insertions, 1034 deletions
diff --git a/controlloop/common/actors/actor.appclcm/pom.xml b/controlloop/common/actors/actor.appclcm/pom.xml
deleted file mode 100644
index 28f9c1c60..000000000
--- a/controlloop/common/actors/actor.appclcm/pom.xml
+++ /dev/null
@@ -1,87 +0,0 @@
-<?xml version="1.0"?>
-<!--
- ============LICENSE_START=======================================================
- drools-pdp-apps
- ================================================================================
- Copyright (C) 2017-2018 AT&T Intellectual Property. 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.
- ============LICENSE_END=========================================================
- -->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
-
- <parent>
- <groupId>org.onap.policy.drools-applications.controlloop.common.actors</groupId>
- <artifactId>actors</artifactId>
- <version>1.4.0-SNAPSHOT</version>
- </parent>
-
- <artifactId>actor.appclcm</artifactId>
-
- <dependencies>
- <dependency>
- <groupId>org.onap.policy.drools-applications.controlloop.common.actors</groupId>
- <artifactId>actorServiceProvider</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.drools-applications.controlloop.common.model-impl</groupId>
- <artifactId>appclcm</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.drools-applications.controlloop.common.model-impl</groupId>
- <artifactId>aai</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>com.google.code.gson</groupId>
- <artifactId>gson</artifactId>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.drools-applications.controlloop.common.model-impl</groupId>
- <artifactId>events</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.common</groupId>
- <artifactId>policy-endpoints</artifactId>
- <version>${version.policy.common}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.drools-pdp</groupId>
- <artifactId>policy-management</artifactId>
- <version>${version.policy.drools-pdp}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.drools-applications.controlloop.common</groupId>
- <artifactId>simulators</artifactId>
- <version>${project.version}</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <scope>test</scope>
- </dependency>
- </dependencies>
-</project>
diff --git a/controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProvider.java b/controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProvider.java
deleted file mode 100644
index 5c82a9500..000000000
--- a/controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProvider.java
+++ /dev/null
@@ -1,359 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * AppcLcmActorServiceProvider
- * ================================================================================
- * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
- * Modifications copyright (c) 2018 Nokia
- * ================================================================================
- * 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.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.actor.appclcm;
-
-import com.google.common.collect.ImmutableList;
-import com.google.common.collect.ImmutableMap;
-
-import java.util.AbstractMap;
-import java.util.AbstractMap.SimpleEntry;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.UUID;
-
-import org.onap.policy.aai.AaiManager;
-import org.onap.policy.aai.AaiNqInstanceFilters;
-import org.onap.policy.aai.AaiNqInventoryResponseItem;
-import org.onap.policy.aai.AaiNqNamedQuery;
-import org.onap.policy.aai.AaiNqQueryParameters;
-import org.onap.policy.aai.AaiNqRequest;
-import org.onap.policy.aai.AaiNqResponse;
-import org.onap.policy.aai.util.AaiException;
-import org.onap.policy.appclcm.LcmCommonHeader;
-import org.onap.policy.appclcm.LcmRequest;
-import org.onap.policy.appclcm.LcmRequestWrapper;
-import org.onap.policy.appclcm.LcmResponse;
-import org.onap.policy.appclcm.LcmResponseCode;
-import org.onap.policy.appclcm.LcmResponseWrapper;
-import org.onap.policy.controlloop.ControlLoopOperation;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
-import org.onap.policy.controlloop.policy.Policy;
-import org.onap.policy.controlloop.policy.PolicyResult;
-import org.onap.policy.drools.system.PolicyEngine;
-import org.onap.policy.rest.RestManager;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-public class AppcLcmActorServiceProvider implements Actor {
-
- private static final Logger logger = LoggerFactory.getLogger(AppcLcmActorServiceProvider.class);
-
- /* To be used in future releases to restart a single vm */
- private static final String APPC_VM_ID = "vm-id";
-
- // Strings for targets
- private static final String TARGET_VM = "VM";
- private static final String TARGET_VNF = "VNF";
-
- // Strings for recipes
- private static final String RECIPE_RESTART = "Restart";
- private static final String RECIPE_REBUILD = "Rebuild";
- private static final String RECIPE_MIGRATE = "Migrate";
- private static final String RECIPE_MODIFY = "ConfigModify";
-
- /* To be used in future releases when LCM ConfigModify is used */
- private static final String APPC_REQUEST_PARAMS = "request-parameters";
- private static final String APPC_CONFIG_PARAMS = "configuration-parameters";
-
- private static final ImmutableList<String> recipes =
- ImmutableList.of(RECIPE_RESTART, RECIPE_REBUILD, RECIPE_MIGRATE, RECIPE_MODIFY);
- private static final ImmutableMap<String, List<String>> targets = new ImmutableMap.Builder<String, List<String>>()
- .put(RECIPE_RESTART, ImmutableList.of(TARGET_VM)).put(RECIPE_REBUILD, ImmutableList.of(TARGET_VM))
- .put(RECIPE_MIGRATE, ImmutableList.of(TARGET_VM)).put(RECIPE_MODIFY, ImmutableList.of(TARGET_VNF)).build();
- private static final ImmutableMap<String, List<String>> payloads =
- new ImmutableMap.Builder<String, List<String>>().put(RECIPE_RESTART, ImmutableList.of(APPC_VM_ID))
- .put(RECIPE_MODIFY, ImmutableList.of(APPC_REQUEST_PARAMS, APPC_CONFIG_PARAMS)).build();
-
- @Override
- public String actor() {
- return "APPC";
- }
-
- @Override
- public List<String> recipes() {
- return ImmutableList.copyOf(recipes);
- }
-
- @Override
- public List<String> recipeTargets(String recipe) {
- return ImmutableList.copyOf(targets.getOrDefault(recipe, Collections.emptyList()));
- }
-
- @Override
- public List<String> recipePayloads(String recipe) {
- return ImmutableList.copyOf(payloads.getOrDefault(recipe, Collections.emptyList()));
- }
-
- /**
- * This method recursively traverses the A&AI named query response to find the generic-vnf
- * object that contains a model-invariant-id that matches the resourceId of the policy. Once
- * this match is found the generic-vnf object's vnf-id is returned.
- *
- * @param items the list of items related to the vnf returned by A&AI
- * @param resourceId the id of the target from the sdc catalog
- *
- * @return the vnf-id of the target vnf to act upon or null if not found
- */
- private static String parseAaiResponse(List<AaiNqInventoryResponseItem> items, String resourceId) {
- String vnfId = null;
- for (AaiNqInventoryResponseItem item : items) {
- if ((item.getGenericVnf() != null) && (item.getGenericVnf().getModelInvariantId() != null)
- && (resourceId.equals(item.getGenericVnf().getModelInvariantId()))) {
- vnfId = item.getGenericVnf().getVnfId();
- break;
- } else {
- if ((item.getItems() != null) && (item.getItems().getInventoryResponseItems() != null)) {
- vnfId = parseAaiResponse(item.getItems().getInventoryResponseItems(), resourceId);
- }
- }
- }
- return vnfId;
- }
-
- /**
- * Constructs an A&AI Named Query using a source vnf-id to determine the vnf-id of the target
- * entity specified in the policy to act upon.
- *
- * @param resourceId the id of the target from the sdc catalog
- *
- * @param sourceVnfId the vnf id of the source entity reporting the alert
- *
- * @return the target entities vnf id to act upon
- * @throws AaiException it an error occurs
- */
- public static String vnfNamedQuery(String resourceId, String sourceVnfId) throws AaiException {
-
- // TODO: This request id should not be hard coded in future releases
- UUID requestId = UUID.fromString("a93ac487-409c-4e8c-9e5f-334ae8f99087");
-
- AaiNqRequest aaiRequest = new AaiNqRequest();
- aaiRequest.setQueryParameters(new AaiNqQueryParameters());
- aaiRequest.getQueryParameters().setNamedQuery(new AaiNqNamedQuery());
- aaiRequest.getQueryParameters().getNamedQuery().setNamedQueryUuid(requestId);
-
- Map<String, Map<String, String>> filter = new HashMap<>();
- Map<String, String> filterItem = new HashMap<>();
-
- filterItem.put("vnf-id", sourceVnfId);
- filter.put("generic-vnf", filterItem);
-
- aaiRequest.setInstanceFilters(new AaiNqInstanceFilters());
- aaiRequest.getInstanceFilters().getInstanceFilter().add(filter);
-
- AaiNqResponse aaiResponse = new AaiManager(new RestManager()).postQuery(getPeManagerEnvProperty("aai.url"),
- getPeManagerEnvProperty("aai.username"), getPeManagerEnvProperty("aai.password"), aaiRequest,
- requestId);
-
- if (aaiResponse == null) {
- throw new AaiException("The named query response was null");
- }
-
- String targetVnfId = parseAaiResponse(aaiResponse.getInventoryResponseItems(), resourceId);
- if (targetVnfId == null) {
- throw new AaiException("Target vnf-id could not be found");
- }
-
- return targetVnfId;
- }
-
- /**
- * Constructs an APPC request conforming to the lcm API. The actual request is constructed and
- * then placed in a wrapper object used to send through DMAAP.
- *
- * @param onset the event that is reporting the alert for policy to perform an action
- * @param operation the control loop operation specifying the actor, operation, target, etc.
- * @param policy the policy the was specified from the yaml generated by CLAMP or through the
- * Policy GUI/API
- * @return an APPC request conforming to the lcm API using the DMAAP wrapper
- */
- public static LcmRequestWrapper constructRequest(VirtualControlLoopEvent onset, ControlLoopOperation operation,
- Policy policy, String targetVnf) {
-
- /* Construct an APPC request using LCM Model */
-
- /*
- * The actual LCM request is placed in a wrapper used to send through dmaap. The current
- * version is 2.0 as of R1.
- */
- AppcLcmRecipeFormatter lcmRecipeFormatter = new AppcLcmRecipeFormatter(policy.getRecipe());
-
- LcmRequestWrapper dmaapRequest = new LcmRequestWrapper();
- dmaapRequest.setVersion("2.0");
- dmaapRequest.setCorrelationId(onset.getRequestId() + "-" + operation.getSubRequestId());
- dmaapRequest.setRpcName(lcmRecipeFormatter.getUrlRecipe());
- dmaapRequest.setType("request");
-
- /* This is the actual request that is placed in the dmaap wrapper. */
- final LcmRequest appcRequest = new LcmRequest();
-
- /* The common header is a required field for all APPC requests. */
- LcmCommonHeader requestCommonHeader = new LcmCommonHeader();
- requestCommonHeader.setOriginatorId(onset.getRequestId().toString());
- requestCommonHeader.setRequestId(onset.getRequestId());
- requestCommonHeader.setSubRequestId(operation.getSubRequestId());
-
- appcRequest.setCommonHeader(requestCommonHeader);
-
- /*
- * Action Identifiers are required for APPC LCM requests. For R1, the recipes supported by
- * Policy only require a vnf-id.
- */
- HashMap<String, String> requestActionIdentifiers = new HashMap<>();
- requestActionIdentifiers.put("vnf-id", targetVnf);
-
- appcRequest.setActionIdentifiers(requestActionIdentifiers);
-
- /*
- * An action is required for all APPC requests, this will be the recipe specified in the
- * policy.
- */
- appcRequest.setAction(lcmRecipeFormatter.getBodyRecipe());
-
- /*
- * For R1, the payloads will not be required for the Restart, Rebuild, or Migrate recipes.
- * APPC will populate the payload based on A&AI look up of the vnd-id provided in the action
- * identifiers.
- */
- if (recipeSupportsPayload(policy.getRecipe()) && payloadSupplied(policy.getPayload())) {
- appcRequest.setPayload(parsePayload(policy.getPayload()));
- } else {
- appcRequest.setPayload(null);
- }
-
- /*
- * Once the LCM request is constructed, add it into the body of the dmaap wrapper.
- */
- dmaapRequest.setBody(appcRequest);
-
- /* Return the request to be sent through dmaap. */
- return dmaapRequest;
- }
-
- private static boolean payloadSupplied(Map<String, String> payload) {
- return payload != null && !payload.isEmpty();
- }
-
- private static boolean recipeSupportsPayload(String recipe) {
- return !RECIPE_RESTART.equalsIgnoreCase(recipe) && !RECIPE_REBUILD.equalsIgnoreCase(recipe)
- && !RECIPE_MIGRATE.equalsIgnoreCase(recipe);
- }
-
- private static String parsePayload(Map<String, String> payload) {
- StringBuilder payloadString = new StringBuilder("{");
- payload
- .forEach((key, value) -> payloadString.append("\"").append(key).append("\": ").append(value).append(","));
- return payloadString.substring(0, payloadString.length() - 1) + "}";
- }
-
- /**
- * Parses the operation attempt using the subRequestId of APPC response.
- *
- * @param subRequestId the sub id used to send to APPC, Policy sets this using the operation
- * attempt
- *
- * @return the current operation attempt
- */
- public static Integer parseOperationAttempt(String subRequestId) {
- Integer operationAttempt;
- try {
- operationAttempt = Integer.parseInt(subRequestId);
- } catch (NumberFormatException e) {
- logger.debug("A NumberFormatException was thrown due to error in parsing the operation attempt");
- return null;
- }
- return operationAttempt;
- }
-
- /**
- * Processes the APPC LCM response sent from APPC. Determines if the APPC operation was
- * successful/unsuccessful and maps this to the corresponding Policy result.
- *
- * @param dmaapResponse the dmaap wrapper message that contains the actual APPC reponse inside
- * the body field
- *
- * @return an key-value pair that contains the Policy result and APPC response message
- */
- public static SimpleEntry<PolicyResult, String> processResponse(LcmResponseWrapper dmaapResponse) {
- /* The actual APPC response is inside the wrapper's body field. */
- LcmResponse appcResponse = dmaapResponse.getBody();
-
- /* The message returned in the APPC response. */
- String message;
-
- /* The Policy result determined from the APPC Response. */
- PolicyResult result;
-
- /* If there is no status, Policy cannot determine if the request was successful. */
- if (appcResponse.getStatus() == null) {
- message = "Policy was unable to parse APP-C response status field (it was null).";
- return new AbstractMap.SimpleEntry<>(PolicyResult.FAILURE_EXCEPTION, message);
- }
-
- /* If there is no code, Policy cannot determine if the request was successful. */
- String responseValue = LcmResponseCode.toResponseValue(appcResponse.getStatus().getCode());
- if (responseValue == null) {
- message = "Policy was unable to parse APP-C response status code field.";
- return new AbstractMap.SimpleEntry<>(PolicyResult.FAILURE_EXCEPTION, message);
- }
-
- /* Save the APPC response's message for Policy notification message. */
- message = appcResponse.getStatus().getMessage();
-
- /* Maps the APPC response result to a Policy result. */
- switch (responseValue) {
- case LcmResponseCode.ACCEPTED:
- /* Nothing to do if code is accept, continue processing */
- result = null;
- break;
- case LcmResponseCode.SUCCESS:
- result = PolicyResult.SUCCESS;
- break;
- case LcmResponseCode.FAILURE:
- result = PolicyResult.FAILURE;
- break;
- case LcmResponseCode.REJECT:
- case LcmResponseCode.ERROR:
- default:
- result = PolicyResult.FAILURE_EXCEPTION;
- }
- return new AbstractMap.SimpleEntry<>(result, message);
- }
-
- /**
- * This method reads and validates environmental properties coming from the policy engine. Null
- * properties cause an {@link IllegalArgumentException} runtime exception to be thrown
- *
- * @param enginePropertyName the name of the parameter to retrieve
- * @return the property value
- */
- private static String getPeManagerEnvProperty(String enginePropertyName) {
- String enginePropertyValue = PolicyEngine.manager.getEnvironmentProperty(enginePropertyName);
- if (enginePropertyValue == null) {
- throw new IllegalArgumentException("The value of policy engine manager environment property \""
- + enginePropertyName + "\" may not be null");
- }
- return enginePropertyValue;
- }
-}
diff --git a/controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatter.java b/controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatter.java
deleted file mode 100644
index 12fad9e84..000000000
--- a/controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatter.java
+++ /dev/null
@@ -1,47 +0,0 @@
-/*
- * ============LICENSE_START=======================================================
- *
- * ================================================================================
- * Copyright (C) 2018 Nokia Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2018 AT&T Intellectual Property. 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.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.actor.appclcm;
-
-import com.google.common.collect.Lists;
-import java.util.stream.Collectors;
-import org.apache.commons.lang.StringUtils;
-
-class AppcLcmRecipeFormatter {
-
- private final String dashCasedRecipe;
-
- AppcLcmRecipeFormatter(String dashCasedRecipe) {
- this.dashCasedRecipe = dashCasedRecipe;
- }
-
- String getUrlRecipe() {
- return dashCasedRecipe.toLowerCase();
- }
-
- String getBodyRecipe() {
- return Lists.newArrayList(dashCasedRecipe.split("-"))
- .stream()
- .map(String::toLowerCase)
- .map(StringUtils::capitalize)
- .collect(Collectors.joining(""));
- }
-}
diff --git a/controlloop/common/actors/actor.appclcm/src/main/resources/META-INF/services/org.onap.policy.controlloop.actorServiceProvider.spi.Actor b/controlloop/common/actors/actor.appclcm/src/main/resources/META-INF/services/org.onap.policy.controlloop.actorServiceProvider.spi.Actor
deleted file mode 100644
index 403ad9859..000000000
--- a/controlloop/common/actors/actor.appclcm/src/main/resources/META-INF/services/org.onap.policy.controlloop.actorServiceProvider.spi.Actor
+++ /dev/null
@@ -1 +0,0 @@
-org.onap.policy.controlloop.actor.appclcm.AppcLcmActorServiceProvider \ No newline at end of file
diff --git a/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProviderTest.java b/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProviderTest.java
deleted file mode 100644
index 79bcf153f..000000000
--- a/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProviderTest.java
+++ /dev/null
@@ -1,442 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * AppcServiceProviderTest
- * ================================================================================
- * Copyright (C) 2017-2018 AT&T Intellectual Property. 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.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.actor.appclcm;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.fail;
-
-import java.time.Instant;
-import java.util.AbstractMap;
-import java.util.HashMap;
-import java.util.UUID;
-
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
-import org.junit.Test;
-import org.onap.policy.aai.util.AaiException;
-import org.onap.policy.appclcm.LcmCommonHeader;
-import org.onap.policy.appclcm.LcmRequest;
-import org.onap.policy.appclcm.LcmRequestWrapper;
-import org.onap.policy.appclcm.LcmResponse;
-import org.onap.policy.appclcm.LcmResponseWrapper;
-import org.onap.policy.common.endpoints.http.server.HttpServletServer;
-import org.onap.policy.controlloop.ControlLoopEventStatus;
-import org.onap.policy.controlloop.ControlLoopOperation;
-import org.onap.policy.controlloop.ControlLoopTargetType;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.policy.Policy;
-import org.onap.policy.controlloop.policy.PolicyResult;
-import org.onap.policy.controlloop.policy.Target;
-import org.onap.policy.controlloop.policy.TargetType;
-import org.onap.policy.drools.system.PolicyEngine;
-import org.onap.policy.simulators.Util;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-
-public class AppcLcmActorServiceProviderTest {
-
- private static final Logger logger = LoggerFactory.getLogger(AppcLcmActorServiceProviderTest.class);
-
- private static final VirtualControlLoopEvent onsetEvent;
- private static final ControlLoopOperation operation;
- private static final Policy policy;
- private static final LcmResponseWrapper dmaapResponse;
-
- private static final String RECIPE_RESTART = "Restart";
- private static final String RECIPE_REBUILD = "Rebuild";
- private static final String RECIPE_MIGRATE = "Migrate";
-
- static {
- /*
- * Construct an onset with an AAI subtag containing generic-vnf.vnf-id and a target type of
- * VM.
- */
- onsetEvent = new VirtualControlLoopEvent();
- onsetEvent.setClosedLoopControlName("closedLoopControlName-Test");
- onsetEvent.setRequestId(UUID.randomUUID());
- onsetEvent.setClosedLoopEventClient("tca.instance00001");
- onsetEvent.setTargetType(ControlLoopTargetType.VM);
- onsetEvent.setTarget("generic-vnf.vnf-name");
- onsetEvent.setFrom("DCAE");
- onsetEvent.setClosedLoopAlarmStart(Instant.now());
- onsetEvent.setAai(new HashMap<>());
- onsetEvent.getAai().put("generic-vnf.vnf-name", "fw0001vm001fw001");
- onsetEvent.setClosedLoopEventStatus(ControlLoopEventStatus.ONSET);
-
- /* Construct an operation with an APPC actor and restart operation. */
- operation = new ControlLoopOperation();
- operation.setActor("APPC");
- operation.setOperation("Restart");
- operation.setTarget("VM");
- operation.setEnd(Instant.now());
- operation.setSubRequestId("1");
-
- /* Construct a policy specifying to restart vm. */
- policy = new Policy();
- policy.setName("Restart the VM");
- policy.setDescription("Upon getting the trigger event, restart the VM");
- policy.setActor("APPC");
- policy.setTarget(new Target(TargetType.VNF));
- policy.setRecipe("Restart");
- policy.setPayload(null);
- policy.setRetry(2);
- policy.setTimeout(300);
-
- /* A sample DMAAP request wrapper. */
- LcmRequestWrapper dmaapRequest = new LcmRequestWrapper();
- dmaapRequest.setCorrelationId(onsetEvent.getRequestId().toString() + "-" + "1");
- dmaapRequest.setRpcName(policy.getRecipe().toLowerCase());
- dmaapRequest.setType("request");
-
- /* A sample DMAAP response wrapper */
- dmaapResponse = new LcmResponseWrapper();
- dmaapResponse.setCorrelationId(onsetEvent.getRequestId().toString() + "-" + "1");
- dmaapResponse.setRpcName(policy.getRecipe().toLowerCase());
- dmaapResponse.setType("response");
-
- /* Set environment properties */
- PolicyEngine.manager.setEnvironmentProperty("aai.url", "http://localhost:6666");
- PolicyEngine.manager.setEnvironmentProperty("aai.username", "AAI");
- PolicyEngine.manager.setEnvironmentProperty("aai.password", "AAI");
-
- /* A sample APPC LCM request. */
- LcmRequest appcRequest = new LcmRequest();
-
- /* The following code constructs a sample APPC LCM Request */
- appcRequest.setAction("restart");
-
- HashMap<String, String> actionIdentifiers = new HashMap<>();
- actionIdentifiers.put("vnf-id", "trial-vnf-003");
-
- appcRequest.setActionIdentifiers(actionIdentifiers);
-
- LcmCommonHeader commonHeader = new LcmCommonHeader();
- commonHeader.setRequestId(onsetEvent.getRequestId());
- commonHeader.setSubRequestId("1");
- commonHeader.setOriginatorId(onsetEvent.getRequestId().toString());
-
- appcRequest.setCommonHeader(commonHeader);
-
- appcRequest.setPayload(null);
-
- dmaapRequest.setBody(appcRequest);
-
- /* The following code constructs a sample APPC LCM Response */
- LcmResponse appcResponse = new LcmResponse(appcRequest);
- appcResponse.getStatus().setCode(400);
- appcResponse.getStatus().setMessage("Restart Successful");
-
- dmaapResponse.setBody(appcResponse);
- }
-
- /**
- * Set up before test class.
- */
- @BeforeClass
- public static void setUpSimulator() {
- try {
- Util.buildAaiSim();
- } catch (Exception e) {
- fail(e.getMessage());
- }
- }
-
- /**
- * Tear down after test class.
- */
- @AfterClass
- public static void tearDownSimulator() {
- HttpServletServer.factory.destroy();
- }
-
- /**
- * A test to construct an APPC LCM restart request.
- */
- @Test
- public void constructRestartRequestTest() {
-
- LcmRequestWrapper dmaapRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, policy, "vnf01");
-
- /* The service provider must return a non null DMAAP request wrapper */
- assertNotNull(dmaapRequest);
-
- /* The DMAAP wrapper's type field must be request */
- assertEquals("request", dmaapRequest.getType());
-
- /* The DMAAP wrapper's body field cannot be null */
- assertNotNull(dmaapRequest.getBody());
-
- LcmRequest appcRequest = dmaapRequest.getBody();
-
- /* A common header is required and cannot be null */
- assertNotNull(appcRequest.getCommonHeader());
- assertEquals(appcRequest.getCommonHeader().getRequestId(), onsetEvent.getRequestId());
-
- /* An action is required and cannot be null */
- assertNotNull(appcRequest.getAction());
- assertEquals("Restart", appcRequest.getAction());
-
- /* Action Identifiers are required and cannot be null */
- assertNotNull(appcRequest.getActionIdentifiers());
- assertNotNull(appcRequest.getActionIdentifiers().get("vnf-id"));
- assertEquals("vnf01", appcRequest.getActionIdentifiers().get("vnf-id"));
-
- logger.debug("APPC Request: \n" + appcRequest.toString());
- }
-
- /**
- * A test to process a successful APPC restart response.
- */
- @Test
- public void processRestartResponseSuccessTest() {
- AbstractMap.SimpleEntry<PolicyResult, String> result =
- AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.SUCCESS, result.getKey());
- assertEquals("Restart Successful", result.getValue());
- }
-
- /**
- * A test to map APPC response results to corresponding Policy results.
- */
- @Test
- public void appcToPolicyResultTest() {
-
- AbstractMap.SimpleEntry<PolicyResult, String> result;
-
- /* If APPC accepts, PolicyResult is null */
- dmaapResponse.getBody().getStatus().setCode(100);
- dmaapResponse.getBody().getStatus().setMessage("ACCEPTED");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertNull(result.getKey());
-
- /* If APPC is successful, PolicyResult is success */
- dmaapResponse.getBody().getStatus().setCode(400);
- dmaapResponse.getBody().getStatus().setMessage("SUCCESS");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.SUCCESS, result.getKey());
-
- /* If APPC returns an error, PolicyResult is failure exception */
- dmaapResponse.getBody().getStatus().setCode(200);
- dmaapResponse.getBody().getStatus().setMessage("ERROR");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- /* If APPC rejects, PolicyResult is failure exception */
- dmaapResponse.getBody().getStatus().setCode(300);
- dmaapResponse.getBody().getStatus().setMessage("REJECT");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- /* Test multiple reject codes */
- dmaapResponse.getBody().getStatus().setCode(306);
- dmaapResponse.getBody().getStatus().setMessage("REJECT");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- dmaapResponse.getBody().getStatus().setCode(313);
- dmaapResponse.getBody().getStatus().setMessage("REJECT");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- /* If APPC returns failure, PolicyResult is failure */
- dmaapResponse.getBody().getStatus().setCode(401);
- dmaapResponse.getBody().getStatus().setMessage("FAILURE");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE, result.getKey());
-
- /* Test multiple failure codes */
- dmaapResponse.getBody().getStatus().setCode(406);
- dmaapResponse.getBody().getStatus().setMessage("FAILURE");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE, result.getKey());
-
- dmaapResponse.getBody().getStatus().setCode(450);
- dmaapResponse.getBody().getStatus().setMessage("FAILURE");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE, result.getKey());
-
- /* If APPC returns partial success, PolicyResult is failure exception */
- dmaapResponse.getBody().getStatus().setCode(500);
- dmaapResponse.getBody().getStatus().setMessage("PARTIAL SUCCESS");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- /* If APPC returns partial failure, PolicyResult is failure exception */
- dmaapResponse.getBody().getStatus().setCode(501);
- dmaapResponse.getBody().getStatus().setMessage("PARTIAL FAILURE");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- /* Test multiple partial failure codes */
- dmaapResponse.getBody().getStatus().setCode(599);
- dmaapResponse.getBody().getStatus().setMessage("PARTIAL FAILURE");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- dmaapResponse.getBody().getStatus().setCode(550);
- dmaapResponse.getBody().getStatus().setMessage("PARTIAL FAILURE");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
-
- /* If APPC code is unknown to Policy, PolicyResult is failure exception */
- dmaapResponse.getBody().getStatus().setCode(700);
- dmaapResponse.getBody().getStatus().setMessage("UNKNOWN");
- result = AppcLcmActorServiceProvider.processResponse(dmaapResponse);
- assertEquals(PolicyResult.FAILURE_EXCEPTION, result.getKey());
- }
-
- /**
- * This test ensures that that if the the source entity is also the target entity, the source
- * will be used for the APPC request.
- */
- @Test
- public void sourceIsTargetTest() {
- String resourceId = "82194af1-3c2c-485a-8f44-420e22a9eaa4";
- String targetVnfId = null;
- try {
- targetVnfId = AppcLcmActorServiceProvider.vnfNamedQuery(resourceId, "vnf01");
- } catch (AaiException e) {
- logger.warn(e.toString());
- fail("no vnf-id found");
- }
- assertNotNull(targetVnfId);
- assertEquals("vnf01", targetVnfId);
- }
-
- /**
- * THis test exercises getters not exercised in other tests.
- */
- @Test
- public void testMethods() {
- AppcLcmActorServiceProvider sp = new AppcLcmActorServiceProvider();
-
- assertEquals("APPC", sp.actor());
- assertEquals(4, sp.recipes().size());
- assertEquals("VM", sp.recipeTargets("Restart").get(0));
- assertEquals("vm-id", sp.recipePayloads("Restart").get(0));
- }
-
- @Test
- public void payloadNotPassedWhenNotSupportedByRecipe() {
- //given
- Policy migratePolicy = constructPolicyWithRecipe(RECIPE_MIGRATE);
- Policy rebuildPolicy = constructPolicyWithRecipe(RECIPE_REBUILD);
- Policy restartPolicy = constructPolicyWithRecipe(RECIPE_RESTART);
-
- // when
- LcmRequestWrapper migrateRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, migratePolicy, "vnf01");
- LcmRequestWrapper rebuildRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, rebuildPolicy, "vnf01");
- LcmRequestWrapper restartRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, restartPolicy, "vnf01");
-
- // then
- assertNull(migrateRequest.getBody().getPayload());
- assertNull(rebuildRequest.getBody().getPayload());
- assertNull(restartRequest.getBody().getPayload());
- }
-
- @Test
- public void payloadNotPassedWhenNotSuppliedOrEmpty() {
- //given
- Policy noPayloadPolicy = constructHealthCheckPolicyWithPayload(null);
- Policy emptyPayloadPolicy = constructHealthCheckPolicyWithPayload(new HashMap<>());
-
- // when
- LcmRequestWrapper noPayloadRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, noPayloadPolicy, "vnf01");
- LcmRequestWrapper emptyPayloadRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, emptyPayloadPolicy, "vnf01");
-
-
- // then
- assertNull(noPayloadRequest.getBody().getPayload());
- assertNull(emptyPayloadRequest.getBody().getPayload());
- }
-
- @Test
- public void payloadParsedProperlyForSinglePayloadParameter() {
- // given
- HashMap<String, String> payload = new HashMap<>();
- payload.put("requestParameters", "{\"host-ip-address\":\"10.183.37.25\"}");
- Policy otherPolicy = constructHealthCheckPolicyWithPayload(payload);
-
- // when
- LcmRequestWrapper dmaapRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, otherPolicy, "vnf01");
-
- // then
- assertEquals(dmaapRequest.getBody().getPayload(),
- "{\"requestParameters\": {\"host-ip-address\":\"10.183.37.25\"}}");
- }
-
-
- @Test
- public void payloadParsedProperlyForMultiplePayloadParameters() {
- // given
- HashMap<String, String> payload = new HashMap<>();
- payload.put("requestParameters", "{\"host-ip-address\":\"10.183.37.25\"}");
- payload.put("configurationParameters", "[{\"ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[9]\","
- + "\"oam-ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[16]\","
- + "\"enabled\":\"$.vf-module-topology.vf-module-parameters.param[23]\"}]");
- Policy otherPolicy = constructHealthCheckPolicyWithPayload(payload);
-
- // when
- LcmRequestWrapper dmaapRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, otherPolicy, "vnf01");
-
- // then
- assertEquals(dmaapRequest.getBody().getPayload(),
- "{\"requestParameters\": "
- + "{\"host-ip-address\":\"10.183.37.25\"},"
- + "\"configurationParameters\": "
- + "[{\"ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[9]\","
- + "\"oam-ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[16]\","
- + "\"enabled\":\"$.vf-module-topology.vf-module-parameters.param[23]\"}]"
- + "}");
- }
-
- private Policy constructHealthCheckPolicyWithPayload(HashMap<String, String> payload) {
- return constructHealthCheckPolicyWithPayloadAndRecipe(payload, "Health-Check");
- }
-
- private Policy constructPolicyWithRecipe(String recipe) {
- return constructHealthCheckPolicyWithPayloadAndRecipe(null, recipe);
- }
-
- private Policy constructHealthCheckPolicyWithPayloadAndRecipe(HashMap<String, String> payload, String recipe) {
- Policy otherPolicy = new Policy();
- otherPolicy.setName("Perform health check");
- otherPolicy.setDescription("Upon getting the trigger event, perform health check");
- otherPolicy.setActor("APPC");
- otherPolicy.setTarget(new Target(TargetType.VNF));
- otherPolicy.setRecipe(recipe);
- otherPolicy.setPayload(payload);
- otherPolicy.setRetry(2);
- otherPolicy.setTimeout(300);
- return otherPolicy;
- }
-}
diff --git a/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatterTest.java b/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatterTest.java
deleted file mode 100644
index e63b04acd..000000000
--- a/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmRecipeFormatterTest.java
+++ /dev/null
@@ -1,98 +0,0 @@
-/*
- * ============LICENSE_START=======================================================
- *
- * ================================================================================
- * Copyright (C) 2018 Nokia Intellectual Property. 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.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.actor.appclcm;
-
-import static org.junit.Assert.assertEquals;
-
-import org.junit.Test;
-
-
-
-public class AppcLcmRecipeFormatterTest {
-
- @Test
- public void shouldCorrectlyFormatRestartRequestWhenRestartGiven() {
- //given
- AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("Restart");
- String expectedUrlRecipe = "restart";
- String expectedBodyRecipe = "Restart";
-
- //when
- String actualUrlRecipe = recipeFormatter.getUrlRecipe();
- String actualBodyRecipe = recipeFormatter.getBodyRecipe();
-
- //then
- assertEquals(expectedUrlRecipe, actualUrlRecipe);
- assertEquals(expectedBodyRecipe, actualBodyRecipe);
- }
-
- @Test
- public void shouldReturnCapitalizedBodySingleWordRecipe() {
- //given
- AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("moDify");
- String expectedRecipe = "Modify";
-
- //when
- String actualRecipe = recipeFormatter.getBodyRecipe();
-
- //then
- assertEquals(expectedRecipe, actualRecipe);
- }
-
- @Test
- public void shouldReturnCapitalizeAndJoinedBodyMultiWordRecipe() {
- //given
- AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("coNfig-moDify");
- String expectedRecipe = "ConfigModify";
-
- //when
- String actualRecipe = recipeFormatter.getBodyRecipe();
-
- //then
- assertEquals(expectedRecipe, actualRecipe);
- }
-
- @Test
- public void shouldReturnLowercasedUrlSingleWordRecipe() {
- //given
- AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("ModIfy");
- String expectedRecipe = "modify";
-
- //when
- String actualRecipe = recipeFormatter.getUrlRecipe();
-
- //then
- assertEquals(expectedRecipe, actualRecipe);
- }
-
- @Test
- public void shouldReturnLowercasedDashJoinedUrlMultiWordRecipe() {
- //given
- AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("Config-MoDify");
- String expectedRecipe = "config-modify";
-
- //when
- String actualRecipe = recipeFormatter.getUrlRecipe();
-
- //then
- assertEquals(expectedRecipe, actualRecipe);
- }
-} \ No newline at end of file