-class Unit(object):
+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']
+
+ @property
+ def tag(self):
+ return 'unit-%s' % self.name.replace('/', '-')
+
def add_storage(self, name, constraints=None):
"""Add unit storage dynamically.
"""
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, details=False):
"""
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):
- """Run action on this unit.
+ async def run(self, command, timeout=None):
+ """Run command on this unit.
- """
- pass
+ :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.
- def scp(self):
+ """
+ action = client.ActionFacade()
+ action.connect(self.connection)
+
+ log.debug(
+ 'Running `%s` on %s', command, self.name)
+
+ res = await action.Run(
+ [],
+ command,
+ [],
+ timeout,
+ [self.name],
+ )
+ return await self.model.wait_for_action(res.results[0].action.tag)
+
+ async def run_action(self, action_name, **params):
+ """Run an action on this unit.
+
+ :param str action_name: Name of action to run
+ :param \*\*params: Action parameters
+ :returns: An `juju.action.Action` instance.
+
+ Note that this only enqueues the action. You will need to call
+ ``action.wait()`` on the resulting `Action` instance if you wish
+ to block until the action is complete.
+ """
+ action_facade = client.ActionFacade()
+ action_facade.connect(self.connection)
+
+ log.debug('Starting action `%s` on %s', action_name, self.name)
+
+ res = await action_facade.Enqueue([client.Action(
+ name=action_name,
+ parameters=params,
+ receiver=self.tag,
+ )])
+ action = res.results[0].action
+ error = res.results[0].error
+ if error and error.code == 'not found':
+ raise ValueError('Action `%s` not found on %s' % (action_name,
+ self.name))
+ elif error:
+ raise Exception('Unknown action error: %s' % error.serialize())
+ action_id = action.tag[len('action-'):]
+ log.debug('Action started as %s', action_id)
+ # we can't use wait_for_new here because we don't
+ # consistently (ever?) get an "add" delta for the action
+ return await self.model._wait('action', action_id, None)
+
+ 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
+
+ async def is_leader_from_status(self):
+ """
+ Check to see if this unit is the leader. Returns True if so, and
+ False if it is not, or if leadership does not make sense
+ (e.g., there is no leader in this application.)
+
+ This method is a kluge that calls FullStatus in the
+ ClientFacade to get its information. Once
+ https://bugs.launchpad.net/juju/+bug/1643691 is resolved, we
+ should add a simple .is_leader property, and deprecate this
+ method.
+
+ """
+ app = self.name.split("/")[0]
+
+ c = client.ClientFacade()
+ c.connect(self.model.connection)
+
+ status = await c.FullStatus(None)
+
+ return status.applications[app]['units'][self.name].get(
+ 'leader', False)
projects / osm / N2VC.git / blobdiff