testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/taskparameters/TestTaskParameters.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.testsuites.integration.uservice.taskparameters;
  22
  23 import static org.awaitility.Awaitility.await;
  24 import static org.junit.Assert.assertTrue;
  25
  26 import java.util.concurrent.TimeUnit;
  27 import javax.ws.rs.client.Client;
  28 import javax.ws.rs.client.ClientBuilder;
  29 import javax.ws.rs.core.Response;
  30 import org.junit.AfterClass;
  31 import org.junit.Before;
  32 import org.junit.BeforeClass;
  33 import org.junit.Test;
  34 import org.onap.policy.apex.auth.clieditor.ApexCommandLineEditorMain;
  35 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  36 import org.onap.policy.apex.service.engine.main.ApexMain;
  37 import org.onap.policy.common.endpoints.http.server.HttpServletServer;
  38 import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
  39 import org.onap.policy.common.gson.GsonMessageBodyHandler;
  40 import org.onap.policy.common.utils.network.NetworkUtil;
  41 import org.slf4j.ext.XLogger;
  42 import org.slf4j.ext.XLoggerFactory;
  43
  44 /**
  45  * This class runs integration tests for taskParameters. Task parameters are read from the ApexConfig, and they can be
  46  * accessed in task logic. In this case, the taskParameters are used to set values in executionProperties. URL
  47  * dynamically populated using executionProperties is hit and values get updated in
  48  * {@link RestClientEndpointForTaskParameters} which acts as a temporary server for requests.
  49  */
  50 public class TestTaskParameters {
  51
  52     private static final XLogger LOGGER = XLoggerFactory.getXLogger(TestTaskParameters.class);
  53
  54     private static HttpServletServer server;
  55     private static final int PORT = 32801;
  56     private static final String HOST = "localhost";
  57
  58     /**
  59      * Compile the policy.
  60      */
  61     @BeforeClass
  62     public static void compilePolicy() {
  63         // @formatter:off
  64         final String[] cliArgs = {
  65             "-c",
  66             "src/test/resources/policies/taskparameters/TaskParametersTestPolicyModel.apex",
  67             "-l",
  68             "target/TaskParametersTestPolicyModel.log",
  69             "-o",
  70             "target/TaskParametersTestPolicyModel.json"
  71         };
  72         // @formatter:on
  73
  74         new ApexCommandLineEditorMain(cliArgs);
  75     }
  76
  77     /**
  78      * Sets up a server for testing.
  79      *
  80      * @throws Exception the exception
  81      */
  82     @BeforeClass
  83     public static void setUp() throws Exception {
  84         if (NetworkUtil.isTcpPortOpen(HOST, PORT, 3, 50L)) {
  85             throw new IllegalStateException("port " + PORT + " is still in use");
  86         }
  87
  88         server = HttpServletServerFactoryInstance.getServerFactory().build("TestTaskParameters", false, null, PORT,
  89             "/TestTaskParametersRest", false, false);
  90
  91         server.addServletClass(null, RestClientEndpointForTaskParameters.class.getName());
  92         server.setSerializationProvider(GsonMessageBodyHandler.class.getName());
  93
  94         server.start();
  95
  96         if (!NetworkUtil.isTcpPortOpen(HOST, PORT, 60, 500L)) {
  97             throw new IllegalStateException("port " + PORT + " is still not in use");
  98         }
  99
 100     }
 101
 102     /**
 103      * Tear down.
 104      *
 105      * @throws Exception the exception
 106      */
 107     @AfterClass
 108     public static void tearDown() throws Exception {
 109         if (server != null) {
 110             server.stop();
 111         }
 112     }
 113
 114     /**
 115      * Clear relative file root environment variable.
 116      */
 117     @Before
 118     public void clearRelativeFileRoot() {
 119         System.clearProperty("APEX_RELATIVE_FILE_ROOT");
 120     }
 121
 122     /**
 123      * Test taskParameters with no taskIds. When taskIds are not provided, all taskParameters provided in config will be
 124      * updated to all tasks.
 125      */
 126     @Test
 127     public void testTaskParameters_with_noTaskIds() throws Exception {
 128         String responseEntity = testTaskParameters(
 129             "src/test/resources/testdata/taskparameters/TaskParameterTestConfig_with_noTaskIds.json");
 130         assertTrue(responseEntity.contains("{\"closedLoopId\": closedLoopId123,\"serviceId\": serviceId123}"));
 131     }
 132
 133     /**
 134      * Test taskParameters with valid taskIds. When valid taskIds are provided, the the taskParameter will be updated in
 135      * that particular task alone.
 136      */
 137     @Test
 138     public void testTaskParameters_with_validTaskIds() throws Exception {
 139         String responseEntity = testTaskParameters(
 140             "src/test/resources/testdata/taskparameters/TaskParameterTestConfig_with_validTaskIds.json");
 141         assertTrue(responseEntity.contains("{\"closedLoopId\": closedLoopIdxyz,\"serviceId\": serviceIdxyz}"));
 142     }
 143
 144     /**
 145      * Test taskParameters with invalid taskIds. When invalid taskIds are provided, or when a taskParameter assigned to
 146      * a particular taskId is tried to be accessed in a taskLogic of a different task, such taskParameters won't be
 147      * accessible in the task
 148      */
 149     @Test
 150     public void testTaskParameters_with_invalidTaskIds() throws Exception {
 151         String responseEntity = testTaskParameters(
 152             "src/test/resources/testdata/taskparameters/TaskParameterTestConfig_with_invalidTaskIds.json");
 153         assertTrue(responseEntity.contains("{\"closedLoopId\": INVALID - closedLoopId not available in TaskParameters,"
 154             + "\"serviceId\": INVALID - serviceId not available in TaskParameters}"));
 155     }
 156
 157     private String testTaskParameters(String apexConfigPath) throws ApexException {
 158         final Client client = ClientBuilder.newClient();
 159         final String[] args = {apexConfigPath};
 160         // clear the details set in server
 161         client.target("http://" + HOST + ":" + PORT + "/TestTaskParametersRest/apex/event/clearDetails")
 162             .request("application/json").get();
 163         final ApexMain apexMain = new ApexMain(args);
 164
 165         String getDetailsUrl = "http://" + HOST + ":" + PORT + "/TestTaskParametersRest/apex/event/getDetails";
 166         // wait for success response code to be received, until a timeout
 167         await().atMost(5, TimeUnit.SECONDS)
 168             .until(() -> 200 == client.target(getDetailsUrl).request("application/json").get().getStatus());
 169         apexMain.shutdown();
 170         Response response = client.target(getDetailsUrl).request("application/json").get();
 171         String responseEntity = response.readEntity(String.class);
 172
 173         LOGGER.info("testTaskParameters-OUTSTRING=\n {}", responseEntity);
 174         return responseEntity;
 175     }
 176 }