Add Callbacks for Workflow lifecycle events by daviddavis · Pull Request #11 · pulp/pulp_workflow

daviddavis · 2026-05-08T18:18:26Z

Introduces CallbackService (an admin-registered executable script, modeled after pulpcore's SigningService but fully API-managed) and WorkflowCallback (a join table to Workflow with a callback_type drawn from the workflow lifecycle states plus a 'finished' wildcard). When a Workflow transitions states, matching callbacks are dispatched as Pulp tasks that invoke the script with PULP_WORKFLOW_NAME / STATE / PK / LABELS / LABEL_ in the environment.

closes #10

Assisted-By: GitHub Copilot (Claude)

Copilot

Pull request overview

This PR adds a workflow lifecycle callback extension point to pulp_workflow by introducing an API-managed CallbackService (an admin-registered executable script) and WorkflowCallback attachments on Workflow that dispatch callback invocations as Pulp tasks when workflows transition states.

Changes:

Added CallbackService and WorkflowCallback models (plus migration) and exposed them via serializers/viewsets.
Dispatched callback tasks on workflow state transitions (running, completed, failed, canceled, plus finished wildcard).
Added functional/unit test coverage, documentation updates, and a changelog entry.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
README.md	Updates README overview to mention callbacks.
CHANGES/+10.feature	Documents the new callback feature and environment variables.
pulp_workflow/app/migrations/0003_callbackservice_workflowcallback.py	Adds DB tables for `CallbackService` and `WorkflowCallback`.
pulp_workflow/app/models.py	Introduces callback-related models/constants and script execution logic.
pulp_workflow/app/serializers.py	Adds serializers for callback services and nested workflow callbacks.
pulp_workflow/app/tasks.py	Dispatches callback tasks on workflow state transitions and implements `run_callback`.
pulp_workflow/app/viewsets.py	Adds `CallbackServiceViewSet` and fires cancel-related callbacks.
pulp_workflow/pytest_plugin.py	Adds factories and `monitor_workflow` helper fixture for functional tests.
pulp_workflow/tests/unit/test_viewsets.py	Adds access policy and locked-role tests for `CallbackServiceViewSet`.
pulp_workflow/tests/functional/api/test_crud_callback_services.py	Adds CRUD functional tests for callback services.
pulp_workflow/tests/functional/api/test_workflow_callbacks.py	Adds end-to-end lifecycle callback dispatch tests.
pulp_workflow/tests/functional/api/test_execute_workflow.py	Refactors workflow execution test to use shared helpers (`extract_pk`, `monitor_workflow`).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.

Copilot

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.

Copilot

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.

Copilot

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 5 comments.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 4 comments.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.

Introduces CallbackService (an admin-registered executable script, modeled after pulpcore's SigningService) and WorkflowCallback (a join table to Workflow with a callback_type drawn from the workflow lifecycle states plus a 'finished' option). When a Workflow transitions states, matching callbacks are dispatched as Pulp tasks that invoke the script. closes #10 Assisted-By: GitHub Copilot (Claude)

Copilot AI review requested due to automatic review settings May 8, 2026 18:18

daviddavis force-pushed the add-workflow-callbacks branch from 9dcf218 to 0df1898 Compare May 8, 2026 18:18

Copilot started reviewing on behalf of daviddavis May 8, 2026 18:19 View session

daviddavis force-pushed the add-workflow-callbacks branch from 0df1898 to 0111ee0 Compare May 8, 2026 18:21

Copilot AI reviewed May 8, 2026

View reviewed changes

Comment thread pulp_workflow/app/serializers.py Outdated

Comment thread pulp_workflow/app/serializers.py

Comment thread pulp_workflow/pytest_plugin.py

Comment thread pulp_workflow/app/models.py Outdated

Comment thread README.md Outdated

daviddavis force-pushed the add-workflow-callbacks branch from 0111ee0 to a550750 Compare May 8, 2026 18:24

daviddavis changed the title ~~Add CallbackServices for Workflow lifecycle events~~ Add callbacks for Workflow lifecycle events May 8, 2026

daviddavis changed the title ~~Add callbacks for Workflow lifecycle events~~ Add Callbacks for Workflow lifecycle events May 8, 2026

daviddavis force-pushed the add-workflow-callbacks branch from a550750 to af65e61 Compare May 8, 2026 18:30

Copilot AI review requested due to automatic review settings May 11, 2026 13:13

daviddavis force-pushed the add-workflow-callbacks branch from af65e61 to fef70cb Compare May 11, 2026 13:13

Copilot started reviewing on behalf of daviddavis May 11, 2026 13:14 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

Comment thread pulp_workflow/app/models.py Outdated

Comment thread pulp_workflow/app/models.py

Comment thread pulp_workflow/app/serializers.py Outdated

Comment thread template_config.yml Outdated

daviddavis force-pushed the add-workflow-callbacks branch from fef70cb to 5111435 Compare May 11, 2026 13:26

daviddavis mentioned this pull request May 11, 2026

CallbackService.run()/arun() should support a configurable timeout #15

Open

daviddavis force-pushed the add-workflow-callbacks branch from 5111435 to d784c71 Compare May 11, 2026 13:35

Copilot AI review requested due to automatic review settings May 11, 2026 13:35

Copilot started reviewing on behalf of daviddavis May 11, 2026 13:36 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

Comment thread pulp_workflow/pytest_plugin.py

Comment thread pulp_workflow/app/models.py

Comment thread pulp_workflow/app/models.py

daviddavis force-pushed the add-workflow-callbacks branch from d784c71 to 624cfb9 Compare May 11, 2026 13:57

Copilot AI review requested due to automatic review settings May 14, 2026 13:34

daviddavis force-pushed the add-workflow-callbacks branch from 624cfb9 to 2d1bfa4 Compare May 14, 2026 13:34

Copilot started reviewing on behalf of daviddavis May 14, 2026 13:35 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread pulp_workflow/pytest_plugin.py

Comment thread pulp_workflow/app/models.py

Comment thread pulp_workflow/app/serializers.py

github-actions Bot added multi-commit no-changelog no-issue labels May 22, 2026

Copilot AI review requested due to automatic review settings June 2, 2026 13:23

daviddavis force-pushed the add-workflow-callbacks branch from 7ccb10a to e325799 Compare June 2, 2026 13:23

Copilot started reviewing on behalf of daviddavis June 2, 2026 13:23 View session

github-actions Bot removed no-issue no-changelog labels Jun 2, 2026

Copilot AI reviewed Jun 2, 2026

View reviewed changes

Comment thread pulp_workflow/pytest_plugin.py

Comment thread pulp_workflow/tests/unit/test_models.py

Comment thread pulp_workflow/tests/unit/test_models.py

Comment thread pulp_workflow/tests/unit/test_models.py

Comment thread pulp_workflow/tests/unit/test_models.py

daviddavis force-pushed the add-workflow-callbacks branch from e325799 to b4703aa Compare June 2, 2026 14:39

Copilot AI review requested due to automatic review settings June 2, 2026 14:40

daviddavis force-pushed the add-workflow-callbacks branch from b4703aa to da7586d Compare June 2, 2026 14:40

Copilot started reviewing on behalf of daviddavis June 2, 2026 14:40 View session

daviddavis force-pushed the add-workflow-callbacks branch from da7586d to 73bd1c1 Compare June 2, 2026 14:42

Copilot AI reviewed Jun 2, 2026

View reviewed changes

Comment thread pulp_workflow/app/viewsets.py Outdated

Comment thread pulp_workflow/app/viewsets.py Outdated

Comment thread pulp_workflow/pytest_plugin.py

Comment thread docs/demo/README.md

daviddavis force-pushed the add-workflow-callbacks branch from 73bd1c1 to 64240a8 Compare June 2, 2026 14:49

Copilot AI review requested due to automatic review settings June 2, 2026 14:56

daviddavis force-pushed the add-workflow-callbacks branch from 64240a8 to 62e8080 Compare June 2, 2026 14:56

Copilot started reviewing on behalf of daviddavis June 2, 2026 14:56 View session

daviddavis force-pushed the add-workflow-callbacks branch from 62e8080 to ef6888b Compare June 2, 2026 14:57

Copilot AI reviewed Jun 2, 2026

View reviewed changes

Comment thread pulp_workflow/app/tasks.py

Comment thread pulp_workflow/app/tasks.py

daviddavis force-pushed the add-workflow-callbacks branch from ef6888b to 8b2ff58 Compare June 2, 2026 15:08

Copilot AI review requested due to automatic review settings June 2, 2026 15:18

daviddavis force-pushed the add-workflow-callbacks branch from 8b2ff58 to caab655 Compare June 2, 2026 15:18

Copilot started reviewing on behalf of daviddavis June 2, 2026 15:18 View session

Copilot AI reviewed Jun 2, 2026

View reviewed changes

Comment thread docs/demo/README.md Outdated

Comment thread docs/demo/README.md Outdated

Comment thread README.md

daviddavis force-pushed the add-workflow-callbacks branch from caab655 to 8241c94 Compare June 2, 2026 15:55

Copilot AI review requested due to automatic review settings June 2, 2026 16:04

daviddavis force-pushed the add-workflow-callbacks branch from 8241c94 to 88a5fe3 Compare June 2, 2026 16:04

Copilot started reviewing on behalf of daviddavis June 2, 2026 16:04 View session

Copilot AI reviewed Jun 2, 2026

View reviewed changes

Comment thread pulp_workflow/app/models.py

Comment thread CHANGES/10.feature

Comment thread pulp_workflow/tests/unit/test_models.py

daviddavis force-pushed the add-workflow-callbacks branch from 88a5fe3 to 50d2746 Compare June 2, 2026 20:02

acheng-01 approved these changes Jun 3, 2026

View reviewed changes

daviddavis merged commit 66a0d3c into main Jun 3, 2026
10 checks passed

daviddavis deleted the add-workflow-callbacks branch June 8, 2026 17:29

Conversation

daviddavis commented May 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!