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