feat: optionally install Scenario with `ops[testing]` and expose the names in ops.testing#1381

Merged

tonyandrewmeyer merged 31 commits intocanonical:mainfrom tonyandrewmeyer:pip-install-ops-testing

Sep 25, 2024

+510-117

Commits on Sep 24, 2024

Offer pip install ops[testing] and if available expose Scenario in ops.testing.
tonyandrewmeyer
committed
Use an explicit reference to help Sphinx out.
tonyandrewmeyer
committed
Create a new class rather than inheriting from both the originals.
tonyandrewmeyer
committed
Add types in the test class.
tonyandrewmeyer
committed
Use explicit references to ops so that copying the docstrings works.
tonyandrewmeyer
committed
CharmEvents should be exposed in ops.testing (maybe also in scenario top level?).
tonyandrewmeyer
committed
Add Scenario and Harness explicitly rather than via automodule, to work around our trickery.
tonyandrewmeyer
committed
Adjust the monkeypatching to also include runtime.
tonyandrewmeyer
committed
Fix markup. Note that Harness is included by default.
tonyandrewmeyer
committed
Merge in the Scenario customisations.
tonyandrewmeyer
committed
Re-pin with ops-scenario added.
tonyandrewmeyer
committed
Add ops-scenario to the docs dependencies.
tonyandrewmeyer
committed
Use __all__ and move ActionFailed to Harness.
tonyandrewmeyer
committed
Add a test to ensure that we don't forget to document ops.testing classes.
tonyandrewmeyer
committed
Minor tweaks, mostly based on review.
tonyandrewmeyer
committed
Update docs/index.rst

tonyandrewmeyer
and
benhoyt
committed
Update docs/index.rst

tonyandrewmeyer
and
benhoyt
committed
Update docs/index.rst

tonyandrewmeyer
and
benhoyt
committed
Tweak, per review.
tonyandrewmeyer
committed
WiP docs on separate pages.
tonyandrewmeyer
committed
Split the testing classes into separate pages.
tonyandrewmeyer
committed
Fix merge.
tonyandrewmeyer
committed
Update test for doc split.
tonyandrewmeyer
committed
Fix rebase.
tonyandrewmeyer
committed
Allow 'pip install ops[harness], which is the same as pip install ops for now, to ease transition.
tonyandrewmeyer
committed
Typo from previous PR.
tonyandrewmeyer
committed
Add a PendingDeprecationWarning for Harness.
tonyandrewmeyer
committed
Tweaks per review.
tonyandrewmeyer
committed
Update ops/_private/harness.py

tonyandrewmeyer
and
dimaqq
authored
Update docs/index.rst

tonyandrewmeyer
and
benhoyt
authored
Move some index content to the harness page.
tonyandrewmeyer
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: optionally install Scenario with `ops[testing]` and expose the names in ops.testing#1381

Commits on Sep 24, 2024

Offer pip install ops[testing] and if available expose Scenario in ops.testing.

Use an explicit reference to help Sphinx out.

Create a new class rather than inheriting from both the originals.

Add types in the test class.

Use explicit references to ops so that copying the docstrings works.

CharmEvents should be exposed in ops.testing (maybe also in scenario top level?).

Add Scenario and Harness explicitly rather than via automodule, to work around our trickery.

Adjust the monkeypatching to also include runtime.

Fix markup. Note that Harness is included by default.

Merge in the Scenario customisations.

Re-pin with ops-scenario added.

Add ops-scenario to the docs dependencies.

Use all and move ActionFailed to Harness.

Add a test to ensure that we don't forget to document ops.testing classes.

Minor tweaks, mostly based on review.

Update docs/index.rst

Update docs/index.rst

Update docs/index.rst

Tweak, per review.

WiP docs on separate pages.

Split the testing classes into separate pages.

Fix merge.

Update test for doc split.

Fix rebase.

Allow 'pip install ops[harness], which is the same as pip install ops for now, to ease transition.

Typo from previous PR.

Add a PendingDeprecationWarning for Harness.

Tweaks per review.

Update ops/_private/harness.py

Update docs/index.rst

Move some index content to the harness page.