Merge pull request #713 from juju/merge_2.9.11

#713

Update the 2.9 branch with the latest changes on version 2.9.11.

Author: jujubot

.github/workflows/tox.yaml

@@ -8,7 +8,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: [3.5, 3.6, 3.7, 3.8, 3.9]
+        python:
+          - "3.5"
+          - "3.6"
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
     steps:
     - name: Check out code
       uses: actions/checkout@v2
@@ -25,11 +31,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: [3.5, 3.6, 3.7, 3.8, 3.9]
+        python:
+          - "3.5"
+          - "3.6"
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
     steps:
       - uses: actions/checkout@v2
       - name: Setup Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies

Makefile

@@ -16,7 +16,7 @@ clean:
 
 .PHONY: client
 client:
-	tox -r --notest -e lint,py38
+	tox -r --notest -e lint,py3
 	$(PY) -m juju.client.facade -s "juju/client/schemas*" -o juju/client/
 
 .PHONY: test
@@ -27,7 +27,7 @@ test: lint
 
 .PHONY: lint
 lint: 
-	tox -e lint --notest
+	tox -e lint
 
 .PHONY: docs
 docs: .tox

VERSION

@@ -1 +1 @@
-2.9.3
+2.9.11

docs/changelog.rst

@@ -1,6 +1,136 @@
 Changelog
 ---------
 
+2.9.11
+^^^^^^
+
+Monday July 11 2022
+
+## What's Changed
+
+* Add REPL quickstart subsection by @sed-i in https://github.com/juju/python-libjuju/pull/676
+* Revision of test onos.charm by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/686
+* [JUJU-1353] Parse assume directives. by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/685
+* Replace deprecated juju.loop() calls from examples and documentation by @ittner in https://github.com/juju/python-libjuju/pull/687
+* Fixed the bundle run when the channel is None by @oEscal in https://github.com/juju/python-libjuju/pull/664
+
+2.9.10
+^^^^^^
+
+Thursday June 9 2022
+
+* [JUJU-1155] Avoid incorrectly setting `series: kubernetes` for sidecar charms in k8s bundles by @cderici in https://github.com/juju/python-libjuju/pull/679
+* [JUJU-1172] Visiting the pylibjuju CI by @cderici in https://github.com/juju/python-libjuju/pull/681
+* [JUJU-1124] Avoid sending path across the wire for local resource file name by @cderici in https://github.com/juju/python-libjuju/pull/678
+
+2.9.9
+^^^^^
+
+Wednesday April 26 2022
+
+* [JUJU-835] Avoid ignoring asyncio exceptions in coroutines by @cderici in https://github.com/juju/python-libjuju/pull/658
+* [JUJU-843] Attach-resource to check if given binary file by @cderici in https://github.com/juju/python-libjuju/pull/659
+* [JUJU-858] Add quality of life feature ensure application removal at return by @cderici in https://github.com/juju/python-libjuju/pull/665
+* [JUJU-965] Add a bit of client side constraint validation by @cderici in https://github.com/juju/python-libjuju/pull/666
+* support python3.10 with later versions of websockets by @addyess in https://github.com/juju/python-libjuju/pull/673
+* Revert "Avoid ignoring asyncio exceptions in coroutines" by @simskij in https://github.com/juju/python-libjuju/pull/672
+* [JUJU-796] Add relate method and deprecate add-relation by @jack-w-shaw in https://github.com/juju/python-libjuju/pull/660
+* [JUJU-981] Get series from deployed app instead of metadata when charm upgrade by @cderici in https://github.com/juju/python-libjuju/pull/671
+
+2.9.8
+^^^^^
+
+Monday March 21 2022
+
+* [JUJU-567] Use ModelManager instead of ControllerFacade to list available models by @cderici in https://github.com/juju/python-libjuju/pull/632
+* [JUJU-573] Fix charm resolution for Juju 2.8.11 by @cderici in https://github.com/juju/python-libjuju/pull/633
+* [JUJU-704] Remove non-implemented (stuıb) functions by @cderici in https://github.com/juju/python-libjuju/pull/646
+* [JUJU-676] Avoid defaulting to empty string for charm origin by @cderici in https://github.com/juju/python-libjuju/pull/647
+* Charmstore compatability of deploying bundles by @addyess in https://github.com/juju/python-libjuju/pull/650
+* [JUJU-731] Subordinate charm num unit by @cderici in https://github.com/juju/python-libjuju/pull/648
+* [JUJU-769] Facade schemas for 2.9.27 by @cderici in https://github.com/juju/python-libjuju/pull/652
+* [JUJU-771] Auto switch to scale from add_unit on container based models by @cderici in https://github.com/juju/python-libjuju/pull/653
+
+2.9.7
+^^^^^
+
+Friday February 11 2022
+
+* [JUJU-556] Facade schemas for Juju 2.9.24 by @cderici in https://github.com/juju/python-libjuju/pull/626
+* Provide extra metadata with charmstore.entity(...)  by @addyess in https://github.com/juju/python-libjuju/pull/635
+
+2.9.6
+^^^^^
+
+Thursday January 27 2022
+
+* [JUJU-320] Unit public address by @SimonRichardson in https://github.com/juju/python-libjuju/pull/600
+* [JUJU-244] Add attach-resource by @cderici in https://github.com/juju/python-libjuju/pull/601
+* [JUJU-140] Model.wait_for_idle -- for apps with no units yet by @cderici in https://github.com/juju/python-libjuju/pull/575
+* [JUJU-367] Improve `get_charm_series` to check the model for series for a local charm by @cderici in https://github.com/juju/python-libjuju/pull/607
+* [JUJU-366] Utility for connecting directly to existing connection by @cderici in https://github.com/juju/python-libjuju/pull/605
+* Use public-address key instead of public_address by @wolsen in https://github.com/juju/python-libjuju/pull/610
+* [JUJU-376] `wait_for_idle` to support scale down by @cderici in https://github.com/juju/python-libjuju/pull/613
+* [JUJU-378] Utility for block_until-ing with a custom coroutine by @cderici in https://github.com/juju/python-libjuju/pull/614
+* Fallback to 'local-fan' by @dparv in https://github.com/juju/python-libjuju/pull/612
+* Minor comments on docs for block_until related functions. by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/617
+* Additional checks in print status. by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/622
+
+2.9.5
+^^^^^
+
+Friday December 3 2021
+
+* remove the event loop arguments by @cderici in https://github.com/juju/python-libjuju/pull/560
+* add debug-log by @cderici in https://github.com/juju/python-libjuju/pull/562
+* Model status by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/563
+* Pin cffi version to 1.14.6 for Python 3.5 by @cderici in https://github.com/juju/python-libjuju/pull/570
+* Wait for applications to terminate on model reset by @balbirthomas in https://github.com/juju/python-libjuju/pull/572
+* Babysitting python3.5 by @cderici in https://github.com/juju/python-libjuju/pull/571
+* Deploy charmhub bundles by @cderici in https://github.com/juju/python-libjuju/pull/569
+* Facade schemas for 2.9.17 by @SimonRichardson in https://github.com/juju/python-libjuju/pull/579
+* Bundles with overlays by @cderici in https://github.com/juju/python-libjuju/pull/566
+* Consistently getting a unit's public address by @cderici in https://github.com/juju/python-libjuju/pull/573
+* [JUJU-158] Add python3.9 to setup.py by @cderici in https://github.com/juju/python-libjuju/pull/585
+* [JUJU-157] Add note for removing services by @cderici in https://github.com/juju/python-libjuju/pull/583
+* Added boolean entries to normalize values. by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/582
+* [JUJU-138] Streamlining asyncio tasks/events by @cderici in https://github.com/juju/python-libjuju/pull/580
+* [JUJU-234] Fix for small bug in task handling by @cderici in https://github.com/juju/python-libjuju/pull/589
+* Ensure all watchers validate for the Id by @SimonRichardson in https://github.com/juju/python-libjuju/pull/592
+* [JUJU-276] Facade schemas for 2.9.19 by @cderici in https://github.com/juju/python-libjuju/pull/594
+* [JUJU-238] Small bug fix for old ClientFacade support by @cderici in https://github.com/juju/python-libjuju/pull/593
+* [JUJU-239] Debug-log parameters by @cderici in https://github.com/juju/python-libjuju/pull/595
+* [JUJU-213] Local type `file` resource support by @cderici in https://github.com/juju/python-libjuju/pull/590
+* [JUJU-289] Use provided series in deploy if supported by @jack-w-shaw in https://github.com/juju/python-libjuju/pull/596
+* [JUJU-292] Update the charms in the tests to use Charmhub by @cderici in https://github.com/juju/python-libjuju/pull/597
+* Legacy "services" for describing "applications" within bundles are no longer supported. "applications" can be used as a direct replacement for "services" in bundles.yaml.
+* The websocket (ws) in a Connection object became a read-only property.
+
+2.9.4
+^^^^^
+
+Tuesday October 12 2021
+
+* Charmhub deploy charm by @SimonRichardson in https://github.com/juju/python-libjuju/pull/483
+* add wait_for_status instead of wait_for_active by @sed-i in https://github.com/juju/python-libjuju/pull/517
+* Adds resource support for charmhub deployments by @tlm in https://github.com/juju/python-libjuju/pull/516
+* Fix bug #519 and #522: Add local resources for bundles by @davigar15 in https://github.com/juju/python-libjuju/pull/520
+* Patching some missing kwargs by @cderici in https://github.com/juju/python-libjuju/pull/527
+* Implementing `backup` functionality by @cderici in https://github.com/juju/python-libjuju/pull/536
+* Fix issue 532: Set the default_series properly by @davigar15 in https://github.com/juju/python-libjuju/pull/533
+* A random small bug fix by @cderici in https://github.com/juju/python-libjuju/pull/541
+* Allow ApplicationFacade set_config with non-string values by @cderici in https://github.com/juju/python-libjuju/pull/540
+* Skip macaroon tests issue 534 by @cderici in https://github.com/juju/python-libjuju/pull/542
+* Fix issue 530: Check the controller for unsynched models by @cderici in https://github.com/juju/python-libjuju/pull/539
+* Upgrade setup-python action. by @juanmanuel-tirado in https://github.com/juju/python-libjuju/pull/543
+* Fix integration tests by @cderici in https://github.com/juju/python-libjuju/pull/544
+* Bring juju/juju.py into life by @cderici in https://github.com/juju/python-libjuju/pull/546
+* Extract resources info from apps in locally deployed bundle by @cderici in https://github.com/juju/python-libjuju/pull/552
+* Fix for simple bug in bundle deployment code self.charm -> self['charm'] by @jnsgruk in https://github.com/juju/python-libjuju/pull/558
+* Fix integration tests continued by @cderici in https://github.com/juju/python-libjuju/pull/547
+* Get the config dir resolve logic into one place by @cderici in https://github.com/juju/python-libjuju/pull/555
+* Complete the backups functionality by @cderici in https://github.com/juju/python-libjuju/pull/556
+
 2.9.3
 ^^^^^
 

docs/narrative/application.rst

@@ -95,7 +95,7 @@ application. The `mysql_app` object is an instance of
 
 Adding and Removing Relations
 -----------------------------
-The :meth:`juju.application.Application.add_relation` method returns a
+The :meth:`juju.application.Application.relate` method returns a
 :class:`juju.relation.Relation` instance.
 
 .. code:: python
@@ -122,7 +122,7 @@ The :meth:`juju.application.Application.add_relation` method returns a
   )
 
   # Add the master-slave relation
-  relation = await mysql_master.add_relation(
+  relation = await mysql_master.relate(
       # Name of the relation on the local (mysql-master) side
       'master',
       # Name of the app:relation on the remote side

docs/readme.rst

@@ -36,6 +36,7 @@ Installation
 
 Quickstart
 ----------
+
 Here's a simple example that shows basic usage of the library. The example
 connects to the currently active Juju model, deploys a single unit of the
 ubuntu charm, then exits:
@@ -48,7 +49,7 @@ ubuntu charm, then exits:
   import logging
   import sys
 
-  from juju import loop
+  from juju import jasyncio
   from juju.model import Model
 
 
@@ -87,7 +88,7 @@ ubuntu charm, then exits:
 
       # Run the deploy coroutine in an asyncio event loop, using a helper
       # that abstracts loop creation and teardown.
-      loop.run(deploy())
+      jasyncio.run(deploy())
 
 
   if __name__ == '__main__':
@@ -103,6 +104,25 @@ example, to run ``examples/connect_current_model.py``, use:
   tox -e example -- examples/connect_current_model.py
 
 
+REPL
+^^^^
+
+To experiment with the library in a REPL, launch python in asyncio mode
+
+.. code:: bash
+
+  $ python3 -m asyncio
+
+and then, to connect to the current model and fetch status:
+
+.. code::
+
+  >>> from juju.model import Model
+  >>> model = Model()
+  >>> await model.connect_current()
+  >>> status = await model.get_status()
+
+
 Versioning
 ----------
 

examples/action.py

@@ -9,7 +9,7 @@
 """
 import logging
 
-from juju import loop
+from juju import jasyncio
 from juju.model import Model
 
 
@@ -39,11 +39,12 @@ async def main():
     for unit in app.units:
         await run_action(unit)
 
+    await app.remove()
     await model.disconnect()
 
 
 if __name__ == '__main__':
     logging.basicConfig(level=logging.DEBUG)
     ws_logger = logging.getLogger('websockets.protocol')
     ws_logger.setLevel(logging.INFO)
-    loop.run(main())
+    jasyncio.run(main())

examples/add_k8s.py

@@ -12,7 +12,7 @@
 import yaml
 import base64
 
-from juju import loop
+from juju import jasyncio
 from juju.client import client
 from juju.controller import Controller
 
@@ -48,11 +48,12 @@ async def main():
     )
     await controller.add_credential("test", credential=cred, cloud="test")
 
+    await controller.remove_cloud('test')
     await controller.disconnect()
 
 
 if __name__ == '__main__':
     logging.basicConfig(level=logging.DEBUG)
     ws_logger = logging.getLogger('websockets.protocol')
     ws_logger.setLevel(logging.INFO)
-    loop.run(main())
+    jasyncio.run(main())

examples/add_machine.py

@@ -10,7 +10,7 @@
 """
 import logging
 
-from juju import loop
+from juju import jasyncio
 from juju.model import Model
 
 MB = 1
@@ -69,4 +69,4 @@ async def main():
     ws_logger = logging.getLogger('websockets.protocol')
     ws_logger.setLevel(logging.INFO)
 
-    loop.run(main())
+    jasyncio.run(main())

examples/add_model.py

@@ -6,7 +6,7 @@
 3. Attempts to ssh into the charm
 
 """
-from juju import loop
+from juju import jasyncio
 from juju import utils
 from juju.controller import Controller
 import asyncio
@@ -64,4 +64,4 @@ async def main():
 
 
 if __name__ == '__main__':
-    loop.run(main())
+    jasyncio.run(main())