-class Unit(object):
- def add_storage(self):
+import asyncio
+import logging
+from datetime import datetime
+
+from . import model
+from .client import client
+
+log = logging.getLogger(__name__)
+
+
+class Unit(model.ModelEntity):
+ @property
+ def agent_status(self):
+ """Returns the current agent status string.
+
+ """
+ return self.data['agent-status']['current']
+
+ @property
+ def agent_status_since(self):
+ """Get the time when the `agent_status` was last updated.
+
+ """
+ since = self.data['agent-status']['since']
+ # Juju gives us nanoseconds, but Python only supports microseconds
+ since = since[:26]
+ return datetime.strptime(since, "%Y-%m-%dT%H:%M:%S.%f")
+
+ @property
+ def agent_status_message(self):
+ """Get the agent status message.
+
+ """
+ return self.data['agent-status']['message']
+
+ @property
+ def workload_status(self):
+ """Returns the current workload status string.
+
+ """
+ return self.data['workload-status']['current']
+
+ @property
+ def workload_status_since(self):
+ """Get the time when the `workload_status` was last updated.
+
+ """
+ since = self.data['workload-status']['since']
+ # Juju gives us nanoseconds, but Python only supports microseconds
+ since = since[:26]
+ return datetime.strptime(since, "%Y-%m-%dT%H:%M:%S.%f")
+
+ @property
+ def workload_status_message(self):
+ """Get the workload status message.
+
+ """
+ return self.data['workload-status']['message']
+
+ def add_storage(self, name, constraints=None):
"""Add unit storage dynamically.
+ :param str name: Storage name, as specified by the charm
+ :param str constraints: Comma-separated list of constraints in the
+ form 'POOL,COUNT,SIZE'
+
"""
pass
"""
pass
- def destroy(self):
+ async def destroy(self):
"""Destroy this unit.
"""
- pass
+ app_facade = client.ApplicationFacade()
+ app_facade.connect(self.connection)
+
+ log.debug(
+ 'Destroying %s', self.name)
+
+ return await app_facade.DestroyUnits([self.name])
remove = destroy
- def get_resources(self):
+ def get_resources(self, details=False):
"""Return resources for this unit.
+ :param bool details: Include detailed info about resources used by each
+ unit
+
"""
pass
- def run(self):
- """Run command on this unit.
+ def resolved(self, retry=False):
+ """Mark unit errors resolved.
+
+ :param bool retry: Re-execute failed hooks
"""
pass
- def run_action(self):
+ async def run(self, command, timeout=None):
+ """Run command on this unit.
+
+ :param str command: The command to run
+ :param int timeout: Time to wait before command is considered failed
+
+ Returns a tuple containing the stdout, stderr, and return code
+ from the command.
+
+ """
+ action = client.ActionFacade()
+ action.connect(self.connection)
+
+ log.debug(
+ 'Running `%s` on %s', command, self.name)
+
+ action_status = asyncio.Queue(loop=self.model.loop)
+ tag = None
+
+ async def wait_for_tag():
+ while tag is None:
+ asyncio.sleep(0.1)
+ return tag
+
+ async def callback(delta, old, new, model):
+ # Wait until we have something to report
+ if not new:
+ return
+
+ # Verify that we have the the right action.
+ tag = await wait_for_tag()
+ if not new.id in tag:
+ return
+
+ # Wait until the action has completed, or errored out.
+ if new.status not in ['completed', 'error']:
+ return
+
+ # Put the action in our queue, so that we can fetch it
+ # with the await below.
+ await action_status.put(new)
+
+ self.model.add_observer(callback, 'action', None)
+
+ res = await action.Run(
+ [],
+ command,
+ [],
+ timeout,
+ [self.name],
+ )
+ tag = res.results[0].action.tag # Set the tag for our waiter above.
+ ret = await action_status.get() # Wait for our callback to fire
+ return (
+ ret.results['Stdout'],
+ ret.results['Stderr'],
+ ret.results['Code']
+ )
+
+ def run_action(self, action_name, **params):
"""Run action on this unit.
+ :param str action_name: Name of action to run
+ :param \*\*params: Action parameters
+
"""
pass
- def scp(self):
+ def scp(
+ self, source_path, user=None, destination_path=None, proxy=False,
+ scp_opts=None):
"""Transfer files to this unit.
+ :param str source_path: Path of file(s) to transfer
+ :param str user: Remote username
+ :param str destination_path: Destination of transferred files on
+ remote machine
+ :param bool proxy: Proxy through the Juju API server
+ :param str scp_opts: Additional options to the `scp` command
+
"""
pass
"""
pass
- def ssh(self):
+ def ssh(
+ self, command, user=None, proxy=False, ssh_opts=None):
"""Execute a command over SSH on this unit.
+ :param str command: Command to execute
+ :param str user: Remote username
+ :param bool proxy: Proxy through the Juju API server
+ :param str ssh_opts: Additional options to the `ssh` command
+
"""
pass
- def status_history(self):
+ def status_history(self, num=20, utc=False):
"""Get status history for this unit.
+ :param int num: Size of history backlog
+ :param bool utc: Display time as UTC in RFC3339 format
+
"""
pass