/
KeycloakKieServerTest.java
304 lines (242 loc) · 12.3 KB
/
KeycloakKieServerTest.java
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
/*
* Copyright 2017 Red Hat, Inc. and/or its affiliates.
*
* 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.
*/
package org.kie.server.springboot.samples;
import static java.util.Collections.singletonMap;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assume.assumeTrue;
import static org.kie.server.springboot.samples.utils.KeycloakSampleConstants.BARTLET;
import static org.kie.server.springboot.samples.utils.KeycloakSampleConstants.BARTLET_PW;
import static org.kie.server.springboot.samples.utils.KeycloakSampleConstants.JOHN;
import static org.kie.server.springboot.samples.utils.KeycloakSampleConstants.JOHN_PW;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.jbpm.kie.services.impl.KModuleDeploymentUnit;
import org.jbpm.services.api.DeploymentService;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestRule;
import org.junit.rules.TestWatcher;
import org.junit.runner.Description;
import org.junit.runner.RunWith;
import org.kie.server.api.KieServerConstants;
import org.kie.server.api.exception.KieServicesHttpException;
import org.kie.server.api.marshalling.MarshallingFormat;
import org.kie.server.api.model.KieContainerResource;
import org.kie.server.api.model.ReleaseId;
import org.kie.server.api.model.definition.ProcessDefinition;
import org.kie.server.api.model.instance.ProcessInstance;
import org.kie.server.api.model.instance.TaskSummary;
import org.kie.server.client.KieServicesClient;
import org.kie.server.client.KieServicesConfiguration;
import org.kie.server.client.KieServicesFactory;
import org.kie.server.client.ProcessServicesClient;
import org.kie.server.client.QueryServicesClient;
import org.kie.server.client.UserTaskServicesClient;
import org.kie.server.springboot.samples.utils.KeycloakContainer;
import org.kie.server.springboot.samples.utils.KeycloakFixture;
import org.kie.server.springboot.samples.utils.KieJarBuildHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.testcontainers.DockerClientFactory;
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = {KieServerApplication.class, KeycloakIdentityProvider.class}, webEnvironment = WebEnvironment.RANDOM_PORT)
@TestPropertySource(locations="classpath:application-test.properties")
public class KeycloakKieServerTest {
static final String ARTIFACT_ID = "keycloak-sample";
static final String GROUP_ID = "org.kie.server.testing";
static final String VERSION = "1.0.0";
static final String PATH = "src/test/resources/kjars/";
private static final Logger logger = LoggerFactory.getLogger(KeycloakKieServerTest.class);
@Rule
public TestRule watcher = new TestWatcher() {
protected void starting(Description description) {
logger.info(">>> Starting test: " + description.getMethodName());
}
};
@Autowired
protected DeploymentService deploymentService;
@LocalServerPort
private int port;
private String containerId = "org.kie.server.testing:keycloak-sample:1.0.0";
private String processId = "evaluation";
private String restrictedVarProcessId = "HumanTaskWithRestrictedVar";
private KModuleDeploymentUnit unit;
private KieServicesClient kieServicesClient;
private static KeycloakContainer keycloak;
@BeforeClass
public static void startTestContainers() {
assumeTrue(isDockerAvailable());
keycloak = new KeycloakContainer();
keycloak.start();
KeycloakFixture.setup(keycloak.getAuthServerUrl());
}
@DynamicPropertySource
public static void registerKeycloakProperties(DynamicPropertyRegistry registry) {
registry.add("keycloak.auth-server-url", keycloak::getAuthServerUrl);
}
@AfterClass
public static void generalCleanup() {
if (keycloak!=null)
keycloak.stop();
System.clearProperty(KieServerConstants.KIE_SERVER_MODE);
}
@Before
public void setup() {
KieJarBuildHelper.createKieJar(PATH + ARTIFACT_ID);
unit = new KModuleDeploymentUnit(GROUP_ID, ARTIFACT_ID, VERSION);
}
@After
public void cleanup() {
if (deploymentService!=null) {
deploymentService.undeploy(unit);
}
if (kieServicesClient != null) {
kieServicesClient.disposeContainer(containerId);
}
}
@Test
public void testProcessStartAndAbort() {
setupClient(JOHN, JOHN_PW);
// query for all available process definitions
QueryServicesClient queryClient = kieServicesClient.getServicesClient(QueryServicesClient.class);
List<ProcessDefinition> processes = queryClient.findProcesses(0, 10);
assertEquals(2, processes.size());
ProcessServicesClient processClient = kieServicesClient.getServicesClient(ProcessServicesClient.class);
// get details of process definition
ProcessDefinition definition = processClient.getProcessDefinition(containerId, processId);
assertNotNull(definition);
assertEquals(processId, definition.getId());
// start process instance
Map<String, Object> params = new HashMap<String, Object>();
params.put("employee", "john");
params.put("reason", "test on spring boot");
Long processInstanceId = processClient.startProcess(containerId, processId, params);
assertNotNull(processInstanceId);
// find active process instances
List<ProcessInstance> instances = queryClient.findProcessInstances(0, 10);
assertEquals(1, instances.size());
// at the end abort process instance
processClient.abortProcessInstance(containerId, processInstanceId);
ProcessInstance processInstance = queryClient.findProcessInstanceById(processInstanceId);
assertNotNull(processInstance);
assertEquals(3, processInstance.getState().intValue());
}
@Test
public void testProcessStartAndWorkOnUserTask() {
setupClient(JOHN, JOHN_PW);
// query for all available process definitions
QueryServicesClient queryClient = kieServicesClient.getServicesClient(QueryServicesClient.class);
List<ProcessDefinition> processes = queryClient.findProcesses(0, 10);
assertEquals(2, processes.size());
ProcessServicesClient processClient = kieServicesClient.getServicesClient(ProcessServicesClient.class);
// get details of process definition
ProcessDefinition definition = processClient.getProcessDefinition(containerId, processId);
assertNotNull(definition);
assertEquals(processId, definition.getId());
// start process instance
Map<String, Object> params = new HashMap<String, Object>();
params.put("employee", JOHN);
params.put("reason", "test on spring boot");
Long processInstanceId = processClient.startProcess(containerId, processId, params);
assertNotNull(processInstanceId);
UserTaskServicesClient taskClient = kieServicesClient.getServicesClient(UserTaskServicesClient.class);
// find available tasks
List<TaskSummary> tasks = taskClient.findTasksAssignedAsPotentialOwner(JOHN, 0, 10);
assertEquals(1, tasks.size());
// complete task
Long taskId = tasks.get(0).getId();
taskClient.startTask(containerId, taskId, JOHN);
taskClient.completeTask(containerId, taskId, JOHN, null);
// find active process instances
List<ProcessInstance> instances = queryClient.findProcessInstances(0, 10);
assertEquals(1, instances.size());
tasks = taskClient.findTasksAssignedAsPotentialOwner(JOHN, 0, 10);
assertEquals(1, tasks.size());
// at the end abort process instance
processClient.abortProcessInstance(containerId, processInstanceId);
ProcessInstance processInstance = queryClient.findProcessInstanceById(processInstanceId);
assertNotNull(processInstance);
assertEquals(3, processInstance.getState().intValue());
}
@Test
public void testAuthorizedUserOnRestrictedVar() {
setupClient(BARTLET, BARTLET_PW);
ProcessServicesClient processClient = kieServicesClient.getServicesClient(ProcessServicesClient.class);
// authorized user can start process instance and update the restricted variable
Long processInstanceId = processClient.startProcess(containerId, restrictedVarProcessId, singletonMap("press", Boolean.TRUE));
assertNotNull(processInstanceId);
abortProcess(processClient, processInstanceId);
}
@Test
public void testNoRestrictedVarViolation() {
setupClient(JOHN, JOHN_PW);
ProcessServicesClient processClient = kieServicesClient.getServicesClient(ProcessServicesClient.class);
// any unauthorized user can start that process if restricted variable value is not updated
Long processInstanceId = processClient.startProcess(containerId, restrictedVarProcessId);
assertNotNull(processInstanceId);
abortProcess(processClient, processInstanceId);
}
@Test
public void testRestrictedVarViolationByUnauthorizedUser() {
setupClient(JOHN, JOHN_PW);
ProcessServicesClient processClient = kieServicesClient.getServicesClient(ProcessServicesClient.class);
Map<String, Object> map = singletonMap("press", Boolean.TRUE);
// an unauthorized user cannot start process instance when trying to update the restricted variable
assertThatExceptionOfType(KieServicesHttpException.class)
.isThrownBy(() -> processClient.startProcess(containerId, restrictedVarProcessId, map));
}
private static boolean isDockerAvailable() {
try {
DockerClientFactory.instance().client();
return true;
} catch (Throwable ex) {
return false;
}
}
private void setupClient(String user, String password) {
ReleaseId releaseId = new ReleaseId(GROUP_ID, ARTIFACT_ID, VERSION);
String serverUrl = "http://localhost:" + port + "/rest/server";
KieServicesConfiguration configuration = KieServicesFactory.newRestConfiguration(serverUrl, user, password);
configuration.setTimeout(60000);
configuration.setMarshallingFormat(MarshallingFormat.JSON);
kieServicesClient = KieServicesFactory.newKieServicesClient(configuration);
KieContainerResource resource = new KieContainerResource(containerId, releaseId);
resource.setContainerAlias(containerId);
kieServicesClient.createContainer(containerId, resource);
}
private void abortProcess(ProcessServicesClient processClient, Long processInstanceId) {
QueryServicesClient queryClient = kieServicesClient.getServicesClient(QueryServicesClient.class);
ProcessInstance processInstance = queryClient.findProcessInstanceById(processInstanceId);
assertNotNull(processInstance);
assertEquals(1, processInstance.getState().intValue());
processClient.abortProcessInstance(containerId, processInstanceId);
}
}