analyser: Separate entrypoint for standalone analysis

Signed-off-by: Arthur Chan <[email protected]>

Author: arthurscchan

src/fuzz_introspector/analyses/far_reach_low_coverage_analyser.py

@@ -95,6 +95,15 @@ def analysis_func(self,
                       basefolder: str, coverage_url: str,
                       conclusions: List[html_helpers.HTMLConclusion],
                       out_dir: str) -> str:
+        self.standalone_analysis(proj_profile, profiles, out_dir)
+        return ''
+
+    def standalone_analysis(self,
+                            proj_profile: project_profile.MergedProjectProfile,
+                            profiles: List[fuzzer_profile.FuzzerProfile],
+                            out_dir: str) -> None:
+        super().standalone_analysis(proj_profile, profiles, out_dir)
+
         logger.info(' - Running analysis %s', self.get_name())
         logger.info(
             ' - Settings: exclude_static_functions: %s, '
@@ -159,8 +168,6 @@ def analysis_func(self,
         with open(result_json_path, 'w') as f:
             json.dump(self.json_results, f)
 
-        return ''
-
     def _get_cross_reference_dict(
             self, functions: List[function_profile.FunctionProfile]
     ) -> Dict[str, int]:

src/fuzz_introspector/analyses/public_candidate_analyser.py

@@ -75,6 +75,15 @@ def analysis_func(self,
                       basefolder: str, coverage_url: str,
                       conclusions: List[html_helpers.HTMLConclusion],
                       out_dir: str) -> str:
+        self.standalone_analysis(proj_profile, profiles, out_dir)
+        return ''
+
+    def standalone_analysis(self,
+                            proj_profile: project_profile.MergedProjectProfile,
+                            profiles: List[fuzzer_profile.FuzzerProfile],
+                            out_dir: str) -> None:
+        super().standalone_analysis(proj_profile, profiles, out_dir)
+
         logger.info(' - Running analysis %s', self.get_name())
 
         # Get all functions from the profiles
@@ -99,8 +108,6 @@ def analysis_func(self,
         with open(result_json_path, 'w') as f:
             json.dump(result_list, f)
 
-        return ''
-
     def _filter_functions(
         self, functions: list[function_profile.FunctionProfile]
     ) -> list[function_profile.FunctionProfile]:

src/fuzz_introspector/analysis.py

@@ -217,6 +217,23 @@ def analysis_func(self,
                    html report.
         """
 
+    def standalone_analysis(self,
+                            proj_profile: project_profile.MergedProjectProfile,
+                            profiles: List[fuzzer_profile.FuzzerProfile],
+                            out_dir: str) -> None:
+        """Second entrypoint for analysis instance which are meant to run
+        alone without html or json report generation.
+        :param proj_profile: project profile involved in the analysis.
+        :type proj_profile: project_profile.MergedProjectProfile
+
+        :param profiles: all fuzzer profiles involved in the current analysis.
+        :type profiles: List[fuzzer_profile.FuzzerProfile]
+
+        :param out_dir: Output directory of analysis report.
+        :type out_dir: str
+        """
+        self.set_display_html(False)
+
     @classmethod
     @abc.abstractmethod
     def get_name(cls):

src/fuzz_introspector/commands.py

@@ -23,7 +23,6 @@
 from fuzz_introspector import analysis
 from fuzz_introspector import constants
 from fuzz_introspector import diff_report
-from fuzz_introspector import html_helpers
 from fuzz_introspector import html_report
 from fuzz_introspector import utils
 
@@ -263,9 +262,7 @@ def analyse(args) -> int:
         target_analyser.set_introspection_project(introspection_proj)
 
     # Run the analyser
-    target_analyser.analysis_func(html_helpers.HtmlTableOfContents(), [],
-                                  introspection_proj.proj_profile,
-                                  introspection_proj.profiles, '', '', [],
-                                  out_dir)
+    target_analyser.standalone_analysis(introspection_proj.proj_profile,
+                                        introspection_proj.profiles, out_dir)
 
     return constants.APP_EXIT_SUCCESS