Added support for new commands.

Refactored some old ones too.

Author: rshipp

nut2.py

@@ -157,6 +157,17 @@ def list_ups(self):
 
         return ups_dict
 
+    def description(self, ups):
+        """Returns the description for a given UPS."""
+        logging.debug("description called...")
+
+        self._srv_handler.write("GET UPSDESC %s\n" % ups)
+        result = self._srv_handler.read_until("\n", self._timeout)
+        try:
+            return result.split('"')[1].strip()
+        except IndexError:
+            raise PyNUTError(result.replace("\n", ""))
+
     def list_vars(self, ups=""):
         """Get all available vars from the specified UPS.
 
@@ -275,7 +286,7 @@ def list_rw_vars(self, ups=""):
 
         return rw_vars
 
-    def set_var(self, ups="", var="", value=""):
+    def set_var(self, ups, var, value):
         """Set a variable to the specified value on selected UPS.
 
         The variable must be a writable value (cf list_rw_vars) and you
@@ -288,7 +299,48 @@ def set_var(self, ups="", var="", value=""):
         if result != "OK\n":
             raise PyNUTError(result.replace("\n", ""))
 
-    def run_command(self, ups="", command=""):
+    def get_var(self, ups, var):
+        """Get the value of a variable."""
+        logging.debug("get_var called...")
+
+        self._srv_handler.write("GET VAR %s %s\n" % (ups, var))
+        result = self._srv_handler.read_until("\n", self._timeout)
+        try:
+            # result = 'VAR %s %s "%s"' % (ups, var, value)
+            return result.split('"')[1].strip()
+        except IndexError:
+            raise PyNUTError(result.replace("\n", ""))
+
+    # Alias for convenience
+    def get(self, ups, var):
+        """Get the value of a variable (alias for get_var)."""
+        return self.get_var(ups, var)
+
+    def var_description(self, ups, var):
+        """Get a variable's description."""
+        logging.debug("var_description called...")
+
+        self._srv_handler.write("GET DESC %s %s\n" % (ups, var))
+        result = self._srv_handler.read_until("\n", self._timeout)
+        try:
+            # result = 'DESC %s %s "%s"' % (ups, var, description)
+            return result.split('"')[1].strip()
+        except IndexError:
+            raise PyNUTError(result.replace("\n", ""))
+
+    def command_description(self, ups, command):
+        """Get a command's description."""
+        logging.debug("command_description called...")
+
+        self._srv_handler.write("GET CMDDESC %s %s\n" % (ups, command))
+        result = self._srv_handler.read_until("\n", self._timeout)
+        try:
+            # result = 'CMDDESC %s %s "%s"' % (ups, command, description)
+            return result.split('"')[1].strip()
+        except IndexError:
+            raise PyNUTError(result.replace("\n", ""))
+
+    def run_command(self, ups, command):
         """Send a command to the specified UPS."""
         logging.debug("run_command called...")
 
@@ -312,6 +364,20 @@ def fsd(self, ups=""):
         if result != "OK FSD-SET\n":
             raise PyNUTError(result.replace("\n", ""))
 
+    def num_logins(self, ups=""):
+        """Send GET NUMLOGINS command to get the number of users logged
+        into a given UPS.
+        """
+        logging.debug("num_logins called on '%s'...", ups)
+
+        self._srv_handler.write("GET NUMLOGINS %s\n" % ups)
+        result = self._srv_handler.read_until("\n", self._timeout)
+        try:
+            # result = "NUMLOGINS %s %s\n" % (ups, int(numlogins))
+            return int(result.split(' ')[2].strip())
+        except (ValueError, IndexError):
+            raise PyNUTError(result.replace("\n", ""))
+
     def help(self):
         """Send HELP command."""
         logging.debug("HELP called...")

tests/mockserver.py

@@ -29,7 +29,7 @@ def run_command(self):
         elif self.command == "VER\n":
             return 'Network UPS Tools upsd 2.7.1 - http://www.networkupstools.org/\n'
         elif self.command == "GET CMDDESC %s %s\n" % (self.valid, self.valid):
-            return 'CMDDESC '+self.valid+' '+self.valid+' "Test description"\n'
+            return 'CMDDESC '+self.valid+' '+self.valid+' '+self.valid_desc+'\n'
         elif self.command == "LIST UPS\n" and self.first:
             self.first = False
             return 'BEGIN LIST UPS\n'

tests/testclient.py

@@ -21,7 +21,9 @@ def setUp(self):
         self.valid = "test"
         self.invalid = "does_not_exist"
         self.valid_ups_name = "Test UPS 1"
-        self.valid_command_desc = "Test description"
+        self.valid_desc = self.valid_ups_name
+        self.valid_value = '100'
+        self.valid_command_desc = self.valid_desc
         telnetlib.Telnet = Mock()
 
     def test_init_with_args(self):
@@ -182,3 +184,46 @@ def test_list_clients_none(self):
     def test_list_clients_broken(self):
         self.assertRaises(PyNUTError, self.broken_client.list_clients,
                 self.valid)
+
+    def test_num_logins(self):
+        self.assertEquals(self.client.num_logins(self.valid), 1)
+
+    def test_num_logins_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.num_logins,
+                self.valid)
+
+    def test_description(self):
+        self.assertEquals(self.client.description(self.valid),
+                self.valid_desc)
+
+    def test_description_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.description,
+                self.valid)
+
+    def test_get(self):
+        self.assertEquals(self.client.get(self.valid, self.valid),
+                self.valid_value)
+
+    def test_get_var_alias_for_get(self):
+        self.assertEquals(self.client.get(self.valid, self.valid),
+                self.client.get_var(self.valid, self.valid))
+
+    def test_get_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.get,
+                self.valid, self.valid)
+
+    def test_var_description(self):
+        self.assertEquals(self.client.var_description(self.valid,
+                    self.valid), self.valid_desc)
+
+    def test_var_description_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.var_description,
+                self.valid, self.valid)
+
+    def test_command_description(self):
+        self.assertEquals(self.client.command_description(self.valid,
+                    self.valid), self.valid_desc)
+
+    def test_command_description_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.command_description,
+                self.valid, self.valid)