Add docker file for all simulators

Some CSITs may require multiple simulators.  This adds a class that
will start all of the simulators.  A tarball is generated from which
a docker image can be built.
Added simulators for Topics: appc and appc-lcm.
Fixed licenses in files in packages directory.
Fixed per review comments:
- add version to Dockerfile

Issue-ID: POLICY-2434
Signed-off-by: Jim Hahn <jrh3@att.com>
Change-Id: Id7aa9cb5a5874f7b4185273ab0d2c074198554ff

4 files changed, 459 insertions, 0 deletions

diff --git a/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/ClassRestServerParameters.java b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/ClassRestServerParameters.java
new file mode 100644
index 000000000..030d77449
--- /dev/null
+++ b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/ClassRestServerParameters.java
@@ -0,0 +1,48 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.models.simulators;
+
+import lombok.Getter;
+import org.apache.commons.lang3.StringUtils;
+import org.onap.policy.common.endpoints.parameters.RestServerParameters;
+import org.onap.policy.common.parameters.ObjectValidationResult;
+import org.onap.policy.common.parameters.ValidationResult;
+import org.onap.policy.common.parameters.ValidationStatus;
+
+@Getter
+public class ClassRestServerParameters extends RestServerParameters {
+    private String providerClass;
+
+    /**
+     * Validates the parameters.
+     *
+     * @param containerName name of the parameter container
+     * @return the validation result
+     */
+    public ValidationResult validate(String containerName) {
+        // not using a BeanValidator because username and password are not required
+        if (StringUtils.isBlank(providerClass)) {
+            return new ObjectValidationResult("providerClass", providerClass, ValidationStatus.INVALID, "is empty");
+        }
+
+        return new ObjectValidationResult("providerClass", providerClass);
+    }
+}
diff --git a/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/Main.java b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/Main.java
new file mode 100644
index 000000000..8333800f3
--- /dev/null
+++ b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/Main.java
@@ -0,0 +1,281 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.models.simulators;
+
+import java.io.FileNotFoundException;
+import java.lang.reflect.InvocationTargetException;
+import java.util.List;
+import java.util.Properties;
+import java.util.concurrent.atomic.AtomicReference;
+import lombok.AccessLevel;
+import lombok.Getter;
+import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
+import org.onap.policy.common.endpoints.event.comm.TopicSink;
+import org.onap.policy.common.endpoints.event.comm.TopicSource;
+import org.onap.policy.common.endpoints.http.server.HttpServletServer;
+import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
+import org.onap.policy.common.endpoints.parameters.TopicParameters;
+import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
+import org.onap.policy.common.gson.GsonMessageBodyHandler;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.utils.coder.Coder;
+import org.onap.policy.common.utils.coder.CoderException;
+import org.onap.policy.common.utils.coder.StandardCoder;
+import org.onap.policy.common.utils.network.NetworkUtil;
+import org.onap.policy.common.utils.resources.ResourceUtils;
+import org.onap.policy.common.utils.services.ServiceManagerContainer;
+import org.onap.policy.models.sim.dmaap.parameters.DmaapSimParameterGroup;
+import org.onap.policy.models.sim.dmaap.provider.DmaapSimProvider;
+import org.onap.policy.models.sim.dmaap.rest.CambriaMessageBodyHandler;
+import org.onap.policy.models.sim.dmaap.rest.TextMessageBodyHandler;
+import org.onap.policy.simulators.TopicServer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * This class runs all simulators specified in the parameter file.
+ */
+public class Main extends ServiceManagerContainer {
+    private static final Logger logger = LoggerFactory.getLogger(Main.class);
+
+    private static final String CANNOT_CONNECT = "cannot connect to port ";
+
+    @Getter(AccessLevel.PROTECTED)
+    private static Main instance;
+
+
+    /**
+     * Runs the simulators.
+     *
+     * @param paramFile parameter file name
+     */
+    public Main(String paramFile) {
+        super(Main.class.getPackage().getName());
+
+        SimulatorParameters params = readParameters(paramFile);
+        BeanValidationResult result = params.validate("simulators");
+        if (!result.isValid()) {
+            logger.error("invalid parameters:\n{}", result.getResult());
+            throw new IllegalArgumentException("invalid simulator parameters");
+        }
+
+        DmaapSimParameterGroup dmaapProv = params.getDmaapProvider();
+        String dmaapName = dmaapProv.getName();
+        String provName = dmaapName.replace("simulator", "provider");
+
+        // dmaap provider
+        AtomicReference<DmaapSimProvider> provRef = new AtomicReference<>();
+        addAction(provName, () -> provRef.set(buildDmaapProvider(dmaapProv)), () -> provRef.get().shutdown());
+
+        // @formatter:off
+
+        // REST server simulators
+        for (ClassRestServerParameters restsim : params.getRestServers()) {
+            AtomicReference<HttpServletServer> ref = new AtomicReference<>();
+            addAction(restsim.getName(),
+                () -> ref.set(buildRestServer(dmaapName, restsim)),
+                () -> ref.get().shutdown());
+        }
+
+        // NOTE: topics must be started AFTER the (dmaap) rest servers
+
+        // topic sinks
+        AtomicReference<List<TopicSink>> sinkRef = new AtomicReference<>();
+        addAction("topic sinks", () -> sinkRef.set(buildSinks(params.getTopicSinks())),
+            () -> shutdownSinks(sinkRef.get()));
+
+        // topic sources
+        AtomicReference<List<TopicSource>> sourceRef = new AtomicReference<>();
+        addAction("topic sources", () -> sourceRef.set(buildSources(params.getTopicSources())),
+            () -> shutdownSources(sourceRef.get()));
+
+        // topic server simulators
+        for (TopicServerParameters topicsim : params.getTopicServers()) {
+            AtomicReference<TopicServer<?>> ref = new AtomicReference<>();
+            addAction(topicsim.getName(),
+                () -> ref.set(buildTopicServer(topicsim, sinkRef.get(), sourceRef.get())),
+                () -> ref.get().shutdown());
+        }
+
+        // @formatter:on
+    }
+
+    /**
+     * The main method.
+     *
+     * @param args the arguments, the first of which is the name of the parameter file
+     */
+    public static void main(final String[] args) {
+        try {
+            if (args.length != 1) {
+                throw new IllegalArgumentException("arg(s): parameter-file-name");
+            }
+
+            instance = new Main(args[0]);
+            instance.start();
+
+        } catch (RuntimeException e) {
+            logger.error("failed to start simulators", e);
+        }
+    }
+
+    private SimulatorParameters readParameters(String paramFile) {
+        try {
+            String paramsJson = getResourceAsString(paramFile);
+            if (paramsJson == null) {
+                throw new IllegalArgumentException(new FileNotFoundException(paramFile));
+            }
+
+            String hostName = NetworkUtil.getHostname();
+            logger.info("replacing 'HOST_NAME' with {} in {}", hostName, paramFile);
+
+            paramsJson = paramsJson.replace("${HOST_NAME}", hostName);
+
+            return makeCoder().decode(paramsJson, SimulatorParameters.class);
+
+        } catch (CoderException e) {
+            throw new IllegalArgumentException("cannot decode " + paramFile, e);
+        }
+    }
+
+    private DmaapSimProvider buildDmaapProvider(DmaapSimParameterGroup params) {
+        DmaapSimProvider prov = new DmaapSimProvider(params);
+        DmaapSimProvider.setInstance(prov);
+        prov.start();
+
+        return prov;
+    }
+
+    protected List<TopicSink> buildSinks(List<TopicParameters> params) {
+        return TopicEndpointManager.getManager().addTopicSinks(params);
+    }
+
+    private void shutdownSinks(List<TopicSink> sinks) {
+        sinks.forEach(TopicSink::shutdown);
+    }
+
+    protected List<TopicSource> buildSources(List<TopicParameters> params) {
+        return TopicEndpointManager.getManager().addTopicSources(params);
+    }
+
+    private void shutdownSources(List<TopicSource> sources) {
+        sources.forEach(TopicSource::shutdown);
+    }
+
+    private HttpServletServer buildRestServer(String dmaapName, ClassRestServerParameters params) {
+        try {
+            Properties props = getServerProperties(dmaapName, params);
+            HttpServletServer testServer = makeServer(props);
+            testServer.waitedStart(5000);
+
+            String svcpfx = PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + params.getName();
+            String hostName = props.getProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_HOST_SUFFIX);
+
+            if (!isTcpPortOpen(hostName, testServer.getPort())) {
+                throw new IllegalStateException(CANNOT_CONNECT + testServer.getPort());
+            }
+
+            return testServer;
+
+        } catch (InterruptedException e) {
+            Thread.currentThread().interrupt();
+            throw new IllegalStateException("interrupted while building " + params.getName(), e);
+        }
+    }
+
+    private TopicServer<?> buildTopicServer(TopicServerParameters params, List<TopicSink> sinks,
+                    List<TopicSource> sources) {
+        try {
+            // find the desired sink
+            TopicSink sink = sinks.stream().filter(sink2 -> sink2.getTopic().equals(params.getSink())).findAny()
+                            .orElseThrow(() -> new IllegalArgumentException("invalid sink topic " + params.getSink()));
+
+            // find the desired source
+            TopicSource source = sources.stream().filter(source2 -> source2.getTopic().equals(params.getSource()))
+                            .findAny().orElseThrow(() -> new IllegalArgumentException(
+                                            "invalid source topic " + params.getSource()));
+
+            // create the topic server
+            return (TopicServer<?>) Class.forName(params.getProviderClass())
+                            .getDeclaredConstructor(TopicSink.class, TopicSource.class).newInstance(sink, source);
+
+        } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException
+                        | SecurityException | ClassNotFoundException e) {
+            throw new IllegalArgumentException("cannot create TopicServer: " + params.getName(), e);
+        }
+    }
+
+    /**
+     * Creates a set of properties, suitable for building a REST server, from the
+     * parameters.
+     *
+     * @param params parameters from which to build the properties
+     * @return a set of properties representing the given parameters
+     */
+    private static Properties getServerProperties(String dmaapName, ClassRestServerParameters params) {
+        final Properties props = new Properties();
+        props.setProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES, params.getName());
+
+        final String svcpfx = PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + params.getName();
+
+        props.setProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES, params.getName());
+        props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_HOST_SUFFIX, params.getHost());
+        props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_PORT_SUFFIX,
+                        Integer.toString(params.getPort()));
+        props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_HTTPS_SUFFIX,
+                        Boolean.toString(params.isHttps()));
+        props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_REST_CLASSES_SUFFIX,
+                        params.getProviderClass());
+        props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX, "false");
+        props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_SWAGGER_SUFFIX, "false");
+        props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX, "true");
+
+        if (dmaapName.equals(params.getName())) {
+            props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_SERIALIZATION_PROVIDER,
+                            String.join(",", CambriaMessageBodyHandler.class.getName(),
+                                            GsonMessageBodyHandler.class.getName(),
+                                            TextMessageBodyHandler.class.getName()));
+        } else {
+            props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_SERIALIZATION_PROVIDER, String.join(",",
+                            GsonMessageBodyHandler.class.getName(), TextMessageBodyHandler.class.getName()));
+        }
+
+        return props;
+    }
+
+    // the following methods may be overridden by junit tests
+
+    protected String getResourceAsString(String resourceName) {
+        return ResourceUtils.getResourceAsString(resourceName);
+    }
+
+    protected Coder makeCoder() {
+        return new StandardCoder();
+    }
+
+    protected HttpServletServer makeServer(Properties props) {
+        return HttpServletServerFactoryInstance.getServerFactory().build(props).get(0);
+    }
+
+    protected boolean isTcpPortOpen(String hostName, int port) throws InterruptedException {
+        return NetworkUtil.isTcpPortOpen(hostName, port, 100, 200L);
+    }
+}
diff --git a/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/SimulatorParameters.java b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/SimulatorParameters.java
new file mode 100644
index 000000000..c47ff8876
--- /dev/null
+++ b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/SimulatorParameters.java
@@ -0,0 +1,82 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.models.simulators;
+
+import java.util.LinkedList;
+import java.util.List;
+import lombok.Getter;
+import org.onap.policy.common.endpoints.parameters.TopicParameters;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.BeanValidator;
+import org.onap.policy.common.parameters.annotations.NotNull;
+import org.onap.policy.models.sim.dmaap.parameters.DmaapSimParameterGroup;
+
+/**
+ * Simulator parameters.
+ */
+@Getter
+@NotNull
+public class SimulatorParameters {
+
+    /**
+     * Note: this is only used to capture the provider's parameters; the rest server
+     * parameters that it contains are ignored. Instead, the parameters for the rest
+     * server are contained within the {@link #restServers} entry having the same name as
+     * the provider parameters.
+     */
+    private DmaapSimParameterGroup dmaapProvider;
+
+    /**
+     * Parameters for the REST server simulators that are to be started.
+     */
+    private List<ClassRestServerParameters> restServers = new LinkedList<>();
+
+    /**
+     * Topic sinks that are used by {@link #topicServers}.
+     */
+    private List<TopicParameters> topicSinks = new LinkedList<>();
+
+    /**
+     * Topic sources that are used by {@link #topicServers}.
+     */
+    private List<TopicParameters> topicSources = new LinkedList<>();
+
+    /**
+     * Parameters for the TOPIC server simulators that are to be started.
+     */
+    private List<TopicServerParameters> topicServers = new LinkedList<>();
+
+
+    /**
+     * Validates the parameters.
+     *
+     * @param containerName name of the parameter container
+     * @return the validation result
+     */
+    public BeanValidationResult validate(String containerName) {
+        BeanValidationResult result = new BeanValidator().validateTop(containerName, this);
+
+        result.validateList("restServers", restServers, params -> params.validate("restServers"));
+        result.validateList("topicServers", topicServers, params -> params.validate("topicServers"));
+
+        return result;
+    }
+}
diff --git a/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/TopicServerParameters.java b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/TopicServerParameters.java
new file mode 100644
index 000000000..8a477b232
--- /dev/null
+++ b/models-sim/policy-models-simulators/src/main/java/org/onap/policy/models/simulators/TopicServerParameters.java
@@ -0,0 +1,48 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.models.simulators;
+
+import lombok.Getter;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.BeanValidator;
+import org.onap.policy.common.parameters.annotations.NotBlank;
+import org.onap.policy.common.parameters.annotations.NotNull;
+
+@Getter
+@NotNull
+@NotBlank
+public class TopicServerParameters {
+    private String name;
+    private String providerClass;
+    private String sink;
+    private String source;
+
+
+    /**
+     * Validates the parameters.
+     *
+     * @param containerName name of the parameter container
+     * @return the validation result
+     */
+    public BeanValidationResult validate(String containerName) {
+        return new BeanValidator().validateTop(containerName, this);
+    }
+}