gerrit.onap Code Review - policy/drools-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2018 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.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
  24 import com.fasterxml.jackson.annotation.PropertyAccessor;
  25 import com.google.gson.Gson;
  26 import com.google.gson.GsonBuilder;
  27
  28 import java.io.IOException;
  29 import java.nio.file.Files;
  30 import java.nio.file.Paths;
  31 import java.util.ArrayList;
  32 import java.util.List;
  33 import java.util.Properties;
  34
  35 import org.junit.Assert;
  36 import org.junit.Before;
  37 import org.junit.Test;
  38 import org.kie.api.builder.ReleaseId;
  39 import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
  40 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  41 import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
  42 import org.onap.policy.drools.controller.DroolsController;
  43 import org.onap.policy.drools.controller.internal.MavenDroolsControllerTest;
  44 import org.onap.policy.drools.properties.DroolsProperties;
  45 import org.onap.policy.drools.protocol.coders.EventProtocolCoder.CoderFilters;
  46 import org.onap.policy.drools.protocol.coders.JsonProtocolFilter.FilterRule;
  47 import org.onap.policy.drools.protocol.coders.TopicCoderFilterConfiguration.CustomGsonCoder;
  48 import org.onap.policy.drools.util.KieUtils;
  49 import org.onap.policy.drools.utils.Triple;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 /**
  54  * ProtocolCoder Toolset JUNITs
  55  */
  56 public class ProtocolCoderToolsetTest {
  57     public static final String JUNIT_PROTOCOL_CODER_ARTIFACT_ID = "protocolcoder";
  58     public static final String JUNIT_PROTOCOL_CODER_TOPIC = JUNIT_PROTOCOL_CODER_ARTIFACT_ID;
  59     public static final String CONTROLLER_ID = "blah";
  60     public static final String ARTIFACT_ID_ECHO = "echo";
  61     public static final String ARTIFACT_ID_POM_LINE = "<artifactId>" + ARTIFACT_ID_ECHO + "</artifactId>";
  62
  63     private static Logger logger = LoggerFactory.getLogger(ProtocolCoderToolset.class);
  64
  65     private volatile ReleaseId releaseId;
  66
  67     public static final Gson customCoder = new GsonBuilder().create();
  68
  69     @Before
  70     public void setUp() throws IOException {
  71         if (releaseId != null) {
  72             return;
  73         }
  74
  75         String pom = new String(Files.readAllBytes(Paths.get(MavenDroolsControllerTest.JUNIT_ECHO_KMODULE_POM_PATH)));
  76
  77         if (!pom.contains(ARTIFACT_ID_POM_LINE)) {
  78             throw new IllegalArgumentException("unexpected junit test pom");
  79         }
  80
  81         String newPom = pom.replace(ARTIFACT_ID_ECHO, JUNIT_PROTOCOL_CODER_ARTIFACT_ID);
  82
  83         String kmodule = new String(Files.readAllBytes(Paths.get(MavenDroolsControllerTest.JUNIT_ECHO_KMODULE_PATH)));
  84
  85         String drl = new String(Files.readAllBytes(Paths.get(MavenDroolsControllerTest.JUNIT_ECHO_KMODULE_DRL_PATH)));
  86
  87         releaseId = KieUtils.installArtifact(kmodule, newPom, MavenDroolsControllerTest.JUNIT_ECHO_KJAR_DRL_PATH, drl);
  88     }
  89
  90     @Test
  91     public void testToolsets() {
  92         createController();
  93         testGsonToolset(createFilterSet());
  94         testJacksonToolset(createFilterSet());
  95     }
  96
  97     public void testGsonToolset(JsonProtocolFilter protocolFilter) {
  98         GsonProtocolCoderToolset gsonToolset = new GsonProtocolCoderToolset(JUNIT_PROTOCOL_CODER_TOPIC, CONTROLLER_ID,
  99                 this.releaseId.getGroupId(), this.releaseId.getArtifactId(), Triple.class.getCanonicalName(),
 100                 protocolFilter, null, 12345678);
 101
 102         Assert.assertNotNull(gsonToolset.getEncoder());
 103         Assert.assertNotNull(gsonToolset.getDecoder());
 104
 105         testToolset(protocolFilter, gsonToolset);
 106
 107         Triple<String, String, String> triple = createTriple();
 108         gsonToolset.setCustomCoder(new CustomGsonCoder(this.getClass().getCanonicalName(), "customCoder"));
 109         String tripleEncoded = encode(gsonToolset, triple);
 110         decode(protocolFilter, gsonToolset, triple, tripleEncoded);
 111     }
 112
 113     private Triple<String, String, String> createTriple() {
 114         return new Triple<>("v1", "v2", "v3");
 115     }
 116
 117     public void testJacksonToolset(JsonProtocolFilter protocolFilter) {
 118         JacksonProtocolCoderToolset jacksonToolset = new JacksonProtocolCoderToolset(JUNIT_PROTOCOL_CODER_TOPIC,
 119                 CONTROLLER_ID, this.releaseId.getGroupId(), this.releaseId.getArtifactId(),
 120                 Triple.class.getCanonicalName(), protocolFilter, null, 12345678);
 121
 122         jacksonToolset.getEncoder().setVisibility(PropertyAccessor.FIELD, Visibility.ANY);
 123         jacksonToolset.getDecoder().setVisibility(PropertyAccessor.FIELD, Visibility.ANY);
 124
 125         testToolset(protocolFilter, jacksonToolset);
 126     }
 127
 128     private void testToolset(JsonProtocolFilter protocolFilter, ProtocolCoderToolset coderToolset) {
 129
 130         validateInitialization(protocolFilter, coderToolset);
 131
 132         updateCoderFilterRule(coderToolset);
 133
 134         addRemoveCoder(coderToolset);
 135
 136         /* restore original filters */
 137         coderToolset.addCoder(Triple.class.getCanonicalName(), protocolFilter, 654321);
 138
 139         Triple<String, String, String> triple = createTriple();
 140
 141         String tripleEncoded = encode(coderToolset, triple);
 142
 143         decode(protocolFilter, coderToolset, triple, tripleEncoded);
 144     }
 145
 146     @SuppressWarnings("unchecked")
 147     private void decode(JsonProtocolFilter protocolFilter, ProtocolCoderToolset coderToolset,
 148             Triple<String, String, String> triple, String tripleEncoded) {
 149
 150         Triple<String, String, String> tripleDecoded = null;
 151         try {
 152             tripleDecoded = (Triple<String, String, String>) coderToolset.decode(tripleEncoded);
 153         } catch (UnsupportedOperationException e) {
 154             /* OK */
 155             logger.trace("Junit expected exception - decode does not pass filtering", e);
 156         }
 157
 158         CoderFilters coderFilters = coderToolset.getCoder(Triple.class.getCanonicalName());
 159         Assert.assertTrue(coderFilters.getCodedClass() == Triple.class.getCanonicalName());
 160         Assert.assertTrue(coderFilters.getFilter() == protocolFilter);
 161         Assert.assertTrue(coderFilters.getFilter().getRules("second").size() == 1);
 162         Assert.assertTrue(coderFilters.getFilter().getRules("third").size() == 1);
 163
 164         coderFilters.getFilter().getRules("second").get(0).setRegex("^v2$");
 165         coderFilters.getFilter().getRules("third").get(0).setRegex(".*v3.*");
 166
 167         tripleDecoded = (Triple<String, String, String>) coderToolset.decode(tripleEncoded);
 168
 169         Assert.assertTrue(tripleDecoded.first().equals(triple.first()));
 170         Assert.assertTrue(tripleDecoded.second().equals(triple.second()));
 171         Assert.assertTrue(tripleDecoded.third().equals(triple.third()));
 172
 173         coderFilters.getFilter().deleteRules("third");
 174         Assert.assertTrue(coderFilters.getFilter().getRules("third").isEmpty());
 175
 176         tripleDecoded = (Triple<String, String, String>) coderToolset.decode(tripleEncoded);
 177
 178         Assert.assertTrue(tripleDecoded.first().equals(triple.first()));
 179         Assert.assertTrue(tripleDecoded.second().equals(triple.second()));
 180         Assert.assertTrue(tripleDecoded.third().equals(triple.third()));
 181
 182         coderFilters.getFilter().addRule("third", ".*v3.*");
 183     }
 184
 185     private String encode(ProtocolCoderToolset coderToolset, Triple<String, String, String> triple) {
 186         String tripleEncoded = coderToolset.encode(triple);
 187         Assert.assertTrue(!tripleEncoded.isEmpty());
 188         return tripleEncoded;
 189     }
 190
 191     private void addRemoveCoder(ProtocolCoderToolset coderToolset) {
 192         List<FilterRule> filters = new ArrayList<>();
 193         filters.add(new FilterRule("second", ".*"));
 194
 195         coderToolset.addCoder(this.getClass().getCanonicalName(), new JsonProtocolFilter(filters), 654321);
 196         Assert.assertTrue(coderToolset.getCoders().size() == 2);
 197
 198         coderToolset.removeCoders(this.getClass().getCanonicalName());
 199         Assert.assertTrue(coderToolset.getCoders().size() == 1);
 200     }
 201
 202     private void updateCoderFilterRule(ProtocolCoderToolset coderToolset) {
 203         List<FilterRule> filters = new ArrayList<>();
 204         filters.add(new FilterRule("third", ".*"));
 205         coderToolset.addCoder(Triple.class.getCanonicalName(), new JsonProtocolFilter(filters), 654321);
 206
 207         Assert.assertTrue(coderToolset.getCoders().size() == 1);
 208
 209         Assert.assertTrue(coderToolset.getCoder(Triple.class.getCanonicalName()).getModelClassLoaderHash() == 654321);
 210
 211         Assert.assertTrue(
 212                 coderToolset.getCoder(Triple.class.getCanonicalName()).getFilter().getRules("third").size() == 1);
 213
 214         Assert.assertTrue(
 215                 coderToolset.getCoder(Triple.class.getCanonicalName()).getFilter().getRules("third").size() == 1);
 216
 217         Assert.assertTrue(".*".equals(coderToolset.getCoder(Triple.class.getCanonicalName()).getFilter()
 218                 .getRules("third").get(0).getRegex()));
 219     }
 220
 221     private void validateInitialization(JsonProtocolFilter protocolFilter, ProtocolCoderToolset coderToolset) {
 222         Assert.assertTrue(CONTROLLER_ID.equals(coderToolset.getControllerId()));
 223         Assert.assertTrue(this.releaseId.getGroupId().equals(coderToolset.getGroupId()));
 224         Assert.assertTrue(this.releaseId.getArtifactId().equals(coderToolset.getArtifactId()));
 225         Assert.assertNull(coderToolset.getCustomCoder());
 226
 227         Assert.assertTrue(coderToolset.getCoders().size() == 1);
 228
 229         CoderFilters coderFilters = coderToolset.getCoder(CONTROLLER_ID);
 230         Assert.assertTrue(coderFilters == null);
 231
 232         coderFilters = coderToolset.getCoder(Triple.class.getCanonicalName());
 233         Assert.assertNotNull(coderFilters);
 234
 235         Assert.assertEquals(coderFilters.getFilter(), protocolFilter);
 236     }
 237
 238     private void createController() {
 239         if (releaseId == null) {
 240             throw new IllegalStateException("no prereq artifact installed in maven repository");
 241         }
 242
 243         Properties sinkConfig = new Properties();
 244         sinkConfig.put(PolicyEndPointProperties.PROPERTY_NOOP_SINK_TOPICS, JUNIT_PROTOCOL_CODER_TOPIC);
 245         List<? extends TopicSink> noopTopics = TopicEndpoint.manager.addTopicSinks(sinkConfig);
 246
 247         Properties droolsControllerConfig = new Properties();
 248         droolsControllerConfig.put(DroolsProperties.RULES_GROUPID, releaseId.getGroupId());
 249         droolsControllerConfig.put(DroolsProperties.RULES_ARTIFACTID, releaseId.getArtifactId());
 250         droolsControllerConfig.put(DroolsProperties.RULES_VERSION, releaseId.getVersion());
 251         droolsControllerConfig.put(PolicyEndPointProperties.PROPERTY_NOOP_SINK_TOPICS + "." + JUNIT_PROTOCOL_CODER_TOPIC
 252                 + PolicyEndPointProperties.PROPERTY_TOPIC_EVENTS_SUFFIX, Triple.class.getCanonicalName());
 253
 254         DroolsController.factory.build(droolsControllerConfig, null, noopTopics);
 255     }
 256
 257     private JsonProtocolFilter createFilterSet() {
 258         List<FilterRule> filters = new ArrayList<>();
 259         filters.add(new FilterRule("first", ".*"));
 260         filters.add(new FilterRule("second", "^blah.*"));
 261         filters.add(new FilterRule("third", "^hello$"));
 262
 263         return new JsonProtocolFilter(filters);
 264     }
 265 }