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

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

Merged
merged 31 commits into from
Sep 25, 2024
Merged

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

merged 31 commits into from
Sep 25, 2024

Commits on Sep 24, 2024

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

    …s.testing.
    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    21c0396 View commit details
    Browse the repository at this point in the history

  2. Use an explicit reference to help Sphinx out.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    cd0ecbf View commit details
    Browse the repository at this point in the history

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

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    4eedb72 View commit details
    Browse the repository at this point in the history

  4. Add types in the test class.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    b61469b View commit details
    Browse the repository at this point in the history

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

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    7ee4fe5 View commit details
    Browse the repository at this point in the history

  6. CharmEvents should be exposed in ops.testing (maybe also in scenario … 

    …top level?).
    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    40323f2 View commit details
    Browse the repository at this point in the history

  7. Add Scenario and Harness explicitly rather than via automodule, to wo… 

    …rk around our trickery.

Drop modindex (only has ops and ops.pebble, seems pointless) and search (it's on the left-hand side all the time, no point in a blank page) as drive-bys.
    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    55f0910 View commit details
    Browse the repository at this point in the history

  8. Adjust the monkeypatching to also include runtime.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    e7870cd View commit details
    Browse the repository at this point in the history

  9. Fix markup. Note that Harness is included by default.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    41a9854 View commit details
    Browse the repository at this point in the history

  10. Merge in the Scenario customisations.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    2b60277 View commit details
    Browse the repository at this point in the history

  11. Re-pin with ops-scenario added.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    c647130 View commit details
    Browse the repository at this point in the history

  12. Add ops-scenario to the docs dependencies.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    5f21f94 View commit details
    Browse the repository at this point in the history

  13. Use __all__ and move ActionFailed to Harness.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    d6c7d2d View commit details
    Browse the repository at this point in the history

  14. Add a test to ensure that we don't forget to document ops.testing cla… 

    …sses.
    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    8905747 View commit details
    Browse the repository at this point in the history

  15. Minor tweaks, mostly based on review.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    98f0e30 View commit details
    Browse the repository at this point in the history

  16. Update docs/index.rst 

    Co-authored-by: Ben Hoyt <[email protected]>
    @tonyandrewmeyer @benhoyt
    tonyandrewmeyer and benhoyt committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    3decc03 View commit details
    Browse the repository at this point in the history

  17. Update docs/index.rst 

    Co-authored-by: Ben Hoyt <[email protected]>
    @tonyandrewmeyer @benhoyt
    tonyandrewmeyer and benhoyt committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    3a6c58f View commit details
    Browse the repository at this point in the history

  18. Update docs/index.rst 

    Co-authored-by: Ben Hoyt <[email protected]>
    @tonyandrewmeyer @benhoyt
    tonyandrewmeyer and benhoyt committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    b92d4e3 View commit details
    Browse the repository at this point in the history

  19. Tweak, per review.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    cbf52b3 View commit details
    Browse the repository at this point in the history

  20. WiP docs on separate pages.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    67b5a7a View commit details
    Browse the repository at this point in the history

  21. Split the testing classes into separate pages.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    1f5801e View commit details
    Browse the repository at this point in the history

  22. Fix merge.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    151ec9f View commit details
    Browse the repository at this point in the history

  23. Update test for doc split.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    04bac0b View commit details
    Browse the repository at this point in the history

  24. Fix rebase.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    08c95f8 View commit details
    Browse the repository at this point in the history

  25. Allow 'pip install ops[harness], which is the same as pip install ops… 

    … for now, to ease transition.
    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    cf61118 View commit details
    Browse the repository at this point in the history

  26. Typo from previous PR.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    8b1d1ee View commit details
    Browse the repository at this point in the history

  27. Add a PendingDeprecationWarning for Harness.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    d0ce232 View commit details
    Browse the repository at this point in the history

  28. Tweaks per review.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    24686d3 View commit details
    Browse the repository at this point in the history

  29. Update ops/_private/harness.py 

    Co-authored-by: Dima Tisnek <[email protected]>
    @tonyandrewmeyer @dimaqq
    tonyandrewmeyer and dimaqq authored Sep 24, 2024
    Configuration menu
    Copy the full SHA
    bac91d7 View commit details
    Browse the repository at this point in the history

  30. Update docs/index.rst 

    Co-authored-by: Ben Hoyt <[email protected]>
    @tonyandrewmeyer @benhoyt
    tonyandrewmeyer and benhoyt authored Sep 24, 2024
    Configuration menu
    Copy the full SHA
    2472e7c View commit details
    Browse the repository at this point in the history

  31. Move some index content to the harness page.

    @tonyandrewmeyer
    tonyandrewmeyer committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    bc05df8 View commit details
    Browse the repository at this point in the history