Add ability to compare submodules from different repositories

As before with wanting to compare revisions across different
repositories, the ability to select the crypto submodule from a
different repository is useful.
This commit is contained in:
Darryl Green 2019-02-27 17:33:31 +00:00
parent 3e7a980d62
commit 4831145cdd

View file

@ -32,17 +32,19 @@ class AbiChecker(object):
"""API and ABI checker.""" """API and ABI checker."""
def __init__(self, report_dir, old_repo, old_rev, old_crypto_rev, def __init__(self, report_dir, old_repo, old_rev, old_crypto_rev,
new_repo, new_rev, new_crypto_rev, keep_all_reports, brief, old_crypto_repo, new_repo, new_rev, new_crypto_rev,
skip_file=None): new_crypto_repo, keep_all_reports, brief, skip_file=None):
"""Instantiate the API/ABI checker. """Instantiate the API/ABI checker.
report_dir: directory for output files report_dir: directory for output files
old_repo: repository for git revision to compare against old_repo: repository for git revision to compare against
old_rev: reference git revision to compare against old_rev: reference git revision to compare against
old_crypto_rev: reference git revision for old crypto submodule old_crypto_rev: reference git revision for old crypto submodule
old_crypto_repo: repository for git revision for old crypto submodule
new_repo: repository for git revision to check new_repo: repository for git revision to check
new_rev: git revision to check new_rev: git revision to check
new_crypto_rev: reference git revision for new crypto submodule new_crypto_rev: reference git revision for new crypto submodule
new_crypto_repo: repository for git revision for new crypto submodule
keep_all_reports: if false, delete old reports keep_all_reports: if false, delete old reports
brief: if true, output shorter report to stdout brief: if true, output shorter report to stdout
skip_file: path to file containing symbols and types to skip skip_file: path to file containing symbols and types to skip
@ -57,9 +59,11 @@ class AbiChecker(object):
self.old_repo = old_repo self.old_repo = old_repo
self.old_rev = old_rev self.old_rev = old_rev
self.old_crypto_rev = old_crypto_rev self.old_crypto_rev = old_crypto_rev
self.old_crypto_repo = old_crypto_repo
self.new_repo = new_repo self.new_repo = new_repo
self.new_rev = new_rev self.new_rev = new_rev
self.new_crypto_rev = new_crypto_rev self.new_crypto_rev = new_crypto_rev
self.new_crypto_repo = new_crypto_repo
self.skip_file = skip_file self.skip_file = skip_file
self.brief = brief self.brief = brief
self.mbedtls_modules = {"old": {}, "new": {}} self.mbedtls_modules = {"old": {}, "new": {}}
@ -125,7 +129,8 @@ class AbiChecker(object):
raise Exception("Checking out worktree failed, aborting") raise Exception("Checking out worktree failed, aborting")
return git_worktree_path return git_worktree_path
def update_git_submodules(self, git_worktree_path, crypto_rev): def update_git_submodules(self, git_worktree_path, crypto_repo,
crypto_rev):
process = subprocess.Popen( process = subprocess.Popen(
[self.git_command, "submodule", "update", "--init", '--recursive'], [self.git_command, "submodule", "update", "--init", '--recursive'],
cwd=git_worktree_path, cwd=git_worktree_path,
@ -138,16 +143,30 @@ class AbiChecker(object):
raise Exception("git submodule update failed, aborting") raise Exception("git submodule update failed, aborting")
if (os.path.exists(os.path.join(git_worktree_path, "crypto")) if (os.path.exists(os.path.join(git_worktree_path, "crypto"))
and crypto_rev): and crypto_rev):
checkout_process = subprocess.Popen( if crypto_repo:
[self.git_command, "checkout", crypto_rev], shutil.rmtree(os.path.join(git_worktree_path, "crypto"))
cwd=os.path.join(git_worktree_path, "crypto"), clone_process = subprocess.Popen(
stdout=subprocess.PIPE, [self.git_command, "clone", crypto_repo,
stderr=subprocess.STDOUT "--branch", crypto_rev, "crypto"],
) cwd=git_worktree_path,
checkout_output, _ = checkout_process.communicate() stdout=subprocess.PIPE,
self.log.info(checkout_output.decode("utf-8")) stderr=subprocess.STDOUT
if checkout_process.returncode != 0: )
raise Exception("git checkout failed, aborting") clone_output, _ = clone_process.communicate()
self.log.info(clone_output.decode("utf-8"))
if clone_process.returncode != 0:
raise Exception("git clone failed, aborting")
else:
checkout_process = subprocess.Popen(
[self.git_command, "checkout", crypto_rev],
cwd=os.path.join(git_worktree_path, "crypto"),
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT
)
checkout_output, _ = checkout_process.communicate()
self.log.info(checkout_output.decode("utf-8"))
if checkout_process.returncode != 0:
raise Exception("git checkout failed, aborting")
def build_shared_libraries(self, git_worktree_path, version): def build_shared_libraries(self, git_worktree_path, version):
"""Build the shared libraries in the specified worktree.""" """Build the shared libraries in the specified worktree."""
@ -216,12 +235,13 @@ class AbiChecker(object):
if worktree_process.returncode != 0: if worktree_process.returncode != 0:
raise Exception("Worktree cleanup failed, aborting") raise Exception("Worktree cleanup failed, aborting")
def get_abi_dump_for_ref(self, remote_repo, git_rev, crypto_rev, version): def get_abi_dump_for_ref(self, remote_repo, git_rev, crypto_repo,
crypto_rev, version):
"""Generate the ABI dumps for the specified git revision.""" """Generate the ABI dumps for the specified git revision."""
git_worktree_path = self.get_clean_worktree_for_git_revision( git_worktree_path = self.get_clean_worktree_for_git_revision(
remote_repo, git_rev remote_repo, git_rev
) )
self.update_git_submodules(git_worktree_path, crypto_rev) self.update_git_submodules(git_worktree_path, crypto_repo, crypto_rev)
self.build_shared_libraries(git_worktree_path, version) self.build_shared_libraries(git_worktree_path, version)
abi_dumps = self.get_abi_dumps_from_shared_libraries( abi_dumps = self.get_abi_dumps_from_shared_libraries(
git_rev, git_worktree_path, version git_rev, git_worktree_path, version
@ -320,8 +340,10 @@ class AbiChecker(object):
self.check_repo_path() self.check_repo_path()
self.check_abi_tools_are_installed() self.check_abi_tools_are_installed()
self.old_dumps = self.get_abi_dump_for_ref(self.old_repo, self.old_rev, self.old_dumps = self.get_abi_dump_for_ref(self.old_repo, self.old_rev,
self.old_crypto_repo,
self.old_crypto_rev, "old") self.old_crypto_rev, "old")
self.new_dumps = self.get_abi_dump_for_ref(self.new_repo, self.new_rev, self.new_dumps = self.get_abi_dump_for_ref(self.new_repo, self.new_rev,
self.new_crypto_repo,
self.new_crypto_rev, "new") self.new_crypto_rev, "new")
return self.get_abi_compatibility_report() return self.get_abi_compatibility_report()
@ -356,8 +378,9 @@ def run_main():
required=True, nargs="+" required=True, nargs="+"
) )
parser.add_argument( parser.add_argument(
"-oc", "--old-crypto-rev", type=str, "-oc", "--old-crypto-rev", type=str, nargs="+",
help="revision for old crypto version", help=("revision for old crypto version."
"Can include repository before revision"),
) )
parser.add_argument( parser.add_argument(
"-n", "--new-rev", type=str, "-n", "--new-rev", type=str,
@ -366,8 +389,9 @@ def run_main():
required=True, nargs="+" required=True, nargs="+"
) )
parser.add_argument( parser.add_argument(
"-nc", "--new-crypto-rev", type=str, "-nc", "--new-crypto-rev", type=str, nargs="+",
help="revision for new crypto version", help=("revision for new crypto version"
"Can include repository before revision"),
) )
parser.add_argument( parser.add_argument(
"-s", "--skip-file", type=str, "-s", "--skip-file", type=str,
@ -394,9 +418,29 @@ def run_main():
new_rev = abi_args.new_rev[1] new_rev = abi_args.new_rev[1]
else: else:
raise Exception("Too many arguments passed for new version") raise Exception("Too many arguments passed for new version")
old_crypto_repo = None
old_crypto_rev = None
if abi_args.old_crypto_rev:
if len(abi_args.old_crypto_rev) == 1:
old_crypto_rev = abi_args.old_crypto_rev[0]
elif len(abi_args.old_crypto_rev) == 2:
old_crypto_repo = abi_args.old_crypto_rev[0]
old_crypto_rev = abi_args.old_crypto_rev[1]
else:
raise Exception("Too many arguments passed for old crypto version")
new_crypto_repo = None
new_crypto_rev = None
if abi_args.new_crypto_rev:
if len(abi_args.new_crypto_rev) == 1:
new_crypto_rev = abi_args.new_crypto_rev[0]
elif len(abi_args.new_crypto_rev) == 2:
new_crypto_repo = abi_args.new_crypto_rev[0]
new_crypto_rev = abi_args.new_crypto_rev[1]
else:
raise Exception("Too many arguments passed for new crypto version")
abi_check = AbiChecker( abi_check = AbiChecker(
abi_args.report_dir, old_repo, old_rev, abi_args.old_crypto_rev, abi_args.report_dir, old_repo, old_rev, old_crypto_rev,
new_repo, new_rev, abi_args.new_crypto_rev, old_crypto_repo, new_repo, new_rev, new_crypto_rev, new_crypto_repo,
abi_args.keep_all_reports, abi_args.brief, abi_args.skip_file abi_args.keep_all_reports, abi_args.brief, abi_args.skip_file
) )
return_code = abi_check.check_for_abi_changes() return_code = abi_check.check_for_abi_changes()