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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 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.acm.participant.intermediary.main.parameters;
  22
  23 import java.io.File;
  24 import java.util.ArrayList;
  25 import java.util.Collections;
  26 import java.util.HashMap;
  27 import java.util.LinkedHashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.TreeMap;
  31 import java.util.UUID;
  32 import org.mockito.Mockito;
  33 import org.onap.policy.clamp.acm.participant.intermediary.comm.ParticipantMessagePublisher;
  34 import org.onap.policy.clamp.acm.participant.intermediary.handler.AutomationCompositionHandler;
  35 import org.onap.policy.clamp.acm.participant.intermediary.handler.DummyParticipantParameters;
  36 import org.onap.policy.clamp.acm.participant.intermediary.handler.ParticipantHandler;
  37 import org.onap.policy.clamp.acm.participant.intermediary.parameters.ParticipantIntermediaryParameters;
  38 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  39 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElement;
  40 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionOrderedState;
  41 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositions;
  42 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantDeregisterAck;
  43 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  44 import org.onap.policy.common.endpoints.parameters.TopicParameters;
  45 import org.onap.policy.common.utils.coder.Coder;
  46 import org.onap.policy.common.utils.coder.CoderException;
  47 import org.onap.policy.common.utils.coder.StandardCoder;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  49
  50 /**
  51  * Class to hold/create all parameters for test cases.
  52  */
  53 public class CommonTestData {
  54     public static final String PARTICIPANT_GROUP_NAME = "AutomationCompositionParticipantGroup";
  55     public static final String DESCRIPTION = "Participant description";
  56     public static final long TIME_INTERVAL = 2000;
  57     public static final List<TopicParameters> TOPIC_PARAMS = List.of(getTopicParams());
  58     public static final Coder CODER = new StandardCoder();
  59     private static final Object lockit = new Object();
  60     public static final UUID AC_ID_0 = UUID.randomUUID();
  61     public static final UUID AC_ID_1 = UUID.randomUUID();
  62
  63     /**
  64      * Get ParticipantIntermediaryParameters.
  65      *
  66      * @return ParticipantIntermediaryParameters
  67      */
  68     public ParticipantIntermediaryParameters getParticipantIntermediaryParameters() {
  69         try {
  70             return CODER.convert(getIntermediaryParametersMap(PARTICIPANT_GROUP_NAME),
  71                     ParticipantIntermediaryParameters.class);
  72         } catch (final CoderException e) {
  73             throw new RuntimeException("cannot create ParticipantSimulatorParameters from map", e);
  74         }
  75     }
  76
  77     /**
  78      * Get ParticipantParameters.
  79      *
  80      * @return ParticipantParameters
  81      */
  82     public static DummyParticipantParameters getParticipantParameters() {
  83         try {
  84             return CODER.convert(getParametersMap(PARTICIPANT_GROUP_NAME), DummyParticipantParameters.class);
  85         } catch (final CoderException e) {
  86             throw new RuntimeException("cannot create ParticipantSimulatorParameters from map", e);
  87         }
  88     }
  89
  90     /**
  91      * Returns a property map for a Parameters map for test cases.
  92      *
  93      * @param name name of the parameters
  94      * @return a property map suitable for constructing an object
  95      */
  96     public static Map<String, Object> getParametersMap(final String name) {
  97         final Map<String, Object> map = new TreeMap<>();
  98         map.put("intermediaryParameters", getIntermediaryParametersMap(name));
  99         return map;
 100     }
 101
 102     /**
 103      * Returns a property map for a intermediaryParameters map for test cases.
 104      *
 105      * @param name name of the parameters
 106      * @return a property map suitable for constructing an object
 107      */
 108     public static Map<String, Object> getIntermediaryParametersMap(final String name) {
 109         final Map<String, Object> map = new TreeMap<>();
 110         map.put("name", name);
 111         map.put("participantId", getParticipantId());
 112         map.put("description", DESCRIPTION);
 113         map.put("participantType", getParticipantId());
 114         map.put("reportingTimeIntervalMs", TIME_INTERVAL);
 115         map.put("clampAutomationCompositionTopics", getTopicParametersMap(false));
 116         map.put("participantSupportedElementTypes", new ArrayList<>());
 117
 118         return map;
 119     }
 120
 121     /**
 122      * Returns a property map for a TopicParameters map for test cases.
 123      *
 124      * @param isEmpty boolean value to represent that object created should be empty or not
 125      * @return a property map suitable for constructing an object
 126      */
 127     public static Map<String, Object> getTopicParametersMap(final boolean isEmpty) {
 128         final Map<String, Object> map = new TreeMap<>();
 129         if (!isEmpty) {
 130             map.put("topicSources", TOPIC_PARAMS);
 131             map.put("topicSinks", TOPIC_PARAMS);
 132         }
 133         return map;
 134     }
 135
 136     /**
 137      * Returns topic parameters for test cases.
 138      *
 139      * @return topic parameters
 140      */
 141     public static TopicParameters getTopicParams() {
 142         final var topicParams = new TopicParameters();
 143         topicParams.setTopic("POLICY-ACRUNTIME-PARTICIPANT");
 144         topicParams.setTopicCommInfrastructure("dmaap");
 145         topicParams.setServers(List.of("localhost"));
 146         return topicParams;
 147     }
 148
 149     /**
 150      * Returns participantId for test cases.
 151      *
 152      * @return participant Id
 153      */
 154     public static ToscaConceptIdentifier getParticipantId() {
 155         return new ToscaConceptIdentifier("org.onap.PM_CDS_Blueprint", "1.0.1");
 156     }
 157
 158     /**
 159      * Returns a participantMessagePublisher for MessageSender.
 160      *
 161      * @return participant Message Publisher
 162      */
 163     private ParticipantMessagePublisher getParticipantMessagePublisher() {
 164         synchronized (lockit) {
 165             var participantMessagePublisher = new ParticipantMessagePublisher();
 166             participantMessagePublisher.active(Collections.singletonList(Mockito.mock(TopicSink.class)));
 167             return participantMessagePublisher;
 168         }
 169     }
 170
 171     /**
 172      * Returns a mocked AutomationCompositionHandler for test cases.
 173      *
 174      * @return AutomationCompositionHandler
 175      */
 176     public AutomationCompositionHandler getMockAutomationCompositionHandler() {
 177         return new AutomationCompositionHandler(getParticipantParameters(), getParticipantMessagePublisher());
 178     }
 179
 180     /**
 181      * Returns a mocked ParticipantHandler for test cases.
 182      *
 183      * @return participant Handler
 184      */
 185     public ParticipantHandler getMockParticipantHandler() {
 186         var parameters = getParticipantParameters();
 187         var automationCompositionHandler = getMockAutomationCompositionHandler();
 188         var publisher = new ParticipantMessagePublisher();
 189         publisher.active(Collections.singletonList(Mockito.mock(TopicSink.class)));
 190         return new ParticipantHandler(parameters, publisher, automationCompositionHandler);
 191     }
 192
 193     /**
 194      * Returns a mocked ParticipantHandler for test cases.
 195      *
 196      * @return participant Handler
 197      *
 198      * @throws CoderException if there is an error with .json file.
 199      */
 200     public ParticipantHandler getParticipantHandlerAutomationCompositions() throws CoderException {
 201         var automationCompositionHandler = Mockito.mock(AutomationCompositionHandler.class);
 202         Mockito.doReturn(getTestAutomationCompositionMap()).when(automationCompositionHandler)
 203                 .getAutomationCompositionMap();
 204         var publisher = new ParticipantMessagePublisher();
 205         publisher.active(Collections.singletonList(Mockito.mock(TopicSink.class)));
 206         var parameters = getParticipantParameters();
 207         var participantHandler = new ParticipantHandler(parameters, publisher, automationCompositionHandler);
 208         participantHandler.sendParticipantRegister();
 209         participantHandler.handleParticipantStatusReq(null);
 210         participantHandler.sendParticipantDeregister();
 211         var participantDeregisterAckMsg = new ParticipantDeregisterAck();
 212         participantDeregisterAckMsg.setResponseTo(UUID.randomUUID());
 213         participantHandler.handleParticipantDeregisterAck(participantDeregisterAckMsg);
 214         return participantHandler;
 215     }
 216
 217     /**
 218      * Returns a Map of ToscaConceptIdentifier and AutomationComposition for test cases.
 219      *
 220      * @return automationCompositionMap
 221      *
 222      * @throws CoderException if there is an error with .json file.
 223      */
 224     public Map<UUID, AutomationComposition> getTestAutomationCompositionMap() throws CoderException {
 225         var automationCompositions = getTestAutomationCompositions();
 226         var automationComposition = automationCompositions.getAutomationCompositionList().get(1);
 227         Map<UUID, AutomationComposition> automationCompositionMap = new LinkedHashMap<>();
 228         automationCompositionMap.put(automationComposition.getInstanceId(), automationComposition);
 229         return automationCompositionMap;
 230     }
 231
 232     /**
 233      * Returns List of AutomationComposition for test cases.
 234      *
 235      * @return AutomationCompositions
 236      *
 237      * @throws CoderException if there is an error with .json file.
 238      */
 239     public AutomationCompositions getTestAutomationCompositions() throws CoderException {
 240         var automationCompositions = new StandardCoder().decode(
 241                 new File("src/test/resources/providers/TestAutomationCompositions.json"), AutomationCompositions.class);
 242         automationCompositions.getAutomationCompositionList().get(1).setInstanceId(AC_ID_0);
 243         automationCompositions.getAutomationCompositionList().get(1).setInstanceId(AC_ID_1);
 244         return automationCompositions;
 245     }
 246
 247     /**
 248      * Returns a map for a elementsOnThisParticipant for test cases.
 249      *
 250      * @param uuid UUID and id ToscaConceptIdentifier
 251      * @return a map suitable for elementsOnThisParticipant
 252      */
 253     public Map<UUID, AutomationCompositionElement> setAutomationCompositionElementTest(UUID uuid,
 254             ToscaConceptIdentifier id) {
 255         var acElement = new AutomationCompositionElement();
 256         acElement.setId(uuid);
 257         acElement.setParticipantId(id);
 258         acElement.setDefinition(id);
 259         acElement.setOrderedState(AutomationCompositionOrderedState.UNINITIALISED);
 260
 261         Map<UUID, AutomationCompositionElement> elementsOnThisParticipant = new LinkedHashMap<>();
 262         elementsOnThisParticipant.put(uuid, acElement);
 263         return elementsOnThisParticipant;
 264     }
 265
 266     /**
 267      * Returns a AutomationCompositionHandler with elements on the id,uuid.
 268      *
 269      * @param id ToscaConceptIdentifier and uuid UUID
 270      * @return a AutomationCompositionHander with elements
 271      */
 272     public AutomationCompositionHandler setTestAutomationCompositionHandler(ToscaConceptIdentifier id, UUID uuid)
 273             throws CoderException {
 274         var ach = getMockAutomationCompositionHandler();
 275
 276         var key = getTestAutomationCompositionMap().keySet().iterator().next();
 277         var value = getTestAutomationCompositionMap().get(key);
 278         ach.getAutomationCompositionMap().put(key, value);
 279
 280         var keyElem = setAutomationCompositionElementTest(uuid, id).keySet().iterator().next();
 281         var valueElem = setAutomationCompositionElementTest(uuid, id).get(keyElem);
 282         ach.getElementsOnThisParticipant().put(keyElem, valueElem);
 283
 284         return ach;
 285     }
 286
 287 }