Updates misc package updates scanner to use BaseScanner and its utilities

Author: navidshaikh

ccp/scanning/misc_package_updates.py

@@ -2,119 +2,113 @@
 
 # this scan file has utilities to find pip, npm, gem package updates
 
-import scan_lib
 
 import sys
 
-
-def binary_does_not_exist(response):
-    """
-    Used to figure if the npm, pip, gem binary exists in the container image
-    """
-    if 'executable file not found in' in response or \
-            'not found' in response or \
-            'No such file or directory' in response:
-        return True
-    return False
+from scanners.base_scanner import BaseScanner, BinaryDoesNotExist
 
 
-def find_pip_updates(executable="/usr/bin/pip"):
+class MiscPackageUpdates(BaseScanner):
     """
-    Finds out outdated installed packages of pip
+    Misc package updates scanner
     """
-    command = [executable, "list", "--outdated", "--disable-pip-version-check"]
-    out, err = [], ""
-
-    try:
-        out, err = scan_lib.run_cmd_out_err(command)
-    except Exception as e:
-        err = e
-
-    if err:
-        if binary_does_not_exist(err):
-            return "{0} is not installed".format(executable)
-        else:
+    NAME = "Misc-package-updates"
+    DESCRIPTION = "Find updates available for pip, npm, and gem."
+
+    def __init__(self, image):
+        super(MiscPackageUpdates, self).__init__()
+
+    def find_pip_updates(self, binary="pip"):
+        """
+        Finds out outdated installed packages of pip
+        """
+        # figure out the absolute path of binary in target system
+        binary = self.which(binary)
+        command = [binary, "list", "--outdated", "--disable-pip-version-check"]
+        out, err = [], ""
+
+        try:
+            out, err = self.run_cmd_out_err(command)
+        except Exception as e:
+            err = e
+
+        if err:
             return "Failed to find the pip updates."
-    else:
-        if out.strip():
-            return out.strip().split("\n")
-        else:
-            return []
-
-
-def find_npm_updates(executable="/usr/bin/npm"):
-    """
-    Finds out outdated installed packages of npm
-    """
-    command = [executable, "-g", "outdated"]
-    out, err = [], ""
-
-    try:
-        out, err = scan_lib.run_cmd_out_err(command)
-    except Exception as e:
-        err = e
-
-    if err:
-        if binary_does_not_exist(err):
-            return "{0} is not installed".format(executable)
         else:
+            if out.strip():
+                return out.strip().split("\n")
+            else:
+                return []
+
+    def find_npm_updates(self, binary="npm"):
+        """
+        Finds out outdated installed packages of npm
+        """
+        # figure out the absolute path of binary in target system
+        binary = self.which(binary)
+        command = [binary, "-g", "outdated"]
+        out, err = [], ""
+
+        try:
+            out, err = self.run_cmd_out_err(command)
+        except Exception as e:
+            err = e
+
+        if err:
             return "Failed to find the npm updates."
-    else:
-        if out.strip():
-            return out.strip().split("\n")
-        else:
-            return []
-
-
-def find_gem_updates(executable="/usr/bin/gem"):
-    """
-    Finds out outdated installed packages of gem
-    """
-    command = [executable, "outdated"]
-    out, err = [], ""
-
-    try:
-        out, err = scan_lib.run_cmd_out_err(command)
-    except Exception as e:
-        err = e
-
-    if err:
-        if binary_does_not_exist(err):
-            return "{0} is not installed".format(executable)
         else:
+            if out.strip():
+                return out.strip().split("\n")
+            else:
+                return []
+
+    def find_gem_updates(self, binary="gem"):
+        """
+        Finds out outdated installed packages of gem
+        """
+        # figure out the absolute path of binary in target system
+        binary = self.which(binary)
+        command = [binary, "outdated"]
+        out, err = [], ""
+
+        try:
+            out, err = self.run_cmd_out_err(command)
+        except Exception as e:
+            err = e
+
+        if err:
             return "Failed to find the gem updates."
-    else:
-        if out.strip():
-            return out.strip().split("\n")
         else:
-            return []
-
-
-def print_updates(binary):
-    """
-    Prints the updates found using given binary
-    """
-    print ("\n{0} updates scan:".format(binary))
-
-    if binary == "npm":
-        result = find_npm_updates()
-    elif binary == "gem":
-        result = find_gem_updates()
-    elif binary == "pip":
-        result = find_pip_updates()
-    else:
-        return
-
-    if result:
-        # prints errors
-        if isinstance(result, str):
-            print (result)
+            if out.strip():
+                return out.strip().split("\n")
+            else:
+                return []
+
+    def print_updates(self, binary):
+        """
+        Prints the updates found using given binary
+        """
+        print ("\n{0} updates scan:".format(binary))
+
+        if binary == "npm":
+            result = self.find_npm_updates()
+        elif binary == "gem":
+            result = self.find_gem_updates()
+        elif binary == "pip":
+            result = self.find_pip_updates()
+        else:
             return
-        # prints result
-        for line in result:
-            print (line)
-    else:
-        print ("No updates required.")
+
+        if result:
+            # prints errors
+            if isinstance(result, str):
+                print (result)
+                return
+            # prints result
+            for line in result:
+                print (line)
+        else:
+            print ("No updates required.")
 
 
 if __name__ == "__main__":
@@ -133,12 +127,17 @@ def print_updates(binary):
         sys.exit(1)
 
     try:
+        misc_pkg_updates = MiscPackageUpdates('')
         if cli_arg == "all":
-            print_updates("pip")
-            print_updates("npm")
-            print_updates("gem")
+            misc_pkg_updates.print_updates("pip")
+            misc_pkg_updates.print_updates("npm")
+            misc_pkg_updates.print_updates("gem")
         else:
-            print_updates(cli_arg)
+            misc_pkg_updates.print_updates(cli_arg)
+    except BinaryDoesNotExist as e:
+        print (e)
+        print ("Scan is aborted!")
+        sys.exit(1)
     except Exception as e:
         print ("Error occurred in Misc Package Updates scanner execution.")
         print ("Error: {0}".format(e))