Update README to point to RTD for docs instead of PythonHosted.org
[osm/N2VC.git] / juju / unit.py
index ab9d1d0..fc597bf 100644 (file)
@@ -51,6 +51,24 @@ class Unit(model.ModelEntity):
         """
         return self.safe_data['workload-status']['message']
 
+    @property
+    def machine(self):
+        """Get the machine object for this unit.
+
+        """
+        machine_id = self.safe_data['machine-id']
+        if machine_id:
+            return self.model.machines.get(machine_id, None)
+        else:
+            return None
+
+    @property
+    def public_address(self):
+        """ Get the public address.
+
+        """
+        return self.safe_data['public-address'] or None
+
     @property
     def tag(self):
         return 'unit-%s' % self.name.replace('/', '-')
@@ -63,20 +81,19 @@ class Unit(model.ModelEntity):
             form 'POOL,COUNT,SIZE'
 
         """
-        pass
+        raise NotImplementedError()
 
     def collect_metrics(self):
         """Collect metrics on this unit.
 
         """
-        pass
+        raise NotImplementedError()
 
     async def destroy(self):
         """Destroy this unit.
 
         """
-        app_facade = client.ApplicationFacade()
-        app_facade.connect(self.connection)
+        app_facade = client.ApplicationFacade.from_connection(self.connection)
 
         log.debug(
             'Destroying %s', self.name)
@@ -91,7 +108,7 @@ class Unit(model.ModelEntity):
             unit
 
         """
-        pass
+        raise NotImplementedError()
 
     def resolved(self, retry=False):
         """Mark unit errors resolved.
@@ -99,20 +116,17 @@ class Unit(model.ModelEntity):
         :param bool retry: Re-execute failed hooks
 
         """
-        pass
+        raise NotImplementedError()
 
     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.
+        :returns: A :class:`juju.action.Action` instance.
 
         """
-        action = client.ActionFacade()
-        action.connect(self.connection)
+        action = client.ActionFacade.from_connection(self.connection)
 
         log.debug(
             'Running `%s` on %s', command, self.name)
@@ -131,14 +145,14 @@ class Unit(model.ModelEntity):
 
         :param str action_name: Name of action to run
         :param \*\*params: Action parameters
-        :returns: A`juju.action.Action` instance.
+        :returns: A :class:`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)
+        action_facade = client.ActionFacade.from_connection(self.connection)
 
         log.debug('Starting action `%s` on %s', action_name, self.name)
 
@@ -160,26 +174,37 @@ class Unit(model.ModelEntity):
         # action is complete, rather than just being in the model
         return await self.model._wait_for_new('action', action_id)
 
-    def scp(
-            self, source_path, user=None, destination_path=None, proxy=False,
-            scp_opts=None):
+    async def scp_to(self, source, destination, user='ubuntu', proxy=False,
+                     scp_opts=''):
         """Transfer files to this unit.
 
-        :param str source_path: Path of file(s) to transfer
+        :param str source: Local path of file(s) to transfer
+        :param str destination: Remote destination of transferred files
         :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
+        """
+        await self.machine.scp_to(source, destination, user=user, proxy=proxy,
+                                  scp_opts=scp_opts)
+
+    async def scp_from(self, source, destination, user='ubuntu', proxy=False,
+                       scp_opts=''):
+        """Transfer files from this unit.
 
+        :param str source: Remote path of file(s) to transfer
+        :param str destination: Local destination of transferred files
+        :param str user: Remote username
+        :param bool proxy: Proxy through the Juju API server
+        :param str scp_opts: Additional options to the `scp` command
         """
-        pass
+        await self.machine.scp_from(source, destination, user=user,
+                                    proxy=proxy, scp_opts=scp_opts)
 
     def set_meter_status(self):
         """Set the meter status on this unit.
 
         """
-        pass
+        raise NotImplementedError()
 
     def ssh(
             self, command, user=None, proxy=False, ssh_opts=None):
@@ -191,7 +216,7 @@ class Unit(model.ModelEntity):
         :param str ssh_opts: Additional options to the `ssh` command
 
         """
-        pass
+        raise NotImplementedError()
 
     def status_history(self, num=20, utc=False):
         """Get status history for this unit.
@@ -200,7 +225,7 @@ class Unit(model.ModelEntity):
         :param bool utc: Display time as UTC in RFC3339 format
 
         """
-        pass
+        raise NotImplementedError()
 
     async def is_leader_from_status(self):
         """
@@ -217,8 +242,7 @@ class Unit(model.ModelEntity):
         """
         app = self.name.split("/")[0]
 
-        c = client.ClientFacade()
-        c.connect(self.model.connection)
+        c = client.ClientFacade.from_connection(self.connection)
 
         status = await c.FullStatus(None)
 
@@ -241,5 +265,10 @@ class Unit(model.ModelEntity):
                                                                 False)
 
     async def get_metrics(self):
+        """Get metrics for the unit.
+
+        :return: Dictionary of metrics for this unit.
+
+        """
         metrics = await self.model.get_metrics(self.tag)
         return metrics[self.name]