Add a wtf script to check if any packages are mistaken as catkin package.

Author: StefanFabian

scripts/hooks/wtf/95.check_for_ament_cmake_mistaken_as_catkin.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+try:
+    from colcon_core.plugin_system import get_package_identification_extensions
+except ImportError:
+    from colcon_core.package_identification import get_package_identification_extensions
+from colcon_core.package_identification import identify, IgnoreLocationException
+from tuda_workspace_scripts.print import print_header, print_info, print_warn
+from tuda_workspace_scripts.workspace import get_packages_in_workspace, get_package_path
+import re
+import os
+
+
+def fix() -> tuple[int, int]:
+    print_header("Checking ament_cmake packages for export")
+    identification_extensions = get_package_identification_extensions()
+    packages = get_packages_in_workspace()
+    buildtool_regex = re.compile(
+        r"<buildtool_depend>\s*([a-z0-9_]+)\s*</buildtool_depend>"
+    )
+    count_warnings = 0
+    for package in packages:
+        try:
+            path = get_package_path(package)
+            result = identify(identification_extensions, path)
+            if result.type != "ros.catkin":
+                continue
+            with open(os.path.join(path, "package.xml"), "r") as f:
+                content = f.read()
+
+            is_ament_cmake = any(
+                [
+                    match.group(1) == "ament_cmake"
+                    for match in buildtool_regex.finditer(content)
+                ]
+            )
+            if is_ament_cmake:
+                print_warn(
+                    f"Package {package} is ament_cmake but has no export tag. This leads to the package being incorrectly identified as catkin package which can cause further issues."
+                )
+                count_warnings += 1
+        except IgnoreLocationException:
+            continue
+    if count_warnings == 0:
+        print_info("All good.")
+    return count_warnings, 0
+
+
+if __name__ == "__main__":
+    fix()

scripts/wtf.py

@@ -24,25 +24,42 @@ def main():
         print_workspace_error()
         return 1
 
+    count_problems = 0
     count_fixes = 0
     hooks = list(sorted(get_hooks_for_command("wtf"), key=basename))
     # Collect all wtf scripts in hooks/wtf folders of TUDA_WSS_SCRIPTS environment variable
     for script in hooks:
         # Load script and run fix command and obtain result
         if script.endswith(".py"):
             fix = load_method_from_file(script, "fix")
-            count_fixes += fix()
+            result = fix()
+            if isinstance(result, tuple):
+                count_problems += result[0]
+                count_fixes += result[1]
+            elif isinstance(result, int):
+                count_problems += result
+                count_fixes += result
+            elif result is not None:
+                print_error(f"Unknown return type from {script}: {type(result)}")
+                continue
         elif script.endswith(".bash") or script.endswith(".sh"):
             executable = "bash" if script.endswith(".bash") else "sh"
             proc = subprocess.run([executable, script], cwd=get_workspace_root())
+            count_problems += proc.returncode
             count_fixes += proc.returncode
         else:
             print_error(f"Unknown file type for hook: {script}")
             continue
-    if count_fixes > 0:
-        print_success(f"{len(hooks)} checks have fixed {count_fixes} potential issues.")
+    if count_problems > 0:
+        print_success(
+            f"{len(hooks)} checks have fixed {count_fixes} out of {count_problems} potential issues."
+        )
     else:
         print_success(f"{len(hooks)} checks have found no potential issues.")
+    if count_problems > count_fixes:
+        print_warn(
+            f"{count_problems - count_fixes} issues could not be fixed automatically, please review these issues yourself."
+        )
 
 
 if __name__ == "__main__":