Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: move the content of ops.testing to ops._private.harness #1369

Merged
merged 7 commits into from
Sep 17, 2024
Merged

refactor: move the content of ops.testing to ops._private.harness #1369

merged 7 commits into from
Sep 17, 2024

Conversation

tonyandrewmeyer
Copy link
Contributor

Moves the content of ops/testing.py to ops/_private/harness.py, and then re-exposes all the names in the ops.testing namespace (other than standard library and third-party modules).

This allows other testing frameworks (such as Scenario) to be exposed in the ops.testing namespace while also building on top of the existing testing code.

@tonyandrewmeyer tonyandrewmeyer marked this pull request as draft September 11, 2024 05:47
@tonyandrewmeyer
Copy link
Contributor Author

tonyandrewmeyer commented Sep 11, 2024 •
edited
Loading

PRs to stop charms using the private class:

@tonyandrewmeyer
Copy link
Contributor Author

tonyandrewmeyer commented Sep 11, 2024 •
edited
Loading

PRs to stop charms using the private class:

Unfortunately, these are not the only culprits, there's also:

My feeling is that by accessing a private name and not fixing that after the issue in ops was fixed, the charmers should take responsibility for fixing this themselves (it's fairly straightforward). However, if people want to argue that we should offer up PRs for the above as well, I can do that.

benhoyt
benhoyt reviewed Sep 11, 2024
View reviewed changes
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Do you think you could rebase/redo this PR into two commits: one with a pure rename of ops/testing.py to ops/_private/harness.py, and one with any actual changes? Otherwise it's very difficult to see the actual changes.

ops/testing.py Outdated Show resolved Hide resolved
@tonyandrewmeyer tonyandrewmeyer marked this pull request as ready for review September 12, 2024 04:47
benhoyt
benhoyt reviewed Sep 13, 2024
View reviewed changes
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Looks straight-forward enough -- just a couple of questions for now.

ops/testing.py Outdated Show resolved Hide resolved
ops/testing.py
)

# The Harness testing framework.
_ = ActionFailed
Copy link
Collaborator

Choose a reason for hiding this comment

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

What's the difference/advantage of doing this over __all__?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

__all__ causes Sphinx to get very confused, and I couldn't figure out any way to keep __all__ and de-confuse it.

ops/testing.py Show resolved Hide resolved
benhoyt
benhoyt reviewed Sep 15, 2024
View reviewed changes
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Okay, I'm happy with the changes themselves, but I'm concerned about what this means for our API reference docs. It seems like PR means there are now no docs for ops.testing -- is that intentional? https://ops--1369.org.readthedocs.build/en/1369/#module-ops.testing

@tonyandrewmeyer
Copy link
Contributor Author

Okay, I'm happy with the changes themselves, but I'm concerned about what this means for our API reference docs. It seems like PR means there are now no docs for ops.testing -- is that intentional?

No, when I checked what the docs were like I loaded the wrong file, so I missed this. I'll figure out how to fix it.

benhoyt
benhoyt approved these changes Sep 16, 2024
View reviewed changes
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@dimaqq
Copy link
Contributor

dimaqq commented Sep 17, 2024

pls rebase too

@tonyandrewmeyer tonyandrewmeyer merged commit cae9cef into canonical:main Sep 17, 2024
29 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the move-harness branch September 17, 2024 22:03
tonyandrewmeyer added a commit to tonyandrewmeyer/operator that referenced this pull request Oct 4, 2024
@tonyandrewmeyer
refactor: move the content of ops.testing to ops._private.harness (ca…
7d3927a 
…nonical#1369)

Moves the content of `ops/testing.py` to `ops/_private/harness.py`, and
then re-exposes all the names in the `ops.testing` namespace (other than
standard library and third-party modules).

This allows other testing frameworks (such as Scenario) to be exposed in
the `ops.testing` namespace while also building on top of the existing
testing code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benhoyt benhoyt benhoyt approved these changes

@dimaqq dimaqq dimaqq approved these changes

@james-garner-canonical james-garner-canonical Awaiting requested review from james-garner-canonical

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tonyandrewmeyer @dimaqq @benhoyt