mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2025-12-16 20:15:46 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add operation to deactivate a workflow execution for a resource

Browse Source 
Closes #42124

Signed-off-by: vramik <vramik@redhat.com>
This commit is contained in:
vramik
2025-11-03 07:42:53 +01:00
committed by Pedro Igor
parent 9d728dd686
commit 84a679224b
7 changed files with 121 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
integration/admin-client/src/main/java/org/keycloak/admin/client/resource/WorkflowResource.java
View File

@@ -37,4 +37,9 @@ public interface WorkflowResource {
@Consumes(MediaType.APPLICATION_JSON)
void bind(@PathParam("type") String type, @PathParam("resourceId") String resourceId, Long milliseconds);
@Path("deactivate/{type}/{resourceId}")
@POST
@Consumes(MediaType.APPLICATION_JSON)
void deactivate(@PathParam("type") String type, @PathParam("resourceId") String resourceId);
}

5
model/jpa/src/main/java/org/keycloak/models/workflow/DefaultWorkflowProvider.java
View File

@@ -132,6 +132,11 @@ public class DefaultWorkflowProvider implements WorkflowProvider {
processEvent(Stream.of(workflow), new AdhocWorkflowEvent(type, resourceId));
}
@Override
public void deactivate(Workflow workflow, String resourceId) {
stateProvider.removeByWorkflowAndResource(workflow.getId(), resourceId);
}
@Override
public void bindToAllEligibleResources(Workflow workflow) {
if (workflow.isEnabled()) {

15
model/jpa/src/main/java/org/keycloak/models/workflow/JpaWorkflowStateProvider.java
View File

@@ -134,6 +134,21 @@ public class JpaWorkflowStateProvider implements WorkflowStateProvider {
}
}
@Override
public void removeByWorkflowAndResource(String workflowId, String resourceId) {
CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaDelete<WorkflowStateEntity> delete = cb.createCriteriaDelete(WorkflowStateEntity.class);
Root<WorkflowStateEntity> root = delete.from(WorkflowStateEntity.class);
delete.where(cb.and(cb.equal(root.get("workflowId"), workflowId), cb.equal(root.get("resourceId"), resourceId)));
int deletedCount = em.createQuery(delete).executeUpdate();
if (LOGGER.isTraceEnabled()) {
if (deletedCount > 0) {
LOGGER.tracev("Deleted {0} state records for resource {1} of workflow {2}", deletedCount, resourceId, workflowId);
}
}
}
@Override
public void removeByWorkflow(String workflowId) {
CriteriaBuilder cb = em.getCriteriaBuilder();

2
server-spi-private/src/main/java/org/keycloak/models/workflow/WorkflowProvider.java
View File

@@ -46,6 +46,8 @@ public interface WorkflowProvider extends Provider {
void bind(Workflow workflow, ResourceType type, String resourceId);
void deactivate(Workflow workflow, String resourceId);
void submit(WorkflowEvent event);
void runScheduledSteps();

8
server-spi-private/src/main/java/org/keycloak/models/workflow/WorkflowStateProvider.java
View File

@@ -33,6 +33,14 @@ public interface WorkflowStateProvider extends Provider {
*/
void removeByResource(String resourceId);
/**
* Deletes the state records associated with the given {@code resourceId} of the given {@code workflowId}.
*
* @param workflowId the id of the workflow.
* @param resourceId the id of the resource.
*/
void removeByWorkflowAndResource(String workflowId, String resourceId);
/**
* Removes any record identified by the specified {@code workflowId}.
* @param workflowId the id of the workflow.

19
services/src/main/java/org/keycloak/workflow/admin/resource/WorkflowResource.java
View File

@@ -81,4 +81,23 @@ public class WorkflowResource {
provider.bind(workflow, type, resourceId);
}
/**
* Deactivate the workflow for the resource.
*
* @param type the resource type
* @param resourceId the resource id
*/
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Path("deactivate/{type}/{resourceId}")
public void deactivate(@PathParam("type") ResourceType type, @PathParam("resourceId") String resourceId) {
Object resource = provider.getResourceTypeSelector(type).resolveResource(resourceId);
if (resource == null) {
throw new BadRequestException("Resource with id " + resourceId + " not found");
}
provider.deactivate(workflow, resourceId);
}
}

67
tests/base/src/test/java/org/keycloak/tests/admin/model/workflow/AdhocWorkflowTest.java
View File

@@ -1,11 +1,13 @@
package org.keycloak.tests.admin.model.workflow;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.hasItems;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.Matchers.is;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.keycloak.models.workflow.ResourceOperationType.USER_ADDED;
import java.time.Duration;
import java.util.List;
@@ -15,8 +17,10 @@ import jakarta.ws.rs.core.Response;
import org.junit.jupiter.api.Test;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel;
import org.keycloak.models.workflow.NotifyUserStepProviderFactory;
import org.keycloak.models.workflow.ResourceType;
import org.keycloak.models.workflow.SetUserAttributeStepProviderFactory;
import org.keycloak.models.workflow.WorkflowStateProvider;
import org.keycloak.representations.idm.CredentialRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.representations.workflows.WorkflowRepresentation;
@@ -181,6 +185,69 @@ public class AdhocWorkflowTest extends AbstractWorkflowTest {
}));
}
@Test
public void testDeactivateWorkflowForResource() {
managedRealm.admin().workflows().create(WorkflowRepresentation.withName("One")
.onEvent(USER_ADDED.name())
.withSteps(
WorkflowStepRepresentation.create()
.of(SetUserAttributeStepProviderFactory.ID)
.withConfig("workflowOne", "first")
.after(Duration.ofDays(5))
.build(),
WorkflowStepRepresentation.create()
.of(NotifyUserStepProviderFactory.ID)
.after(Duration.ofDays(5))
.build()
)
.withName("Two")
.onEvent(USER_ADDED.name())
.withSteps(
WorkflowStepRepresentation.create()
.of(SetUserAttributeStepProviderFactory.ID)
.withConfig("workflowTwo", "second")
.after(Duration.ofDays(5))
.build(),
WorkflowStepRepresentation.create()
.of(NotifyUserStepProviderFactory.ID)
.after(Duration.ofDays(5))
.build()
)
.build()).close();
List<WorkflowRepresentation> workflows = managedRealm.admin().workflows().list();
assertThat(workflows, hasSize(2));
String workflowOneId = workflows.stream().filter(w -> w.getName().equals("One")).findFirst().orElseThrow(IllegalStateException::new).getId();
// create a new user - should bind the user to the workflow and set up the first step in both workflows
String id = ApiUtil.handleCreatedResponse(managedRealm.admin().users().create(getUserRepresentation("alice", "Alice", "Wonderland", "alice@wornderland.org")));
runScheduledSteps(Duration.ofDays(6));
runOnServer.run(session -> {
RealmModel realm = session.getContext().getRealm();
UserModel user = session.users().getUserByUsername(realm, "alice");
assertThat(user.getAttributes().keySet(), hasItems("workflowOne", "workflowTwo"));
// Verify that the steps are scheduled for the user
WorkflowStateProvider stateProvider = session.getProvider(WorkflowStateProvider.class);
List<WorkflowStateProvider.ScheduledStep> scheduledSteps = stateProvider.getScheduledStepsByResource(user.getId());
assertNotNull(scheduledSteps, "Two steps should have been scheduled for the user " + user.getUsername());
assertThat(scheduledSteps, hasSize(2));
});
//deactivate workflow One
managedRealm.admin().workflows().workflow(workflowOneId).deactivate(ResourceType.USERS.name(), id);
runOnServer.run(session -> {
// Verify that there is single step scheduled for the user
WorkflowStateProvider stateProvider = session.getProvider(WorkflowStateProvider.class);
List<WorkflowStateProvider.ScheduledStep> scheduledSteps = stateProvider.getScheduledStepsByResource(id);
assertThat(scheduledSteps, hasSize(1));
});
}
private UserRepresentation getUserRepresentation(String username, String firstName, String lastName, String email) {
UserRepresentation representation = new UserRepresentation();
representation.setUsername(username);