webapp: Add API for macro block query (#2171)

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

Author: arthurscchan

tools/web-fuzzing-introspection/app/static/assets/db/oss_fuzz.py

@@ -51,6 +51,10 @@ def get_introspector_report_url_typedef(project_name, datestr):
     return get_introspector_report_url_base(project_name,
                                             datestr) + "full_type_defs.json"
 
+def get_introspector_report_url_macro_block(project_name, datestr):
+    return get_introspector_report_url_base(project_name,
+                                            datestr) + "macro_block_info.json"
+
 
 def get_fuzzer_stats_fuzz_count_url(project_name, date_str):
     base_url = 'https://storage.googleapis.com/oss-fuzz-coverage/{0}/fuzzer_stats/{1}/coverage_targets.txt'
@@ -249,6 +253,17 @@ def extract_local_introspector_typedef(project_name, oss_fuzz_folder):
     return json_list
 
 
+def extract_local_introspector_macro_block(project_name, oss_fuzz_folder):
+    summary_json = os.path.join(oss_fuzz_folder, 'build', 'out', project_name,
+                                'inspector', 'macro_block_info.json')
+    if not os.path.isfile(summary_json):
+        return {}
+
+    with open(summary_json, 'r') as f:
+        json_list = json.load(f)
+    return json_list
+
+
 def get_local_code_coverage_summary(project_name, oss_fuzz_folder):
     summary_json = os.path.join(oss_fuzz_folder, 'build', 'out', project_name,
                                 'report', 'linux', 'summary.json')
@@ -400,6 +415,22 @@ def extract_introspector_typedef(project_name, date_str):
     return typedef_list
 
 
+def extract_introspector_macro_block(project_name, date_str):
+    introspector_test_url = get_introspector_report_url_macro_block(
+        project_name, date_str.replace("-", ""))
+
+    # Read the introspector atifact
+    try:
+        raw_introspector_json_request = requests.get(introspector_test_url,
+                                                     timeout=10)
+    except:
+        return []
+    try:
+        return json.loads(raw_introspector_json_request.text)
+    except:
+        return []
+
+
 def extract_introspector_report(project_name, date_str):
     introspector_summary_url = get_introspector_report_url_summary(
         project_name, date_str.replace("-", ""))

tools/web-fuzzing-introspection/app/static/assets/db/web_db_creator_from_summary.py

@@ -453,6 +453,10 @@ def extract_local_project_data(project_name, oss_fuzz_path,
     typedef_list = oss_fuzz.extract_local_introspector_typedef(
         project_name, oss_fuzz_path)
 
+    # Extract macro block information
+    macro_block = oss_fuzz.extract_local_introspector_macro_block(
+        project_name, oss_fuzz_path)
+
     introspector_data_dict = {
         "introspector_report_url":
         'introspector_url',
@@ -475,7 +479,9 @@ def extract_local_project_data(project_name, oss_fuzz_path,
         'project_name':
         project_name,
         'typedef_list':
-        typedef_list
+        typedef_list,
+        'macro_block':
+        macro_block
     }
 
     code_coverage_data_dict = prepare_code_coverage_dict(
@@ -731,6 +737,10 @@ def extract_project_data(project_name, date_str, should_include_details,
         typedef_list = oss_fuzz.extract_introspector_typedef(
             project_name, date_str)
 
+        # Extract macro block information
+        macro_block = oss_fuzz.extract_introspector_macro_block(
+            project_name, date_str)
+
         introspector_data_dict = {
             "introspector_report_url": introspector_report_url,
             "coverage_lines":
@@ -745,7 +755,8 @@ def extract_project_data(project_name, date_str, should_include_details,
             'annotated_cfg': annotated_cfg,
             'optimal_targets': optimal_targets,
             'project_name': project_name,
-            'typedef_list': typedef_list
+            'typedef_list': typedef_list,
+            'macro_block': macro_block
         }
 
     code_coverage_data_dict = prepare_code_coverage_dict(

tools/web-fuzzing-introspection/app/webapp/routes.py

@@ -1349,11 +1349,65 @@ def api_full_type_definition(args):
         return {'result': 'error', 'msg': 'Found no introspector data.'}
 
 
+@blueprint.route('/api/check_macro')
+def api_check_macro():
+    """API that returns all macro block wrapper for a line range in a
+    specific source file of a project."""
+    source_file = request.args.get('source', '')
+    if not source_file:
+        return {'result': 'error', 'msg': 'Please provide source file path'}
+
+    project_name = request.args.get('project', '')
+    if not project_name:
+        return {'result': 'error', 'msg': 'Please provide project name'}
+
+    target_project = get_project_with_name(project_name)
+    if target_project is None:
+        return {'result': 'error', 'msg': 'Project not in the database'}
+
+    line_start = int(request.args.get('start', 0))
+    line_end = int(request.args.get('end', 999999))
+
+    if target_project.introspector_data is None:
+        return {'result': 'error', 'msg': 'Found no introspector data.'}
+
+    try:
+        result_list = []
+        macro_list = target_project.introspector_data.get('macro_block')
+
+        if not macro_list:
+            return {'result': 'error', 'msg': 'Found no introspector data.'}
+
+        for macro in macro_list:
+            pos = macro.get('pos')
+            if not pos:
+                continue
+
+            macro_source = pos.get('source_file')
+            macro_start = pos.get('line_start', -1)
+            macro_end = pos.get('line_end', -1)
+
+            if source_file != macro_source:
+                continue
+
+            if line_start <= macro_end and macro_start <= line_end:
+                result_list.append(macro)
+        return {
+            'result': 'success',
+            'project': {
+                'name': project_name,
+                'macro_block_info': result_list
+            }
+        }
+    except TypeError:
+        return {'result': 'error', 'msg': 'Found no introspector data.'}
+
+
 @api_blueprint.route('/api/project-summary')
 @api_blueprint.arguments(ProjectSchema, location='query')
 def api_project_summary(args):
     """Returns high-level fuzzing stats of a given project.
-    
+
     # Examples
 
     ## Example 1