Automated gtest formatting checks

Jenkinsfile

@@ -598,6 +598,19 @@ pipeline {
                         buildHipClangJobAndReboot(setup_cmd: "", build_cmd: "", execute_cmd: execute_cmd, needs_gpu:false, needs_reboot:false)
                     }
                 }
+                stage('Check GTest Format') {
+                agent { label rocmnode("nogpu") }
+                when {
+                    changeset "**/test/gtest/**"
+                }
+                steps {
+                    script {
+                        checkout scm
+                        sh 'cd ./test/utils && python3 gtest_formating_checks.py'
+                        }
+                    }
+                }
+
                 stage('HipNoGPU Debug Build Test') {
                     when {
                         beforeAgent true

README.md

@@ -280,6 +280,12 @@ To build and run a single test, use the following code:
 cmake --build . --config Release --target test_tensor
 ./bin/test_tensor
 ```
+Check gtests formats
+
+```shell
+cd ./test/utils && python3 gtest_formating_checks.py
+```
+
 
 ## Formatting the code
 

test/utils/gtest_formating_checks.py

@@ -0,0 +1,116 @@
+import os
+import re
+import logging
+
+logging.basicConfig(level=logging.INFO, format='%(levelname)s: %(message)s')
+
+FOLDER_PATH = "../../test/gtest"
+
+# Ignore list: Add test names or file paths you want to exclude
+IGNORE_LIST = {
+    "CPU_MIOpenDriverRegressionBigTensorTest_FP32",
+    "../../test/gtest/reduce_custom_fp32.cpp",
+    "../../test/gtest/binary_tensor_ops.cpp",
+    "../../test/gtest/layout_transpose.cpp",
+    "../../test/gtest/graphapi_conv_bias_res_add_activ_fwd.cpp",
+    "../../test/gtest/unary_tensor_ops.cpp",
+    "../../test/gtest/graphapi_operation_rng.cpp"
+}
+
+# Valid enums and Regex for validation
+VALID_HW_TYPES = {"CPU", "GPU"}
+VALID_DATATYPES = {"FP8", "FP16", "FP32", "FP64", "BFP16", "BFP8", "I64", "I32", "I16", "I8", "NONE"}
+TESTSUITE_REGEX = re.compile(
+    r"^(CPU|GPU)_[A-Za-z0-9]+(?:_[A-Za-z0-9]+)*_(" + "|".join(VALID_DATATYPES) + r")$"
+)
+TEST_P_REGEX = re.compile(r"\bTEST_P\(\s*([^,]+),\s*([^)]+)\)")
+INSTANTIATE_TEST_REGEX = re.compile(r"\bINSTANTIATE_TEST_SUITE_P\(\s*([^,]+),\s*([^,]+),")
+ALLOW_UNINSTANTIATED_REGEX = re.compile(r"\bGTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST\(\s*([^)]+)\)")
+TEST_TYPE_REGEX = re.compile(r"^(Smoke|Full|Perf|Unit)([A-Za-z0-9]*)?$")
+
+
+def analyze_tests(folder_path):
+    errors = []
+
+    for root, _, files in os.walk(folder_path):
+        for file in files:
+            if file.endswith(".cpp"):
+                file_path = os.path.join(root, file)
+
+                if file_path in IGNORE_LIST:
+                    logging.info(f"Skipping ignored file: {file_path}")
+                    continue
+
+                with open(file_path, "r") as f:
+                    lines = f.readlines()
+
+                # Store all content in a single string for regex matching
+                content = "".join(lines)
+
+                # Extract TEST_P, INSTANTIATE_TEST_SUITE_P, and GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST
+                test_p_matches = [(m.start(), m.groups()) for m in TEST_P_REGEX.finditer(content)]
+                instantiate_matches = [(m.start(), m.groups()) for m in INSTANTIATE_TEST_REGEX.finditer(content)]
+                allow_uninstantiated_matches = [(m.start(), m.group(1)) for m in ALLOW_UNINSTANTIATED_REGEX.finditer(content)]
+
+                # Map line numbers to errors
+                def get_line_number(position):
+                    return sum(1 for i, line in enumerate(lines) if position >= len("".join(lines[:i + 1])))
+
+                test_p_suites = {suite: (info, get_line_number(pos)) for pos, (suite, info) in test_p_matches}
+                instantiated_suites = {suite: (test_type, get_line_number(pos)) for pos, (test_type, suite) in instantiate_matches}
+                allowed_uninstantiated_suites = {(suite, get_line_number(pos)) for pos, suite in allow_uninstantiated_matches}
+
+                # Validate TEST_P suites
+                for suite, (info, line) in test_p_suites.items():
+                    if suite in IGNORE_LIST:
+                        logging.info(f"Skipping ignored test suite: {suite}")
+                        continue
+
+                    if not TESTSUITE_REGEX.match(suite):
+                        errors.append(f"{file_path}:{line}: Invalid TESTSUITE_NAME '{suite}' in TEST_P.")
+
+                    if suite not in instantiated_suites and suite not in [s[0] for s in allowed_uninstantiated_suites]:
+                        errors.append(
+                            f"{file_path}:{line}: Test '{suite}.{info}' does not have a matching "
+                            f"INSTANTIATE_TEST_SUITE_P or GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST."
+                        )
+
+                # Validate instantiated suites
+                for suite, (test_type, line) in instantiated_suites.items():
+                    normalized_test_type = test_type.replace("\\", "").strip()
+
+                    if suite in IGNORE_LIST:
+                        logging.info(f"Skipping ignored instantiated suite: {suite}")
+                        continue
+
+                    if suite not in test_p_suites:
+                        errors.append(f"{file_path}:{line}: INSTANTIATE_TEST_SUITE_P references non-existent TESTSUITE_NAME '{suite}'.")
+                    if not TEST_TYPE_REGEX.match(normalized_test_type):
+                        errors.append(f"{file_path}:{line}: Invalid TEST_TYPE '{test_type}' in INSTANTIATE_TEST_SUITE_P.")
+
+                # Validate allowed uninstantiated suites
+                for suite, line in allowed_uninstantiated_suites:
+                    if suite in IGNORE_LIST:
+                        logging.info(f"Skipping ignored allowed uninstantiated suite: {suite}")
+                        continue
+
+                    if suite not in test_p_suites:
+                        errors.append(f"{file_path}:{line}: GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST references non-existent TESTSUITE_NAME '{suite}'.")
+
+    return errors
+
+
+def main():
+    errors = analyze_tests(FOLDER_PATH)
+
+    if errors:
+        logging.error("The following issues were found:")
+        for error in errors:
+            logging.error(f"  {error}")
+        raise ValueError("Validation failed. See the errors above.")
+    else:
+        logging.info("All tests meet the criteria.")
+
+
+if __name__ == "__main__":
+    main()