refactor: move the content of ops.testing to ops._private.harness - #1369
Conversation
|
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
left a comment
benhoyt
left a comment
There was a problem hiding this comment.
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.
116e30d to
7e098fe
Compare
7e098fe to
362f7eb
Compare
benhoyt
left a comment
benhoyt
left a comment
There was a problem hiding this comment.
Looks straight-forward enough -- just a couple of questions for now.
| ) | ||
|
|
||
| # The Harness testing framework. | ||
| _ = ActionFailed |
There was a problem hiding this comment.
What's the difference/advantage of doing this over __all__?
There was a problem hiding this comment.
__all__ causes Sphinx to get very confused, and I couldn't figure out any way to keep __all__ and de-confuse it.
benhoyt
left a comment
benhoyt
left a comment
There was a problem hiding this comment.
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
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. |
… ops.testing, not ops._private.harness.
benhoyt
left a comment
benhoyt
left a comment
There was a problem hiding this comment.
Looks good to me, thanks!
|
pls rebase too |
…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.
Remove mocking of private ops class according to canonical/operator#1369 and canonical/seldon-core-operator#268
Remove mocking of private ops class according to canonical/operator#1369 and canonical/seldon-core-operator#268
* Pin pip to 24.2 due to jazzband/pip-tools#2131 * Update python dependencies using 'tox -e update-requirements' * Remove unused pytest-lazy-fixture package * Remove mocking of private ops class according to canonical/operator#1369 and canonical/seldon-core-operator#268 Ref canonical/bundle-kubeflow#1177 Ref canonical/bundle-kubeflow#1185
* Pin pip to 24.2 due to jazzband/pip-tools#2131 * Update python dependencies using 'tox -e update-requirements' * Remove mocking of private ops class according to canonical/operator#1369 and canonical/seldon-core-operator#268 * Pin blinker due to seleniumbase/SeleniumBase#2782 Ref canonical/bundle-kubeflow#1177
3 participants
Moves the content of
ops/testing.pytoops/_private/harness.py, and then re-exposes all the names in theops.testingnamespace (other than standard library and third-party modules).This allows other testing frameworks (such as Scenario) to be exposed in the
ops.testingnamespace while also building on top of the existing testing code.