[infra] Scripts for building fuzzers with CIFuzz (#3207)

1 files changed, 54 insertions, 27 deletions

diff --git a/infra/base-images/base-builder/detect_repo.py b/infra/base-images/base-builder/detect_repo.py
index d7974ca5e..f57947e7e 100644
--- a/infra/base-images/base-builder/detect_repo.py
+++ b/infra/base-images/base-builder/detect_repo.py
@@ -16,9 +16,11 @@ inside of an OSS-Fuzz project.
 
 Example Usage:
 
-  python detect_repo.py --src_dir /src --example_commit b534f03eecd8a109db2b085ab24d419b6486de97
+  python detect_repo.py --src_dir /src --example_commit
+    b534f03eecd8a109db2b085ab24d419b6486de97
 
-Prints the location of the git remote repo as well as the repos name seperated by a space.
+Prints the location of the git remote repo as well as the repo's name
+seperated by a space.
 
   https://github.com/VirusTotal/yara.git yara
 
@@ -29,26 +31,36 @@ import subprocess
 
 
 def main():
-  """Function to get a git repos information based on its commit."""
+  """Function to get a git repo's url and name referenced by OSS-Fuzz
+  Dockerfile.
+
+  Raises:
+    ValueError when a commit or a ref is not provided.
+  """
   parser = argparse.ArgumentParser(
-      description='Finds a specific git repo in an oss-fuzz projects docker file.'
-  )
+      description=
+      'Finds a specific git repo in an oss-fuzz project\'s docker file.')
   parser.add_argument(
       '--src_dir',
-      help='The location of the oss-fuzz projects source directory',
-      required=True)
-  parser.add_argument(
-      '--example_commit',
-      help='A commit SHA refrencing the projects main repo',
+      help='The location of an oss-fuzz project\'s source directory.',
       required=True)
+  parser.add_argument('--repo_name', help='The name of the git repo.')
+  parser.add_argument('--example_commit',
+                      help='A commit SHA referencing the project\'s main repo.')
+
   args = parser.parse_args()
+  if not args.repo_name and not args.example_commit:
+    raise ValueError(
+        'Requires an example commit or a repo name to find repo location.')
   for single_dir in os.listdir(args.src_dir):
     full_path = os.path.join(args.src_dir, single_dir)
     if not os.path.isdir(full_path):
       continue
-    if check_for_commit(
-        os.path.join(args.src_dir, full_path), args.example_commit):
-      print('Detected repo: %s %s' % (get_repo(full_path), single_dir.rstrip()))
+    if args.example_commit and check_for_commit(full_path, args.example_commit):
+      print('Detected repo:', get_repo(full_path), single_dir)
+      return
+    if args.repo_name and check_for_repo_name(full_path, args.repo_name):
+      print('Detected repo:', get_repo(full_path), single_dir)
       return
   print('No git repos with specific commit: %s found in %s' %
         (args.example_commit, args.src_dir))
@@ -61,26 +73,41 @@ def get_repo(repo_path):
     repo_path: The directory on the image where the git repo exists.
 
   Returns:
-    The repo location or None
+    The repo location or None.
   """
-  output, return_code = execute(
-      ['git', 'config', '--get', 'remote.origin.url'],
-      location=repo_path,
-      check_result=True)
+  output, return_code = execute(['git', 'config', '--get', 'remote.origin.url'],
+                                location=repo_path,
+                                check_result=True)
   if return_code == 0 and output:
     return output.rstrip()
   return None
 
 
+def check_for_repo_name(repo_path, repo_name):
+  """Check to see if the repo_name matches the remote repository repo name.
+
+  Args:
+    repo_path: The directory of the git repo.
+    repo_name: The name of the target git repo.
+  """
+  if not os.path.exists(os.path.join(repo_path, '.git')):
+    return False
+
+  out, _ = execute(['git', 'config', '--get', 'remote.origin.url'],
+                   location=repo_path)
+  out = out.split('/')[-1].replace('.git', '').rstrip()
+  return out == repo_name
+
+
 def check_for_commit(repo_path, commit):
   """Checks a directory for a specific commit.
 
   Args:
-    repo_path: The name of the directory to test for the commit
-    commit: The commit SHA to check for
+    repo_path: The name of the directory to test for the commit.
+    commit: The commit SHA to check for.
 
   Returns:
-    True if directory contains that commit
+    True if directory contains that commit.
   """
 
   # Check if valid git repo.
@@ -93,7 +120,7 @@ def check_for_commit(repo_path, commit):
 
   # Check if commit is in history.
   _, return_code = execute(['git', 'cat-file', '-e', commit],
-                               location=repo_path)
+                           location=repo_path)
   return return_code == 0
 
 
@@ -101,15 +128,15 @@ def execute(command, location, check_result=False):
   """Runs a shell command in the specified directory location.
 
   Args:
-    command: The command as a list to be run
-    location: The directory the command is run in
-    check_result: Should an exception be thrown on failed command
+    command: The command as a list to be run.
+    location: The directory the command is run in.
+    check_result: Should an exception be thrown on failed command.
 
   Returns:
-    The stdout of the command, the error code
+    The stdout of the command, the error code.
 
   Raises:
-    RuntimeError: running a command resulted in an error
+    RuntimeError: running a command resulted in an error.
   """
   process = subprocess.Popen(command, stdout=subprocess.PIPE, cwd=location)
   output, err = process.communicate()