2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2020-2021 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.policy.controlloop.actor.test;
23 import static org.junit.Assert.assertFalse;
24 import static org.junit.Assert.assertNotNull;
25 import static org.junit.Assert.assertTrue;
27 import java.io.FileNotFoundException;
30 import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
31 import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
32 import org.onap.policy.common.endpoints.http.client.HttpClientConfigException;
33 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
34 import org.onap.policy.common.endpoints.parameters.TopicParameterGroup;
35 import org.onap.policy.common.parameters.BeanValidationResult;
36 import org.onap.policy.common.parameters.BeanValidator;
37 import org.onap.policy.common.parameters.annotations.NotNull;
38 import org.onap.policy.common.utils.coder.Coder;
39 import org.onap.policy.common.utils.coder.CoderException;
40 import org.onap.policy.common.utils.coder.StandardYamlCoder;
41 import org.onap.policy.common.utils.resources.ResourceUtils;
42 import org.onap.policy.controlloop.actorserviceprovider.ActorService;
43 import org.onap.policy.controlloop.actorserviceprovider.Operator;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
48 * Superclass for various Actor tests.
50 public class BasicActor {
51 private static final Logger logger = LoggerFactory.getLogger(BasicActor.class);
52 private static final Coder yamlCoder = new StandardYamlCoder();
55 * Reads a YAML configuration file, configures the specified topics and HTTP clients,
56 * and then runs the specified actor through its paces: configure(), start(), stop(),
57 * and shutdown(). Finally, it destroys the topics and HTTP clients.
59 * @param actorName name of the actor to be tested.
60 * @param yamlConfigFile YAML configuration file name
61 * @throws IllegalArgumentException if an error occurs
63 protected void verifyActorService(String actorName, String yamlConfigFile) {
64 ActorService service = new ActorService() {};
66 // ensure the actor was loaded
67 assertNotNull(service.getActor(actorName));
70 MyConfig config = readConfig(yamlConfigFile);
73 startOtherServices(config);
75 // configure and verify
76 service.configure(config.getActors());
77 for (Operator operator : service.getActor(actorName).getOperators()) {
78 assertTrue(operator.isConfigured());
83 for (Operator operator : service.getActor(actorName).getOperators()) {
84 assertTrue(operator.isAlive());
89 for (Operator operator : service.getActor(actorName).getOperators()) {
90 assertFalse(operator.isAlive());
93 // shut down and verify
95 for (Operator operator : service.getActor(actorName).getOperators()) {
96 assertFalse(operator.isAlive());
99 } catch (HttpClientConfigException e) {
100 logger.error("failed to configure HTTP client(s) for actor: {}", actorName);
101 throw new IllegalArgumentException(e);
109 * Reads a YAML configuration from a file.
111 * @param yamlConfigFile YAML configuration file name
112 * @return the configuration that was read from the file
113 * @throws AssertionError if an error occurs
114 * @throws CoderException if an error occurs
116 private MyConfig readConfig(String yamlConfigFile) {
118 var yaml = ResourceUtils.getResourceAsString(yamlConfigFile);
120 throw new FileNotFoundException(yamlConfigFile);
123 return yamlCoder.decode(yaml, MyConfig.class);
125 } catch (CoderException | FileNotFoundException e) {
126 logger.error("cannot decode YAML file {}", yamlConfigFile);
127 throw new IllegalArgumentException(e);
132 * Starts the Topic and HTTP clients.
134 * @param config configuration
135 * @throws HttpClientConfigException if an error occurs
137 private void startOtherServices(MyConfig config) throws HttpClientConfigException {
140 if (config.getHttpClients() != null) {
141 var factory = HttpClientFactoryInstance.getClientFactory();
142 for (BusTopicParams params : config.getHttpClients()) {
143 factory.build(params);
147 if (config.getTopics() != null) {
148 TopicEndpointManager.getManager().addTopics(config.getTopics());
153 * Stops the Topic and HTTP clients.
155 private void stopOtherServices() {
156 TopicEndpointManager.getManager().shutdown();
157 HttpClientFactoryInstance.getClientFactory().destroy();
161 public static class MyConfig {
162 private BusTopicParams[] httpClients;
163 private TopicParameterGroup topics;
166 private Map<String, Object> actors;
169 * Validates the config.
171 public void validate() {
172 BeanValidationResult result = new BeanValidator().validateTop(BasicActor.class.getSimpleName(), this);
173 if (topics != null) {
174 result.addResult(topics.validate());
176 if (!result.isValid()) {
177 throw new IllegalArgumentException(result.getResult());