Fix CI issues

Author: haeter525

quark/cli.py

@@ -23,7 +23,7 @@
     print_warning,
 )
 from quark.utils.weight import Weight
-from quark.utils.tools import find_rizin_instance, get_rizin_version
+from quark.utils.tools import find_rizin_instance, _get_rizin_version
 
 logo()
 
@@ -190,7 +190,7 @@ def entry_point(
                 )
                 return
             else:
-                version = get_rizin_version(rizin_path)
+                version = _get_rizin_version(rizin_path)
                 if rizin_path.startswith(config.HOME_DIR):
                     print_info(
                         f"Use the Rizin executable (version {version})"

quark/core/rzapkinfo.py

@@ -19,7 +19,7 @@
 from quark.core.struct.bytecodeobject import BytecodeObject
 from quark.core.struct.methodobject import MethodObject
 from quark.utils.tools import (descriptor_to_androguard_format,
-                               get_rizin_version, remove_dup_list)
+                               _get_rizin_version, remove_dup_list)
 
 RizinCache = namedtuple("rizin_cache", "address dexindex is_imported")
 
@@ -57,7 +57,7 @@ def __init__(
         super().__init__(apk_filepath, "rizin")
 
         if rizin_path:
-            if not get_rizin_version(rizin_path):
+            if not _get_rizin_version(rizin_path):
                 raise ValueError(
                     f"The file in {rizin_path} is not a valid Rizin"
                     + " executable."

quark/utils/tools.py

@@ -5,7 +5,13 @@
 import copy
 import re
 import shutil
-import subprocess
+from subprocess import (  # nosec
+    STDOUT,
+    CalledProcessError,
+    Popen,
+    PIPE,
+    check_output,
+)
 from ast import Str
 from os import F_OK, PathLike, access, mkdir
 from xmlrpc.client import Boolean
@@ -70,7 +76,7 @@ def descriptor_to_androguard_format(descriptor):
     return new_descriptor
 
 
-def execute_command(command, stderr=subprocess.PIPE, cwd=None):
+def _execute_command(command, stderr=PIPE, cwd=None):
     """
     Execute a given command and yield the messages from the standard output.
 
@@ -81,10 +87,10 @@ def execute_command(command, stderr=subprocess.PIPE, cwd=None):
     non-zero return code
     :yield: a string holding a line of message in the standard output
     """
-    process = subprocess.Popen(
+    process = Popen(  # nosec
         command,
         bufsize=1,
-        stdout=subprocess.PIPE,
+        stdout=PIPE,
         stderr=stderr,
         universal_newlines=True,
         cwd=cwd,
@@ -109,29 +115,26 @@ def execute_command(command, stderr=subprocess.PIPE, cwd=None):
 
     if return_code:
         error_messages = ""
-        if stderr == subprocess.PIPE:
+        if stderr == PIPE:
             for message in process.stderr.readlines():
                 error_messages = error_messages + message
 
-        raise subprocess.CalledProcessError(
-            return_code, command, stderr=error_messages
-        )
+        raise CalledProcessError(return_code, command, stderr=error_messages)
 
-    if stderr == subprocess.PIPE:
+    if stderr == PIPE:
         process.stderr.close()
 
 
-def get_rizin_version(rizin_path) -> Str:
+def _get_rizin_version(rizin_path) -> Str:
     """
     Get the version number of the Rizin instance in the path.
 
     :param rizin_path: a path to the Rizin executable
     :return: the version number of the Rizin instance
     """
     try:
-        result = subprocess.check_output(
-            [rizin_path, "-v"], timeout=5, check=True, stdout=subprocess.PIPE
-        )
+        result = check_output([rizin_path, "-v"], timeout=5)  # nosec
+        result = str(result)
 
         matched_versions = re.finditer(
             r"[0-9]+\.[0-9]+\.[0-9]+", result[: result.index("@")]
@@ -143,7 +146,7 @@ def get_rizin_version(rizin_path) -> Str:
         else:
             return None
 
-    except subprocess.CalledProcessError:
+    except CalledProcessError:
         return None
 
     except OSError:
@@ -166,21 +169,21 @@ def download_rizin(target_path) -> Boolean:
     try:
         print()
 
-        for line in execute_command(
+        for line in _execute_command(
             [
                 "git",
                 "clone",
                 "--progress",
                 "https://github.com/rizinorg/rizin",
                 target_path,
             ],
-            stderr=subprocess.STDOUT,
+            stderr=STDOUT,
         ):
             print_info(line)
 
         return True
 
-    except subprocess.CalledProcessError:
+    except CalledProcessError:
         print_error("An error occurred when downloading Rizin.\n")
 
     except OSError:
@@ -205,48 +208,54 @@ def update_rizin(source_path, target_commit) -> Boolean:
         print()
 
         # Checkout to target commit
-        for line in execute_command(
+        for line in _execute_command(
             ["git", "checkout", target_commit], cwd=source_path
         ):
             print_info(line)
 
         # Remove the last build
-        for line in execute_command(["rm", "-rf", "build"], cwd=source_path):
+        for line in _execute_command(["rm", "-rf", "build"], cwd=source_path):
             print_info(line)
 
         # Clean out old subproject
-        for line in execute_command(
+        for line in _execute_command(
             ["git", "clean", "-dxff", "subprojects/"], cwd=source_path
         ):
             print_info(line)
 
-    except subprocess.CalledProcessError as error:
+    except CalledProcessError as error:
         print_error("An error occurred when updating Rizin.\n")
 
         for line in error.stderr.decode().splitlines():
             print_error(line)
 
         return False
 
+    except OSError as error:
+        print_error("An error occurred when updating Rizin.\n")
+        print_error(error)
+
+        return False
+
     # Compile Rizin
     try:
         print()
 
         # Configure
-        for line in execute_command(
+        for line in _execute_command(
             ["meson", "--buildtype=release", "build"], cwd=source_path
         ):
             print_info(line)
 
         # Compile the source code
-        for line in execute_command(
+        for line in _execute_command(
             ["meson", "compile", "-C", "build"], cwd=source_path
         ):
             print_info(line)
 
         return True
 
-    except subprocess.CalledProcessError as error:
+    except CalledProcessError as error:
         pass
     except OSError:
         pass
@@ -286,13 +295,13 @@ def find_rizin_instance(
     # Search Rizin in PATH
     which_result = shutil.which("rizin")
     if which_result:
-        version = get_rizin_version(which_result)
+        version = _get_rizin_version(which_result)
         if version in COMPATIBLE_RAZIN_VERSIONS:
             return which_result
 
     # Otherwise, search the home path
     rizin_executable_path = rizin_source_path + "build/binrz/rizin/rizin"
-    current_version = get_rizin_version(rizin_executable_path)
+    current_version = _get_rizin_version(rizin_executable_path)
 
     if not current_version and not disable_rizin_installation:
         print_info("Cannot find a compatible Rizin instance.")

tests/test_report.py

@@ -131,8 +131,9 @@ def test_analysis_with_rule_directory(
                 assert mock_run.call_count == num_of_rules
                 assert mock_generate_report.call_count == num_of_rules
 
+    @staticmethod
     def test_analysis_without_specified_rizin_path(
-        self, sample_apk_file, sample_rule_directory
+        sample_apk_file, sample_rule_directory
     ):
         expected_path = shutil.which("rizin")
 
@@ -152,8 +153,9 @@ def test_analysis_without_specified_rizin_path(
                 mock_run.assert_called_once()
                 mock_generate_report.assert_called_once()
 
+    @staticmethod
     def test_analysis_with_specified_rizin_path(
-        self, sample_apk_file, sample_rule_directory
+        sample_apk_file, sample_rule_directory
     ):
         rizin_path = shutil.which("rizin")
 
@@ -179,8 +181,9 @@ def test_analysis_with_specified_rizin_path(
                     mock_run.assert_called_once()
                     mock_generate_report.assert_called_once()
 
+    @staticmethod
     def test_analysis_with_invalid_rizin_path(
-        self, sample_report, sample_apk_file, sample_rule_directory
+        sample_report, sample_apk_file, sample_rule_directory
     ):
         invalid_path = "INVALID_PATH"