models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/BasicSoOperation.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020 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.policy.controlloop.actor.so;
  22
  23 import static org.mockito.ArgumentMatchers.any;
  24 import static org.mockito.Mockito.when;
  25
  26 import java.util.Collections;
  27 import java.util.HashMap;
  28 import java.util.LinkedList;
  29 import java.util.List;
  30 import java.util.Map;
  31 import org.mockito.Mock;
  32 import org.onap.policy.aai.AaiCqResponse;
  33 import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
  34 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
  35 import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
  36 import org.onap.policy.controlloop.actor.test.BasicHttpOperation;
  37 import org.onap.policy.controlloop.actorserviceprovider.Util;
  38 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig;
  39 import org.onap.policy.controlloop.policy.Target;
  40 import org.onap.policy.simulators.SoSimulatorJaxRs;
  41 import org.onap.policy.so.SoRequest;
  42 import org.onap.policy.so.SoRequestParameters;
  43 import org.onap.policy.so.SoRequestReferences;
  44 import org.onap.policy.so.SoRequestStatus;
  45 import org.onap.policy.so.SoResponse;
  46
  47 /**
  48  * Superclass for various operator tests.
  49  */
  50 public abstract class BasicSoOperation extends BasicHttpOperation<SoRequest> {
  51     protected static final String[] IGNORE_FIELDS = {"RequestID", "subRequestID", "seconds", "nanos"};
  52
  53     public static final String MODEL_CUSTOM_ID = "my-model-customization-id";
  54     public static final String MODEL_INVAR_ID = "my-model-invariant-id";
  55     public static final String MODEL_NAME = "my-model-name";
  56     public static final String MODEL_VERSION = "my-model-version";
  57     public static final String MODEL_VERS_ID = "my-model-version-id";
  58     public static final String SUBSCRIPTION_SVC_TYPE = "my-subscription-service-type";
  59     public static final String MY_PATH = "my-path";
  60     public static final String POLL_PATH = "my-poll-path/";
  61     public static final int MAX_POLLS = 3;
  62     public static final int POLL_WAIT_SEC = 20;
  63     public static final Integer VF_COUNT = 10;
  64
  65     @Mock
  66     protected HttpPollingConfig config;
  67
  68     protected Target target;
  69     protected SoResponse response;
  70
  71     /**
  72      * Constructs the object using a default actor and operation name.
  73      */
  74     public BasicSoOperation() {
  75         super();
  76     }
  77
  78     /**
  79      * Constructs the object.
  80      *
  81      * @param actor actor name
  82      * @param operation operation name
  83      */
  84     public BasicSoOperation(String actor, String operation) {
  85         super(actor, operation);
  86     }
  87
  88     /**
  89      * Starts the simulator.
  90      */
  91     protected static void initBeforeClass() throws Exception {
  92         org.onap.policy.simulators.Util.buildSoSim();
  93
  94         BusTopicParams clientParams = BusTopicParams.builder().clientName(MY_CLIENT).basePath("").hostname("localhost")
  95                         .managed(true).port(org.onap.policy.simulators.Util.SOSIM_SERVER_PORT)
  96                         .build();
  97         HttpClientFactoryInstance.getClientFactory().build(clientParams);
  98
  99         SoSimulatorJaxRs.setRequirePolling(true);
 100     }
 101
 102     protected static void destroyAfterClass() {
 103         SoSimulatorJaxRs.setRequirePolling(false);
 104         HttpClientFactoryInstance.getClientFactory().destroy();
 105         HttpServletServerFactoryInstance.getServerFactory().destroy();
 106     }
 107
 108     /**
 109      * Initializes mocks and sets up.
 110      */
 111     public void setUp() throws Exception {
 112         super.setUpBasic();
 113
 114         response = new SoResponse();
 115
 116         SoRequest request = new SoRequest();
 117         response.setRequest(request);
 118
 119         SoRequestStatus status = new SoRequestStatus();
 120         request.setRequestStatus(status);
 121         status.setRequestState(SoOperation.COMPLETE);
 122
 123         SoRequestReferences ref = new SoRequestReferences();
 124         response.setRequestReferences(ref);
 125         ref.setRequestId(REQ_ID.toString());
 126
 127         when(rawResponse.getStatus()).thenReturn(200);
 128         when(rawResponse.readEntity(String.class)).thenReturn(coder.encode(response));
 129
 130         initConfig();
 131     }
 132
 133     @Override
 134     protected void initConfig() {
 135         super.initConfig();
 136         when(config.getClient()).thenReturn(client);
 137         when(config.getPath()).thenReturn(MY_PATH);
 138         when(config.getMaxPolls()).thenReturn(MAX_POLLS);
 139         when(config.getPollPath()).thenReturn(POLL_PATH);
 140         when(config.getPollWaitSec()).thenReturn(POLL_WAIT_SEC);
 141     }
 142
 143     @Override
 144     protected void makeContext() {
 145         super.makeContext();
 146
 147         target = new Target();
 148         target.setModelCustomizationId(MODEL_CUSTOM_ID);
 149         target.setModelInvariantId(MODEL_INVAR_ID);
 150         target.setModelName(MODEL_NAME);
 151         target.setModelVersion(MODEL_VERSION);
 152         target.setModelVersionId(MODEL_VERS_ID);
 153
 154         params = params.toBuilder().target(target).build();
 155     }
 156
 157     @Override
 158     protected Map<String, Object> makePayload() {
 159         Map<String, Object> payload = new HashMap<>();
 160
 161         // request parameters
 162         SoRequestParameters reqParams = new SoRequestParameters();
 163         reqParams.setSubscriptionServiceType(SUBSCRIPTION_SVC_TYPE);
 164         payload.put(SoOperation.REQ_PARAM_NM, Util.translate("", reqParams, String.class));
 165
 166         // config parameters
 167         List<Map<String, String>> config = new LinkedList<>();
 168         config.add(Collections.emptyMap());
 169         payload.put(SoOperation.CONFIG_PARAM_NM, Util.translate("", config, String.class));
 170
 171         return payload;
 172     }
 173
 174     protected AaiCqResponse makeCqResponse() {
 175         when(cqResponse.getVfModuleCount(any(), any(), any())).thenReturn(VF_COUNT);
 176         return cqResponse;
 177     }
 178 }