gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.controlloop.participant.simulator.main.parameters;
  22
  23 import java.util.Arrays;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.TreeMap;
  27 import org.onap.policy.common.endpoints.parameters.TopicParameters;
  28 import org.onap.policy.common.utils.coder.Coder;
  29 import org.onap.policy.common.utils.coder.CoderException;
  30 import org.onap.policy.common.utils.coder.StandardCoder;
  31 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  32
  33 /**
  34  * Class to hold/create all parameters for test cases.
  35  */
  36 public class CommonTestData {
  37     public static final String PARTICIPANT_GROUP_NAME = "ControlLoopParticipantGroup";
  38     public static final String DESCRIPTION = "Participant description";
  39     public static final long TIME_INTERVAL = 2000;
  40     public static final List<TopicParameters> TOPIC_PARAMS = Arrays.asList(getTopicParams());
  41
  42     public static final Coder CODER = new StandardCoder();
  43
  44     /**
  45      * Get ParticipantSimulatorParameters.
  46      *
  47      * @return ParticipantSimulatorParameters
  48      */
  49     public ParticipantSimulatorParameters getParticipantSimulatorParameters() {
  50         try {
  51             return CODER.convert(getParticipantParameterGroupMap(PARTICIPANT_GROUP_NAME),
  52                     ParticipantSimulatorParameters.class);
  53         } catch (final CoderException e) {
  54             throw new RuntimeException("cannot create ParticipantSimulatorParameters from map", e);
  55         }
  56     }
  57
  58     /**
  59      * Returns a property map for a ApexStarterParameterGroup map for test cases.
  60      *
  61      * @param name name of the parameters
  62      *
  63      * @return a property map suitable for constructing an object
  64      */
  65     public Map<String, Object> getParticipantParameterGroupMap(final String name) {
  66         final Map<String, Object> map = new TreeMap<>();
  67
  68         map.put("intermediaryParameters", getIntermediaryParametersMap(false));
  69         return map;
  70     }
  71
  72     /**
  73      * Returns a property map for a intermediaryParameters map for test cases.
  74      *
  75      * @param isEmpty boolean value to represent that object created should be empty or not
  76      * @return a property map suitable for constructing an object
  77      */
  78     public Map<String, Object> getIntermediaryParametersMap(final boolean isEmpty) {
  79         final Map<String, Object> map = new TreeMap<>();
  80         if (!isEmpty) {
  81             map.put("name", "Participant parameters");
  82             map.put("reportingTimeIntervalMs", TIME_INTERVAL);
  83             map.put("description", DESCRIPTION);
  84             map.put("participantId", getParticipantId());
  85             map.put("participantType", getParticipantId());
  86             map.put("clampControlLoopTopics", getTopicParametersMap(false));
  87         }
  88
  89         return map;
  90     }
  91
  92     /**
  93      * Returns a property map for a TopicParameters map for test cases.
  94      *
  95      * @param isEmpty boolean value to represent that object created should be empty or not
  96      * @return a property map suitable for constructing an object
  97      */
  98     public Map<String, Object> getTopicParametersMap(final boolean isEmpty) {
  99         final Map<String, Object> map = new TreeMap<>();
 100         if (!isEmpty) {
 101             map.put("topicSources", TOPIC_PARAMS);
 102             map.put("topicSinks", TOPIC_PARAMS);
 103         }
 104         return map;
 105     }
 106
 107     /**
 108      * Returns topic parameters for test cases.
 109      *
 110      * @return topic parameters
 111      */
 112     public static TopicParameters getTopicParams() {
 113         final TopicParameters topicParams = new TopicParameters();
 114         topicParams.setTopic("POLICY-CLRUNTIME-PARTICIPANT");
 115         topicParams.setTopicCommInfrastructure("dmaap");
 116         topicParams.setServers(Arrays.asList("localhost"));
 117         return topicParams;
 118     }
 119
 120     /**
 121      * Returns participantId for test cases.
 122      *
 123      * @return participant Id
 124      */
 125     public static ToscaConceptIdentifier getParticipantId() {
 126         final ToscaConceptIdentifier participantId = new ToscaConceptIdentifier("org.onap.PM_CDS_Blueprint", "1.0.0");
 127         return participantId;
 128     }
 129
 130     /**
 131      * Nulls out a field within a JSON string.
 132      *
 133      * @param json JSON string
 134      * @param field field to be nulled out
 135      * @return a new JSON string with the field nulled out
 136      */
 137     public String nullifyField(String json, String field) {
 138         return json.replace(field + "\"", field + "\":null, \"" + field + "Xxx\"");
 139     }
 140 }