Add pre-commit hook to ban usage of unittest.TestCase in unit tests

.pre-commit-config.yaml

@@ -908,6 +908,12 @@ repos:
         entry: ./scripts/ci/pre_commit/pre_commit_www_lint.py
         additional_dependencies: ['yarn@1.22.19']
         pass_filenames: false
+      - id: check-tests-unittest-testcase
+        name: Check that unit tests do not inherit from unittest.TestCase
+        entry: ./scripts/ci/pre_commit/pre_commit_unittest_testcase.py
+        language: python
+        pass_filenames: true
+        files: ^tests/.*\.py$
         ## ADD MOST PRE-COMMITS ABOVE THAT LINE
         # The below pre-commits are those requiring CI image to be built
       - id: mypy-dev

STATIC_CODE_CHECKS.rst

@@ -227,6 +227,8 @@ require Breeze Docker image to be build locally.
 +-----------------------------------------------------------+------------------------------------------------------------------+---------+
 | check-system-tests-tocs                                   | Check that system tests is properly added                        |         |
 +-----------------------------------------------------------+------------------------------------------------------------------+---------+
+| check-tests-unittest-testcase                             | Check that unit tests do not inherit from unittest.TestCase      |         |
++-----------------------------------------------------------+------------------------------------------------------------------+---------+
 | check-urlparse-usage-in-code                              | Don't use urlparse in code                                       |         |
 +-----------------------------------------------------------+------------------------------------------------------------------+---------+
 | check-xml                                                 | Check XML files with xmllint                                     |         |

dev/breeze/src/airflow_breeze/pre_commit_ids.py

@@ -67,6 +67,7 @@
     "check-start-date-not-used-in-defaults",
     "check-system-tests-present",
     "check-system-tests-tocs",
+    "check-tests-unittest-testcase",
     "check-urlparse-usage-in-code",
     "check-xml",
     "codespell",

images/breeze/output-commands-hash.txt

@@ -55,7 +55,7 @@ setup:version:123b462a421884dc2320ffc5e54b2478
 setup:26f37743534e14f5aad5300aad920301
 shell:bd3e004a92ebcec8feb40fc5cd95872d
 start-airflow:ee5066f1420a489864b48bc4e5e472da
-static-checks:543f0c776d0f198e80a0f75058445bb2
+static-checks:806eafbc99a76ebba6178b0b461b3499
 stop:e5aa686b4e53707ced4039d8414d5cd6
 testing:docker-compose-tests:b86c044b24138af0659a05ed6331576c
 testing:helm-tests:936cf28fd84ce4ff5113795fdae9624b

scripts/ci/pre_commit/pre_commit_unittest_testcase.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+from __future__ import annotations
+
+import ast
+import pathlib
+import sys
+
+
+def check_test_file(file: str) -> int:
+    node = ast.parse(pathlib.Path(file).read_text("utf-8"), file)
+
+    found = 0
+    classes = [c for c in node.body if isinstance(c, ast.ClassDef)]
+    for c in classes:
+        # Some classes are returned as an ast.Attribute, some as an ast.Name object. Not quite sure why
+        parent_classes = [base.attr for base in c.bases if isinstance(base, ast.Attribute)]
+        parent_classes.extend([base.id for base in c.bases if isinstance(base, ast.Name)])
+
+        if "TestCase" in parent_classes:
+            found += 1
+            print(f"The class {c.name} inherits from TestCase, please use pytest instead")
+
+    return found
+
+
+def main(*args: str) -> int:
+    return sum([check_test_file(file) for file in args[1:]])
+
+
+if __name__ == "__main__":
+    sys.exit(main(*sys.argv))