Update public API to use this feature

Author: haeter525

quark/report.py

@@ -6,27 +6,54 @@
 
 from quark.core.quark import Quark
 from quark.core.struct.ruleobject import RuleObject
+from quark.utils.tools import find_rizin_instance
 
 
 class Report:
     """
     This module is for users who want to use quark as a Python module.
     """
 
-    def __init__(self):
-        self.quark = None
+    def __init__(self, rizin_path=None, disable_rizin_installation=False):
+        """
+        Create a Report object.
 
-    def analysis(self, apk, rule, core_library="androguard"):
+        :param rizin_path: a PathLike object to specify a Rizin executable for
+        the Rizin-based analysis library. Defaults to None
+        :param disable_rizin_installation: a flag to disable the automatic
+        installation of Rizin. Defaults to False. Defaults to False
         """
-        The main function of Quark-Engine analysis, the analysis is based on the provided APK file.
+        self.quark = None
+        self.rizin_path = rizin_path
+        self.disable_rizin_installation = disable_rizin_installation
 
-        :param core_library: the library to analysis binary
-        :param apk: the APK file
-        :param rule: the rule to be checked, it could be a directory or a single json rule
+    def analysis(self, apk, rule, core_library="androguard", rizin_path=None):
+        """
+        The main function of Quark-Engine analysis, the analysis is based on
+        the provided APK file.
+
+        :param apk: an APK for Quark to analyze
+        :param rule: a Quark rule that will be used in the analysis. It could
+        be a directory or a Quark rule
+        :param core_library: a string indicating which analysis library Quark
+        should use. Defaults to "androguard"
+        :param rizin_path: a PathLike object to specify a Rizin executable for
+        the Rizin-based analysis library. Defaults to None
         :return: None
         """
 
-        self.quark = Quark(apk, core_library)
+        if core_library.lower() == "rizin":
+            if rizin_path:
+                self.rizin_path = rizin_path
+            elif not self.rizin_path:
+                self.rizin_path = find_rizin_instance(
+                    disable_rizin_installation=self.disable_rizin_installation
+                )
+
+                if not self.rizin_path:
+                    raise ValueError("Cannot found a valid Rizin executable.")
+
+        self.quark = Quark(apk, core_library, self.rizin_path)
 
         if os.path.isdir(rule):
 

tests/test_report.py

@@ -1,11 +1,11 @@
 import os
 import os.path
+import shutil
 import zipfile
 from unittest.mock import patch
 
 import pytest
 import requests
-
 from quark.report import Report
 
 
@@ -19,7 +19,8 @@ def invalid_file(tempfile):
 @pytest.fixture(scope="module")
 def sample_apk_file():
     APK_SOURCE = (
-        "https://github.com/quark-engine/" "apk-malware-samples/raw/master/Ahmyth.apk"
+        "https://github.com/quark-engine/"
+        "apk-malware-samples/raw/master/Ahmyth.apk"
     )
     APK_NAME = "Ahmyth.apk"
 
@@ -130,6 +131,67 @@ def test_analysis_with_rule_directory(
                 assert mock_run.call_count == num_of_rules
                 assert mock_generate_report.call_count == num_of_rules
 
+    def test_analysis_without_specified_rizin_path(
+        self, sample_apk_file, sample_rule_directory
+    ):
+        expected_path = shutil.which("rizin")
+
+        with patch("quark.core.quark.Quark.run") as mock_run:
+            with patch(
+                "quark.core.quark.Quark.generate_json_report"
+            ) as mock_generate_report:
+                sample_report = Report()
+                sample_report.analysis(
+                    sample_apk_file,
+                    sample_rule_directory,
+                    core_library="rizin",
+                )
+
+                assert sample_report.rizin_path == expected_path
+
+                mock_run.assert_called_once()
+                mock_generate_report.assert_called_once()
+
+    def test_analysis_with_specified_rizin_path(
+        self, sample_apk_file, sample_rule_directory
+    ):
+        rizin_path = shutil.which("rizin")
+
+        with patch("quark.core.quark.Quark.run") as mock_run:
+            with patch(
+                "quark.core.quark.Quark.generate_json_report"
+            ) as mock_generate_report:
+                with patch(
+                    "quark.utils.tools.find_rizin_instance"
+                ) as mock_find_rizin:
+
+                    sample_report = Report()
+                    sample_report.analysis(
+                        sample_apk_file,
+                        sample_rule_directory,
+                        core_library="rizin",
+                        rizin_path=rizin_path,
+                    )
+
+                    assert sample_report.rizin_path == rizin_path
+
+                    mock_find_rizin.assert_not_called()
+                    mock_run.assert_called_once()
+                    mock_generate_report.assert_called_once()
+
+    def test_analysis_with_invalid_rizin_path(
+        self, sample_report, sample_apk_file, sample_rule_directory
+    ):
+        invalid_path = "INVALID_PATH"
+
+        with pytest.raises(ValueError):
+            sample_report.analysis(
+                sample_apk_file,
+                sample_rule_directory,
+                core_library="rizin",
+                rizin_path=invalid_path,
+            )
+
     def test_get_report_with_invalid_type(self, sample_report):
         with pytest.raises(ValueError):
             sample_report.get_report(None)