docs: update integration testing how-to guide#2390
Merged
dwilding merged 13 commits intocanonical:mainfrom Mar 27, 2026
Merged
Conversation
dwilding
changed the title
james-garner-canonical
approved these changes
Mar 25, 2026
tonyandrewmeyer
approved these changes
Mar 26, 2026
Collaborator
tonyandrewmeyer
left a comment
tonyandrewmeyer
left a comment
There was a problem hiding this comment.
Definitely an improved order, thanks! One small suggestion and some +1s on ones from James.
dwilding
added a commit
to canonical/jubilant
that referenced
this pull request
Mar 30, 2026
This PR removes charm integration testing from the [tutorial](https://documentation.ubuntu.com/jubilant/tutorial/getting-started/). It's confusing to cover this here and [in the Ops docs](https://documentation.ubuntu.com/ops/latest/howto/write-integration-tests-for-a-charm/). In [operator#2390](canonical/operator#2390) I'm making sure that the Ops docs cover the info that I'm removing from the tutorial. With the exception of CI/Concierge - I'll do that in a separate PR. Also with the exception of `keep` - I've moved that info to the Jubilant reference docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR makes several improvements to the how-to guide for integration testing.
Main improvements:
Reduce the introduction, especially the number of outgoing links. Currently, it's easy to get confused about what to read first. There's especially no need to go and read about Jubilant first. I'm making sure that Jubilant is linked from several places throughout the doc.
Add extra info about fixtures and
juju.deploy(). Mostly this is adapted from the Jubilant tutorial, which I'm pruning in jubilant#280.Reorganise the flow of examples. The current flow shows a deploy, then defines fixtures, then shows a deploy again (in a better way).
Preview of updated doc