Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

experimental: add utility for extracting top projects #519

Merged
merged 2 commits into from
Jul 31, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 73 additions & 17 deletions experimental/c-cpp/post-process.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
# limitations under the License.
"""Post process results by from-scratch OSS-Fuzz generation."""

import argparse
import json
import logging
import os
import sys
from typing import Any, Optional
from typing import Any, Dict, List, Optional

import constants

Expand Down Expand Up @@ -156,30 +156,34 @@ def read_session_project_report(project_folder_out):
}


def analyse_project_session(oss_fuzz_dir: str, project_folder_out: str) -> None:
def analyse_project_session(oss_fuzz_dir: str,
project_folder_out: str,
to_print: bool = False) -> List[Dict[str, Any]]:
"""Interprets the results for a auto-gen session."""
logger.info('Analysing: %s', project_folder_out)
project_report = read_session_project_report(project_folder_out)
if not project_report:
return
return []

total_outcomes = extract_results_from_generated_samples(
oss_fuzz_dir, project_folder_out)

sorted_outcomes = sorted(total_outcomes,
key=lambda x: x['cov_history'][-1],
reverse=True)
logger.info('Results: %s', project_report['project'])
logger.info('- Language: %s', project_report['language'])
logger.info('- Functions from Fuzz Introspector: %s',
project_report['total-functions'])
logger.info('- Harnesses generated: %d', len(total_outcomes))
for harness_result in sorted_outcomes:
logger.info('%s :: %d :: %d :: [asan errors: %d] :: coverage: %f ',
harness_result['target'], harness_result['cov_history'][0],
harness_result['cov_history'][-1],
len(harness_result['addr_san']),
harness_result['line_coverage'])
if to_print:
logger.info('Results: %s', project_report['project'])
logger.info('- Language: %s', project_report['language'])
logger.info('- Functions from Fuzz Introspector: %s',
project_report['total-functions'])
logger.info('- Harnesses generated: %d', len(total_outcomes))
for harness_result in sorted_outcomes:
logger.info('%s :: %d :: %d :: [asan errors: %d] :: coverage: %f ',
harness_result['target'], harness_result['cov_history'][0],
harness_result['cov_history'][-1],
len(harness_result['addr_san']),
harness_result['line_coverage'])
return sorted_outcomes


def analyse_oss_fuzz_build(oss_fuzz_dir: str) -> None:
Expand All @@ -193,7 +197,55 @@ def analyse_oss_fuzz_build(oss_fuzz_dir: str) -> None:
if not os.path.isdir(project_folder_out):
continue

analyse_project_session(oss_fuzz_dir, project_folder_out)
analyse_project_session(oss_fuzz_dir, project_folder_out, True)


def get_top_projects(oss_fuzz_dir: str) -> List[Dict[str, Any]]:
"""Gets the top project for each auto-generated project."""
sorted_project_folders = get_oss_fuzz_generated_projects(oss_fuzz_dir)

top_projects = []
for target_project in sorted_project_folders:
project_folder_out = os.path.join(oss_fuzz_out_dir(oss_fuzz_dir),
target_project)
if not os.path.isdir(project_folder_out):
continue

sorted_projects = analyse_project_session(oss_fuzz_dir, project_folder_out)
if sorted_projects:
top_projects.append(sorted_projects[0])

for top_project in top_projects:
logger.info('%s :: %d :: %d :: [asan errors: %d] :: coverage: %f ',
top_project['target'],
top_project['cov_history'][0], top_project['cov_history'][-1],
len(top_project['addr_san']), top_project['line_coverage'])
return top_projects


def parse_args() -> argparse.Namespace:
"""Parses commandline arguments."""
parser = argparse.ArgumentParser()

subparsers = parser.add_subparsers(dest='command')
print_parser = subparsers.add_parser(
'print',
help='prints results of auto-gen to stdout',
)
print_parser.add_argument('--oss-fuzz-dir',
type=str,
help='OSS-Fuzz directory with generated results',
required=True)
top_finder = subparsers.add_parser(
'top-projects',
help='prints status of top projects',
)
top_finder.add_argument('--oss-fuzz-dir',
type=str,
help='OSS-Fuzz directory with generated results',
required=True)
args = parser.parse_args()
return args


def setup_logging() -> None:
Expand All @@ -204,7 +256,11 @@ def setup_logging() -> None:
def main() -> None:
"""Entrypoint"""
setup_logging()
analyse_oss_fuzz_build(sys.argv[1])
args = parse_args()
if args.command == 'print':
analyse_oss_fuzz_build(args.oss_fuzz_dir)
elif args.command == 'top-projects':
get_top_projects(args.oss_fuzz_dir)


if __name__ == '__main__':
Expand Down