CHANGES.md

2.17.1 - 28 Nov 2024

Fixes

• Make push_path open in binary mode so it works on non-text files (#1458)

Documentation

• Use MaintenanceStatus for local issues (#1397)
• Explicitly document that collect-status is is run on every hook (#1399)
• Use our docs URL for the ogp:url properties Sphinx generates (#1411)
• Set the READTHEDOCS context variable (#1410)
• Fix Read the Docs ad placement (#1414)
• Clarify where StoredState is stored, and the upgrade behaviour (#1416)
• Fix copy 'n' paste error in stop_services docstring (#1457)

Continuous Integration

• Configure the labels for dependabot PRs (#1407)
• Disable the automatic ops[testing] releasing (#1415)
• Use the actual poetry command, rather than manually tweaking the file (#1443)
• Fix broken GitHub variable expansion (#1446)
• Coverage report generation should also include testing/src/scenario (#1453)
• Fix PR title CI job concurrency (#1451)
• Adjust the release process to handle publishing ops and ops[testing] (#1432)
• A better way than commenting out external repos (#1463)
• Use more descriptive names for the publish workflows (#1464)
• Move the XML coverage report to .report (#1465)

Refactoring

• Import the ops[testing] repository (#1406)
• Update linting with the latest ruff (#1441)

2.17.0 - 26 Sep 2024

Features

• Optionally install Scenario with ops[testing] and expose the names in ops.testing (#1381)
• Change ops.main() so that you don't need to type: ignore it (#1345)
• Expand the secret ID out to the full URI when only given the ID (#1358)
• Add a JujuVersion property for Pebble log forwarding to Loki (#1370)
• Pre-emptively raise InvalidStatusError instead of waiting for Juju:
  • Make it an error to call CollectStatusEvent.add_status with error or unknown (#1386)
  • Document and validate settable status values in _ModelBackend.set_status (#1354)

Fixes

• Fix type of StatusBase subclasses by calling StatusBase.register in __init_subclass__ (#1383)
• Secret.set_info and Secret.set_content can be called in the same hook (#1373)

Documentation

• Add top-level intro and module-level intros (#1320)
• Update the links to the Pebble docs (#1362)
• Note about repeatedly setting secret value in Juju 3.6 (#1366)
• config-changed is triggered by Juju trust (#1357)
• Typo on CharmBase inheritance example by @theofpa (#1349)
• Docs: move Pebble to a separate page (#1392)

Continuous Integration

• Periodically run the unit tests of all GitHub-hosted published charms (#1365)
• Update the TIOBE reporting for the changes in coverage calculation (#1367)
• Spell-check the code as part of linting (#1388)
• Run the smoke tests on a schedule (#1387)

Testing

• Fix tests that leaked environment variables (#1385)

Refactoring

• Move the content of ops.testing to ops._private.harness (#1369)
• Keep the unittest.mock names in the 'mock' namespace (#1379)
• Deprecate StatusBase.register decorator (#1384)

Chores

• Note Juju version on legacy workaround (#1355)
• Re-enable test now that Pebble directory permissions are fixed (#1363)
• Generate warnings for events that will be removed in Juju 4.0 (#1374)

2.16.1 - 5 Sep 2024

Fix

• Don't alter os.environ when creating a Harness (#1359)

2.16.0 - 29 Aug 2024

Features

• Add the description field to SecretInfo in (#1338)

Refactor

• Parse JUJU_* environment variables in one place in (#1313)

Fixes

• Fix reading Juju secret expiry dates in (#1317)
• Correct the signature of .events() in (#1342)

Documentation

• Security policy change to only support each active major release in (#1297)
• Add Juju version markers in (#1311)
• Use Sphinx 8 in (#1303)
• Live reload documentation with sphinx-autobuild in (#1323)

Tests

• Update the smoke test series/bases in (#1318)
• Run pytest in parallel with pytest xdist in (#1319)
• Bump Pyright to 1.1.377 in (#1332)
• Run tests on Python 3.12 and the install test on Python 3.13 in (#1315)

CI

• Add a workflow that runs the TIOBE quality checks in (#1301)
• Allow executing the TIOBE workflow manually in (#1321)
• Make Pyright report unnecessary type ignore comments in (#1333)
• Enable linting of docs/custom_conf.py in (#1330)

2.15.0 - 22 Jul 2024

Features

• Add support for Pebble check-failed and check-recovered events (#1281)

Fixes

• Pass secret data to Juju via files, rather than as command-line values (#1290) fixing CVE-2024-41129
• Include checks and log targets when merging layers in ops.testing (#1268)

Documentation

• Clarify distinction between maintenance and waiting status (#1148)

CI

• Bump the Go version to match Pebble (#1285)
• Run ruff format over charm pin update code (#1278)
• Bump certifi from 2024.2.2 to 2024.7.4 in /docs (#1282)
• Update charm pins (#1269)

2.14.1 - 27 Jun 2024

Fixes

• Add connect timeout for exec websockets to avoid hanging (#1247)
• Adjust Harness secret behaviour to align with Juju (#1248)

Tests

• Fix TypeError when running test.pebble_cli (#1245)
• Properly clean up after running setup_root_logging in test_log (#1259)
• Verify that defer() is not usable on stop,remove,secret-expired,secret-rotate (#1233)

Documentation

• Fix HACKING.md link on PyPI, and internal links (#1261, #1236)
• Add a section to HACKING.md on PR titles (commit messages to main) (#1252)
• Add release step to update pinned charm tests (#1213)
• Add a security policy (#1266)

CI

• Only run tests once on push to PR (#1242)
• Validate PR title against conventional commit rules in (#1262)
• Only update ops, not all dependencies, in charm tests in (#1275)
• Add artefact attestation (#1267)

2.14.0 - 29 May 2024

Features

• Add a __str__ to ActionFailed, for better unexpected failure output (#1209)

Fixes

• The other argument to RelatationDataContent.update(...) should be optional (#1226)

Documentation

• Use the actual emoji character rather than GitHub markup, to show properly on PyPI (#1221)
• Clarify that SecretNotFound may be raised for permission errors (#1231)

Refactoring

• Refactor tests to pytest style (#1199, #1200, #1203, #1206)
• Use ruff formatter and reformat all code (#1224)
• Don't use f-strings in logging calls (#1227, 1234)

2.13.0 - 30 Apr 2024

Features

• Added support for user secrets in Harness (#1176)

Fixes

• Corrected the model config types (#1183)
• In Harness, only inspect the source file if it will be used - this fixed using Harness in a Python REPL (#1181)

Documentation

• Updated publishing a release in HACKING.md (#1173)
• Added tox -e docs-deps to compile requirements.txt (#1172)
• Updated doc to note deprecated functionality in (#1178)

Tests

• First stage of converting tests from unittest to pytest (#1191, #1192, #1196, #1193, #1195)
• Added pebble.CheckInfo.change_id field (#1197)

2.12.0 - 28 Mar 2024

Features

• Added Model.get_cloud_spec which uses the credential-get hook tool to get details of the cloud where the model is deployed (#1152)

Fixes

• Update Pebble Notices get_notices parameter name to users=all (previously select=all) (#1146)
• Warn when an observer weakref is lost (#1142)
• More robust validation of observer signatures (#1147)
• Change Model.relation.app type from Application|None to Application (#1151)
• Fix attaching storage in Harness before begin (#1150)
• Fixed an issue where pebble.Client.exec might leak a socket.timeout (builtins.TimeoutError) exception (#1155)
• Add a consistency check and default network to add_relation (#1138)
• Don't special-case get_relation behaviour in leader-elected (#1156)
• Accept type: secret for config options (#1167)

Refactoring

• Refactor main.py, creating a new _Manager class (#1085)

Documentation

• Use "integrate with" rather than "relate to" (#1145)
• Updated code examples in the docstring of ops.testing from unittest to pytest style (#1157)
• Add peer relation details in Harness.add_relation docstring (#1168)
• Update Read the Docs Sphinx Furo theme to use Canonical's latest styling (#1163, #1164, #1165)

2.11.0 - 29 Feb 2024

Features

• StopEvent, RemoveEvent, and all LifecycleEvents are no longer deferrable, and will raise a RuntimeError if defer() is called on the event object (#1122)
• Add ActionEvent.id, exposing the JUJU_ACTION_UUID environment variable (#1124)
• Add support for creating pebble.Plan objects by passing in a pebble.PlanDict, the ability to compare two Plan objects with ==, and the ability to create an empty Plan with Plan() (#1134)

Fixes

• The remote app name (and its databag) is now consistently available in relation-broken events (#1130)

Documentation

• Improve the can_connect() API documentation (#1123)

Tooling

• Use ruff for linting (#1120, #1139, #1114)

2.10.0 - 31 Jan 2024

Features

• Add support for Pebble Notices (PebbleCustomNoticeEvent, get_notices, and so on) (#1086, #1100)
• Add Relation.active, and excluded inactive relations from Model.relations (#1091)
• Add full support for charm metadata v2 (in particular, extended ContainerMeta, and various info links in CharmMeta) (#1106)
• When handling actions, print uncaught exceptions to stderr (#1087)
• Raise ModelError in Harness if an invalid status is set (#1107)

Fixes

• Add Pebble log targets and checks to testing plans (#1111)
• CollectStatusEvent is now a LifecycleEvent (#1080)

Documentation

• Update README to reflect charmcraft init changes (#1089)
• Add information on pushing locked/bind-mount files (#1094)
• Add instructions for using a custom version of ops to HACKING (#1092)

Tooling

• Use pyproject.toml for building (#1068)
• Update to the latest version of Pyright (#1105)

2.9.0 - 30 Nov 2023

Features

• Add log target support to ops.pebble layers and plans (#1074)
• Add Harness.run_action(), testing.ActionOutput, and testing.ActionFailed (#1053)

Fixes

• Secret owners no longer auto-peek, and can use refresh, in Harness, and corrected secret access for non-leaders (#1067, #1076)
• Test suite adjustments to pass with Python 3.12 (#1081)

Documentation

• Refresh README (#1052)
• Clarify how custom events are emitted (#1072)
• Fix the Harness.get_filesystem_root example (#1065)

2.8.0 - 25 Oct 2023

Features

• Add Unit.reboot() and Harness.reboot_count (#1041)
• Add RelationMeta.optional (#1038)
• Raise a clearer exception when the Pebble socket is missing (#1049)

Fixes

• The type of a Handle's key was expanded from str to str|None
• Narrow types of app and unit in relation events to exclude None where applicable
• push_path and pull_path now include empty directories (#1024)
• Harness's evaluate_status resets collected statuses (#1048)

Documentation

• Notes that status changes are immediate (#1029)
• Clarifies set_results maximum size (#1047)
• Expands documentation on when exceptions may be raised (#1044)
• Makes pebble.Client.remove_path and Container.remove_path docs consistent (#1031)

Tooling

• Adds type hinting across the test suite (#1017, #1015, #1022, #1023, #1025, #1028, #1030, #1018, #1034, #1032)

2.7.0 - 29 Sept 2023

Features

• Adds Unit.set_ports() (#1005)
• Type checks now allow comparing a JujuVersion to a str
• Rename OpenPort to Port (OpenPort remains as an alias)

Documentation

• Reduces the amount of detail in open/close port methods (#1006)
• Removes you/your from docstrings (#1003)
• Minor improvements to HACKING (#1016)

Tooling

• Extends the use of type hints in the test suite (#1008, #1009, #1011, #1012, #1013, #1014, #1004)