Merge pull request #435 from chrisburr/show-client-diff-on-failure

Show the diff if client regneration fails

Author: chrisburr

diracx-client/tests/test_regenerate.py

@@ -70,9 +70,14 @@ def test_regenerate_client(test_client, tmp_path):
     print("Running pre-commit...")
     subprocess.run(cmd, check=False, cwd=repo_root)
     print("Re-running pre-commit...")
-    subprocess.run(cmd, check=True, cwd=repo_root)
-    if repo.is_dirty(path=client_src):
-        raise AssertionError("Client was regenerated with changes")
+    proc = subprocess.run(cmd, check=False, cwd=repo_root)
+    if proc.returncode == 0 and not repo.is_dirty(path=client_src):
+        return
+    # Show the diff to aid debugging
+    print(repo.git.diff(client_src))
+    if proc.returncode != 0:
+        raise AssertionError("Pre-commit failed")
+    raise AssertionError("Client was regenerated with changes")
 
 
 if __name__ == "__main__":

extensions/gubbins/gubbins-client/tests/test_regenerate.py

@@ -75,15 +75,21 @@ def test_regenerate_client(test_client, tmp_path):
     # and use it
     # cmd += [f"--use=@autorest/python@{AUTOREST_VERSION}"]
 
-    subprocess.run(cmd, check=True)  # noqa
+    # ruff: noqa: S603
+    subprocess.run(cmd, check=True)
 
     cmd = ["pre-commit", "run", "--all-files"]
     print("Running pre-commit...")
-    subprocess.run(cmd, check=False, cwd=repo_root)  # noqa
+    subprocess.run(cmd, check=False, cwd=repo_root)
     print("Re-running pre-commit...")
-    subprocess.run(cmd, check=True, cwd=repo_root)  # noqa
-    if repo.is_dirty(path=client_src):
-        raise AssertionError("Client was regenerated with changes")
+    proc = subprocess.run(cmd, check=False, cwd=repo_root)
+    if proc.returncode == 0 and not repo.is_dirty(path=client_src):
+        return
+    # Show the diff to aid debugging using gitpython
+    print(repo.git.diff(client_src))
+    if proc.returncode != 0:
+        raise AssertionError("Pre-commit failed")
+    raise AssertionError("Client was regenerated with changes")
 
 
 if __name__ == "__main__":