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 com.jayway.jsonpath.DocumentContext;
  24
  25 import java.util.*;
  26
  27 import org.onap.aai.edges.EdgeRuleQuery;
  28 import org.onap.aai.edges.EdgeRuleQuery.Builder;
  29 import org.onap.aai.edges.enums.EdgeField;
  30 import org.onap.aai.edges.enums.EdgeType;
  31 import org.springframework.stereotype.Component;
  32
  33 /**
  34  * Validates that in the collection of cousin rules between a given node type pair,
  35  * there is exactly 1 set default=true.
  36  */
  37 @Component
  38 public class CousinDefaultingValidationModule {
  39
  40     /**
  41      * Validates that in the collection of cousin rules between a given node type pair,
  42      * there is exactly 1 set default=true.
  43      *
  44      * @param String nodeTypePair - pair of A&AI node types in the form "typeA|typeB"
  45      * @param List<DocumentContext> ctxs - the ingested json schema to validate
  46      * @return empty string if ok, appropriate error message otherwise
  47      */
  48     public String validate(String nodeTypePair, List<DocumentContext> ctxs) {
  49         String[] types = nodeTypePair.split("\\|");
  50         EdgeRuleQuery lookup = new Builder(types[0], types[1]).edgeType(EdgeType.COUSIN).build();
  51         List<Map<String, String>> rules = new ArrayList<>();
  52         for (DocumentContext ctx : ctxs) {
  53             rules.addAll(ctx.read("$.rules.[?]", lookup.getFilter()));
  54         }
  55
  56         if (rules.isEmpty()) {
  57             return ""; // bc irrelevant check
  58         }
  59
  60         int defaultCount = 0;
  61         Set<String> defLabels = new HashSet<>();
  62         for (Map<String, String> rule : rules) {
  63             if ("true".equals(rule.get(EdgeField.DEFAULT.toString()))) {
  64                 defaultCount++;
  65                 defLabels.add(rule.get(EdgeField.LABEL.toString()));
  66             }
  67         }
  68
  69         StringBuilder errorBase = new StringBuilder().append("Pair ").append(nodeTypePair)
  70                 .append(" must have exactly one cousin rule set as default. ");
  71         if (defaultCount == 1) {
  72             return "";
  73         } else if (defaultCount == 0) {
  74             errorBase.append("None set.");
  75             return errorBase.toString();
  76         } else {
  77             errorBase.append("Multiple set, see labels: ");
  78             for (String label : defLabels) {
  79                 errorBase.append(label).append(" ");
  80             }
  81             return errorBase.toString();
  82         }
  83     }
  84 }