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