aboutsummaryrefslogtreecommitdiffstats
path: root/controlloop/common/actors/actor.appclcm
diff options
context:
space:
mode:
authormmis <michael.morris@ericsson.com>2018-03-21 15:22:10 +0000
committermmis <michael.morris@ericsson.com>2018-03-22 13:58:39 +0000
commitaf861a9d8e28d49d357ead4a4acad82554510b6f (patch)
tree8f21c330990242ed4a2b40b13bae811a9affc7fb /controlloop/common/actors/actor.appclcm
parent512a8f5b4dc9afaf382dd76531dcbc0667551c58 (diff)
Removed checkstyle warnings
Removed checkstyle warnings in: policy/drools-applications/controlloop/common/actors policy/drools-applications/controlloop/common/eventmanager policy/drools-applications/controlloop/common/feature-controlloop-utils Issue-ID: POLICY-705 Change-Id: Iccf99b291bc62bc3ba2082ccdb4c1f9e12107896 Signed-off-by: mmis <michael.morris@ericsson.com>
Diffstat (limited to 'controlloop/common/actors/actor.appclcm')
-rw-r--r--controlloop/common/actors/actor.appclcm/src/main/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmActorServiceProvider.java582
-rw-r--r--controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmServiceProviderTest.java116
2 files changed, 344 insertions, 354 deletions
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
index 1635094f9..f2d0991e2 100644
--- 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
@@ -2,7 +2,7 @@
* ============LICENSE_START=======================================================
* AppcLcmActorServiceProvider
* ================================================================================
- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * 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.
@@ -31,9 +31,9 @@ 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.AAIManager;
import org.onap.policy.aai.AAINQNamedQuery;
import org.onap.policy.aai.AAINQQueryParameters;
import org.onap.policy.aai.AAINQRequest;
@@ -57,302 +57,284 @@ 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
- */
- 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.
- */
- LCMRequestWrapper dmaapRequest = new LCMRequestWrapper();
- dmaapRequest.setVersion("2.0");
- dmaapRequest.setCorrelationId(onset.getRequestID() + "-" + operation.getSubRequestId());
- dmaapRequest.setRpcName(policy.getRecipe().toLowerCase());
- dmaapRequest.setType("request");
-
- /* This is the actual request that is placed in the dmaap wrapper. */
- 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(policy.getRecipe().substring(0, 1).toUpperCase()
- + policy.getRecipe().substring(1).toLowerCase());
-
- /*
- * 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 (RECIPE_RESTART.equalsIgnoreCase(policy.getRecipe()) || RECIPE_REBUILD.equalsIgnoreCase(policy.getRecipe())
- || RECIPE_MIGRATE.equalsIgnoreCase(policy.getRecipe())) {
- 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;
- }
-
- /**
- * 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 noticiation 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 string 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;
- }
+ 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.
+ */
+ LCMRequestWrapper dmaapRequest = new LCMRequestWrapper();
+ dmaapRequest.setVersion("2.0");
+ dmaapRequest.setCorrelationId(onset.getRequestID() + "-" + operation.getSubRequestId());
+ dmaapRequest.setRpcName(policy.getRecipe().toLowerCase());
+ 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(
+ policy.getRecipe().substring(0, 1).toUpperCase() + policy.getRecipe().substring(1).toLowerCase());
+
+ /*
+ * 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 (RECIPE_RESTART.equalsIgnoreCase(policy.getRecipe()) || RECIPE_REBUILD.equalsIgnoreCase(policy.getRecipe())
+ || RECIPE_MIGRATE.equalsIgnoreCase(policy.getRecipe())) {
+ 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;
+ }
+
+ /**
+ * 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 noticiation 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 string 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/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmServiceProviderTest.java b/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmServiceProviderTest.java
index cf5360202..50b03c6b4 100644
--- a/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmServiceProviderTest.java
+++ b/controlloop/common/actors/actor.appclcm/src/test/java/org/onap/policy/controlloop/actor/appclcm/AppcLcmServiceProviderTest.java
@@ -2,7 +2,7 @@
* ============LICENSE_START=======================================================
* AppcServiceProviderTest
* ================================================================================
- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * 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.
@@ -20,7 +20,9 @@
package org.onap.policy.controlloop.actor.appclcm;
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.fail;
import java.time.Instant;
import java.util.AbstractMap;
@@ -51,9 +53,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class AppcLcmServiceProviderTest {
-
+
private static final Logger logger = LoggerFactory.getLogger(AppcLcmServiceProviderTest.class);
-
+
private static VirtualControlLoopEvent onsetEvent;
private static ControlLoopOperation operation;
private static Policy policy;
@@ -61,9 +63,9 @@ public class AppcLcmServiceProviderTest {
private static LCMResponseWrapper dmaapResponse;
static {
- /*
- * Construct an onset with an AAI subtag containing
- * generic-vnf.vnf-id and a target type of VM.
+ /*
+ * 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");
@@ -84,7 +86,7 @@ public class AppcLcmServiceProviderTest {
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");
@@ -107,30 +109,30 @@ public class AppcLcmServiceProviderTest {
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);
@@ -142,7 +144,10 @@ public class AppcLcmServiceProviderTest {
dmaapResponse.setBody(appcResponse);
}
-
+
+ /**
+ * Set up before test class.
+ */
@BeforeClass
public static void setUpSimulator() {
try {
@@ -152,30 +157,34 @@ public class AppcLcmServiceProviderTest {
}
}
+ /**
+ * 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");
+
+ 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());
@@ -188,7 +197,7 @@ public class AppcLcmServiceProviderTest {
assertNotNull(appcRequest.getActionIdentifiers());
assertNotNull(appcRequest.getActionIdentifiers().get("vnf-id"));
assertEquals("vnf01", appcRequest.getActionIdentifiers().get("vnf-id"));
-
+
logger.debug("APPC Request: \n" + appcRequest.toString());
}
@@ -197,106 +206,105 @@ public class AppcLcmServiceProviderTest {
*/
@Test
public void processRestartResponseSuccessTest() {
- AbstractMap.SimpleEntry<PolicyResult, String> result = AppcLcmActorServiceProvider
- .processResponse(dmaapResponse);
+ 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
+ * 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);
assertEquals(null, 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
+ * 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() {
@@ -311,17 +319,17 @@ public class AppcLcmServiceProviderTest {
assertNotNull(targetVnfId);
assertEquals("vnf01", targetVnfId);
}
-
+
/**
- * THis test exercises getters not exercised in other tests
+ * 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));
+ 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));
}
}