blob: 5785eab23cb3e872ef5283b204e77e0ee4237e1a [file] [log] [blame]
#!/usr/bin/env python
# Copyright 2017 The PDFium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Generates a coverage report for given tests.
Requires that 'use_clang_coverage = true' is set in
Prefers that 'is_component_build = false' is set in
import argparse
from collections import namedtuple
import fnmatch
import os
import pprint
import subprocess
import sys
# Add src dir to path to avoid having to set PYTHONPATH.
os.path.dirname(__file__), os.path.pardir, os.path.pardir,
from import GetBooleanGnArg
# 'binary' is the file that is to be run for the test.
# 'use_test_runner' indicates if 'binary' depends on and thus
# requires special handling.
# 'opt_args' are optional arguments to pass to the test 'binary'.
TestSpec = namedtuple('TestSpec', 'binary, use_test_runner, opt_args')
# All of the coverage tests that the script knows how to run.
TestSpec('pdfium_unittests', False, []),
TestSpec('pdfium_embeddertests', False, []),
TestSpec('', True, []),
TestSpec('', True, ['--disable-javascript']),
TestSpec('', True, []),
TestSpec('', True, ['--disable-javascript']),
TestSpec('', True, []),
TestSpec('', True, ['--disable-javascript']),
class CoverageExecutor(object):
def __init__(self, parser, args):
"""Initialize executor based on the current script environment
parser: argparse.ArgumentParser for handling improper inputs.
args: Dictionary of arguments passed into the calling script.
self.dry_run = args['dry_run']
self.verbose = args['verbose']
self.source_directory = args['source_directory']
if not os.path.isdir(self.source_directory):
parser.error("'%s' needs to be a directory" % self.source_directory)
self.llvm_directory = os.path.join(self.source_directory, 'third_party',
'llvm-build', 'Release+Asserts', 'bin')
if not os.path.isdir(self.llvm_directory):
parser.error("Cannot find LLVM bin directory , expected it to be in '%s'"
% self.llvm_directory)
self.build_directory = args['build_directory']
if not os.path.isdir(self.build_directory):
parser.error("'%s' needs to be a directory" % self.build_directory)
self.build_targets) = self.calculate_coverage_tests(args)
if not self.coverage_tests:
'No valid tests in set to be run. This is likely due to bad command '
'line arguments')
if not GetBooleanGnArg('use_clang_coverage', self.build_directory,
'use_clang_coverage does not appear to be set to true for build, but '
'is needed')
self.use_goma = GetBooleanGnArg('use_goma', self.build_directory,
self.output_directory = args['output_directory']
if not os.path.exists(self.output_directory):
if not self.dry_run:
elif not os.path.isdir(self.output_directory):
parser.error('%s exists, but is not a directory' % self.output_directory)
elif len(os.listdir(self.output_directory)) > 0:
parser.error('%s is not empty, cowardly refusing to continue' %
self.prof_data = os.path.join(self.output_directory, 'pdfium.profdata')
def check_output(self, args, dry_run=False, env=None):
"""Dry run aware wrapper of subprocess.check_output()"""
if dry_run:
print "Would have run '%s'" % ' '.join(args)
return ''
output = subprocess.check_output(args, env=env)
if self.verbose:
print "check_output(%s) returned '%s'" % (args, output)
return output
def call(self, args, dry_run=False, env=None):
"""Dry run aware wrapper of"""
if dry_run:
print "Would have run '%s'" % ' '.join(args)
return 0
output =, env=env)
if self.verbose:
print 'call(%s) returned %s' % (args, output)
return output
def call_silent(self, args, dry_run=False, env=None):
"""Dry run aware wrapper of that eats output from call"""
if dry_run:
print "Would have run '%s'" % ' '.join(args)
return 0
with open(os.devnull, 'w') as f:
output =, env=env, stdout=f)
if self.verbose:
print 'call_silent(%s) returned %s' % (args, output)
return output
def calculate_coverage_tests(self, args):
"""Determine which tests should be run."""
testing_tools_directory = os.path.join(self.source_directory, 'testing',
tests = args['tests'] if args['tests'] else COVERAGE_TESTS.keys()
coverage_tests = {}
build_targets = set()
for name in tests:
test_spec = COVERAGE_TESTS[name]
if test_spec.use_test_runner:
binary_path = os.path.join(testing_tools_directory, test_spec.binary)
binary_path = os.path.join(self.build_directory, test_spec.binary)
coverage_tests[name] = TestSpec(binary_path, test_spec.use_test_runner,
build_targets = list(build_targets)
return coverage_tests, build_targets
def build_binaries(self):
"""Build all the binaries that are going to be needed for coverage
call_args = ['ninja']
if self.use_goma:
call_args += ['-j', '250']
call_args += ['-C', self.build_directory]
call_args += self.build_targets
return, dry_run=self.dry_run) == 0
def generate_coverage(self, name, spec):
"""Generate the coverage data for a test
name: Name associated with the test to be run. This is used as a label
in the coverage data, so should be unique across all of the tests
being run.
spec: Tuple containing the TestSpec.
if self.verbose:
print "Generating coverage for test '%s', using data '%s'" % (name, spec)
if not os.path.exists(spec.binary):
print('Unable to generate coverage for %s, since it appears to not exist'
' @ %s') % (name, spec.binary)
return False
binary_args = [spec.binary]
if spec.opt_args:
profile_pattern_string = '%8m'
expected_profraw_file = '%s.%s.profraw' % (name, profile_pattern_string)
expected_profraw_path = os.path.join(self.output_directory,
env = {
'LLVM_PROFILE_FILE': expected_profraw_path,
'PATH': os.getenv('PATH') + os.pathsep + self.llvm_directory
if spec.use_test_runner:
# Test runner performs multi-threading in the wrapper script, not the test
# binary, so need to limit the number of instances of the binary being run
# to the max value in LLVM_PROFILE_FILE, which is 8.
binary_args.extend(['-j', '8', '--build-dir', self.build_directory])
if, dry_run=self.dry_run, env=env) and self.verbose:
print('Running %s appears to have failed, which might affect '
'results') % spec.binary
return True
def merge_raw_coverage_results(self):
"""Merge raw coverage data sets into one one file for report generation."""
llvm_profdata_bin = os.path.join(self.llvm_directory, 'llvm-profdata')
raw_data = []
raw_data_pattern = '*.profraw'
for file_name in os.listdir(self.output_directory):
if fnmatch.fnmatch(file_name, raw_data_pattern):
raw_data.append(os.path.join(self.output_directory, file_name))
[llvm_profdata_bin, 'merge', '-o', self.prof_data, '-sparse=true'] +
raw_data) == 0
def generate_html_report(self):
"""Generate HTML report by calling upstream"""
coverage_bin = os.path.join(self.source_directory, 'tools', 'code_coverage',
report_directory = os.path.join(self.output_directory, 'HTML')
coverage_args = ['-p', self.prof_data]
coverage_args += ['-b', self.build_directory]
coverage_args += ['-o', report_directory]
coverage_args += self.build_targets
# Whitelist the directories of interest
coverage_args += ['-f', 'core']
coverage_args += ['-f', 'fpdfsdk']
coverage_args += ['-f', 'fxbarcode']
coverage_args += ['-f', 'fxjs']
coverage_args += ['-f', 'public']
coverage_args += ['-f', 'samples']
coverage_args += ['-f', 'xfa']
# Blacklist test files
coverage_args += ['-i', '.*test.*']
# Component view is only useful for Chromium
coverage_args += ['--no-component-view']
return[coverage_bin] + coverage_args) == 0
def run(self):
"""Setup environment, execute the tests and generate coverage report"""
if not self.fetch_profiling_tools():
print 'Unable to fetch profiling tools'
return False
if not self.build_binaries():
print 'Failed to successfully build binaries'
return False
for name in self.coverage_tests.keys():
if not self.generate_coverage(name, self.coverage_tests[name]):
print 'Failed to successfully generate coverage data'
return False
if not self.merge_raw_coverage_results():
print 'Failed to successfully merge raw coverage results'
return False
if not self.generate_html_report():
print 'Failed to successfully generate HTML report'
return False
return True
def fetch_profiling_tools(self):
"""Call with no args to ensure profiling tools are present."""
return self.call_silent(
os.path.join(self.source_directory, 'tools', 'code_coverage',
'')) == 0
def main():
parser = argparse.ArgumentParser()
parser.formatter_class = argparse.RawDescriptionHelpFormatter
parser.description = 'Generates a coverage report for given tests.'
help='Location of PDFium source directory, defaults to CWD',
build_default = os.path.join('out', 'Coverage')
'Location of PDFium build directory with coverage enabled, defaults to '
'%s under CWD' % build_default,
default=os.path.join(os.getcwd(), build_default))
output_default = 'coverage_report'
help='Location to write out coverage report to, defaults to %s under CWD '
% output_default,
default=os.path.join(os.getcwd(), output_default))
help='Output commands instead of executing them',
help='Output additional diagnostic information',
help='Tests to be run, defaults to all. Valid entries are %s' %
args = vars(parser.parse_args())
if args['verbose']:
executor = CoverageExecutor(parser, args)
return 0
return 1
if __name__ == '__main__':