456c22f80d63ae4805b36801635376ee1f851bf3
[policy/drools-pdp.git] /
1 /*
2  * ============LICENSE_START=======================================================
3  * ONAP
4  * ================================================================================
5  * Copyright (C) 2018-2019 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.drools.protocol.coders;
22
23 import com.google.gson.Gson;
24 import com.google.gson.GsonBuilder;
25 import java.io.IOException;
26 import java.nio.file.Paths;
27 import java.util.List;
28 import java.util.Properties;
29 import org.junit.Assert;
30 import org.junit.BeforeClass;
31 import org.junit.Test;
32 import org.kie.api.builder.ReleaseId;
33 import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
34 import org.onap.policy.common.endpoints.event.comm.TopicSink;
35 import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
36 import org.onap.policy.drools.controller.DroolsControllerConstants;
37 import org.onap.policy.drools.controller.internal.MavenDroolsControllerTest;
38 import org.onap.policy.drools.properties.DroolsPropertyConstants;
39 import org.onap.policy.drools.protocol.coders.EventProtocolCoder.CoderFilters;
40 import org.onap.policy.drools.protocol.coders.TopicCoderFilterConfiguration.CustomGsonCoder;
41 import org.onap.policy.drools.util.KieUtils;
42 import org.onap.policy.drools.utils.Triple;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
45
46 /**
47  * ProtocolCoder Toolset Junits.
48  */
49 public class ProtocolCoderToolsetTest {
50     public static final String JUNIT_PROTOCOL_CODER_ARTIFACT_ID = "protocolcoder";
51     public static final String JUNIT_PROTOCOL_CODER_TOPIC = JUNIT_PROTOCOL_CODER_ARTIFACT_ID;
52     public static final String CONTROLLER_ID = "blah";
53
54     private static Logger logger = LoggerFactory.getLogger(ProtocolCoderToolset.class);
55
56     private static volatile ReleaseId releaseId;
57
58     // customCoder has to be public to be accessed in tests below
59     public static final Gson customCoder = new GsonBuilder().create();
60
61     /**
62      * Test Class Initialization.
63      */
64     @BeforeClass
65     public static void setupClass() throws IOException {
66         releaseId = KieUtils.installArtifact(
67             Paths.get(MavenDroolsControllerTest.JUNIT_ECHO_KMODULE_PATH).toFile(),
68             Paths.get(MavenDroolsControllerTest.JUNIT_ECHO_KMODULE_POM_PATH).toFile(),
69             MavenDroolsControllerTest.JUNIT_ECHO_KJAR_DRL_PATH,
70             Paths.get(MavenDroolsControllerTest.JUNIT_ECHO_KMODULE_DRL_PATH).toFile());
71     }
72
73     @Test
74     public void testToolsets() {
75         createController();
76         testGsonToolset(createFilterSet());
77         DroolsControllerConstants.getFactory().destroy();
78     }
79
80     /**
81      * Test the Gson toolset.
82      *
83      * @param protocolFilter protocol filter
84      */
85     public void testGsonToolset(JsonProtocolFilter protocolFilter) {
86         GsonProtocolCoderToolset gsonToolset = new GsonProtocolCoderToolset(
87                 EventProtocolParams.builder().topic(JUNIT_PROTOCOL_CODER_TOPIC)
88                         .groupId(releaseId.getGroupId())
89                         .artifactId(releaseId.getArtifactId())
90                         .eventClass(Triple.class.getName())
91                         .protocolFilter(protocolFilter)
92                         .customGsonCoder(null)
93                         .modelClassLoaderHash(12345678), CONTROLLER_ID);
94
95         Assert.assertNotNull(gsonToolset.getEncoder());
96         Assert.assertNotNull(gsonToolset.getDecoder());
97
98         testToolset(protocolFilter, gsonToolset);
99
100         Triple<String, String, String> triple = createTriple();
101         gsonToolset.setCustomCoder(new CustomGsonCoder(this.getClass().getName(), "customCoder"));
102         String tripleEncoded = encode(gsonToolset, triple);
103         decode(protocolFilter, gsonToolset, triple, tripleEncoded);
104     }
105
106     private Triple<String, String, String> createTriple() {
107         return new Triple<>("v1", "v2", "v3");
108     }
109
110     private void testToolset(JsonProtocolFilter protocolFilter, ProtocolCoderToolset coderToolset) {
111
112         validateInitialization(protocolFilter, coderToolset);
113
114         updateCoderFilterRule(coderToolset);
115
116         addRemoveCoder(coderToolset);
117
118         /* restore original filters */
119         coderToolset.addCoder(Triple.class.getName(), protocolFilter, 654321);
120
121         Triple<String, String, String> triple = createTriple();
122
123         String tripleEncoded = encode(coderToolset, triple);
124
125         decode(protocolFilter, coderToolset, triple, tripleEncoded);
126     }
127
128     @SuppressWarnings("unchecked")
129     private void decode(JsonProtocolFilter protocolFilter, ProtocolCoderToolset coderToolset,
130             Triple<String, String, String> triple, String tripleEncoded) {
131
132         Triple<String, String, String> tripleDecoded = null;
133         try {
134             tripleDecoded = (Triple<String, String, String>) coderToolset.decode(tripleEncoded);
135         } catch (UnsupportedOperationException e) {
136             /* OK */
137             logger.trace("Junit expected exception - decode does not pass filtering", e);
138         }
139
140         CoderFilters coderFilters = coderToolset.getCoder(Triple.class.getName());
141         Assert.assertTrue(coderFilters.getCodedClass() == Triple.class.getName());
142         Assert.assertTrue(coderFilters.getFilter() == protocolFilter);
143         Assert.assertTrue(coderFilters.getFilter().getRule() != null);
144
145         coderFilters.getFilter().setRule("[?($.second =~ /^v2$/ && $.third =~ /.*v3.*/)]");
146
147         tripleDecoded = (Triple<String, String, String>) coderToolset.decode(tripleEncoded);
148
149         Assert.assertTrue(tripleDecoded.first().equals(triple.first()));
150         Assert.assertTrue(tripleDecoded.second().equals(triple.second()));
151         Assert.assertTrue(tripleDecoded.third().equals(triple.third()));
152
153         coderFilters.getFilter().setRule(null);
154         Assert.assertEquals("[?($ =~ /.*/)]", coderFilters.getFilter().getRule());
155
156         tripleDecoded = (Triple<String, String, String>) coderToolset.decode(tripleEncoded);
157
158         Assert.assertTrue(tripleDecoded.first().equals(triple.first()));
159         Assert.assertTrue(tripleDecoded.second().equals(triple.second()));
160         Assert.assertTrue(tripleDecoded.third().equals(triple.third()));
161
162         coderFilters.getFilter().setRule("[?($.third =~ /.*v3.*/)]");
163     }
164
165     private String encode(ProtocolCoderToolset coderToolset, Triple<String, String, String> triple) {
166         String tripleEncoded = coderToolset.encode(triple);
167         Assert.assertTrue(!tripleEncoded.isEmpty());
168         return tripleEncoded;
169     }
170
171     private void addRemoveCoder(ProtocolCoderToolset coderToolset) {
172         coderToolset.addCoder(this.getClass().getName(),
173                 new JsonProtocolFilter("[?($.second =~ /.*/)]"), 654321);
174         Assert.assertTrue(coderToolset.getCoders().size() == 2);
175
176         coderToolset.removeCoders(this.getClass().getName());
177         Assert.assertTrue(coderToolset.getCoders().size() == 1);
178     }
179
180     private void updateCoderFilterRule(ProtocolCoderToolset coderToolset) {
181         coderToolset.addCoder(Triple.class.getName(), new JsonProtocolFilter("[?($.third =~ /.*/)]"), 654321);
182
183         Assert.assertTrue(coderToolset.getCoders().size() == 1);
184
185         Assert.assertTrue(coderToolset.getCoder(Triple.class.getName()).getModelClassLoaderHash() == 654321);
186
187         Assert.assertTrue(
188                 coderToolset.getCoder(
189                         Triple.class.getName()).getFilter().getRule() != null);
190
191         Assert.assertTrue("[?($.third =~ /.*/)]".equals(coderToolset.getCoder(Triple.class.getName())
192                 .getFilter().getRule()));
193     }
194
195     private void validateInitialization(JsonProtocolFilter protocolFilter, ProtocolCoderToolset coderToolset) {
196         Assert.assertTrue(CONTROLLER_ID.equals(coderToolset.getControllerId()));
197         Assert.assertTrue(releaseId.getGroupId().equals(coderToolset.getGroupId()));
198         Assert.assertTrue(releaseId.getArtifactId().equals(coderToolset.getArtifactId()));
199         Assert.assertNull(coderToolset.getCustomCoder());
200
201         Assert.assertTrue(coderToolset.getCoders().size() == 1);
202
203         CoderFilters coderFilters = coderToolset.getCoder(CONTROLLER_ID);
204         Assert.assertTrue(coderFilters == null);
205
206         coderFilters = coderToolset.getCoder(Triple.class.getName());
207         Assert.assertNotNull(coderFilters);
208
209         Assert.assertEquals(coderFilters.getFilter(), protocolFilter);
210     }
211
212     private void createController() {
213         if (releaseId == null) {
214             throw new IllegalStateException("no prereq artifact installed in maven repository");
215         }
216
217         Properties sinkConfig = new Properties();
218         sinkConfig.put(PolicyEndPointProperties.PROPERTY_NOOP_SINK_TOPICS, JUNIT_PROTOCOL_CODER_TOPIC);
219         final List<TopicSink> noopTopics = TopicEndpointManager.getManager().addTopicSinks(sinkConfig);
220
221         Properties droolsControllerConfig = new Properties();
222         droolsControllerConfig.put(DroolsPropertyConstants.RULES_GROUPID, releaseId.getGroupId());
223         droolsControllerConfig.put(DroolsPropertyConstants.RULES_ARTIFACTID, releaseId.getArtifactId());
224         droolsControllerConfig.put(DroolsPropertyConstants.RULES_VERSION, releaseId.getVersion());
225         droolsControllerConfig.put(PolicyEndPointProperties.PROPERTY_NOOP_SINK_TOPICS + "." + JUNIT_PROTOCOL_CODER_TOPIC
226                 + PolicyEndPointProperties.PROPERTY_TOPIC_EVENTS_SUFFIX, Triple.class.getName());
227
228         DroolsControllerConstants.getFactory().build(droolsControllerConfig, null, noopTopics);
229     }
230
231     private JsonProtocolFilter createFilterSet() {
232         return new JsonProtocolFilter("[?($.first =~ /.*/ && $.second =~ /^blah.*/ && $.third =~ /^hello$/)]");
233     }
234 }