class CompareRun(object):
"""A comparison between two branches of pdfium."""
def __init__(self, args):
self.git = GitHelper()
self.args = args
self._InitPaths()
def _InitPaths(self):
if self.args.this_repo:
self.safe_script_dir = self.args.build_dir
else:
self.safe_script_dir = os.path.join('testing', 'tools')
self.safe_measure_script_path = os.path.abspath(
os.path.join(self.safe_script_dir, 'safetynet_measure.py'))
input_file_re = re.compile('^.+[.]pdf$')
self.test_cases = []
for input_path in self.args.input_paths:
if os.path.isfile(input_path):
self.test_cases.append(input_path)
elif os.path.isdir(input_path):
for file_dir, _, filename_list in os.walk(input_path):
for input_filename in filename_list:
if input_file_re.match(input_filename):
file_path = os.path.join(file_dir, input_filename)
if os.path.isfile(file_path):
self.test_cases.append(file_path)
self.after_build_dir = self.args.build_dir
if self.args.build_dir_before:
self.before_build_dir = self.args.build_dir_before
else:
self.before_build_dir = self.after_build_dir
def Run(self):
"""Runs comparison by checking out branches, building and measuring them.
Returns:
Exit code for the script.
"""
if self.args.this_repo:
self._FreezeMeasureScript()
if self.args.branch_after:
if self.args.this_repo:
before, after = self._ProfileTwoOtherBranchesInThisRepo(
self.args.branch_before, self.args.branch_after)
else:
before, after = self._ProfileTwoOtherBranches(
self.args.branch_before, self.args.branch_after)
elif self.args.branch_before:
if self.args.this_repo:
before, after = self._ProfileCurrentAndOtherBranchInThisRepo(
self.args.branch_before)
else:
before, after = self._ProfileCurrentAndOtherBranch(
self.args.branch_before)
else:
if self.args.this_repo:
before, after = self._ProfileLocalChangesAndCurrentBranchInThisRepo(
)
else:
before, after = self._ProfileLocalChangesAndCurrentBranch()
conclusions = self._DrawConclusions(before, after)
conclusions_dict = conclusions.GetOutputDict()
conclusions_dict.setdefault('metadata',
{})['profiler'] = self.args.profiler
self._PrintConclusions(conclusions_dict)
self._CleanUp(conclusions)
return 0
def _FreezeMeasureScript(self):
"""Freezes a version of the measuring script.
This is needed to make sure we are comparing the pdfium library changes and
not script changes that may happen between the two branches.
"""
self.__FreezeFile(
os.path.join('testing', 'tools', 'safetynet_measure.py'))
self.__FreezeFile(os.path.join('testing', 'tools', 'common.py'))
def __FreezeFile(self, file):
RunCommandPropagateErr(['cp', file, self.safe_script_dir],
exit_status_on_error=1)
def _ProfileTwoOtherBranchesInThisRepo(self, before_branch, after_branch):
"""Profiles two branches that are not the current branch.
This is done in the local repository and changes may not be restored if the
script fails or is interrupted.
after_branch does not need to descend from before_branch, they will be
measured the same way
Args:
before_branch: One branch to profile.
after_branch: Other branch to profile.
Returns:
A tuple (before, after), where each of before and after is a dict
mapping a test case name to the profiling values for that test case
in the given branch.
"""
branch_to_restore = self.git.GetCurrentBranchName()
self._StashLocalChanges()
self._CheckoutBranch(after_branch)
self._BuildCurrentBranch(self.after_build_dir)
after = self._MeasureCurrentBranch('after', self.after_build_dir)
self._CheckoutBranch(before_branch)
self._BuildCurrentBranch(self.before_build_dir)
before = self._MeasureCurrentBranch('before', self.before_build_dir)
self._CheckoutBranch(branch_to_restore)
self._RestoreLocalChanges()
return before, after
def _ProfileTwoOtherBranches(self, before_branch, after_branch):
"""Profiles two branches that are not the current branch.
This is done in new, cloned repositories, therefore it is safer but slower
and requires downloads.
after_branch does not need to descend from before_branch, they will be
measured the same way
Args:
before_branch: One branch to profile.
after_branch: Other branch to profile.
Returns:
A tuple (before, after), where each of before and after is a dict
mapping a test case name to the profiling values for that test case
in the given branch.
"""
after = self._ProfileSeparateRepo('after', self.after_build_dir,
after_branch)
before = self._ProfileSeparateRepo('before', self.before_build_dir,
before_branch)
return before, after
def _ProfileCurrentAndOtherBranchInThisRepo(self, other_branch):
"""Profiles the current branch (with uncommitted changes) and another one.
This is done in the local repository and changes may not be restored if the
script fails or is interrupted.
The current branch does not need to descend from other_branch.
Args:
other_branch: Other branch to profile that is not the current.
Returns:
A tuple (before, after), where each of before and after is a dict
mapping a test case name to the profiling values for that test case
in the given branch. The current branch is considered to be "after" and
the other branch is considered to be "before".
"""
branch_to_restore = self.git.GetCurrentBranchName()
self._BuildCurrentBranch(self.after_build_dir)
after = self._MeasureCurrentBranch('after', self.after_build_dir)
self._StashLocalChanges()
self._CheckoutBranch(other_branch)
self._BuildCurrentBranch(self.before_build_dir)
before = self._MeasureCurrentBranch('before', self.before_build_dir)
self._CheckoutBranch(branch_to_restore)
self._RestoreLocalChanges()
return before, after
def _ProfileCurrentAndOtherBranch(self, other_branch):
"""Profiles the current branch (with uncommitted changes) and another one.
This is done in new, cloned repositories, therefore it is safer but slower
and requires downloads.
The current branch does not need to descend from other_branch.
Args:
other_branch: Other branch to profile that is not the current. None will
compare to the same branch.
Returns:
A tuple (before, after), where each of before and after is a dict
mapping a test case name to the profiling values for that test case
in the given branch. The current branch is considered to be "after" and
the other branch is considered to be "before".
"""
self._BuildCurrentBranch(self.after_build_dir)
after = self._MeasureCurrentBranch('after', self.after_build_dir)
before = self._ProfileSeparateRepo('before', self.before_build_dir,
other_branch)
return before, after
def _ProfileLocalChangesAndCurrentBranchInThisRepo(self):
"""Profiles the current branch with and without uncommitted changes.
This is done in the local repository and changes may not be restored if the
script fails or is interrupted.
Returns:
A tuple (before, after), where each of before and after is a dict
mapping a test case name to the profiling values for that test case
using the given version. The current branch without uncommitted changes is
considered to be "before" and with uncommitted changes is considered to be
"after".
"""
self._BuildCurrentBranch(self.after_build_dir)
after = self._MeasureCurrentBranch('after', self.after_build_dir)
pushed = self._StashLocalChanges()
if not pushed and not self.args.build_dir_before:
PrintErr('Warning: No local changes to compare')
before_build_dir = self.before_build_dir
self._BuildCurrentBranch(before_build_dir)
before = self._MeasureCurrentBranch('before', before_build_dir)
self._RestoreLocalChanges()
return before, after
def _ProfileLocalChangesAndCurrentBranch(self):
"""Profiles the current branch with and without uncommitted changes.
This is done in new, cloned repositories, therefore it is safer but slower
and requires downloads.
Returns:
A tuple (before, after), where each of before and after is a dict
mapping a test case name to the profiling values for that test case
using the given version. The current branch without uncommitted changes is
considered to be "before" and with uncommitted changes is considered to be
"after".
"""
return self._ProfileCurrentAndOtherBranch(other_branch=None)
def _ProfileSeparateRepo(self, run_label, relative_build_dir, branch):
"""Profiles a branch in a a temporary git repository.
Args:
run_label: String to differentiate this version of the code in output
files from other versions.
relative_build_dir: Path to the build dir in the current working dir to
clone build args from.
branch: Branch to checkout in the new repository. None will
profile the same branch checked out in the original repo.
Returns:
A dict mapping each test case name to the profiling values for that
test case.
"""
build_dir = self._CreateTempRepo('repo_%s' % run_label,
relative_build_dir, branch)
self._BuildCurrentBranch(build_dir)
return self._MeasureCurrentBranch(run_label, build_dir)
def _CreateTempRepo(self, dir_name, relative_build_dir, branch):
"""Clones a temporary git repository out of the current working dir.
Args:
dir_name: Name for the temporary repository directory
relative_build_dir: Path to the build dir in the current working dir to
clone build args from.
branch: Branch to checkout in the new repository. None will keep checked
out the same branch as the local repo.
Returns:
Path to the build directory of the new repository.
"""
cwd = os.getcwd()
repo_dir = tempfile.mkdtemp(suffix='-%s' % dir_name)
src_dir = os.path.join(repo_dir, 'pdfium')
self.git.CloneLocal(os.getcwd(), src_dir)
if branch is not None:
os.chdir(src_dir)
self.git.Checkout(branch)
os.chdir(repo_dir)
PrintErr('Syncing...')
cmd = [
'gclient', 'config', '--unmanaged',
'https://pdfium.googlesource.com/pdfium.git'
]
if self.args.cache_dir:
cmd.append('--cache-dir=%s' % self.args.cache_dir)
RunCommandPropagateErr(cmd, exit_status_on_error=1)
RunCommandPropagateErr(['gclient', 'sync'], exit_status_on_error=1)
PrintErr('Done.')
build_dir = os.path.join(src_dir, relative_build_dir)
os.makedirs(build_dir)
os.chdir(src_dir)
source_gn_args = os.path.join(cwd, relative_build_dir, 'args.gn')
dest_gn_args = os.path.join(build_dir, 'args.gn')
shutil.copy(source_gn_args, dest_gn_args)
RunCommandPropagateErr(['gn', 'gen', relative_build_dir],
exit_status_on_error=1)
os.chdir(cwd)
return build_dir
def _CheckoutBranch(self, branch):
PrintErr("Checking out branch '%s'" % branch)
self.git.Checkout(branch)
def _StashLocalChanges(self):
PrintErr('Stashing local changes')
return self.git.StashPush()
def _RestoreLocalChanges(self):
PrintErr('Restoring local changes')
self.git.StashPopAll()
def _BuildCurrentBranch(self, build_dir):
"""Synchronizes and builds the current version of pdfium.
Args:
build_dir: String with path to build directory
"""
PrintErr('Syncing...')
RunCommandPropagateErr(['gclient', 'sync'], exit_status_on_error=1)
PrintErr('Done.')
PrintErr('Building...')
cmd = ['ninja', '-C', build_dir, 'pdfium_test']
if GetBooleanGnArg('use_goma', build_dir):
cmd.extend(['-j', '250'])
RunCommandPropagateErr(cmd,
stdout_has_errors=True,
exit_status_on_error=1)
PrintErr('Done.')
def _MeasureCurrentBranch(self, run_label, build_dir):
PrintErr('Measuring...')
if self.args.num_workers > 1 and len(self.test_cases) > 1:
results = self._RunAsync(run_label, build_dir)
else:
results = self._RunSync(run_label, build_dir)
PrintErr('Done.')
return results
def _RunSync(self, run_label, build_dir):
"""Profiles the test cases synchronously.
Args:
run_label: String to differentiate this version of the code in output
files from other versions.
build_dir: String with path to build directory
Returns:
A dict mapping each test case name to the profiling values for that
test case.
"""
results = {}
for test_case in self.test_cases:
result = self.RunSingleTestCase(run_label, build_dir, test_case)
if result is not None:
results[test_case] = result
return results
def _RunAsync(self, run_label, build_dir):
"""Profiles the test cases asynchronously.
Uses as many workers as configured by --num-workers.
Args:
run_label: String to differentiate this version of the code in output
files from other versions.
build_dir: String with path to build directory
Returns:
A dict mapping each test case name to the profiling values for that
test case.
"""
results = {}
pool = multiprocessing.Pool(self.args.num_workers)
worker_func = functools.partial(RunSingleTestCaseParallel, self,
run_label, build_dir)
try:
# The timeout is a workaround for http://bugs.python.org/issue8296
# which prevents KeyboardInterrupt from working.
one_year_in_seconds = 3600 * 24 * 365
worker_results = (pool.map_async(
worker_func, self.test_cases).get(one_year_in_seconds))
for worker_result in worker_results:
test_case, result = worker_result
if result is not None:
results[test_case] = result
except KeyboardInterrupt:
pool.terminate()
sys.exit(1)
else:
pool.close()
pool.join()
return results
def RunSingleTestCase(self, run_label, build_dir, test_case):
"""Profiles a single test case.
Args:
run_label: String to differentiate this version of the code in output
files from other versions.
build_dir: String with path to build directory
test_case: Path to the test case.
Returns:
The measured profiling value for that test case.
"""
command = [
self.safe_measure_script_path, test_case,
'--build-dir=%s' % build_dir
]
if self.args.interesting_section:
command.append('--interesting-section')
if self.args.profiler:
command.append('--profiler=%s' % self.args.profiler)
profile_file_path = self._GetProfileFilePath(run_label, test_case)
if profile_file_path:
command.append('--output-path=%s' % profile_file_path)
output = RunCommandPropagateErr(command)
if output is None:
return None
# Get the time number as output, making sure it's just a number
output = output.strip()
if re.match('^[0-9]+$', output):
return int(output)
return None
def _GetProfileFilePath(self, run_label, test_case):
if self.args.output_dir:
output_filename = ('callgrind.out.%s.%s' %
(test_case.replace('/', '_'), run_label))
return os.path.join(self.args.output_dir, output_filename)
else:
return None
def _DrawConclusions(self, times_before_branch, times_after_branch):
"""Draws conclusions comparing results of test runs in two branches.
Args:
times_before_branch: A dict mapping each test case name to the
profiling values for that test case in the branch to be considered
as the baseline.
times_after_branch: A dict mapping each test case name to the
profiling values for that test case in the branch to be considered
as the new version.
Returns:
ComparisonConclusions with all test cases processed.
"""
conclusions = ComparisonConclusions(self.args.threshold_significant)
for test_case in sorted(self.test_cases):
before = times_before_branch.get(test_case)
after = times_after_branch.get(test_case)
conclusions.ProcessCase(test_case, before, after)
return conclusions
def _PrintConclusions(self, conclusions_dict):
"""Prints the conclusions as the script output.
Depending on the script args, this can output a human or a machine-readable
version of the conclusions.
Args:
conclusions_dict: Dict to print returned from
ComparisonConclusions.GetOutputDict().
"""
if self.args.machine_readable:
print json.dumps(conclusions_dict)
else:
PrintConclusionsDictHumanReadable(conclusions_dict,
colored=True,
key=self.args.case_order)
def _CleanUp(self, conclusions):
"""Removes profile output files for uninteresting cases.
Cases without significant regressions or improvements and considered
uninteresting.
Args:
conclusions: A ComparisonConclusions.
"""
if not self.args.output_dir:
return
if self.args.profiler != 'callgrind':
return
for case_result in conclusions.GetCaseResults().values():
if case_result.rating not in [
RATING_REGRESSION, RATING_IMPROVEMENT
]:
self._CleanUpOutputFile('before', case_result.case_name)
self._CleanUpOutputFile('after', case_result.case_name)
def _CleanUpOutputFile(self, run_label, case_name):
"""Removes one profile output file.
If the output file does not exist, fails silently.
Args:
run_label: String to differentiate a version of the code in output
files from other versions.
case_name: String identifying test case for which to remove the output
file.
"""
try:
os.remove(self._GetProfileFilePath(run_label, case_name))
except OSError:
pass
class JobRun:
"""A single run looking for regressions since the last one."""
def __init__(self, args, context):
"""Constructor.
Args:
args: Namespace with arguments passed to the script.
context: JobContext for this run.
"""
self.git = GitHelper()
self.args = args
self.context = context
def Run(self):
"""Searches for regressions.
Will only write a checkpoint when first run, and on all subsequent runs
a comparison is done against the last checkpoint.
Returns:
Exit code for the script: 0 if no significant changes are found; 1 if
there was an error in the comparison; 3 if there was a regression; 4 if
there was an improvement and no regression.
"""
pdfium_src_dir = os.path.join(
os.path.dirname(__file__), os.path.pardir, os.path.pardir)
os.chdir(pdfium_src_dir)
branch_to_restore = self.git.GetCurrentBranchName()
if not self.args.no_checkout:
self.git.FetchOriginMaster()
self.git.Checkout('origin/main')
# Make sure results dir exists
if not os.path.exists(self.context.results_dir):
os.makedirs(self.context.results_dir)
if not os.path.exists(self.context.last_revision_covered_file):
result = self._InitialRun()
else:
with open(self.context.last_revision_covered_file) as f:
last_revision_covered = f.read().strip()
result = self._IncrementalRun(last_revision_covered)
self.git.Checkout(branch_to_restore)
return result
def _InitialRun(self):
"""Initial run, just write a checkpoint.
Returns:
Exit code for the script.
"""
current = self.git.GetCurrentBranchHash()
PrintWithTime('Initial run, current is %s' % current)
self._WriteCheckpoint(current)
PrintWithTime('All set up, next runs will be incremental and perform '
'comparisons')
return 0
def _IncrementalRun(self, last_revision_covered):
"""Incremental run, compare against last checkpoint and update it.
Args:
last_revision_covered: String with hash for last checkpoint.
Returns:
Exit code for the script.
"""
current = self.git.GetCurrentBranchHash()
PrintWithTime('Incremental run, current is %s, last is %s' %
(current, last_revision_covered))
if not os.path.exists(self.context.run_output_dir):
os.makedirs(self.context.run_output_dir)
if current == last_revision_covered:
PrintWithTime('No changes seen, finishing job')
output_info = {
'metadata':
self._BuildRunMetadata(last_revision_covered, current, False)
}
self._WriteRawJson(output_info)
return 0
# Run compare
cmd = [
'testing/tools/safetynet_compare.py', '--this-repo',
'--machine-readable',
'--branch-before=%s' % last_revision_covered,
'--output-dir=%s' % self.context.run_output_dir
]
cmd.extend(self.args.input_paths)
json_output = RunCommandPropagateErr(cmd)
if json_output is None:
return 1
output_info = json.loads(json_output)
run_metadata = self._BuildRunMetadata(last_revision_covered, current, True)
output_info.setdefault('metadata', {}).update(run_metadata)
self._WriteRawJson(output_info)
PrintConclusionsDictHumanReadable(
output_info,
colored=(not self.args.output_to_log and not self.args.no_color),
key='after')
status = 0
if output_info['summary']['improvement']:
PrintWithTime('Improvement detected.')
status = 4
if output_info['summary']['regression']:
PrintWithTime('Regression detected.')
status = 3
if status == 0:
PrintWithTime('Nothing detected.')
self._WriteCheckpoint(current)
return status
def _WriteRawJson(self, output_info):
json_output_file = os.path.join(self.context.run_output_dir, 'raw.json')
with open(json_output_file, 'w') as f:
json.dump(output_info, f)
def _BuildRunMetadata(self, revision_before, revision_after,
comparison_performed):
return {
'datetime': self.context.datetime,
'revision_before': revision_before,
'revision_after': revision_after,
'comparison_performed': comparison_performed,
}
def _WriteCheckpoint(self, checkpoint):
if not self.args.no_checkpoint:
with open(self.context.last_revision_covered_file, 'w') as f:
f.write(checkpoint + '\n')