From bc02433cc5292c5272dc084db8044bb4c8140135 Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Tue, 17 Mar 2020 17:41:59 -0400 Subject: 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 Change-Id: Id7aa9cb5a5874f7b4185273ab0d2c074198554ff --- models-interactions/model-simulators/pom.xml | 137 ++++++++++++--------- .../onap/policy/simulators/AppcLcmTopicServer.java | 42 +++++++ .../policy/simulators/AppcLegacyTopicServer.java | 42 +++++++ .../org/onap/policy/simulators/TopicServer.java | 72 +++++++++++ .../simulators/appc/appc.legacy.success.json | 17 +++ .../simulators/appclcm/appc.lcm.success.json | 22 ++++ .../policy/simulators/AppcLcmTopicServerTest.java | 69 +++++++++++ .../simulators/AppcLegacyTopicServerTest.java | 69 +++++++++++ .../onap/policy/simulators/TopicServerTest.java | 104 ++++++++++++++++ .../simulators/appc/appc.legacy.request.json | 10 ++ .../simulators/appclcm/appc.lcm.request.json | 17 +++ 11 files changed, 541 insertions(+), 60 deletions(-) create mode 100644 models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLcmTopicServer.java create mode 100644 models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLegacyTopicServer.java create mode 100644 models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/TopicServer.java create mode 100644 models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appc/appc.legacy.success.json create mode 100644 models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appclcm/appc.lcm.success.json create mode 100644 models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLcmTopicServerTest.java create mode 100644 models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLegacyTopicServerTest.java create mode 100644 models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/TopicServerTest.java create mode 100644 models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appc/appc.legacy.request.json create mode 100644 models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appclcm/appc.lcm.request.json (limited to 'models-interactions') diff --git a/models-interactions/model-simulators/pom.xml b/models-interactions/model-simulators/pom.xml index fc9fe12f3..d74aa05ad 100644 --- a/models-interactions/model-simulators/pom.xml +++ b/models-interactions/model-simulators/pom.xml @@ -1,6 +1,6 @@ - - 4.0.0 + + 4.0.0 - - org.onap.policy.models - policy-models-interactions - 2.2.1-SNAPSHOT - + + org.onap.policy.models + policy-models-interactions + 2.2.1-SNAPSHOT + - org.onap.policy.models.policy-models-interactions - simulators + org.onap.policy.models.policy-models-interactions + simulators - - - org.onap.policy.common - policy-endpoints - ${policy.common.version} - - - junit - junit - test - - - org.onap.policy.models.policy-models-interactions.model-impl - aai - ${project.version} - - - org.onap.policy.models.policy-models-interactions.model-impl - so - ${project.version} - - - org.onap.policy.models.policy-models-interactions.model-impl - vfc - ${project.version} - test - - - com.google.code.gson - gson - provided - - - org.onap.policy.models.policy-models-interactions.model-impl - sdnc - ${project.version} - - - org.onap.policy.models - policy-models-decisions - ${project.version} - - - org.onap.policy.models.sim - policy-models-sim-dmaap - ${project.version} - - + + + org.onap.policy.common + policy-endpoints + ${policy.common.version} + + + junit + junit + test + + + org.onap.policy.models.policy-models-interactions.model-impl + aai + ${project.version} + + + org.onap.policy.models.policy-models-interactions.model-impl + appc + ${project.version} + + + org.onap.policy.models.policy-models-interactions.model-impl + appclcm + ${project.version} + + + org.onap.policy.models.policy-models-interactions.model-impl + so + ${project.version} + + + org.onap.policy.models.policy-models-interactions.model-impl + vfc + ${project.version} + test + + + com.google.code.gson + gson + provided + + + org.onap.policy.models.policy-models-interactions.model-impl + sdnc + ${project.version} + + + org.onap.policy.models + policy-models-decisions + ${project.version} + + + org.onap.policy.models.sim + policy-models-sim-dmaap + ${project.version} + + + org.powermock + powermock-api-mockito2 + test + + diff --git a/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLcmTopicServer.java b/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLcmTopicServer.java new file mode 100644 index 000000000..df4cbb31e --- /dev/null +++ b/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLcmTopicServer.java @@ -0,0 +1,42 @@ +/*- + * ============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.simulators; + +import org.onap.policy.appclcm.AppcLcmDmaapWrapper; +import org.onap.policy.common.endpoints.event.comm.TopicSink; +import org.onap.policy.common.endpoints.event.comm.TopicSource; +import org.onap.policy.common.utils.coder.StandardCoder; +import org.onap.policy.common.utils.resources.ResourceUtils; + +/** + * APPC-LCM topic server. + */ +public class AppcLcmTopicServer extends TopicServer { + public AppcLcmTopicServer(TopicSink sink, TopicSource source) { + super(sink, source, new StandardCoder(), AppcLcmDmaapWrapper.class); + } + + @Override + protected String process(AppcLcmDmaapWrapper request) { + String response = ResourceUtils.getResourceAsString("org/onap/policy/simulators/appclcm/appc.lcm.success.json"); + return response.replace("${replaceMe}", request.getBody().getInput().getCommonHeader().getSubRequestId()); + } +} diff --git a/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLegacyTopicServer.java b/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLegacyTopicServer.java new file mode 100644 index 000000000..5ebd3bd2a --- /dev/null +++ b/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/AppcLegacyTopicServer.java @@ -0,0 +1,42 @@ +/*- + * ============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.simulators; + +import org.onap.policy.appc.Request; +import org.onap.policy.common.endpoints.event.comm.TopicSink; +import org.onap.policy.common.endpoints.event.comm.TopicSource; +import org.onap.policy.common.utils.coder.StandardCoderInstantAsMillis; +import org.onap.policy.common.utils.resources.ResourceUtils; + +/** + * Legacy APPC topic server. + */ +public class AppcLegacyTopicServer extends TopicServer { + public AppcLegacyTopicServer(TopicSink sink, TopicSource source) { + super(sink, source, new StandardCoderInstantAsMillis(), Request.class); + } + + @Override + protected String process(Request request) { + String response = ResourceUtils.getResourceAsString("org/onap/policy/simulators/appc/appc.legacy.success.json"); + return response.replace("${replaceMe}", request.getCommonHeader().getSubRequestId()); + } +} diff --git a/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/TopicServer.java b/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/TopicServer.java new file mode 100644 index 000000000..0abe5f421 --- /dev/null +++ b/models-interactions/model-simulators/src/main/java/org/onap/policy/simulators/TopicServer.java @@ -0,0 +1,72 @@ +/*- + * ============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.simulators; + +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.endpoints.event.comm.TopicListener; +import org.onap.policy.common.endpoints.event.comm.TopicSink; +import org.onap.policy.common.endpoints.event.comm.TopicSource; +import org.onap.policy.common.utils.coder.Coder; +import org.onap.policy.common.utils.coder.CoderException; + +/** + * Server whose requests are received from a topic, and whose responses are sent to a + * topic. + */ +public abstract class TopicServer implements TopicListener { + private final TopicSink sink; + private final TopicSource source; + private final Coder coder; + private final Class reqClass; + + /** + * Constructs the object. + * + * @param sink sink to which responses should be published + * @param source source from which requests arrive + */ + public TopicServer(TopicSink sink, TopicSource source, Coder coder, Class reqClass) { + this.sink = sink; + this.source = source; + this.coder = coder; + this.reqClass = reqClass; + + source.register(this); + } + + public void shutdown() { + source.unregister(this); + } + + @Override + public void onTopicEvent(CommInfrastructure commType, String topic, String request) { + Q req; + try { + req = coder.decode(request, reqClass); + } catch (CoderException e) { + throw new IllegalArgumentException("cannot decode request from " + source.getTopic()); + } + + sink.send(process(req)); + } + + protected abstract String process(Q request); +} diff --git a/models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appc/appc.legacy.success.json b/models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appc/appc.legacy.success.json new file mode 100644 index 000000000..eb19c6832 --- /dev/null +++ b/models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appc/appc.legacy.success.json @@ -0,0 +1,17 @@ +{ + "CommonHeader": { + "TimeStamp": 1506051879001, + "APIver": "1.01", + "RequestID": "c7c6a4aa-bb61-4a15-b831-ba1472dd4a65", + "SubRequestID": "${replaceMe}", + "RequestTrack": [], + "Flags": [] + }, + "Status": { + "Code": 400, + "Value": "SUCCESS" + }, + "Payload": { + "generic-vnf.vnf-id": "jimmy-test-vnf2" + } +} diff --git a/models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appclcm/appc.lcm.success.json b/models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appclcm/appc.lcm.success.json new file mode 100644 index 000000000..331021798 --- /dev/null +++ b/models-interactions/model-simulators/src/main/resources/org/onap/policy/simulators/appclcm/appc.lcm.success.json @@ -0,0 +1,22 @@ +{ + "body": { + "output": { + "common-header": { + "timestamp": "2017-08-25T21:06:23.037Z", + "api-ver": "5.00", + "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200", + "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200", + "sub-request-id": "${replaceMe}", + "flags": {} + }, + "status": { + "code": 400, + "message": "Restart Successful" + } + } + }, + "version": "2.0", + "rpc-name": "restart", + "correlation-id": "664be3d2-6c12-4f4b-a3e7-c349acced200-1", + "type": "response" +} diff --git a/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLcmTopicServerTest.java b/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLcmTopicServerTest.java new file mode 100644 index 000000000..bc803154f --- /dev/null +++ b/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLcmTopicServerTest.java @@ -0,0 +1,69 @@ +/*- + * ============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.simulators; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.Assert.assertNotNull; +import static org.mockito.Mockito.verify; + +import org.junit.Before; +import org.junit.Test; +import org.mockito.ArgumentCaptor; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.endpoints.event.comm.TopicSink; +import org.onap.policy.common.endpoints.event.comm.TopicSource; +import org.onap.policy.common.utils.resources.ResourceUtils; + +public class AppcLcmTopicServerTest { + private static final String MY_TOPIC = "my-topic"; + + @Mock + private TopicSink sink; + @Mock + private TopicSource source; + + private AppcLcmTopicServer server; + + /** + * Sets up. + */ + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + + server = new AppcLcmTopicServer(sink, source); + } + + @Test + public void testProcessAppcLcmDmaapWrapper() { + String request = ResourceUtils.getResourceAsString("org/onap/policy/simulators/appclcm/appc.lcm.request.json"); + assertNotNull(request); + + server.onTopicEvent(CommInfrastructure.NOOP, MY_TOPIC, request); + + ArgumentCaptor respCaptor = ArgumentCaptor.forClass(String.class); + verify(sink).send(respCaptor.capture()); + + assertThat(respCaptor.getValue()).contains("111be3d2").doesNotContain("replaceMe"); + } +} diff --git a/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLegacyTopicServerTest.java b/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLegacyTopicServerTest.java new file mode 100644 index 000000000..57d574a0b --- /dev/null +++ b/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/AppcLegacyTopicServerTest.java @@ -0,0 +1,69 @@ +/*- + * ============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.simulators; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.Assert.assertNotNull; +import static org.mockito.Mockito.verify; + +import org.junit.Before; +import org.junit.Test; +import org.mockito.ArgumentCaptor; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.endpoints.event.comm.TopicSink; +import org.onap.policy.common.endpoints.event.comm.TopicSource; +import org.onap.policy.common.utils.resources.ResourceUtils; + +public class AppcLegacyTopicServerTest { + private static final String MY_TOPIC = "my-topic"; + + @Mock + private TopicSink sink; + @Mock + private TopicSource source; + + private AppcLegacyTopicServer server; + + /** + * Sets up. + */ + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + + server = new AppcLegacyTopicServer(sink, source); + } + + @Test + public void testProcessAppcLcmDmaapWrapper() { + String request = ResourceUtils.getResourceAsString("org/onap/policy/simulators/appc/appc.legacy.request.json"); + assertNotNull(request); + + server.onTopicEvent(CommInfrastructure.NOOP, MY_TOPIC, request); + + ArgumentCaptor respCaptor = ArgumentCaptor.forClass(String.class); + verify(sink).send(respCaptor.capture()); + + assertThat(respCaptor.getValue()).contains("111be3d2").doesNotContain("replaceMe"); + } +} diff --git a/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/TopicServerTest.java b/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/TopicServerTest.java new file mode 100644 index 000000000..6e176423e --- /dev/null +++ b/models-interactions/model-simulators/src/test/java/org/onap/policy/simulators/TopicServerTest.java @@ -0,0 +1,104 @@ +/*- + * ============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.simulators; + +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.junit.Assert.assertEquals; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; + +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.endpoints.event.comm.TopicSink; +import org.onap.policy.common.endpoints.event.comm.TopicSource; +import org.onap.policy.common.utils.coder.StandardCoder; + +public class TopicServerTest { + private static final String MY_TOPIC = "my-topic"; + private static final String TEXT = "hello"; + private static final String RESPONSE = "world"; + + @Mock + private TopicSink sink; + @Mock + private TopicSource source; + + private MyServer server; + + /** + * Sets up. + */ + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + + server = new MyServer(); + } + + @Test + public void testConstructor() { + verify(source).register(server); + } + + @Test + public void testShutdown() { + server.shutdown(); + verify(source).unregister(server); + } + + @Test + public void testOnTopicEvent() { + server.onTopicEvent(CommInfrastructure.NOOP, MY_TOPIC, "{\"text\": \"hello\"}"); + verify(sink).send(RESPONSE); + } + + /** + * Tests onTopicEvent() when the coder throws an exception. + */ + @Test + public void testOnTopicEventException() { + assertThatIllegalArgumentException() + .isThrownBy(() -> server.onTopicEvent(CommInfrastructure.NOOP, MY_TOPIC, "{invalid json")); + + verify(sink, never()).send(any()); + } + + + private class MyRequest { + private String text; + } + + private class MyServer extends TopicServer { + public MyServer() { + super(sink, source, new StandardCoder(), MyRequest.class); + } + + @Override + protected String process(MyRequest request) { + assertEquals(TEXT, request.text); + return RESPONSE; + } + } +} diff --git a/models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appc/appc.legacy.request.json b/models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appc/appc.legacy.request.json new file mode 100644 index 000000000..8b3b73a88 --- /dev/null +++ b/models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appc/appc.legacy.request.json @@ -0,0 +1,10 @@ +{ + "CommonHeader": { + "TimeStamp": 1506051879001, + "APIver": "1.01", + "RequestID": "c7c6a4aa-bb61-4a15-b831-ba1472dd4a65", + "SubRequestID": "111be3d2-6c12-4f4b-a3e7-c349acced200", + "RequestTrack": [], + "Flags": [] + } +} diff --git a/models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appclcm/appc.lcm.request.json b/models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appclcm/appc.lcm.request.json new file mode 100644 index 000000000..cf2ebd521 --- /dev/null +++ b/models-interactions/model-simulators/src/test/resources/org/onap/policy/simulators/appclcm/appc.lcm.request.json @@ -0,0 +1,17 @@ +{ + "body": { + "input": { + "common-header": { + "timestamp": "2017-08-25T21:06:23.037Z", + "api-ver": "5.00", + "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200", + "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200", + "sub-request-id": "111be3d2-6c12-4f4b-a3e7-c349acced200", + "flags": {} + } + } + }, + "version": "2.0", + "rpc-name": "restart", + "type": "request" +} -- cgit 1.2.3-korg