Skip to content

Testing docs#141

Merged
FranzBusch merged 2 commits into
apple:mainfrom
RalucaP:fb-testing-docs
May 12, 2026
Merged

Testing docs#141
FranzBusch merged 2 commits into
apple:mainfrom
RalucaP:fb-testing-docs

Conversation

@RalucaP

@RalucaP RalucaP commented Apr 29, 2026

Copy link
Copy Markdown
Contributor

Closes #115, #116.

Motivation

Add testing guides for workflows and activities to enhance documentation.

Modifications

  • Add Testing-Activities.md covering unit tests with withActivityTestEnvironment and integration tests with the test server trait.
  • Add Testing-Workflows.md covering signals/queries/updates, time-skipping, and replay testing.
  • Add links to the two new pages above in the relevant files.

Result

Docs for testing workflows and activities.

Test Plan

All code examples verified against source signatures and compilation-tested.

Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Activities.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Workflows.md Outdated
@RalucaP RalucaP requested a review from FranzBusch April 29, 2026 18:44
@FranzBusch FranzBusch changed the title Fb testing docs Testing docs Apr 30, 2026
@FranzBusch FranzBusch added the semver/none No version bump required. label Apr 30, 2026

@heckj heckj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A variety of small tips and rewording suggestions to aim for more direct voice and to align more closely to Apple's style patterns, but structurally there's a biggest question of repeating the example of the integration test in two places that may be best resolved as putting it in a single place and keeping the first article focused on unit testing, and the second on integration testing and their associated patterns and use cases.

Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Activities.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Activities.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Activities.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Activities.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Workflows.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Workflows.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Workflows.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Workflows.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Workflows.md Outdated
Comment thread Sources/Temporal/Documentation.docc/Testing/Testing-Workflows.md Outdated
RalucaP and others added 2 commits May 4, 2026 13:05
Covers unit testing with withActivityTestEnvironment (heartbeat assertion,
cancellation), and integration testing with the test server trait.

Co-Authored-By: Franz Busch <f.busch@apple.com>
Covers integration testing with signals/queries/updates, time-skipping
for timer-dependent workflows, and replay testing with WorkflowReplayer.

Co-Authored-By: Franz Busch <f.busch@apple.com>

@heckj heckj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great @RalucaP !

@FranzBusch FranzBusch merged commit ff3d1c3 into apple:main May 12, 2026
29 of 31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver/none No version bump required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to test activities

3 participants