test: Support global ignore

j3soon · Sep 16, 2024 · a7f5a28 · a7f5a28
1 parent 5008bf2
commit a7f5a28
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 0 deletions.
diff --git a/tests/lint_comp_template.py b/tests/lint_comp_template.py
@@ -24,6 +24,9 @@ def compare_file_with_template(filepath, targetpath=None, ignored_workspaces=[])
         # Skip certain cases intentionally
         if any(ws in filename for ws in ignored_workspaces):
             continue
+        # Global ignore
+        if any(ws in filename for ws in os.getenv('IGNORED_WORKSPACES', '').split()):
+            continue
         logging.debug(f"Checking: '{filename[len(repo_dir)+1:]}'...")
         content = Path(filename).read_text().splitlines(keepends=True)
         diff = list(filter(lambda x: x.startswith('- ') or x.startswith('+ ') or x.startswith('  '), difflib.ndiff(template, content)))

diff --git a/tests/lint_compose.py b/tests/lint_compose.py
@@ -9,6 +9,9 @@
 
 logging.info("Checking `compose.yaml` files...")
 for filename in glob.glob(f"{repo_dir}/*_ws/docker/compose*.yaml"):
+    # Global ignore
+    if any(ws in filename for ws in os.getenv('IGNORED_WORKSPACES', '').split()):
+        continue
     logging.debug(f"Checking: '{filename[len(repo_dir)+1:]}'...")
     content = Path(filename).read_text()
     if "version:" in content:

diff --git a/tests/lint_dockerfile.py b/tests/lint_dockerfile.py
@@ -9,6 +9,9 @@
 
 logging.info("Checking `Dockerfile` files...")
 for filename in glob.glob(f"{repo_dir}/*_ws/docker/Dockerfile*"):
+    # Global ignore
+    if any(ws in filename for ws in os.getenv('IGNORED_WORKSPACES', '').split()):
+        continue
     logging.debug(f"Checking: '{filename[len(repo_dir)+1:]}'...")
     # Skip certain cases intentionally
     if "ros1_bridge_ws" in filename:

diff --git a/tests/lint_filenames.py b/tests/lint_filenames.py
@@ -19,6 +19,9 @@
 for filename in DEFAULT_FILES:
     logging.debug(f"Checking existence of: '{filename}'...")
     for workspace_path in glob.glob(f"{repo_dir}/*_ws"):
+        # Global ignore
+        if any(ws in workspace_path for ws in os.getenv('IGNORED_WORKSPACES', '').split()):
+            continue
         if not os.path.isfile(f"{workspace_path}/{filename}"):
             # Skip certain cases intentionally
             if filename in (".gitignore", "docker/.bashrc") and os.path.basename(workspace_path) == "ros1_bridge_ws":
@@ -37,5 +40,8 @@
 for filename in OBSOLETE_FILES:
     logging.debug(f"Checking non-existence of: '{filename}'...")
     for workspace_path in glob.glob(f"{repo_dir}/*_ws"):
+        # Global ignore
+        if any(ws in workspace_path for ws in os.getenv('IGNORED_WORKSPACES', '').split()):
+            continue
         if os.path.isfile(f"{workspace_path}/{filename}"):
             raise ValueError(f"'{filename}' exists in: '{workspace_path}'")
diff --git a/tests/lint_gitignore.py b/tests/lint_gitignore.py
@@ -9,6 +9,9 @@
 
 logging.info("Checking `.gitignore` files...")
 for filename in glob.glob(f"{repo_dir}/*_ws/.gitignore"):
+    # Global ignore
+    if any(ws in filename for ws in os.getenv('IGNORED_WORKSPACES', '').split()):
+        continue
     logging.debug(f"Checking: '{filename[len(repo_dir)+1:]}'...")
     content = Path(filename).read_text()
     if "gazebo" in content:

diff --git a/tests/lint_readme.py b/tests/lint_readme.py
@@ -9,6 +9,9 @@
 
 logging.info("Checking `README.md` files...")
 for filename in glob.glob(f"{repo_dir}/*_ws/README.md"):
+    # Global ignore
+    if any(ws in filename for ws in os.getenv('IGNORED_WORKSPACES', '').split()):
+        continue
     logging.debug(f"Checking: '{filename[len(repo_dir)+1:]}'...")
     content = Path(filename).read_text()
     if "ros2-agv-essentials" in content:

diff --git a/tests/test_all.sh b/tests/test_all.sh
@@ -4,6 +4,7 @@
 # Reference: https://stackoverflow.com/q/59895
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)"
 cd $SCRIPT_DIR
+# export IGNORED_WORKSPACES="temp_ws tmp_ws"
 # Loop through all Python files in the current directory
 for script in *.py; do
   echo "Running $script..."