Add presubmit script
Bug: b/287529705
Change-Id: I36b5f926b311af80e7498514150400b4e4f2bb3c
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/152193
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Reviewed-by: Darren Krahn <dkrahn@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
diff --git a/tools/open_dice_tools/presubmit.py b/tools/open_dice_tools/presubmit.py
index 241f8ac..1b1160e 100644
--- a/tools/open_dice_tools/presubmit.py
+++ b/tools/open_dice_tools/presubmit.py
@@ -11,3 +11,126 @@
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
+"""Presubmit script."""
+
+import argparse
+import logging
+import os
+from pathlib import Path
+import re
+import sys
+
+import pw_cli.log
+import pw_presubmit
+from pw_presubmit import (
+ PresubmitContext,
+ build,
+ cli,
+ format_code,
+ git_repo,
+ inclusive_language,
+ install_hook,
+ keep_sorted,
+ python_checks,
+)
+
+_LOG = logging.getLogger(__name__)
+
+# Set up variables for key project paths.
+try:
+ PROJECT_ROOT = Path(os.environ['PW_PROJECT_ROOT'])
+except KeyError:
+ print(
+ "ERROR: The presubmit checks must be run in the Open Dice project's "
+ 'root directory',
+ file=sys.stderr,
+ )
+ sys.exit(2)
+
+PIGWEED_ROOT = PROJECT_ROOT / 'third_party' / 'pigweed' / 'src'
+
+# Rerun the build if files with these extensions change.
+_BUILD_EXTENSIONS = frozenset(
+ ['.rst', '.gn', '.gni', *format_code.C_FORMAT.extensions]
+)
+
+
+default_build = build.GnGenNinja(name='default_build')
+
+
+OTHER_CHECKS = (build.gn_gen_check,)
+
+QUICK = (
+ default_build,
+ format_code.presubmit_checks(),
+)
+
+LINTFORMAT = (
+ # keep-sorted: start
+ format_code.presubmit_checks(),
+ inclusive_language.presubmit_check,
+ keep_sorted.presubmit_check,
+ python_checks.gn_python_lint,
+ # keep-sorted: end
+)
+
+FULL = (
+ QUICK, # Add all checks from the 'quick' program
+ LINTFORMAT,
+ # Use the upstream Python checks, with custom path filters applied.
+ python_checks.gn_python_check,
+)
+
+PROGRAMS = pw_presubmit.Programs(
+ # keep-sorted: start
+ full=FULL,
+ lintformat=LINTFORMAT,
+ other_checks=OTHER_CHECKS,
+ quick=QUICK,
+ # keep-sorted: end
+)
+
+
+def run(install: bool, exclude: list, **presubmit_args) -> int:
+ """Process the --install argument then invoke pw_presubmit."""
+
+ # Install the presubmit Git pre-push hook, if requested.
+ if install:
+ install_hook.install_git_hook(
+ 'pre-push',
+ [
+ 'python',
+ '-m',
+ 'sample_project_tools.presubmit_checks',
+ '--base',
+ 'origin/main..HEAD',
+ '--program',
+ 'quick',
+ ],
+ )
+ return 0
+
+ repos = git_repo.discover_submodules(superproject_dir=PROJECT_ROOT)
+ return cli.run(
+ root=PROJECT_ROOT, repositories=repos, exclude=exclude, **presubmit_args
+ )
+
+
+def main() -> int:
+ """Run the presubmit checks for this repository."""
+ parser = argparse.ArgumentParser(description=__doc__)
+ cli.add_arguments(parser, PROGRAMS, 'quick')
+
+ # Define an option for installing a Git pre-push hook for this script.
+ parser.add_argument(
+ '--install',
+ action='store_true',
+ help='Install the presubmit as a Git pre-push hook and exit.',
+ )
+
+ return run(**vars(parser.parse_args()))
+
+
+if __name__ == '__main__':
+ pw_cli.log.install(logging.INFO)
+ sys.exit(main())
