From 1148834bc4b10d00c1b1830b087357e63af8293f Mon Sep 17 00:00:00 2001 From: rb7147 Date: Thu, 1 Feb 2018 12:07:13 -0500 Subject: Included Policy GUI Enhancements and validations Added hover messages for all policy templates. Resolved few sonar issues. Added fixes for Policy GUI Validations. Issue-ID: POLICY-597 Change-Id: I74abb92dd6ac8722d7869b6a316fad1d8db11d9c Signed-off-by: rb7147 --- .../rest/adapter/ClosedLoopFaultTrapDatas.java | 69 ++++ .../policy/rest/adapter/PolicyRestAdapter.java | 15 + .../java/org/onap/policy/rest/jpa/TermList.java | 14 + .../org/onap/policy/rest/util/MSModelUtils.java | 20 +- .../onap/policy/rest/util/PolicyValidation.java | 403 ++++++++++++++++----- .../rest/util/PolicyValidationRequestWrapper.java | 47 ++- .../rest/adapter/ClosedLoopFaultTrapDatasTest.java | 50 +++ 7 files changed, 511 insertions(+), 107 deletions(-) create mode 100644 ONAP-REST/src/main/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatas.java create mode 100644 ONAP-REST/src/test/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatasTest.java (limited to 'ONAP-REST') diff --git a/ONAP-REST/src/main/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatas.java b/ONAP-REST/src/main/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatas.java new file mode 100644 index 000000000..efbbf27a6 --- /dev/null +++ b/ONAP-REST/src/main/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatas.java @@ -0,0 +1,69 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP Policy Engine + * ================================================================================ + * Copyright (C) 2017 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.rest.adapter; + +import java.util.List; + +public class ClosedLoopFaultTrapDatas { + + private List trap1; + private List trap2; + private List trap3; + private List trap4; + private List trap5; + private List trap6; + public List getTrap1() { + return trap1; + } + public void setTrap1(List trap1) { + this.trap1 = trap1; + } + public List getTrap2() { + return trap2; + } + public void setTrap2(List trap2) { + this.trap2 = trap2; + } + public List getTrap3() { + return trap3; + } + public void setTrap3(List trap3) { + this.trap3 = trap3; + } + public List getTrap4() { + return trap4; + } + public void setTrap4(List trap4) { + this.trap4 = trap4; + } + public List getTrap5() { + return trap5; + } + public void setTrap5(List trap5) { + this.trap5 = trap5; + } + public List getTrap6() { + return trap6; + } + public void setTrap6(List trap6) { + this.trap6 = trap6; + } + +} diff --git a/ONAP-REST/src/main/java/org/onap/policy/rest/adapter/PolicyRestAdapter.java b/ONAP-REST/src/main/java/org/onap/policy/rest/adapter/PolicyRestAdapter.java index b4056a3a0..dfc6dff49 100644 --- a/ONAP-REST/src/main/java/org/onap/policy/rest/adapter/PolicyRestAdapter.java +++ b/ONAP-REST/src/main/java/org/onap/policy/rest/adapter/PolicyRestAdapter.java @@ -98,6 +98,8 @@ public class PolicyRestAdapter { private String trapMaxAge; private String verificationclearTimeOut; private Map dynamicLayoutMap; + private ClosedLoopFaultTrapDatas trapDatas; + private ClosedLoopFaultTrapDatas faultDatas; //FireWall private String fwPolicyType; @@ -893,4 +895,17 @@ public class PolicyRestAdapter { public void setPolicyJSON(Object policyJSON) { this.policyJSON = policyJSON; } + + public ClosedLoopFaultTrapDatas getTrapDatas() { + return trapDatas; + } + public void setTrapDatas(ClosedLoopFaultTrapDatas trapDatas) { + this.trapDatas = trapDatas; + } + public ClosedLoopFaultTrapDatas getFaultDatas() { + return faultDatas; + } + public void setFaultDatas(ClosedLoopFaultTrapDatas faultDatas) { + this.faultDatas = faultDatas; + } } diff --git a/ONAP-REST/src/main/java/org/onap/policy/rest/jpa/TermList.java b/ONAP-REST/src/main/java/org/onap/policy/rest/jpa/TermList.java index 099257c39..9c18343bf 100644 --- a/ONAP-REST/src/main/java/org/onap/policy/rest/jpa/TermList.java +++ b/ONAP-REST/src/main/java/org/onap/policy/rest/jpa/TermList.java @@ -109,6 +109,20 @@ public class TermList implements Serializable { @JoinColumn(name="modified_by") private UserInfo userModifiedBy; + public Date getCreatedDate() { + return this.createdDate; + } + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public Date getModifiedDate() { + return this.modifiedDate; + } + public void setModifiedDate(Date modifiedDate) { + this.modifiedDate = modifiedDate; + } + public UserInfo getUserCreatedBy() { return userCreatedBy; } diff --git a/ONAP-REST/src/main/java/org/onap/policy/rest/util/MSModelUtils.java b/ONAP-REST/src/main/java/org/onap/policy/rest/util/MSModelUtils.java index 3880b35d8..e96396e0c 100644 --- a/ONAP-REST/src/main/java/org/onap/policy/rest/util/MSModelUtils.java +++ b/ONAP-REST/src/main/java/org/onap/policy/rest/util/MSModelUtils.java @@ -315,7 +315,11 @@ public class MSModelUtils { if (annotation && obj instanceof EReference) { EClass refType = ((EReference) obj).getEReferenceType(); if(!refType.toString().contains(eProxyURI)){ - subAttribute.put(eStrucClassifier.getName(), refType.getName()); + String required = ":required-false"; + if(eStrucClassifier.getLowerBound() == 1){ + required = ":required-true"; + } + subAttribute.put(eStrucClassifier.getName(), refType.getName() + required); } } } @@ -390,18 +394,28 @@ public class MSModelUtils { refAttribute.put(eStrucClassifier.getName(), refValue); } else { String array = arrayCheck(((EStructuralFeature) obj).getUpperBound()); - refAttribute.put(eStrucClassifier.getName(), refType.getName() + array); + String required = ":required-false"; + if(((EStructuralFeature) obj).getLowerBound() == 1){ + required = ":required-true"; + } + refAttribute.put(eStrucClassifier.getName(), refType.getName() + array + required); } } else if (annotation && obj instanceof EAttributeImpl){ EClassifier refType = ((EAttributeImpl) obj).getEType(); if (refType instanceof EEnumImpl){ String array = arrayCheck(((EStructuralFeature) obj).getUpperBound()); - refAttribute.put(eStrucClassifier.getName(), refType.getName() + array); } + String required = ":required-false"; + if(((EStructuralFeature) obj).getLowerBound() == 1){ + required = ":required-true"; + } + refAttribute.put(eStrucClassifier.getName(), refType.getName() + array + required); + } } } } } } + return refAttribute; } diff --git a/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidation.java b/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidation.java index df4fbf62d..77dcbdc1d 100644 --- a/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidation.java +++ b/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidation.java @@ -20,6 +20,8 @@ package org.onap.policy.rest.util; import java.io.IOException; +import java.io.StringReader; +import java.util.ArrayList; import java.util.HashMap; import java.util.Iterator; import java.util.LinkedHashMap; @@ -27,6 +29,12 @@ import java.util.List; import java.util.Map; import java.util.Map.Entry; +import javax.json.Json; +import javax.json.JsonException; +import javax.json.JsonObject; +import javax.json.JsonReader; +import javax.json.JsonValue; + import org.apache.commons.lang.StringUtils; import org.json.JSONObject; import org.onap.policy.common.logging.flexlogger.FlexLogger; @@ -65,6 +73,8 @@ public class PolicyValidation { public static final String EMPTY_COMPONENT_ATTR = "Component Attributes: One or more Fields in Component Attributes is Empty."; private static Map mapAttribute = new HashMap<>(); + private static Map jsonRequestMap = new HashMap<>(); + private static List modelRequiredFieldsList = new ArrayList<>(); private static CommonClassDao commonClassDao; @@ -90,21 +100,126 @@ public class PolicyValidation { if(policyData.getPolicyName() != null){ String policyNameValidate = PolicyUtils.policySpecialCharValidator(policyData.getPolicyName()); if(!policyNameValidate.contains(SUCCESS)){ - responseString.append("PolicyName:" + policyNameValidate + "
"); + responseString.append("PolicyName:" + policyNameValidate + HTML_ITALICS_LNBREAK); valid = false; - }; + } }else{ - responseString.append( "PolicyName: PolicyName Should not be empty" + "
"); + responseString.append( "PolicyName: PolicyName Should not be empty" + HTML_ITALICS_LNBREAK); valid = false; } if(policyData.getPolicyDescription() != null){ String descriptionValidate = PolicyUtils.descriptionValidator(policyData.getPolicyDescription()); if(!descriptionValidate.contains(SUCCESS)){ - responseString.append("Description:" + descriptionValidate + "
"); + responseString.append("Description:" + descriptionValidate + HTML_ITALICS_LNBREAK); valid = false; } } + if(!"API".equals(policyData.getApiflag()) && policyData.getAttributes() != null && !policyData.getAttributes().isEmpty()){ + for(Object attribute : policyData.getAttributes()){ + if(attribute instanceof LinkedHashMap){ + String value = null; + String key = null; + if(((LinkedHashMap) attribute).get("key") != null){ + key = ((LinkedHashMap) attribute).get("key").toString(); + if(!PolicyUtils.policySpecialCharValidator(key).contains("success")){ + responseString.append("Attributes or Component Attributes:" + value + " : value has spaces or invalid characters
"); + valid = false; + } + }else{ + if(CONFIG_POLICY.equals(policyData.getPolicyType())){ + if("Base".equals(policyData.getConfigPolicyType())){ + responseString.append("Attributes: has one missing Attribute key
"); + } + if("BRMS_Param".equals(policyData.getConfigPolicyType()) || "BRMS_Raw".equals(policyData.getConfigPolicyType())){ + responseString.append("Rule Attributes: has one missing Attribute key
"); + } + }else{ + responseString.append("Component Attributes: has one missing Component Attribute key
"); + } + valid = false; + } + if(((LinkedHashMap) attribute).get("value") != null){ + value = ((LinkedHashMap) attribute).get("value").toString(); + if(!PolicyUtils.policySpecialCharValidator(value).contains("success")){ + if(CONFIG_POLICY.equals(policyData.getPolicyType())){ + if("Base".equals(policyData.getConfigPolicyType())){ + responseString.append("Attributes:" + value + " : value has spaces or invalid characters
"); + } + if("BRMS_Param".equals(policyData.getConfigPolicyType()) || "BRMS_Raw".equals(policyData.getConfigPolicyType())){ + responseString.append("Rule Attributes:" + value + " : value has spaces or invalid characters
"); + } + }else{ + responseString.append("Component Attributes:" + value + " : value has spaces or invalid characters
"); + } + valid = false; + } + }else{ + if(CONFIG_POLICY.equals(policyData.getPolicyType())){ + if("Base".equals(policyData.getConfigPolicyType())){ + responseString.append("Attributes: has one missing Attribute value
"); + } + if("BRMS_Param".equals(policyData.getConfigPolicyType()) || "BRMS_Raw".equals(policyData.getConfigPolicyType())){ + responseString.append("Rule Attributes: has one missing Attribute value
"); + } + }else{ + responseString.append("Component Attributes: has one missing Component Attribute value
"); + } + valid = false; + } + } + } + } + + //Decision Policy Attributes Validation + if(!"API".equals(policyData.getApiflag()) && policyData.getSettings() != null && !policyData.getSettings().isEmpty()){ + for(Object attribute : policyData.getAttributes()){ + if(attribute instanceof LinkedHashMap){ + String value = null; + if(((LinkedHashMap) attribute).get("key") == null){ + responseString.append("Settings Attributes: has one missing Attribute key
"); + valid = false; + } + if(((LinkedHashMap) attribute).get("value") != null){ + value = ((LinkedHashMap) attribute).get("value").toString(); + if(!PolicyUtils.policySpecialCharValidator(value).contains("success")){ + responseString.append("Settings Attributes:" + value + " : value has spaces or invalid characters
"); + valid = false; + } + }else{ + responseString.append("Settings Attributes: has one missing Attribute Value
"); + valid = false; + } + } + } + } + + if(!"API".equals(policyData.getApiflag()) && policyData.getRuleAlgorithmschoices() != null && !policyData.getRuleAlgorithmschoices().isEmpty()){ + for(Object attribute : policyData.getRuleAlgorithmschoices()){ + if(attribute instanceof LinkedHashMap){ + String label = ((LinkedHashMap) attribute).get("id").toString(); + if(((LinkedHashMap) attribute).get("dynamicRuleAlgorithmField1") == null){ + responseString.append("Rule Algorithms:" + label + " : Field 1 value is not selected
"); + valid = false; + } + if(((LinkedHashMap) attribute).get("dynamicRuleAlgorithmCombo") == null){ + responseString.append("Rule Algorithms:" + label + " : Field 2 value is not selected
"); + valid = false; + } + if(((LinkedHashMap) attribute).get("dynamicRuleAlgorithmField2") != null){ + String value = ((LinkedHashMap) attribute).get("dynamicRuleAlgorithmField2").toString(); + if(!PolicyUtils.policySpecialCharValidator(value).contains("success")){ + responseString.append("Rule Algorithms:" + label + " : Field 3 value has special characters
"); + valid = false; + } + }else{ + responseString.append("Rule Algorithms:" + label + " : Field 3 value is empty
"); + valid = false; + } + } + } + } + if(CONFIG_POLICY.equalsIgnoreCase(policyData.getPolicyType())){ if ("Base".equals(policyData.getConfigPolicyType()) || CLOSEDLOOP_POLICY.equals(policyData.getConfigPolicyType()) || CLOSEDLOOP_PM.equals(policyData.getConfigPolicyType()) || ENFORCER_CONFIG_POLICY.equals(policyData.getConfigPolicyType()) @@ -113,11 +228,11 @@ public class PolicyValidation { if(!Strings.isNullOrEmpty(policyData.getOnapName())) { String onapNameValidate = PolicyUtils.policySpecialCharValidator(policyData.getOnapName()); if(!onapNameValidate.contains(SUCCESS)){ - responseString.append("OnapName:" + onapNameValidate + "
"); + responseString.append("OnapName:" + onapNameValidate + HTML_ITALICS_LNBREAK); valid = false; } }else{ - responseString.append("Onap Name: Onap Name Should not be empty" + "
"); + responseString.append("Onap Name: Onap Name Should not be empty" + HTML_ITALICS_LNBREAK); valid = false; } } @@ -125,33 +240,33 @@ public class PolicyValidation { if(!Strings.isNullOrEmpty(policyData.getRiskType())) { String riskTypeValidate = PolicyUtils.policySpecialCharValidator(policyData.getRiskType()); if(!riskTypeValidate.contains(SUCCESS)){ - responseString.append("RiskType:" + riskTypeValidate + "
"); + responseString.append("RiskType:" + riskTypeValidate + HTML_ITALICS_LNBREAK); valid = false; } }else { - responseString.append("Risk Type: Risk Type Should not be Empty" + "
"); + responseString.append("RiskType: Risk Type Should not be Empty" + HTML_ITALICS_LNBREAK); valid = false; } if(!Strings.isNullOrEmpty(policyData.getRiskLevel())) { String validateRiskLevel = PolicyUtils.policySpecialCharValidator(policyData.getRiskLevel()); if(!validateRiskLevel.contains(SUCCESS)){ - responseString.append("RiskLevel:" + validateRiskLevel + "
"); + responseString.append("RiskLevel:" + validateRiskLevel + HTML_ITALICS_LNBREAK); valid = false; } }else { - responseString.append("Risk Level: Risk Level Should not be Empty" + "
"); + responseString.append("RiskLevel: Risk Level Should not be Empty" + HTML_ITALICS_LNBREAK); valid = false; } if(!Strings.isNullOrEmpty(policyData.getGuard())) { String validateGuard = PolicyUtils.policySpecialCharValidator(policyData.getGuard()); if(!validateGuard.contains(SUCCESS)){ - responseString.append("Guard:" + validateGuard + "
"); + responseString.append("Guard:" + validateGuard + HTML_ITALICS_LNBREAK); valid = false; } }else { - responseString.append("Guard: Guard Value Should not be Empty" + "
"); + responseString.append("Guard: Guard Value Should not be Empty" + HTML_ITALICS_LNBREAK); valid = false; } @@ -159,21 +274,21 @@ public class PolicyValidation { if(!Strings.isNullOrEmpty(policyData.getConfigName())) { String configNameValidate = PolicyUtils.policySpecialCharValidator(policyData.getConfigName()); if(!configNameValidate.contains(SUCCESS)){ - responseString.append("ConfigName:" + configNameValidate + "
"); + responseString.append("ConfigName:" + configNameValidate + HTML_ITALICS_LNBREAK); valid = false; } }else{ - responseString.append("Config Name: Config Name Should not be Empty" + "
"); + responseString.append("Config Name: Config Name Should not be Empty" + HTML_ITALICS_LNBREAK); valid = false; } if(!Strings.isNullOrEmpty(policyData.getConfigType())) { String configTypeValidate = PolicyUtils.policySpecialCharValidator(policyData.getConfigType()); if(!configTypeValidate.contains(SUCCESS)){ - responseString.append("ConfigType:" + configTypeValidate + "
"); + responseString.append("ConfigType:" + configTypeValidate + HTML_ITALICS_LNBREAK); valid = false; } }else{ - responseString.append("Config Type: Config Type Should not be Empty" + "
"); + responseString.append("Config Type: Config Type Should not be Empty" + HTML_ITALICS_LNBREAK); valid = false; } if(!Strings.isNullOrEmpty(policyData.getConfigBodyData())) { @@ -182,26 +297,26 @@ public class PolicyValidation { if (configType != null) { if ("JSON".equals(configType)) { if (!PolicyUtils.isJSONValid(configBodyData)) { - responseString.append("Config Body: JSON Content is not valid" + "
"); + responseString.append("Config Body: JSON Content is not valid" + HTML_ITALICS_LNBREAK); valid = false; } } else if ("XML".equals(configType)) { if (!PolicyUtils.isXMLValid(configBodyData)) { - responseString.append("Config Body: XML Content data is not valid" + "
"); + responseString.append("Config Body: XML Content data is not valid" + HTML_ITALICS_LNBREAK); valid = false; } } else if ("PROPERTIES".equals(configType)) { if (!PolicyUtils.isPropValid(configBodyData)||configBodyData.equals("")) { - responseString.append("Config Body: Property data is not valid" + "
"); + responseString.append("Config Body: Property data is not valid" + HTML_ITALICS_LNBREAK); valid = false; } } else if ("OTHER".equals(configType) && ("".equals(configBodyData))) { - responseString.append("Config Body: Config Body Should not be Empty" + "
"); + responseString.append("Config Body: Config Body Should not be Empty" + HTML_ITALICS_LNBREAK); valid = false; } } }else{ - responseString.append("Config Body: Config Body Should not be Empty" + "
"); + responseString.append("Config Body: Config Body Should not be Empty" + HTML_ITALICS_LNBREAK); valid = false; } } @@ -259,7 +374,7 @@ public class PolicyValidation { if(pmBody.getEmailAddress() != null){ String result = emailValidation(pmBody.getEmailAddress(), responseString.toString()); if(result != SUCCESS){ - responseString.append(result + "
"); + responseString.append(result + HTML_ITALICS_LNBREAK); valid = false; } } @@ -272,7 +387,7 @@ public class PolicyValidation { if(!result.contains(SUCCESS)){ responseString.append("GeoLink:" + result + HTML_ITALICS_LNBREAK); valid = false; - }; + } } if(pmBody.getAttributes() != null && !pmBody.getAttributes().isEmpty()){ for(Entry entry : pmBody.getAttributes().entrySet()){ @@ -283,7 +398,7 @@ public class PolicyValidation { if(!attributeValidate.contains(SUCCESS)){ responseString.append("Attributes:" + key + " : value has spaces or invalid characters" + HTML_ITALICS_LNBREAK); valid = false; - }; + } } } } @@ -308,13 +423,28 @@ public class PolicyValidation { responseString.append("Conditions: There were no conditions provided in configBody json" + HTML_ITALICS_LNBREAK); return responseString; } + }else{ + if(policyData.getTrapDatas().getTrap1() != null){ + if(policyData.getClearTimeOut() == null){ + responseString.append("Trigger Clear TimeOut: Trigger Clear TimeOut is required when atleast One Trigger Signature is enabled
"); + valid = false; + } + if(policyData.getTrapMaxAge() == null){ + responseString.append("Trap Max Age: Trap Max Age is required when atleast One Trigger Signature is enabled
"); + valid = false; + } + } + if(policyData.getFaultDatas().getTrap1() != null && policyData.getVerificationclearTimeOut() == null){ + responseString.append("Fault Clear TimeOut: Fault Clear TimeOut is required when atleast One Fault Signature is enabled
"); + valid = false; + } } ClosedLoopFaultBody faultBody = mapper.readValue(policyData.getJsonBody(), ClosedLoopFaultBody.class); if(faultBody.getEmailAddress() != null && !faultBody.getEmailAddress().isEmpty()){ String result = emailValidation(faultBody.getEmailAddress(), responseString.toString()); - if(result != SUCCESS){ - responseString.append(result+ "
"); + if(!SUCCESS.equals(result)){ + responseString.append(result+ HTML_ITALICS_LNBREAK); valid = false; } } @@ -384,6 +514,8 @@ public class PolicyValidation { if (MICROSERVICES.equals(policyData.getConfigPolicyType())){ if(!Strings.isNullOrEmpty(policyData.getServiceType())){ + + modelRequiredFieldsList = new ArrayList<>(); pullJsonKeyPairs((JsonNode) policyData.getPolicyJSON()); String service; @@ -400,7 +532,12 @@ public class PolicyValidation { MicroServiceModels returnModel = getAttributeObject(service, version); if(returnModel != null) { + String annotation = returnModel.getAnnotation(); + String refAttributes = returnModel.getRef_attributes(); + String subAttributes = returnModel.getSub_attributes(); + String modelAttributes = returnModel.getAttributes(); + if (!Strings.isNullOrEmpty(annotation)){ Map rangeMap = Splitter.on(",").withKeyValueSeparator("=").split(annotation); for (Entry rMap : rangeMap.entrySet()){ @@ -431,18 +568,85 @@ public class PolicyValidation { } } + } else { + // Validate for configName, location, uuid, and policyScope if no annotations exist for this model + if(Strings.isNullOrEmpty(policyData.getMsLocation())){ + responseString.append("Micro Service Model: location is required for this model" + HTML_ITALICS_LNBREAK); + valid = false; + } + + if(Strings.isNullOrEmpty(policyData.getConfigName())){ + responseString.append("Micro Service Model: configName is required for this model" + HTML_ITALICS_LNBREAK); + valid = false; + } + + if(Strings.isNullOrEmpty(policyData.getUuid())){ + responseString.append("Micro Service Model: uuid is required for this model" + HTML_ITALICS_LNBREAK); + valid = false; + } + + if(Strings.isNullOrEmpty(policyData.getPolicyScope())){ + responseString.append("Micro Service Model: policyScope is required for this model" + HTML_ITALICS_LNBREAK); + valid = false; + } + } + + // get list of required fields from the sub_Attributes of the Model + if(!Strings.isNullOrEmpty(subAttributes)) { + JsonObject subAttributesJson = stringToJsonObject(subAttributes); + findRequiredFields(subAttributesJson); + } + + // get list of required fields from the attributes of the Model + if (!Strings.isNullOrEmpty(modelAttributes)) { + Map modelAttributesMap = Splitter.on(",").withKeyValueSeparator("=").split(modelAttributes); + String json = new ObjectMapper().writeValueAsString(modelAttributesMap); + findRequiredFields(stringToJsonObject(json)); + } + + // get list of required fields from the ref_Attributes of the Model + if (!Strings.isNullOrEmpty(refAttributes)) { + Map refAttributesMap = Splitter.on(",").withKeyValueSeparator("=").split(refAttributes); + String json = new ObjectMapper().writeValueAsString(refAttributesMap); + findRequiredFields(stringToJsonObject(json)); + } + + // Validate Required Fields in the Micro Service Model + if (modelRequiredFieldsList!=null || !modelRequiredFieldsList.isEmpty()) { + // create jsonRequestMap with all json keys and values from request + JsonNode rootNode = (JsonNode) policyData.getPolicyJSON(); + pullModelJsonKeyPairs(rootNode); + + // validate if the requiredFields are in the request + for(String requiredField : modelRequiredFieldsList) { + if (jsonRequestMap.containsKey(requiredField)) { + String value = jsonRequestMap.get(requiredField); + if(Strings.isNullOrEmpty(jsonRequestMap.get(requiredField)) || + "\"\"".equals(value) || + "".equals(jsonRequestMap.get(requiredField))){ + responseString.append("Micro Service Model: " + requiredField + " is required" + HTML_ITALICS_LNBREAK); + valid = false; + } + } else { + responseString.append("Micro Service Model: " + requiredField + " is required" + HTML_ITALICS_LNBREAK); + valid = false; + } + } } + + + } else { responseString.append("Micro Service Model: Invalid Model. The model name, " + service + " of version, " + version + " was not found in the dictionary" + HTML_ITALICS_LNBREAK); valid = false; } } else { - responseString.append("Micro Version: Micro Service Version is required" + HTML_ITALICS_LNBREAK); + responseString.append("Micro Service Version: Micro Service Version is required" + HTML_ITALICS_LNBREAK); valid = false; } } else { - responseString.append("Micro Service: Micro Service is required" + HTML_ITALICS_LNBREAK); + responseString.append("Micro Service: Micro Service Model is required" + HTML_ITALICS_LNBREAK); valid = false; } @@ -456,11 +660,11 @@ public class PolicyValidation { if(!Strings.isNullOrEmpty(policyData.getOnapName())){ String onapNameValidate = PolicyUtils.policySpecialCharValidator(policyData.getOnapName()); if(!onapNameValidate.contains(SUCCESS)){ - responseString.append("OnapName:" + onapNameValidate + "
"); + responseString.append("OnapName:" + onapNameValidate + HTML_ITALICS_LNBREAK); valid = false; } }else{ - responseString.append("Onap Name: Onap Name Should not be empty" + "
"); + responseString.append("Onap Name: Onap Name Should not be empty" + HTML_ITALICS_LNBREAK); valid = false; } @@ -527,52 +731,52 @@ public class PolicyValidation { if("GUARD_YAML".equals(policyData.getRuleProvider()) || "GUARD_BL_YAML".equals(policyData.getRuleProvider())){ if(policyData.getYamlparams()==null){ - responseString.append(" Guard Params are Required " + "
"); + responseString.append(" Guard Params are Required " + HTML_ITALICS_LNBREAK); valid = false; }else{ if(Strings.isNullOrEmpty(policyData.getYamlparams().getActor())){ - responseString.append("Guard Params Actor is Required " + "
"); + responseString.append("Guard Params Actor is Required " + HTML_ITALICS_LNBREAK); valid = false; } if(Strings.isNullOrEmpty(policyData.getYamlparams().getRecipe())){ - responseString.append("Guard Params Recipe is Required " + "
"); + responseString.append("Guard Params Recipe is Required " + HTML_ITALICS_LNBREAK); valid = false; } if(Strings.isNullOrEmpty(policyData.getYamlparams().getGuardActiveStart())){ - responseString.append("Guard Params Guard Active Start is Required " + "
"); + responseString.append("Guard Params Guard Active Start is Required " + HTML_ITALICS_LNBREAK); valid = false; } if(Strings.isNullOrEmpty(policyData.getYamlparams().getGuardActiveEnd())){ - responseString.append("Guard Params Guard Active End is Required " + "
"); + responseString.append("Guard Params Guard Active End is Required " + HTML_ITALICS_LNBREAK); valid = false; } if("GUARD_YAML".equals(policyData.getRuleProvider())){ if(Strings.isNullOrEmpty(policyData.getYamlparams().getLimit())){ - responseString.append(" Guard Params Limit is Required " + "
"); + responseString.append(" Guard Params Limit is Required " + HTML_ITALICS_LNBREAK); valid = false; }else if(!PolicyUtils.isInteger(policyData.getYamlparams().getLimit())){ - responseString.append(" Guard Params Limit Should be Integer " + "
"); + responseString.append(" Guard Params Limit Should be Integer " + HTML_ITALICS_LNBREAK); valid = false; } if(Strings.isNullOrEmpty(policyData.getYamlparams().getTimeWindow())){ - responseString.append("Guard Params Time Window is Required" + "
"); + responseString.append("Guard Params Time Window is Required" + HTML_ITALICS_LNBREAK); valid = false; }else if(!PolicyUtils.isInteger(policyData.getYamlparams().getTimeWindow())){ - responseString.append(" Guard Params Time Window Should be Integer " + "
"); + responseString.append(" Guard Params Time Window Should be Integer " + HTML_ITALICS_LNBREAK); valid = false; } if(Strings.isNullOrEmpty(policyData.getYamlparams().getTimeUnits())){ - responseString.append("Guard Params Time Units is Required" + "
"); + responseString.append("Guard Params Time Units is Required" + HTML_ITALICS_LNBREAK); valid = false; } }else if("GUARD_BL_YAML".equals(policyData.getRuleProvider())){ if(policyData.getYamlparams().getBlackList()==null || policyData.getYamlparams().getBlackList().isEmpty()){ - responseString.append(" Guard Params BlackList is Required " + "
"); + responseString.append(" Guard Params BlackList is Required " + HTML_ITALICS_LNBREAK); valid = false; }else{ for(String blackList: policyData.getYamlparams().getBlackList()){ if(blackList==null || !(SUCCESS.equals(PolicyUtils.policySpecialCharValidator(blackList)))){ - responseString.append(" Guard Params BlackList Should be valid String" + "
"); + responseString.append(" Guard Params BlackList Should be valid String" + HTML_ITALICS_LNBREAK); valid = false; break; } @@ -587,70 +791,24 @@ public class PolicyValidation { if(!Strings.isNullOrEmpty(policyData.getActionPerformer())){ String actionPerformer = PolicyUtils.policySpecialCharValidator(policyData.getActionPerformer()); if(!actionPerformer.contains(SUCCESS)){ - responseString.append("ActionPerformer:" + actionPerformer + "
"); + responseString.append("ActionPerformer:" + actionPerformer + HTML_ITALICS_LNBREAK); valid = false; } }else{ - responseString.append("ActionPerformer: ActionPerformer Should not be empty" + "
"); - valid = false; - } - if(policyData.getAttributes() != null){ - for(Object attribute : policyData.getAttributes()){ - if(attribute instanceof LinkedHashMap){ - try{ - //This is for validation check if the value exists or not - String key = ((LinkedHashMap) attribute).get("key").toString(); - String value = ((LinkedHashMap) attribute).get("value").toString(); - if("".equals(key) || "".equals(value)){ - responseString.append(EMPTY_COMPONENT_ATTR + "
"); - valid = false; - break; - } - }catch(Exception e){ - LOGGER.error("This is a Policy Validation check" +e); - responseString.append(EMPTY_COMPONENT_ATTR + "
"); - valid = false; - break; - } - } - } - }else{ - responseString.append(EMPTY_COMPONENT_ATTR + "
"); + responseString.append("ActionPerformer: ActionPerformer Should not be empty" + HTML_ITALICS_LNBREAK); valid = false; } + if(!Strings.isNullOrEmpty(policyData.getActionAttributeValue())){ String actionAttribute = PolicyUtils.policySpecialCharValidator(policyData.getActionAttributeValue()); if(!actionAttribute.contains(SUCCESS)){ - responseString.append("ActionAttribute:" + actionAttribute + "
"); + responseString.append("ActionAttribute:" + actionAttribute + HTML_ITALICS_LNBREAK); valid = false; - }; + } }else{ - responseString.append("ActionAttribute: ActionAttribute Should not be empty" + "
"); + responseString.append("ActionAttribute: ActionAttribute Should not be empty" + HTML_ITALICS_LNBREAK); valid = false; } - - if(!policyData.getRuleAlgorithmschoices().isEmpty()){ - for(Object attribute : policyData.getRuleAlgorithmschoices()){ - if(attribute instanceof LinkedHashMap){ - try{ - String label = ((LinkedHashMap) attribute).get("id").toString(); - String key = ((LinkedHashMap) attribute).get("dynamicRuleAlgorithmField1").toString(); - String rule = ((LinkedHashMap) attribute).get("dynamicRuleAlgorithmCombo").toString(); - String value = ((LinkedHashMap) attribute).get("dynamicRuleAlgorithmField2").toString(); - - if(Strings.isNullOrEmpty(label) || Strings.isNullOrEmpty(key) || Strings.isNullOrEmpty(rule) || Strings.isNullOrEmpty(value)){ - responseString.append("Rule Algorithms: One or more Fields in Rule Algorithms is Empty." + "
"); - valid = false; - } - }catch(Exception e){ - LOGGER.error("This is a Policy Validation check" +e); - responseString.append("Rule Algorithms: One or more Fields in Rule Algorithms is Empty." + "
"); - valid = false; - break; - } - } - } - } } if(CONFIG_POLICY.equals(policyData.getPolicyType())){ @@ -660,7 +818,7 @@ public class PolicyValidation { List spData = commonClassDao.getDataById(SafePolicyWarning.class, "riskType", policyData.getRiskType()); if (!spData.isEmpty()){ SafePolicyWarning safePolicyWarningData = (SafePolicyWarning) spData.get(0); - value = "Message:" + safePolicyWarningData.getMessage(); + value = "Message:" + safePolicyWarningData.getMessage() +""; } } responseString.append(SUCCESS + "@#"+ value); @@ -729,5 +887,60 @@ public class PolicyValidation { } } } + + private void pullModelJsonKeyPairs(JsonNode rootNode) { + Iterator> fieldsIterator = rootNode.fields(); + + while (fieldsIterator.hasNext()) { + Map.Entry field = fieldsIterator.next(); + final String key = field.getKey(); + final JsonNode value = field.getValue(); + + if (value.isContainerNode() && !value.isArray()) { + pullModelJsonKeyPairs(value); // RECURSIVE CALL + } else if (value.isArray()) { + try { + String stringValue = StringUtils.replaceEach(value.toString(), new String[]{"[", "]"}, new String[]{"",""}); + ObjectMapper mapper = new ObjectMapper(); + JsonNode newValue = mapper.readTree(stringValue); + pullModelJsonKeyPairs(newValue); + } catch (IOException e) { + LOGGER.info("PolicyValidation: Exception occurred while mapping string to JsonNode " + e); + } + } else { + jsonRequestMap.put(key, value.toString().trim()); + } + } + + } + + private JsonObject stringToJsonObject(String value) { + try(JsonReader jsonReader = Json.createReader(new StringReader(value))){ + return jsonReader.readObject(); + } catch(JsonException| IllegalStateException e){ + LOGGER.info(XACMLErrorConstants.ERROR_DATA_ISSUE+ "Improper JSON format... may or may not cause issues in validating the policy: " + value, e); + return null; + } + } + + private void findRequiredFields(JsonObject json) { + + for(Entry keyMap : json.entrySet()){ + Object obj = keyMap.getValue(); + if(obj instanceof JsonObject){ + JsonObject jsonObj = (JsonObject)obj; + for(Entry jsonMap : jsonObj.entrySet()){ + if(jsonMap.getValue().toString().contains("required-true")){ + modelRequiredFieldsList.add(jsonMap.getKey()); + } + } + } else { + if(keyMap.getValue().toString().contains("required-true")){ + modelRequiredFieldsList.add(keyMap.getKey()); + } + } + } + + } } diff --git a/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidationRequestWrapper.java b/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidationRequestWrapper.java index ac97fb0ee..4267ff9fc 100644 --- a/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidationRequestWrapper.java +++ b/ONAP-REST/src/main/java/org/onap/policy/rest/util/PolicyValidationRequestWrapper.java @@ -37,6 +37,7 @@ import org.onap.policy.api.AttributeType; import org.onap.policy.api.PolicyParameters; import org.onap.policy.common.logging.flexlogger.FlexLogger; import org.onap.policy.common.logging.flexlogger.Logger; +import org.onap.policy.rest.adapter.ClosedLoopFaultTrapDatas; import org.onap.policy.rest.adapter.PolicyRestAdapter; import org.onap.policy.rest.adapter.RainyDayParams; import org.onap.policy.rest.adapter.YAMLParams; @@ -55,12 +56,21 @@ public class PolicyValidationRequestWrapper { public PolicyRestAdapter populateRequestParameters(HttpServletRequest request) { PolicyRestAdapter policyData = null; - + ClosedLoopFaultTrapDatas trapDatas = null; + ClosedLoopFaultTrapDatas faultDatas = null; try { ObjectMapper mapper = new ObjectMapper(); mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); JsonNode root = mapper.readTree(request.getReader()); policyData = mapper.readValue(root.get("policyData").toString(), PolicyRestAdapter.class); + if(root.get("trapData") != null){ + trapDatas = mapper.readValue(root.get("trapData").toString(), ClosedLoopFaultTrapDatas.class); + policyData.setTrapDatas(trapDatas); + } + if(root.get("faultData") != null){ + faultDatas = mapper.readValue(root.get("faultData").toString(), ClosedLoopFaultTrapDatas.class); + policyData.setFaultDatas(faultDatas); + } JsonObject json; json = stringToJsonObject(root.toString()); @@ -88,9 +98,15 @@ public class PolicyValidationRequestWrapper { /* * set policy adapter values for Building JSON object containing policy data */ - //Common among policy types + //Common Policy Fields policyData.setPolicyName(parameters.getPolicyName()); policyData.setOnapName(parameters.getOnapName()); + policyData.setPriority(parameters.getPriority()); //Micro Service + policyData.setConfigName(parameters.getConfigName()); //Base and Firewall + policyData.setRiskType(parameters.getRiskType()); //Safe parameters Attributes + policyData.setRiskLevel(parameters.getRiskLevel());//Safe parameters Attributes + policyData.setGuard(String.valueOf(parameters.getGuard()));//Safe parameters Attributes + policyData.setTtlDate(convertDate(parameters.getTtlDate()));//Safe parameters Attributes //Some policies require jsonObject conversion from String for configBody (i.e. MicroService and Firewall) JsonObject json = null; @@ -298,6 +314,26 @@ public class PolicyValidationRequestWrapper { String version = json.get("version").toString().replace("\"", ""); policyData.setVersion(version); } + if(json.containsKey("policyScope")){ + String policyScope = json.get("policyScope").toString().replace("\"", ""); + policyData.setPolicyScope(policyScope); + } + if(json.containsKey("riskType")){ + String riskType = json.get("riskType").toString().replace("\"", ""); + policyData.setRiskType(riskType); + } + if(json.containsKey("riskLevel")){ + String riskLevel = json.get("riskLevel").toString().replace("\"", ""); + policyData.setRiskLevel(riskLevel); + } + if(json.containsKey("guard")){ + String guard = json.get("guard").toString().replace("\"", ""); + policyData.setGuard(guard); + } + } else { + String message = XACMLErrorConstants.ERROR_DATA_ISSUE+ " improper JSON object : " + parameters.getConfigBody(); + LOGGER.error(message); + return null; } } else if("Fault".equals(parameters.getPolicyConfigType().toString())){ @@ -337,13 +373,6 @@ public class PolicyValidationRequestWrapper { } } - - policyData.setPriority(parameters.getPriority()); //Micro Service - policyData.setConfigName(parameters.getConfigName()); //Base and Firewall - policyData.setRiskType(parameters.getRiskType()); //Safe parameters Attributes - policyData.setRiskLevel(parameters.getRiskLevel());//Safe parameters Attributes - policyData.setGuard(String.valueOf(parameters.getGuard()));//Safe parameters Attributes - policyData.setTtlDate(convertDate(parameters.getTtlDate()));//Safe parameters Attributes return policyData; diff --git a/ONAP-REST/src/test/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatasTest.java b/ONAP-REST/src/test/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatasTest.java new file mode 100644 index 000000000..bb8385bc3 --- /dev/null +++ b/ONAP-REST/src/test/java/org/onap/policy/rest/adapter/ClosedLoopFaultTrapDatasTest.java @@ -0,0 +1,50 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP Policy Engine + * ================================================================================ + * 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.rest.adapter; + +import static org.junit.Assert.*; + +import java.util.ArrayList; +import java.util.List; + +import org.junit.Test; + +public class ClosedLoopFaultTrapDatasTest { + + @Test + public void testClosedLoopFaultTrapDatas(){ + List trap = new ArrayList<>(); + trap.add("Test"); + ClosedLoopFaultTrapDatas closedLoopTrapData = new ClosedLoopFaultTrapDatas(); + closedLoopTrapData.setTrap1(trap); + assertTrue("Test".equals(closedLoopTrapData.getTrap1().get(0))); + closedLoopTrapData.setTrap2(trap); + assertTrue("Test".equals(closedLoopTrapData.getTrap2().get(0))); + closedLoopTrapData.setTrap3(trap); + assertTrue("Test".equals(closedLoopTrapData.getTrap3().get(0))); + closedLoopTrapData.setTrap4(trap); + assertTrue("Test".equals(closedLoopTrapData.getTrap4().get(0))); + closedLoopTrapData.setTrap5(trap); + assertTrue("Test".equals(closedLoopTrapData.getTrap5().get(0))); + closedLoopTrapData.setTrap6(trap); + assertTrue("Test".equals(closedLoopTrapData.getTrap6().get(0))); + + } +} -- cgit 1.2.3-korg