aai-schema-ingest/src/main/java/org/onap/aai/validation/edges/CousinDefaultingValidationModule.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-18 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *   http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.aai.validation.edges;
  22
  23 import java.util.ArrayList;
  24 import java.util.HashSet;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Set;
  28
  29 import org.onap.aai.edges.EdgeRuleQuery;
  30 import org.onap.aai.edges.EdgeRuleQuery.Builder;
  31 import org.onap.aai.edges.enums.EdgeField;
  32 import org.onap.aai.edges.enums.EdgeType;
  33
  34 import com.jayway.jsonpath.DocumentContext;
  35
  36 /**
  37  * Validates that in the collection of cousin rules between a given node type pair,
  38  * there is exactly 1 set default=true.
  39  */
  40 public class CousinDefaultingValidationModule {
  41
  42         /**
  43          * Validates that in the collection of cousin rules between a given node type pair,
  44          * there is exactly 1 set default=true.
  45          *
  46          * @param String nodeTypePair - pair of A&AI node types in the form "typeA|typeB"
  47          * @param List<DocumentContext> ctxs - the ingested json schema to validate
  48          * @return empty string if ok, appropriate error message otherwise
  49          */
  50         public String validate(String nodeTypePair, List<DocumentContext> ctxs) {
  51                 String[] types = nodeTypePair.split("\\|");
  52                 EdgeRuleQuery lookup = new Builder(types[0], types[1]).edgeType(EdgeType.COUSIN).build();
  53                 List<Map<String, String>> rules = new ArrayList<>();
  54                 for (DocumentContext ctx : ctxs) {
  55                         rules.addAll(ctx.read("$.rules.[?]", lookup.getFilter()));
  56                 }
  57
  58                 if (rules.isEmpty()) {
  59                         return ""; //bc irrelevant check
  60                 }
  61
  62                 int defaultCount = 0;
  63                 Set<String> defLabels = new HashSet<>();
  64                 for (Map<String, String> rule : rules) {
  65                         if ("true".equals(rule.get(EdgeField.DEFAULT.toString()))) {
  66                                 defaultCount++;
  67                                 defLabels.add(rule.get(EdgeField.LABEL.toString()));
  68                         }
  69                 }
  70
  71                 StringBuilder errorBase = new StringBuilder().append("Pair ").append(nodeTypePair).append(" must have exactly one cousin rule set as default. ");
  72                 if (defaultCount == 1) {
  73                         return "";
  74                 } else if (defaultCount == 0){
  75                         errorBase.append("None set.");
  76                         return errorBase.toString();
  77                 } else {
  78                         errorBase.append("Multiple set, see labels: ");
  79                         for (String label : defLabels) {
  80                                 errorBase.append(label).append(" ");
  81                         }
  82                         return errorBase.toString();
  83                 }
  84         }
  85 }