fix: Remove placeholders that are mistakenly added to certain workspace; Rename placeholders and add comment-only placeholders

j3soon · j3soon · commit de4743aed9ea · 2024-08-22T16:19:20.000+08:00
diff --git a/cartographer_ws/docker/.bashrc b/cartographer_ws/docker/.bashrc
@@ -26,6 +26,5 @@ if [ ! -f $ROS2_WS/install/setup.bash ]; then
     echo "Workspace built."
 fi
 # TODO: Source other workspace environments as underlay
-MULTILINE_PLACEHOLDER
 # Source workspace environment
 source $ROS2_WS/install/setup.bash
diff --git a/rtabmap_ws/docker/.bashrc b/rtabmap_ws/docker/.bashrc
@@ -26,6 +26,5 @@ if [ ! -f $ROS2_WS/install/setup.bash ]; then
     echo "Workspace built."
 fi
 # TODO: Source other workspace environments as underlay
-MULTILINE_PLACEHOLDER
 # Source workspace environment
 source $ROS2_WS/install/setup.bash
diff --git a/tests/diff_base/.devcontainer/devcontainer.json b/tests/diff_base/.devcontainer/devcontainer.json
@@ -1,10 +1,10 @@
 /* Reference: https://aka.ms/devcontainer.json */
 {
-    "name": "PLACEHOLDER",
+    "name": "{PLACEHOLDER}",
     "dockerComposeFile": "../docker/compose.yaml",
-    "service": "PLACEHOLDER-ws",
+    "service": "{PLACEHOLDER}-ws",
     // Workspace settings
-    "workspaceFolder": "/home/ros2-essentials/PLACEHOLDER_ws",
+    "workspaceFolder": "/home/ros2-essentials/{PLACEHOLDER}_ws",
     // Vscode extensions
     "customizations": {
         "vscode": {
diff --git a/tests/diff_base/.gitignore b/tests/diff_base/.gitignore
@@ -5,4 +5,4 @@
 /build
 /install
 /log
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
diff --git a/tests/diff_base/docker/.bashrc b/tests/diff_base/docker/.bashrc
@@ -19,13 +19,13 @@ if [ ! -f $ROS2_WS/install/setup.bash ]; then
     # TODO: If command `arch` outputs `aarch64`, consider adding `--packages-ignore <package>` to ignore x86 packages
     # Ref: https://docs.ros.org/en/humble/Tutorials/Beginner-Client-Libraries/Creating-Your-First-ROS2-Package.html
     if [ $(arch) == "aarch64" ]; then
-        colcon build --symlink-installPLACEHOLDER
+        colcon build --symlink-install{PLACEHOLDER}
     else
         colcon build --symlink-install
     fi
     echo "Workspace built."
 fi
 # TODO: Source other workspace environments as underlay
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
 # Source workspace environment
 source $ROS2_WS/install/setup.bash
diff --git a/tests/diff_base/docker/.dockerignore b/tests/diff_base/docker/.dockerignore
@@ -1,3 +1,3 @@
 *
 !.bashrc
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
diff --git a/tests/diff_base/docker/Dockerfile b/tests/diff_base/docker/Dockerfile
@@ -1,14 +1,14 @@
-# Base Image: PLACEHOLDER
-FROM PLACEHOLDER AS amd64
-# Base Image: PLACEHOLDER
-FROM PLACEHOLDER AS arm64
+# Base Image: {PLACEHOLDER}
+FROM {PLACEHOLDER} AS amd64
+# Base Image: {PLACEHOLDER}
+FROM {PLACEHOLDER} AS arm64
 
 # Use docker automatic platform args to select the base image.
 # It may be `arm64` or `amd64` depending on the platform.
 # Ref: https://docs.docker.com/reference/dockerfile/#automatic-platform-args-in-the-global-scope
 FROM $TARGETARCH
 ARG TARGETARCH
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
 # Arguments for the default user
 ARG USERNAME=user
 ARG USER_UID=1000
@@ -84,14 +84,14 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=private \
 #     apt-get update && apt-get install -y \
 #     $OTHER_PACKAGES \
 #     && rm -rf /var/lib/apt/lists/*
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
 USER $USERNAME
 # Create Gazebo cache directory with correct ownership to avoid permission issues after volume mount
 RUN mkdir /home/$USERNAME/.gazebo
 # TODO: Run additional commands as non-root user here
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
 COPY .bashrc /home/$USERNAME/.bashrc
 # TODO: Copy additional files here
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
 ENTRYPOINT []
 CMD ["/bin/bash"]
diff --git a/tests/diff_base/docker/compose.yaml b/tests/diff_base/docker/compose.yaml
@@ -1,21 +1,21 @@
 services:
-  PLACEHOLDER-ws:
+  {PLACEHOLDER}-ws:
     build:
       context: .
       dockerfile: Dockerfile
       # TODO: Specify the target platform to build the image, otherwise it will build for the host platform.
       # Reference: https://docs.docker.com/compose/compose-file/build/#platforms
       # platforms:
       #   - "linux/arm64"
-    image: j3soon/ros2-PLACEHOLDER-ws
-    container_name: ros2-PLACEHOLDER-ws
+    image: j3soon/ros2-{PLACEHOLDER}-ws
+    container_name: ros2-{PLACEHOLDER}-ws
     stdin_open: true
     tty: true
     # TODO: Comment the line below if the workspace don't need to communicate through `/dev/*` devices.
-    PLACEHOLDERprivileged: true
+    {PLACEHOLDER_#}privileged: true
     command: /bin/bash
     network_mode: host
-    working_dir: /home/ros2-essentials/PLACEHOLDER_ws
+    working_dir: /home/ros2-essentials/{PLACEHOLDER}_ws
     environment:
       # Set X11 server environment variable for existing display.
       - DISPLAY=$DISPLAY
@@ -28,18 +28,18 @@ services:
       - ROS_DOMAIN_ID=0
         # Domain ID is set to 0 to allow communication through ros1_bridge.
       - RCUTILS_COLORIZED_OUTPUT=1
-      - ROS2_WS=/home/ros2-essentials/PLACEHOLDER_ws
+      - ROS2_WS=/home/ros2-essentials/{PLACEHOLDER}_ws
       # TODO: Set more environment variables.
-MULTILINE_PLACEHOLDER
+{PLACEHOLDER_MULTILINE}
     # TODO: Uncomment the lines below to enable GPU support.
-    # # Reference: https://docs.docker.com/compose/gpu-support/
-    # deploy:
-    #   resources:
-    #     reservations:
-    #       devices:
-    #         - driver: nvidia
-    #           count: all
-    #           capabilities: [ gpu ]
+    {PLACEHOLDER_#}# Reference: https://docs.docker.com/compose/gpu-support/
+    {PLACEHOLDER_#}deploy:
+    {PLACEHOLDER_#}  resources:
+    {PLACEHOLDER_#}    reservations:
+    {PLACEHOLDER_#}      devices:
+    {PLACEHOLDER_#}        - driver: nvidia
+    {PLACEHOLDER_#}          count: all
+    {PLACEHOLDER_#}          capabilities: [ gpu ]
     volumes:
       # Mount local timezone into container.
       # Reference: https://stackoverflow.com/questions/57607381/how-do-i-change-timezone-in-a-docker-container
@@ -51,13 +51,13 @@ MULTILINE_PLACEHOLDER
       - $HOME/.Xauthority:/home/user/.Xauthority
         # Xauthority is mounted to allow X11 forwarding for remote display.
       # Mount Direct Rendering Infrastructure (DRI) for hardware acceleration support such as OpenGL.
-      PLACEHOLDER- /dev/dri:/dev/dri
+      {PLACEHOLDER_#}- /dev/dri:/dev/dri
       # Mount sound card to prevent Gazebo warning.
-      PLACEHOLDER- /dev/snd:/dev/snd
+      {PLACEHOLDER_#}- /dev/snd:/dev/snd
       # Mount shared memory for ROS2 communication.
-      PLACEHOLDER- /dev/shm:/dev/shm
+      {PLACEHOLDER_#}- /dev/shm:/dev/shm
       # TODO: Uncomment the line below and comment out the three entries above to enable USB support.
-      PLACEHOLDER- /dev:/dev
+      {PLACEHOLDER_#}- /dev:/dev
       # Mount Gazebo models directory to reuse models downloaded during first launch.
       # Reference: https://answers.ros.org/question/365658
       # Note that this volume is shared among all workspaces.
diff --git a/tests/lint_comp_template.py b/tests/lint_comp_template.py
@@ -9,6 +9,12 @@
 current_dir = os.path.dirname(os.path.realpath(__file__))
 repo_dir = os.path.realpath(f"{current_dir}/..")
 
+def get_regexp_from_template_line(line):
+    regexp = re.escape(line) \
+        .replace(r'\{PLACEHOLDER_\#\}', '(# )?') \
+        .replace(r'\{PLACEHOLDER\}', '.*')
+    return f"^{regexp}$"
+
 def compare_file_with_template(filepath, targetpath=None, ignored_workspaces=[]):
     targetpath = targetpath or filepath
     logging.info(f"Checking if '{targetpath}' matches the template...")
@@ -28,7 +34,7 @@ def error(msg, i):
             raise ValueError(f"'{filepath}' does not match the template: '{filename}'")
         i = 0
         while i < len(diff):
-            if "- MULTILINE_PLACEHOLDER" in diff[i]:  # don't use exact match to avoid cases without trailing newline
+            if "- {PLACEHOLDER_MULTILINE}" in diff[i]:  # don't use exact match to avoid cases without trailing newline
                 i += 1
                 while i < len(diff) and diff[i].startswith('+ '):
                     i += 1
@@ -47,9 +53,9 @@ def error(msg, i):
                     j += 1
                 k = 0
                 while k < len(stack) and j+k < len(diff) and diff[j+k].startswith('+ '):
-                    if "- MULTILINE_PLACEHOLDER" in diff[i+k]:
-                        raise error("MULTILINE_PLACEHOLDER is not supported in this case yet", i)
-                    regexp = "^" + re.escape(diff[i+k][2:]).replace('PLACEHOLDER', '.*') + "$"
+                    if "- {PLACEHOLDER_MULTILINE}" in diff[i+k]:
+                        raise error("{PLACEHOLDER_MULTILINE} is not supported in this case yet", i)
+                    regexp = get_regexp_from_template_line(diff[i+k][2:])
                     if not re.match(regexp, diff[j+k][2:]):
                         error("Expected line deletion and addition to differ only in the placeholder", i)
                     k += 1
@@ -63,9 +69,9 @@ def error(msg, i):
                     j += 1
                 k = 0
                 while k < len(stack) and j+k < len(diff) and diff[j+k].startswith('- '):
-                    if "- MULTILINE_PLACEHOLDER" in diff[j+k]:
-                        raise error("MULTILINE_PLACEHOLDER is not supported in this case yet", i)
-                    regexp = "^" + re.escape(diff[j+k][2:]).replace('PLACEHOLDER', '.*') + "$"
+                    if "- {PLACEHOLDER_MULTILINE}" in diff[j+k]:
+                        raise error("{PLACEHOLDER_MULTILINE} is not supported in this case yet", i)
+                    regexp = get_regexp_from_template_line(diff[j+k][2:])
                     if not re.match(regexp, diff[i+k][2:]):
                         error("Expected line deletion and addition to differ only in the placeholder", i)
                     k += 1
diff --git a/vlp_ws/docker/.bashrc b/vlp_ws/docker/.bashrc
@@ -26,6 +26,5 @@ if [ ! -f $ROS2_WS/install/setup.bash ]; then
     echo "Workspace built."
 fi
 # TODO: Source other workspace environments as underlay
-MULTILINE_PLACEHOLDER
 # Source workspace environment
 source $ROS2_WS/install/setup.bash

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`*`
`2`	`2`	`!.bashrc`
`3`		`-MULTILINE_PLACEHOLDER`
	`3`	`+{PLACEHOLDER_MULTILINE}`