services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/ParameterTests.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * Modifications Copyright (C) 2019-2020 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.service.engine.parameters;
  23
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.Assert.assertFalse;
  26 import static org.junit.Assert.assertTrue;
  27 import static org.junit.Assert.fail;
  28
  29 import java.util.Arrays;
  30 import org.junit.Test;
  31 import org.onap.policy.apex.service.engine.event.impl.filecarrierplugin.consumer.ApexFileEventConsumer;
  32 import org.onap.policy.apex.service.engine.event.impl.filecarrierplugin.producer.ApexFileEventProducer;
  33 import org.onap.policy.apex.service.engine.main.ApexCommandLineArguments;
  34 import org.onap.policy.apex.service.engine.parameters.dummyclasses.SuperDooperCarrierTechnologyParameters;
  35 import org.onap.policy.apex.service.engine.parameters.dummyclasses.SuperDooperEventProducer;
  36 import org.onap.policy.apex.service.engine.parameters.dummyclasses.SuperDooperEventSubscriber;
  37 import org.onap.policy.apex.service.parameters.ApexParameterHandler;
  38 import org.onap.policy.apex.service.parameters.ApexParameters;
  39 import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
  40 import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters;
  41 import org.onap.policy.common.parameters.ParameterException;
  42
  43 /**
  44  * Test for an empty parameter file.
  45  *
  46  * @author Liam Fallon (liam.fallon@ericsson.com)
  47  */
  48 public class ParameterTests {
  49     @Test
  50     public void testInvalidParametersNoFileTest() throws ParameterException {
  51         final String[] args = {"-c", "src/test/resources/parameters/invalidNoFile.json"};
  52         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
  53
  54         try {
  55             new ApexParameterHandler().getParameters(arguments);
  56             fail("This test should throw an exception");
  57         } catch (final ParameterException e) {
  58             assertTrue(e.getMessage().startsWith("error reading parameters from \"src"));
  59             assertTrue(e.getMessage().contains("FileNotFoundException"));
  60         }
  61     }
  62
  63     @Test
  64     public void testInvalidParametersEmptyTest() {
  65         final String[] args = {"-c", "src/test/resources/parameters/empty.json"};
  66         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
  67
  68         try {
  69             new ApexParameterHandler().getParameters(arguments);
  70             fail("This test should throw an exception");
  71         } catch (final ParameterException e) {
  72             assertTrue(e.getMessage()
  73                     .startsWith("validation error(s) on parameters from \"src/test/resources/parameters/empty.json\""));
  74         }
  75     }
  76
  77     @Test
  78     public void testInvalidParametersNoParamsTest() {
  79         final String[] args = {"-c", "src/test/resources/parameters/noParams.json"};
  80         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
  81
  82         try {
  83             new ApexParameterHandler().getParameters(arguments);
  84             fail("This test should throw an exception");
  85         } catch (final ParameterException e) {
  86             assertEquals("validation error(s) on parameters from \"src/test/resources/parameters/noParams.json\"\n"
  87                     + "parameter group \"APEX_PARAMETERS\" type "
  88                     + "\"org.onap.policy.apex.service.parameters.ApexParameters\" INVALID, "
  89                     + "parameter group has status INVALID\n" + "  parameter group \"UNDEFINED\" INVALID, "
  90                     + "engine service parameters are not specified\n"
  91                     + "  parameter group map \"eventOutputParameters\" INVALID, "
  92                     + "at least one event output must be specified\n"
  93                     + "  parameter group map \"eventInputParameters\" INVALID, "
  94                     + "at least one event input must be specified\n", e.getMessage());
  95         }
  96     }
  97
  98     @Test
  99     public void testInvalidParametersBlankParamsTest() {
 100         final String[] args = {"-c", "src/test/resources/parameters/blankParams.json"};
 101         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
 102
 103         try {
 104             new ApexParameterHandler().getParameters(arguments);
 105             fail("This test should throw an exception");
 106         } catch (final ParameterException e) {
 107
 108             assertEquals("validation error(s) on parameters from \"src/test/resources/parameters/blankParams.json\"\n"
 109                     + "parameter group \"APEX_PARAMETERS\" type "
 110                     + "\"org.onap.policy.apex.service.parameters.ApexParameters\" INVALID, "
 111                     + "parameter group has status INVALID\n" + "  parameter group \"ENGINE_SERVICE_PARAMETERS\" type "
 112                     + "\"org.onap.policy.apex.service.parameters.engineservice.EngineServiceParameters\" "
 113                     + "INVALID, parameter group has status INVALID\n"
 114                     + "    field \"id\" type \"int\" value \"-1\" INVALID, "
 115                     + "id not specified or specified value [-1] invalid, must be specified as id >= 0\n"
 116                     + "  parameter group map \"eventOutputParameters\" INVALID, "
 117                     + "at least one event output must be specified\n"
 118                     + "  parameter group map \"eventInputParameters\" INVALID, "
 119                     + "at least one event input must be specified\n", e.getMessage());
 120         }
 121     }
 122
 123     @Test
 124     public void testInvalidParametersTest() {
 125         final String[] args = {"-c", "src/test/resources/parameters/badParams.json"};
 126         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
 127
 128         try {
 129             new ApexParameterHandler().getParameters(arguments);
 130             fail("This test should throw an exception");
 131         } catch (final ParameterException e) {
 132             assertEquals("validation error(s) on parameters from \"src/test/resources/parameters/badParams.json\"\n"
 133                     + "parameter group \"APEX_PARAMETERS\" type "
 134                     + "\"org.onap.policy.apex.service.parameters.ApexParameters\" INVALID, "
 135                     + "parameter group has status INVALID\n" + "  parameter group \"hello there\" type "
 136                     + "\"org.onap.policy.apex.service.parameters.engineservice.EngineServiceParameters\" "
 137                     + "INVALID, parameter group has status INVALID\n"
 138                     + "    field \"name\" type \"java.lang.String\" value \"hello there\" INVALID, "
 139                     + "name is invalid, it must match regular expression[A-Za-z0-9\\-_\\.]+\n"
 140                     + "    field \"id\" type \"int\" value \"-45\" INVALID, id not specified or "
 141                     + "specified value [-45] invalid, must be specified as id >= 0\n"
 142                     + "    field \"instanceCount\" type \"int\" value \"-345\" INVALID, "
 143                     + "instanceCount [-345] invalid, must be specified as instanceCount >= 1\n"
 144                     + "    field \"deploymentPort\" type \"int\" value \"65536\" INVALID, "
 145                     + "deploymentPort [65536] invalid, must be specified as 1024 <= port <= 65535\n"
 146                     + "    field \"policyModelFileName\" type \"java.lang.String\" "
 147                     + "value \"/some/file/name.xml\" INVALID, not found\n"
 148                     + "  parameter group map \"eventOutputParameters\" INVALID, "
 149                     + "parameter group map has status INVALID\n" + "    parameter group \"FirstProducer\" type "
 150                     + "\"org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters\" INVALID"
 151                     + ", parameter group has status INVALID\n" + "      parameter group \"FILE\" type "
 152                     + "\"org.onap.policy.apex.service.engine.event.impl."
 153                     + "filecarrierplugin.FileCarrierTechnologyParameters\" INVALID, "
 154                     + "parameter group has status INVALID\n"
 155                     + "        field \"fileName\" type \"java.lang.String\" value \"null\" INVALID, "
 156                     + "\"null\" invalid, must be specified as a non-empty string\n"
 157                     + "  parameter group map \"eventInputParameters\" INVALID, "
 158                     + "parameter group map has status INVALID\n" + "    parameter group \"TheFileConsumer1\" type "
 159                     + "\"org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters\" INVALID"
 160                     + ", parameter group has status INVALID\n" + "      parameter group \"FILE\" type "
 161                     + "\"org.onap.policy.apex.service.engine.event.impl."
 162                     + "filecarrierplugin.FileCarrierTechnologyParameters\" INVALID, "
 163                     + "parameter group has status INVALID\n"
 164                     + "        field \"fileName\" type \"java.lang.String\" value \"null\" INVALID, "
 165                     + "\"null\" invalid, must be specified as a non-empty string\n", e.getMessage());
 166         }
 167     }
 168
 169     @Test
 170     public void testModelNotFileTest() {
 171         final String[] args = {"-c", "src/test/resources/parameters/badParamsModelNotFile.json"};
 172         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
 173
 174         try {
 175             new ApexParameterHandler().getParameters(arguments);
 176             fail("This test should throw an exception");
 177         } catch (final ParameterException e) {
 178             assertEquals(
 179                     "validation error(s) on parameters from "
 180                             + "\"src/test/resources/parameters/badParamsModelNotFile.json\"\n"
 181                             + "parameter group \"APEX_PARAMETERS\" type "
 182                             + "\"org.onap.policy.apex.service.parameters.ApexParameters\" INVALID, "
 183                             + "parameter group has status INVALID\n" + "  parameter group \"MyApexEngine\" type "
 184                             + "\"org.onap.policy.apex.service.parameters.engineservice.EngineServiceParameters\" "
 185                             + "INVALID, parameter group has status INVALID\n" + "    field \"policyModelFileName\" "
 186                             + "type \"java.lang.String\" value \"src/test\" INVALID, is not a plain file\n",
 187                     e.getMessage());
 188         }
 189     }
 190
 191     @Test
 192     public void testGoodParametersTest() {
 193         final String[] args = {"-c", "src/test/resources/parameters/goodParams.json"};
 194         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
 195
 196         try {
 197             final ApexParameters parameters = new ApexParameterHandler().getParameters(arguments);
 198
 199             assertEquals(2, parameters.getEventInputParameters().size());
 200             assertEquals(2, parameters.getEventOutputParameters().size());
 201
 202             assertTrue(parameters.getEventOutputParameters().containsKey("FirstProducer"));
 203             assertTrue(parameters.getEventOutputParameters().containsKey("MyOtherProducer"));
 204             assertEquals("FILE", parameters.getEventOutputParameters().get("FirstProducer")
 205                     .getCarrierTechnologyParameters().getLabel());
 206             assertEquals("FILE", parameters.getEventOutputParameters().get("MyOtherProducer")
 207                     .getCarrierTechnologyParameters().getLabel());
 208             assertEquals(ApexFileEventProducer.class.getName(), parameters.getEventOutputParameters()
 209                     .get("MyOtherProducer").getCarrierTechnologyParameters().getEventProducerPluginClass());
 210             assertEquals(ApexFileEventConsumer.class.getName(), parameters.getEventOutputParameters()
 211                     .get("MyOtherProducer").getCarrierTechnologyParameters().getEventConsumerPluginClass());
 212             assertEquals("JSON",
 213                     parameters.getEventOutputParameters().get("FirstProducer").getEventProtocolParameters().getLabel());
 214             assertEquals("JSON", parameters.getEventOutputParameters().get("MyOtherProducer")
 215                     .getEventProtocolParameters().getLabel());
 216
 217             assertTrue(parameters.getEventInputParameters().containsKey("TheFileConsumer1"));
 218             assertTrue(parameters.getEventInputParameters().containsKey("MySuperDooperConsumer1"));
 219             assertEquals("FILE", parameters.getEventInputParameters().get("TheFileConsumer1")
 220                     .getCarrierTechnologyParameters().getLabel());
 221             assertEquals("SUPER_DOOPER", parameters.getEventInputParameters().get("MySuperDooperConsumer1")
 222                     .getCarrierTechnologyParameters().getLabel());
 223             assertEquals("JSON", parameters.getEventInputParameters().get("TheFileConsumer1")
 224                     .getEventProtocolParameters().getLabel());
 225             assertEquals("SUPER_TOK_DEL", parameters.getEventInputParameters().get("MySuperDooperConsumer1")
 226                     .getEventProtocolParameters().getLabel());
 227             assertEquals(ApexFileEventProducer.class.getName(), parameters.getEventInputParameters()
 228                     .get("TheFileConsumer1").getCarrierTechnologyParameters().getEventProducerPluginClass());
 229             assertEquals(ApexFileEventConsumer.class.getName(), parameters.getEventInputParameters()
 230                     .get("TheFileConsumer1").getCarrierTechnologyParameters().getEventConsumerPluginClass());
 231             assertEquals(SuperDooperEventProducer.class.getName(), parameters.getEventInputParameters()
 232                     .get("MySuperDooperConsumer1").getCarrierTechnologyParameters().getEventProducerPluginClass());
 233             assertEquals(SuperDooperEventSubscriber.class.getName(), parameters.getEventInputParameters()
 234                     .get("MySuperDooperConsumer1").getCarrierTechnologyParameters().getEventConsumerPluginClass());
 235         } catch (final ParameterException e) {
 236             fail("This test should not throw an exception");
 237         }
 238     }
 239
 240     @Test
 241     public void testSuperDooperParametersTest() {
 242         final String[] args = {"-c", "src/test/resources/parameters/superDooperParams.json"};
 243         final ApexCommandLineArguments arguments = new ApexCommandLineArguments(args);
 244
 245         try {
 246             final ApexParameters parameters = new ApexParameterHandler().getParameters(arguments);
 247
 248             assertEquals("MyApexEngine", parameters.getEngineServiceParameters().getName());
 249             assertEquals("0.0.1", parameters.getEngineServiceParameters().getVersion());
 250             assertEquals(45, parameters.getEngineServiceParameters().getId());
 251             assertEquals(345, parameters.getEngineServiceParameters().getInstanceCount());
 252             assertEquals(65522, parameters.getEngineServiceParameters().getDeploymentPort());
 253
 254             final CarrierTechnologyParameters prodCarrierTech =
 255                     parameters.getEventOutputParameters().get("FirstProducer").getCarrierTechnologyParameters();
 256             final EventProtocolParameters prodEventProt =
 257                     parameters.getEventOutputParameters().get("FirstProducer").getEventProtocolParameters();
 258             final CarrierTechnologyParameters consCarrierTech =
 259                     parameters.getEventInputParameters().get("MySuperDooperConsumer1").getCarrierTechnologyParameters();
 260             final EventProtocolParameters consEventProt =
 261                     parameters.getEventInputParameters().get("MySuperDooperConsumer1").getEventProtocolParameters();
 262
 263             assertEquals("SUPER_DOOPER", prodCarrierTech.getLabel());
 264             assertEquals("SUPER_TOK_DEL", prodEventProt.getLabel());
 265             assertEquals("SUPER_DOOPER", consCarrierTech.getLabel());
 266             assertEquals("JSON", consEventProt.getLabel());
 267
 268             assertTrue(prodCarrierTech instanceof SuperDooperCarrierTechnologyParameters);
 269
 270             final SuperDooperCarrierTechnologyParameters superDooperParameters =
 271                     (SuperDooperCarrierTechnologyParameters) prodCarrierTech;
 272             assertEquals("somehost:12345", superDooperParameters.getBootstrapServers());
 273             assertEquals("0", superDooperParameters.getAcks());
 274             assertEquals(25, superDooperParameters.getRetries());
 275             assertEquals(98765, superDooperParameters.getBatchSize());
 276             assertEquals(21, superDooperParameters.getLingerTime());
 277             assertEquals(50505050, superDooperParameters.getBufferMemory());
 278             assertEquals("first-group-id", superDooperParameters.getGroupId());
 279             assertFalse(superDooperParameters.isEnableAutoCommit());
 280             assertEquals(441, superDooperParameters.getAutoCommitTime());
 281             assertEquals(987, superDooperParameters.getSessionTimeout());
 282             assertEquals("producer-out", superDooperParameters.getProducerTopic());
 283             assertEquals(101, superDooperParameters.getConsumerPollTime());
 284             assertEquals("some.key.serailizer", superDooperParameters.getKeySerializer());
 285             assertEquals("some.value.serailizer", superDooperParameters.getValueSerializer());
 286             assertEquals("some.key.deserailizer", superDooperParameters.getKeyDeserializer());
 287             assertEquals("some.value.deserailizer", superDooperParameters.getValueDeserializer());
 288
 289             final String[] consumerTopics = {"consumer-out-0", "consumer-out-1", "consumer-out-2"};
 290             assertEquals(Arrays.asList(consumerTopics), superDooperParameters.getConsumerTopicList());
 291         } catch (final ParameterException e) {
 292             fail("This test should not throw an exception");
 293         }
 294     }
 295 }