Implement clean command

Author: daymxn

ci/fireci/fireci/ci_utils.py

@@ -61,3 +61,9 @@ def gcloud_identity_token():
   """Returns an identity token with the current gcloud service account."""
   result = subprocess.run(['gcloud', 'auth', 'print-identity-token'], stdout=subprocess.PIPE, check=True)
   return result.stdout.decode('utf-8').strip()
+
+def get_projects(file_path: str = "subprojects.cfg") -> list[str]:
+  """Parses the specified file for a list of projects in the repo."""
+  with open(file_path, 'r') as file:
+    stripped_lines = [line.strip() for line in file]
+    return [line for line in stripped_lines if line and not line.startswith('#')]

ci/fireci/fireci/dir_utils.py

@@ -15,6 +15,9 @@
 import contextlib
 import logging
 import os
+import pathlib
+import shutil
+import glob
 
 _logger = logging.getLogger('fireci.dir_utils')
 
@@ -30,3 +33,28 @@ def chdir(directory):
   finally:
     _logger.debug(f'Restoring directory to: {original_dir} ...')
     os.chdir(original_dir)
+
+def rmdir(path: str) -> bool:
+  """Recursively deletes a directory, and returns a boolean indicating if the dir was deleted."""
+  dir = pathlib.Path(path)
+  if not dir.exists():
+    _logger.debug(f"Directory already deleted: {dir}")
+    return False
+
+  _logger.debug(f"Deleting directory: {dir}")
+  shutil.rmtree(dir)
+  return True
+
+def rmglob(pattern: str) -> int:
+  """Deletes all files that match a given pattern, and returns the amount of (root) files deleted"""
+  files = 0
+  for file in glob.glob(os.path.expanduser(pattern)):
+    path = pathlib.Path(file)
+    if path.is_dir():
+      rmdir(path)
+    else:
+      _logger.debug(f"Deleting file: {path}")
+      os.remove(path)
+    files += 1
+
+  return files

ci/fireci/fireciplugins/clean.py

@@ -0,0 +1,108 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import click
+import logging
+
+from fireci import ci_command
+from fireci import ci_utils
+from fireci import dir_utils
+
+log = logging.getLogger('fireci.clean')
+
+@click.argument("projects", 
+  nargs=-1,
+  type=click.Path(), 
+  required=False
+)
+@click.option('--gradle/--no-gradle', default=False, help="Delete the local .gradle caches.")
+@click.option('--build/--no-build', default=True, help="Delete the local build caches.")
+@click.option('--transforms/--no-transforms', default=False, help="Delete the system-wide transforms cache.")
+@click.option('--build-cache/--no-build-cache', default=False, help="Delete the system-wide build cache.")
+
+@click.option('--deep/--no-deep', default=False, help="Delete all of the system-wide files for gradle.")
+@click.option('--cache/--no-cache', default=False, help="Delete all of the system-wide caches for gradle.")
+@ci_command(epilog="""
+  Clean a subset of projects:
+
+  \b
+  $ fireci clean firebase-common
+  $ fireci clean firebase-common firebase-vertexai
+
+  Clean all projects:
+
+  $ fireci clean
+""")
+def clean(projects, gradle, build, transforms, build_cache, deep, cache):
+  """
+  Delete files cached by gradle.
+
+  Alternative to the standard `gradlew clean`, which runs outside the scope of gradle,
+  and provides deeper cache cleaning capabilities.
+  """
+  if not projects:
+    log.debug("No projects specified, so we're defaulting to all projects.")
+    projects = ci_utils.get_projects()
+
+  cache = cache or deep
+  gradle = gradle or cache
+
+  cleaners = []
+
+  if build:
+    cleaners.append(delete_build)
+  if gradle:
+    cleaners.append(delete_build)
+
+  results = [call_and_sum(projects, cleaner) for cleaner in cleaners]
+  delete_count = sum(map(int, results))
+
+  cleaners = []
+
+  if deep:
+    cleaners.append(delete_deep)
+  elif cache:
+    cleaners.append(delete_cache)
+  else:
+    if transforms:
+      cleaners.append(delete_transforms)
+    if build_cache:
+      cleaners.append(delete_build_cache)
+
+  results = [cleaner() for cleaner in cleaners]
+  delete_count += sum(map(int, results))
+
+  log.info(f"Deleted {delete_count} directories/files")
+
+def call_and_sum(variables, func) -> int:
+  results = map(lambda var: func(var), variables)
+  return sum(map(int, results))
+
+def delete_build(dir: str) -> bool:
+  return dir_utils.rmdir(f"{dir}/build")
+
+def delete_gradle(dir: str) -> bool:
+  return dir_utils.rmdir(f"{dir}/.gradle")
+
+def delete_transforms() -> int:
+  return dir_utils.rmglob("~/.gradle/caches/transforms-*")
+
+def delete_build_cache() -> int:
+  return dir_utils.rmglob("~/.gradle/caches/build-cache-*")
+
+def delete_deep() -> bool:
+  return dir_utils.rmdir("~/.gradle")
+
+def delete_cache() -> bool:
+  return dir_utils.rmdir("~/.gradle/caches")