* ONAP Policy API\r
* ================================================================================\r
* Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.\r
- * Modifications Copyright (C) 2019 Nordix Foundation.\r
+ * Modifications Copyright (C) 2019-2020 Nordix Foundation.\r
* ================================================================================\r
* Licensed under the Apache License, Version 2.0 (the "License");\r
* you may not use this file except in compliance with the License.\r
import java.util.List;\r
import java.util.Map;\r
import java.util.function.BiConsumer;\r
+\r
import javax.ws.rs.core.Response;\r
\r
import org.apache.commons.lang3.tuple.Pair;\r
import org.onap.policy.models.provider.PolicyModelsProvider;\r
import org.onap.policy.models.provider.PolicyModelsProviderFactory;\r
import org.onap.policy.models.provider.PolicyModelsProviderParameters;\r
-import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;\r
-import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
\r
/**\r
* Super class for providers that use a model provider.\r
modelsProvider.close();\r
}\r
\r
- /**\r
- * Checks if service template contains any policy.\r
- *\r
- * @param serviceTemplate the service template to check against\r
- *\r
- * @return boolean whether service template contains any policy\r
- */\r
- protected boolean hasPolicy(ToscaServiceTemplate serviceTemplate) {\r
-\r
- return hasData(serviceTemplate.getToscaTopologyTemplate().getPolicies());\r
- }\r
-\r
- /**\r
- * Checks if service template contains any policy type.\r
- *\r
- * @param serviceTemplate the service template to check against\r
- *\r
- * @return boolean whether service template contains any policy type\r
- */\r
- protected boolean hasPolicyType(ToscaServiceTemplate serviceTemplate) {\r
-\r
- return hasData(serviceTemplate.getPolicyTypes());\r
- }\r
-\r
- /**\r
- * Checks if the first element of a list of maps contains data.\r
- *\r
- * @param listOfMapsToCheck list of maps to be examined\r
- * @return {@code true} if the list contains data, {@code false} otherwise\r
- */\r
- protected <T> boolean hasData(List<Map<String, T>> listOfMapsToCheck) {\r
-\r
- return (listOfMapsToCheck != null && !listOfMapsToCheck.isEmpty() && !listOfMapsToCheck.get(0).isEmpty());\r
- }\r
-\r
-\r
- /**\r
- * Checks if a maps contains data.\r
- *\r
- * @param mapToCheck map to be examined\r
- * @return {@code true} if the list contains data, {@code false} otherwise\r
- */\r
- protected <T> boolean hasData(Map<String, T> mapToCheck) {\r
-\r
- // We don't allow a null or empty map as well as a map entry with a valid key but null value\r
- return (mapToCheck != null && !mapToCheck.isEmpty() && !mapToCheck.containsValue(null));\r
- }\r
-\r
- /**\r
- * Validates that some text represents a number.\r
- *\r
- * @param text text to be validated\r
- * @param errorMsg error message included in the exception, if the text is not a valid\r
- * number\r
- * @throws PfModelException if the text is not a valid number\r
- */\r
- protected void validNumber(String text, String errorMsg) throws PfModelException {\r
- try {\r
- Integer.parseInt(text);\r
-\r
- } catch (NumberFormatException exc) {\r
- throw new PfModelException(Response.Status.BAD_REQUEST, errorMsg, exc);\r
- }\r
- }\r
-\r
- /**\r
- * Constructs returned message for policy delete rule violation.\r
- *\r
- * @param policyId the ID of policy\r
- * @param policyVersion the version of policy\r
- * @param pdpGroups the list of pdp groups\r
- *\r
- * @return the constructed message\r
- */\r
- protected String constructDeletePolicyViolationMessage(String policyId, String policyVersion,\r
- List<PdpGroup> pdpGroups) {\r
-\r
- List<String> pdpGroupNameVersionList = new ArrayList<>(pdpGroups.size());\r
- for (PdpGroup pdpGroup : pdpGroups) {\r
- pdpGroupNameVersionList.add(pdpGroup.getName() + ":" + pdpGroup.getVersion());\r
- }\r
- String deployedPdpGroups = String.join(",", pdpGroupNameVersionList);\r
- return "policy with ID " + policyId + ":" + policyVersion\r
- + " cannot be deleted as it is deployed in pdp groups " + deployedPdpGroups;\r
- }\r
-\r
- /**\r
- * Constructs returned message for policy type delete rule violation.\r
- *\r
- * @param policyTypeId the ID of policy type\r
- * @param policyTypeVersion the version of policy type\r
- * @param policies the list of policies that parameterizes specified policy type\r
- *\r
- * @return the constructed message\r
- */\r
- protected String constructDeletePolicyTypeViolationMessage(String policyTypeId, String policyTypeVersion,\r
- List<ToscaPolicy> policies) {\r
-\r
- List<String> policyNameVersionList = new ArrayList<>(policies.size());\r
- for (ToscaPolicy policy : policies) {\r
- policyNameVersionList.add(policy.getName() + ":" + policy.getVersion());\r
- }\r
- String parameterizedPolicies = String.join(",", policyNameVersionList);\r
- return "policy type with ID " + policyTypeId + ":" + policyTypeVersion\r
- + " cannot be deleted as it is parameterized by policies " + parameterizedPolicies;\r
- }\r
-\r
/**\r
* Collects all deployed versions of specified policy in all pdp groups.\r
*\r
}\r
\r
@FunctionalInterface\r
- protected interface BiFunctionWithEx<T,U,R> {\r
+ protected interface BiFunctionWithEx<T, U, R> {\r
public R apply(T value1, U value2) throws PfModelException;\r
}\r
\r
/**\r
- * Checks if the list of pdp groups is empty.\r
- * If so, throws exception saying specified policy deployment is not found in all existing pdp groups.\r
+ * Checks if the list of pdp groups is empty. If so, throws exception saying specified policy deployment is not\r
+ * found in all existing pdp groups.\r
*\r
* @param pdpGroups the list of pdp groups to check against\r
* @param policyType the concept key of policy type\r
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- private List<PdpGroup> getPolicyTypeFilteredPdpGroups(PfConceptKey policyType)\r
- throws PfModelException {\r
+ private List<PdpGroup> getPolicyTypeFilteredPdpGroups(PfConceptKey policyType) throws PfModelException {\r
\r
List<ToscaPolicyTypeIdentifier> policyTypes = new ArrayList<>();\r
policyTypes.add(new ToscaPolicyTypeIdentifier(policyType.getName(), policyType.getVersion()));\r
- PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder().policyTypeList(policyTypes)\r
- .groupState(PdpState.ACTIVE).pdpState(PdpState.ACTIVE).build();\r
+ PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder().policyTypeList(policyTypes).groupState(PdpState.ACTIVE)\r
+ .pdpState(PdpState.ACTIVE).build();\r
return modelsProvider.getFilteredPdpGroups(pdpGroupFilter);\r
}\r
\r
*/\r
private <T, R> Map<Pair<String, String>, T> constructDeployedPolicyMap(List<PdpGroup> pdpGroups, String policyId,\r
PfConceptKey policyType, BiFunctionWithEx<String, String, R> getter, BiConsumer<T, R> consumer, T data)\r
- throws PfModelException {\r
+ throws PfModelException {\r
\r
Map<Pair<String, String>, T> deployedPolicyMap = new HashMap<>();\r
for (PdpGroup pdpGroup : pdpGroups) {\r
* @return the trimmed version\r
*/\r
private String getTrimedVersionForLegacyType(String fullVersion, PfConceptKey policyType) {\r
- return (policyType.getName().contains("guard")\r
- || policyType.getName().contains("Operational")) ? fullVersion.split("\\.")[0] : fullVersion;\r
+ return (policyType.getName().contains("guard") || policyType.getName().contains("Operational"))\r
+ ? fullVersion.split("\\.")[0]\r
+ : fullVersion;\r
}\r
\r
/**\r
*/\r
private String constructDeploymentNotFoundMessage(PfConceptKey policyType, String policyId) {\r
\r
- return "could not find policy with ID " + policyId + " and type "\r
- + policyType.getName() + ":" + policyType.getVersion() + " deployed in any pdp group";\r
+ return "could not find policy with ID " + policyId + " and type " + policyType.getName() + ":"\r
+ + policyType.getVersion() + " deployed in any pdp group";\r
}\r
}\r
import java.util.List;\r
import java.util.Map;\r
\r
-import javax.ws.rs.core.Response;\r
-\r
import org.apache.commons.lang3.tuple.Pair;\r
import org.onap.policy.models.base.PfConceptKey;\r
import org.onap.policy.models.base.PfModelException;\r
public ToscaServiceTemplate fetchPolicies(String policyTypeId, String policyTypeVersion, String policyId,\r
String policyVersion) throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate =\r
- getFilteredPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
-\r
- if (!hasPolicy(serviceTemplate)) {\r
- throw new PfModelException(Response.Status.NOT_FOUND,\r
- constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, policyVersion));\r
- }\r
-\r
- return serviceTemplate;\r
+ return getFilteredPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
}\r
\r
/**\r
public ToscaServiceTemplate fetchLatestPolicies(String policyTypeId, String policyTypeVersion, String policyId)\r
throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate =\r
- getFilteredPolicies(policyTypeId, policyTypeVersion, policyId, ToscaPolicyFilter.LATEST_VERSION);\r
-\r
- if (!hasPolicy(serviceTemplate)) {\r
- throw new PfModelException(Response.Status.NOT_FOUND,\r
- constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, null));\r
- }\r
-\r
- return serviceTemplate;\r
+ return getFilteredPolicies(policyTypeId, policyTypeVersion, policyId, ToscaPolicyFilter.LATEST_VERSION);\r
}\r
\r
/**\r
public ToscaServiceTemplate deletePolicy(String policyTypeId, String policyTypeVersion, String policyId,\r
String policyVersion) throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate = modelsProvider.deletePolicy(policyId, policyVersion);\r
-\r
- if (!hasPolicy(serviceTemplate)) {\r
- throw new PfModelException(Response.Status.NOT_FOUND,\r
- constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, policyVersion));\r
- }\r
-\r
- return serviceTemplate;\r
+ return modelsProvider.deletePolicy(policyId, policyVersion);\r
}\r
\r
/**\r
.type(policyTypeName).typeVersion(policyTypeVersion).build();\r
return modelsProvider.getFilteredPolicies(policyFilter);\r
}\r
-\r
- /**\r
- * Constructs returned message for not found resource.\r
- *\r
- * @param policyTypeId the ID of policy type\r
- * @param policyTypeVersion the version of policy type\r
- * @param policyId the ID of policy\r
- * @param policyVersion the version of policy\r
- *\r
- * @return constructed message\r
- */\r
- private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion, String policyId,\r
- String policyVersion) {\r
-\r
- return "policy with ID " + policyId + ":" + policyVersion + " and type " + policyTypeId + ":"\r
- + policyTypeVersion + " does not exist";\r
- }\r
}\r
\r
package org.onap.policy.api.main.rest.provider;\r
\r
-import javax.ws.rs.core.Response;\r
-\r
import org.onap.policy.models.base.PfModelException;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion)\r
throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate = getFilteredPolicyTypes(policyTypeId, policyTypeVersion);\r
-\r
- if (policyTypeId != null && !hasPolicyType(serviceTemplate)) {\r
- throw new PfModelException(Response.Status.NOT_FOUND,\r
- constructResourceNotFoundMessage(policyTypeId, policyTypeVersion));\r
- }\r
-\r
- return serviceTemplate;\r
+ return getFilteredPolicyTypes(policyTypeId, policyTypeVersion);\r
}\r
\r
/**\r
*/\r
public ToscaServiceTemplate fetchLatestPolicyTypes(String policyTypeId) throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate =\r
- getFilteredPolicyTypes(policyTypeId, ToscaPolicyTypeFilter.LATEST_VERSION);\r
- if (!hasPolicyType(serviceTemplate)) {\r
- throw new PfModelException(Response.Status.NOT_FOUND, constructResourceNotFoundMessage(policyTypeId, null));\r
- }\r
-\r
- return serviceTemplate;\r
+ return getFilteredPolicyTypes(policyTypeId, ToscaPolicyTypeFilter.LATEST_VERSION);\r
}\r
\r
/**\r
*/\r
public ToscaServiceTemplate createPolicyType(ToscaServiceTemplate body) throws PfModelException {\r
\r
- if (!hasPolicyType(body)) {\r
- throw new PfModelException(Response.Status.BAD_REQUEST,\r
- "no policy types specified in the service template");\r
- }\r
-\r
return modelsProvider.createPolicyTypes(body);\r
}\r
\r
public ToscaServiceTemplate deletePolicyType(String policyTypeId, String policyTypeVersion)\r
throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate = modelsProvider.deletePolicyType(policyTypeId, policyTypeVersion);\r
-\r
- if (!hasPolicyType(serviceTemplate)) {\r
- throw new PfModelException(Response.Status.NOT_FOUND,\r
- constructResourceNotFoundMessage(policyTypeId, policyTypeVersion));\r
- }\r
-\r
- return serviceTemplate;\r
+ return modelsProvider.deletePolicyType(policyTypeId, policyTypeVersion);\r
}\r
\r
/**\r
ToscaPolicyTypeFilter.builder().name(policyTypeName).version(policyTypeVersion).build();\r
return modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
}\r
-\r
- /**\r
- * Constructs returned message for not found resource.\r
- *\r
- * @param policyTypeId the ID of policy type\r
- * @param policyTypeVersion the version of policy type\r
- *\r
- * @return constructed message\r
- */\r
- private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion) {\r
-\r
- return "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
- }\r
}\r
String firstPolicyType = response.getPolicyTypes().keySet().iterator().next();
response.getPolicyTypes().put(firstPolicyType, null);
Response rawResponse2 = createResource(POLICYTYPES, standardCoder.encode(response));
- assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), rawResponse2.getStatus());
+ assertEquals(Response.Status.NOT_FOUND.getStatusCode(), rawResponse2.getStatus());
ErrorResponse errorResponse = rawResponse2.readEntity(ErrorResponse.class);
- assertEquals("no policy types specified in the service template", errorResponse.getErrorMessage());
+ assertEquals("no policy types specified on service template", errorResponse.getErrorMessage());
}
@Test
}
private void testReadPolicyTypes(String mediaType) throws Exception {
- Response rawResponse = readResource(POLICYTYPES, mediaType);
+ Response rawResponse = readResource("policytypes/onap.policies.optimization.resource.HpaPolicy", mediaType);
+ assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
+ ToscaServiceTemplate namingServiceTemplate = rawResponse.readEntity(ToscaServiceTemplate.class);
+ assertNotNull(namingServiceTemplate);
+ assertEquals(3, namingServiceTemplate.getPolicyTypesAsMap().size());
+ assertEquals(5, namingServiceTemplate.getDataTypesAsMap().size());
+
+ rawResponse = readResource(POLICYTYPES, mediaType);
assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
ToscaServiceTemplate response = rawResponse.readEntity(ToscaServiceTemplate.class);
assertFalse(response.getPolicyTypes().isEmpty());
assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
}
+ @Test
+ public void testNamingPolicyGet() throws Exception {
+ Response rawResponse = createResource("policies", "policies/sdnc.policy.naming.input.tosca.yaml");
+ assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
+
+ rawResponse = readResource("policytypes/"
+ + "onap.policies.Naming/versions/1.0.0/policies/SDNC_Policy.ONAP_VNF_NAMING_TIMESTAMP/versions/1.0.0",
+ APP_JSON);
+ assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
+
+ ToscaServiceTemplate namingServiceTemplate = rawResponse.readEntity(ToscaServiceTemplate.class);
+ assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
+ assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
+ assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
+
+ rawResponse = readResource("policytypes/"
+ + "onap.policies.Naming/versions/1.0.0/policies/SDNC_Policy.ONAP_VNF_NAMING_TIMESTAMP/versions/latest",
+ APP_JSON);
+ assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
+
+ namingServiceTemplate = rawResponse.readEntity(ToscaServiceTemplate.class);
+ assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
+ assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
+ assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
+
+ rawResponse = readResource(
+ "policytypes/" + "onap.policies.Naming/versions/1.0.0/policies/SDNC_Policy.ONAP_VNF_NAMING_TIMESTAMP",
+ APP_JSON);
+ assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
+
+ namingServiceTemplate = rawResponse.readEntity(ToscaServiceTemplate.class);
+ assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
+ assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
+ assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
+
+ rawResponse = deleteResource("policytypes/"
+ + "onap.policies.Naming/versions/1.0.0/policies/SDNC_Policy.ONAP_VNF_NAMING_TIMESTAMP/versions/1.0.0",
+ APP_JSON);
+ assertEquals(Response.Status.OK.getStatusCode(), rawResponse.getStatus());
+ }
+
@Test
public void testDeletePoliciesJson() throws Exception {
testDeletePolicies(APP_JSON);
assertEquals(Response.Status.NOT_FOUND.getStatusCode(), rawResponse.getStatus());
ErrorResponse errorResponse = rawResponse.readEntity(ErrorResponse.class);
assertEquals(
- "policy with ID onap.restart.tca:1.0.0 and type "
- + "onap.policies.monitoring.cdap.tca.hi.lo.app:1.0.0 does not exist",
+ "policies for filter ToscaPolicyFilter(name=onap.restart.tca, version=1.0.0, versionPrefix=null, "
+ + "type=onap.policies.monitoring.cdap.tca.hi.lo.app, typeVersion=1.0.0) do not exist",
errorResponse.getErrorMessage());
rawResponse = deleteResource(POLICYTYPES_TCA_POLICIES_VCPE_VERSION2, mediaType);
assertThatThrownBy(() -> {
policyTypeProvider.fetchPolicyTypes("dummy", null);
- }).hasMessage("policy type with ID dummy:null does not exist");
+ }).hasMessage("policy types for filter ToscaPolicyTypeFilter(name=dummy, version=null) do not exist");
assertThatThrownBy(() -> {
policyTypeProvider.fetchPolicyTypes("dummy", "dummy");
- }).hasMessage("policy type with ID dummy:dummy does not exist");
+ }).hasMessage("policy types for filter ToscaPolicyTypeFilter(name=dummy, version=dummy) do not exist");
}
@Test
assertThatThrownBy(() -> {
policyTypeProvider.fetchLatestPolicyTypes("dummy");
- }).hasMessage("policy type with ID dummy:null does not exist");
+ }).hasMessage("policy types for filter ToscaPolicyTypeFilter(name=dummy, version=LATEST) do not exist");
}
@Test
Code Review / policy / api.git / commitdiff