SW-527 mr beam tag based updates (#6)

* SW-995 change versioning file for netconnectd plugin (mrbeam#31)
* SW-650 create update script for netconnectd plugin (mrbeam#30)

Author: JFSolution

octoprint_netconnectd/scripts/update_script.py

@@ -16,8 +16,8 @@
 from octoprint.plugins.softwareupdate import exceptions
 from octoprint.settings import _default_basedir
 
-from octoprint_mrbeam.util.pip_util import get_version_of_pip_module, \
-    get_pip_caller  # TODO check how to be independent of mrbeam plugin
+from octoprint_netconnectd.util.pip_util import get_version_of_pip_module, \
+    get_pip_caller
 
 from requests.adapters import HTTPAdapter
 from urllib3 import Retry

octoprint_netconnectd/util/__init__.py

@@ -0,0 +1,78 @@
+"""
+copy pasta of octoprint_mrbeam/util/cmd_exec.py
+only changed the logging to be mrbeam plugin independend
+"""
+import logging
+import subprocess
+from logging import DEBUG
+
+
+def exec_cmd(cmd, log=True, shell=True, loglvl=DEBUG):
+    """
+    Executes a system command
+    :param cmd:
+    :return: True if system returncode was 0,
+                     False if the command returned with an error,
+                     None if there was an exception.
+    """
+    _logger = logging.getLogger(__name__ + ".exec_cmd")
+    code = None
+    if log:
+        _logger.log(loglvl, "cmd=%s", cmd)
+    try:
+        code = subprocess.call(cmd, shell=shell)
+    except Exception as e:
+        _logger.debug(
+            "Failed to execute command '%s', return code: %s, Exception: %s",
+            cmd,
+            code,
+            e,
+        )
+        return None
+    if code != 0 and log:
+        _logger.info("cmd= '%s', return code: '%s'", code)
+    return code == 0
+
+
+def exec_cmd_output(cmd, log=True, shell=False, loglvl=DEBUG):
+    """
+    Executes a system command and returns its output.
+    :param cmd:
+    :return: Tuple(String:output , int return_code)
+    """
+    _logger = logging.getLogger(__name__ + "exec_cmd_output")
+    output = None
+    code = 0
+    if log:
+        _logger.log(loglvl, "cmd='%s'", cmd)
+    try:
+        output = subprocess.check_output(cmd, shell=shell, stderr=subprocess.STDOUT)
+    except subprocess.CalledProcessError as e:
+        code = e.returncode
+
+        if not log:
+            cmd = cmd[:50] + "..." if len(cmd) > 30 else cmd
+            if e.output is not None:
+                output = e.output[:30] + "..." if len(e.output) > 30 else e.output
+        else:
+            output = e.output
+        _logger.log(
+            loglvl,
+            "Failed to execute command '%s', return code: %s, output: '%s'",
+            cmd,
+            e.returncode,
+            output,
+        )
+
+    except Exception as e:
+        code = 99
+        output = "{e}: {o}".format(e=e, o=output)
+        _logger.log(
+            loglvl,
+            "Failed to execute command '%s', return code: %s, output: '%s'",
+            cmd,
+            None,
+            output,
+        )
+
+    return output, code

octoprint_netconnectd/util/cmd_exec.py

@@ -0,0 +1,109 @@
+"""
+copy pasta of octoprint_mrbeam/util/pip_util.py
+only changed the logging to be mrbeam plugin independend
+"""
+import logging
+
+from octoprint.plugins.softwareupdate.updaters.pip import _get_pip_caller
+from octoprint.util.pip import PipCaller
+from cmd_exec import exec_cmd_output
+
+DISABLE_PIP_CHECK = "--disable-pip-version-check"
+DISABLE_PY_WARNING = "--no-python-version-warning"
+
+# Dictionary of package versions available at different locations
+# {
+# /home/pi/oprint/bin/pip : {
+#   "OctoPrint    x.x.x",
+#   ...
+#   },
+# /usr/share/iobeam/venv/bin/pip : {
+#   "iobeam y.y.y",
+#   ...
+#   }
+# }
+_pip_package_version_lists = {}
+
+
+def get_version_of_pip_module(pip_name, pip_command=None, disable_pip_ver_check=True):
+    _logger = logging.getLogger(__name__ + ".get_version_of_pip_module")
+    global _pip_package_version_lists
+    version = None
+    returncode = -1
+    if pip_command is None:
+        pip_command = "pip"
+    elif isinstance(pip_command, list):
+        pip_command = " ".join(pip_command)
+    # Checking for pip version outdate takes extra time and text output.
+    # NOTE: Older versions of pip do not have the --no-python-version-warning flag
+    for disabled in [
+        DISABLE_PIP_CHECK,
+    ]:  # DISABLE_PY_WARNING]:
+        if disable_pip_ver_check and not disabled in pip_command:
+            pip_command += " " + disabled
+    venv_packages = _pip_package_version_lists.get(pip_command, None)
+
+    if venv_packages is None:
+        # perform a pip discovery and remember it for next time
+        command = "{pip_command} list".format(pip_command=pip_command)
+        _logger.debug("refreshing list of installed packages (%s list)", pip_command)
+        output, returncode = exec_cmd_output(command, shell=True, log=False)
+        if returncode == 0:
+            venv_packages = output.splitlines()
+            _pip_package_version_lists[pip_command] = venv_packages
+        elif returncode == 127:
+            _logger.error(
+                "`%s` was not found in local $PATH (returncode %s)",
+                pip_command,
+                returncode,
+            )
+            return None
+        else:
+            _logger.warning("`%s list` returned code %s", pip_command, returncode)
+            return None
+    # Go through the package list available in our venv
+    for line in venv_packages:
+        token = line.split()
+        if len(token) >= 2 and token[0] == pip_name:
+            version = token[1]
+            break
+    _logger.debug("%s==%s", pip_name, version)
+    return version
+
+
+def get_pip_caller(venv, _logger=None):
+    """
+    gets the pip caller of the givenv venv
+
+    Args:
+        venv: path to venv
+        _logger: logger to log call, stdout and stderr of the pip caller
+
+    Returns:
+        PipCaller of the venv
+    """
+    pip_caller = _get_pip_caller(command=venv)
+    if not isinstance(pip_caller, PipCaller):
+        raise RuntimeError("Can't run pip", None)
+
+    def _log_call(*lines):
+        _log(lines, prefix=" ", stream="call")
+
+    def _log_stdout(*lines):
+        _log(lines, prefix=">", stream="stdout")
+
+    def _log_stderr(*lines):
+        _log(lines, prefix="!", stream="stderr")
+
+    def _log(lines, prefix=None, stream=None, strip=True):
+        if strip:
+            lines = map(lambda x: x.strip(), lines)
+        for line in lines:
+            print(u"{} {}".format(prefix, line))
+
+    if _logger is not None:
+        pip_caller.on_log_call = _log_call
+        pip_caller.on_log_stdout = _log_stdout
+        pip_caller.on_log_stderr = _log_stderr
+
+    return pip_caller