Merge pull request #832 from cambid/solaar-module

new module solaar.py for logitech's unifying devices

bumblebee_status/modules/contrib/solaar.py

@@ -0,0 +1,58 @@
+"""Shows status and load percentage of logitech's unifying device
+
+Requires the following executable:
+    * solaar (from community)
+
+contributed by `cambid <https://github.com/cambid>`_ - many thanks!
+"""
+
+import logging
+
+import core.module
+import core.widget
+import core.decorators
+
+import util.cli
+
+
+class Module(core.module.Module):
+    @core.decorators.every(seconds=30)
+    def __init__(self, config, theme):
+        super().__init__(config, theme, core.widget.Widget(self.utilization))
+        self.__battery = self.parameter("device", "")
+        self.background = True
+        self.__battery_status = ""
+        self.__error = False
+        if self.__battery != "":
+            self.__cmd = f"solaar show '{self.__battery}'"
+        else:
+            self.__cmd = "solaar show"
+
+    @property
+    def __format(self):
+        return self.parameter("format", "{}")
+
+    def utilization(self, widget):
+        return self.__format.format(self.__battery_status)
+
+    def update(self):
+        self.__error = False
+        code, result = util.cli.execute(
+            self.__cmd, ignore_errors=True, return_exitcode=True
+        )
+
+        if code == 0:
+            for line in result.split('\n'):
+                if line.count('Battery') > 0:
+                    self.__battery_status = line.split(':')[1].strip()
+        else:
+            self.__error = True
+            logging.error(f"solaar exited with {code}: {result}")
+
+    def state(self, widget):
+        if self.__error:
+            return "warning"
+        return "okay"
+
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4

tests/modules/contrib/test_solaar.py

@@ -0,0 +1,32 @@
+import pytest
+
+import util.cli
+import core.config
+import modules.contrib.solaar
+
+
+@pytest.fixture
+def module():
+    module = modules.contrib.solaar.Module(
+        config=core.config.Config([]),
+        theme=None
+    )
+
+    yield module
+
+
+def test_load_module():
+    __import__("modules.contrib.solaar")
+
+
+def test_with_unknown_code(module, mocker):
+    mocker.patch('util.cli.execute', return_value=(99, 'error'))
+    logger = mocker.patch('logging.error')
+
+    module.update()
+
+    logger.assert_called_with('solaar exited with {}: {}'.format(99, 'error'))
+
+    widget = module.widget()
+    assert module.state(widget) == 'warning'
+    assert module.hidden() == False