Add a GH test to verify the generated code is clean (#206)

* Add --no-update-api-spec to neptune_api_codegen.cli

* Add a GH test to verify the generated code is clean

* Install pre-commit hooks in the install pre-commit phase

* --help update

Author: gabrys

.github/workflows/tests-e2e.yml

@@ -17,7 +17,7 @@ on:
       - 'tests/e2e/**'
       - 'dev_requirements.txt'
       - 'pyproject.toml'
-      - '.github/workflows/tests-e2e.yml'
+      - '.github/**'
 
 jobs:
   test:

.github/workflows/tests-neptune-api-codegen.yml

@@ -0,0 +1,45 @@
+name: Verify generated neptune_api code is clean
+
+permissions:
+  checks: write
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - dev/.*
+  pull_request:
+    paths:
+      - 'src/**'
+      - 'tests/e2e/**'
+      - 'dev_requirements.txt'
+      - 'pyproject.toml'
+      - '.github/**'
+
+jobs:
+  test:
+    runs-on: tools-gha-runners
+    timeout-minutes: 5
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install pre-commit
+        run: |
+          python -m pip install pre-commit &&
+          pre-commit install-hooks
+
+      - name: Run codegen and verify no changes
+        run: |
+          cd src &&
+          python -m neptune_api_codegen.cli --no-update-api-spec --update &&
+          ( pre-commit run --all-files >/dev/null || true ; ) &&
+          pre-commit run --all-files &&
+          [ -z "$(git status --porcelain)" ] &&
+          echo "✅ Repository is clean after regenerating neptune_api code"

src/neptune_api_codegen/cli.py

@@ -48,6 +48,12 @@ def build_parser() -> argparse.ArgumentParser:
         help="Path to the neptune backend repository. If not specified, it will be auto-detected.",
         default=None,
     )
+    parser.add_argument(
+        "--no-update-api-spec",
+        action="store_true",
+        help="Do not fetch new API spec files (swagger, proto) from Neptune repo.",
+        default=False,
+    )
     parser.add_argument(
         "--update",
         action="store_true",
@@ -140,14 +146,17 @@ def main() -> None:
     # Project root
     project_root = find_project_root()
 
-    # Neptune repo path
-    if args.neptune_repo_path is None:
-        args.neptune_repo_path = find_neptune_repo(project_root)
-    elif not is_neptune_repo(args.neptune_repo_path):
-        raise RuntimeError(
-            f"The specified neptune repo path {args.neptune_repo_path} is not a valid neptune backend repository."
-        )
-    print_err(f"Using neptune backend repository at:              {rel(args.neptune_repo_path)}")
+    update_api_spec = not args.no_update_api_spec
+
+    if update_api_spec:
+        # Neptune repo path
+        if args.neptune_repo_path is None:
+            args.neptune_repo_path = find_neptune_repo(project_root)
+        elif not is_neptune_repo(args.neptune_repo_path):
+            raise RuntimeError(
+                f"The specified neptune repo path {args.neptune_repo_path} is not a valid neptune backend repository."
+            )
+        print_err(f"Using neptune backend repository at:              {rel(args.neptune_repo_path)}")
 
     # Target and backup dirs
     rand_bit = int(random() * 1e4)
@@ -174,12 +183,16 @@ def main() -> None:
         apispec_dir.mkdir()
         generated_py_dir.mkdir()
 
-        print_err(f"Copying proto directories and swagger files to:   {rel(apispec_dir)}")
-        copy_swagger_files(
-            neptune_repo_path=args.neptune_repo_path,
-            target_dir=apispec_dir,
-            verbose=args.verbose,
-        )
+        if update_api_spec:
+            print_err(f"Copying proto directories and swagger files to:   {rel(apispec_dir)}")
+            copy_swagger_files(
+                neptune_repo_path=args.neptune_repo_path,
+                target_dir=apispec_dir,
+                verbose=args.verbose,
+            )
+        else:
+            print_err(f"Using proto directories and swagger files from:   {rel(target_apispec)}")
+            shutil.copytree(target_apispec, apispec_dir, dirs_exist_ok=True)
 
         print_err(f"Generating OpenAPI clients in:                    {rel(generated_py_dir)}")
         run_in_docker(