blob: ca372dcb48fadc15fe49fa0aa61b9dffaca57a37 [file] [log] [blame]
# Copyright 2018 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Tools for annotation test scripts."""
import os
import subprocess
import sys
class NetworkTrafficAnnotationTools():
def __init__(self, build_path=None):
"""Initializes a NetworkTrafficAnnotationTools object.
build_path: str Absolute or relative path to a fully compiled build
directory. If not specified, the script tries to find it based on
relative position of this file (src/tools/traffic_annotation).
self.this_dir = os.path.dirname(os.path.abspath(__file__))
if not build_path:
build_path = self._FindPossibleBuildPath()
if build_path:
self.build_path = os.path.abspath(build_path)
self.auditor_path = None
# For each platform, map the returned platform name from python sys, to
# directory name of traffic_annotation_auditor executable.
platform = {
'linux2': 'linux64',
'darwin': 'mac',
'win32': 'win32',
path = os.path.join(self.this_dir, '..', 'bin', platform,
if sys.platform == 'win32':
path += '.exe'
if os.path.exists(path):
self.auditor_path = path
def _FindPossibleBuildPath(self):
"""Returns the first folder in //out that looks like a build dir."""
# Assuming this file is in 'tools/traffic_annotation/scripts', three
# directories deeper is 'src' and hopefully there is an 'out' in it.
out = os.path.abspath(os.path.join(self.this_dir, '..', '..', '..', 'out'))
if os.path.exists(out):
for folder in os.listdir(out):
candidate = os.path.join(out, folder)
if (os.path.isdir(candidate) and
return candidate
return None
def _CheckIfDirectorySeemsAsBuild(self, path):
"""Checks to see if a directory seems to be a compiled build directory by
searching for 'gen' folder and '' file in it.
return all(os.path.exists(
os.path.join(path, item)) for item in ('gen', ''))
def GetModifiedFiles(self):
"""Gets the list of modified files from git. Returns None if any error
list of str List of modified files. Returns None on errors.
# List of files is extracted almost the same way as the following test
# recipe:
# recipe_modules/tryserver/
# '--no-renames' switch is added so that if a file is renamed, both old and
# new name would be given. Old name is needed to discard its data in
# annotations.xml and new name is needed for updating the XML and checking
# its content for possible changes.
args = ["git.bat"] if sys.platform == "win32" else ["git"]
args += ["diff", "--cached", "--name-only", "--no-renames"]
original_path = os.getcwd()
# Change directory to src (two levels upper than build path).
os.chdir(os.path.join(self.build_path, "..", ".."))
command = subprocess.Popen(args, stdout=subprocess.PIPE,
stdout_text, stderr_text = command.communicate()
if stderr_text:
print("Could not run '%s' to get the list of changed files "
"beacuse: %s" % (" ".join(args), stderr_text))
return None
return stdout_text.splitlines()
def CanRunAuditor(self):
"""Retruns true if all required paths to run auditor are known."""
return self.build_path and self.auditor_path
def RunAuditor(self, args):
"""Runs traffic annotation auditor and returns the results.
args: list of str Arguments to be passed to traffic annotation auditor.
stdout_text: str Auditor's runtime outputs.
stderr_text: str Auditor's returned errors.
return_code: int Auditor's exit code.
command = subprocess.Popen(
[self.auditor_path, "--build-path=" + self.build_path] + args,
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout_text, stderr_text = command.communicate()
return_code = command.returncode
return stdout_text, stderr_text, return_code