Merge branch 'main' into better-error-message-for-missing-config

Author: ayin21

.devcontainer/Dockerfile

@@ -1,4 +1,8 @@
-FROM ros:iron
+FROM ros:jazzy
+
+ARG user=bitbots
+ARG uid=1000
+ARG gid=1000
 
 # Basic Utilities
 ENV DEBIAN_FRONTEND=noninteractive
@@ -54,41 +58,51 @@ RUN apt update -y \
 RUN apt-get install -y \
   python3-rosdep \
   python3-vcstool \
-  ros-iron-camera-calibration \
-  ros-iron-desktop \
-  ros-iron-joint-state-publisher-gui \
-  ros-iron-plotjuggler \
-  ros-iron-plotjuggler-msgs \
-  ros-iron-plotjuggler-ros \
-  ros-iron-rmw-cyclonedds-cpp \
-  ros-iron-rqt-robot-monitor \
-  ros-iron-soccer-vision-3d-rviz-markers
-
-# Update pip and install colcon-clean
-RUN pip3 install pip -U
-
-# Install colcon extensions / patches
-RUN python3 -m pip install \
-  git+https://github.com/ruffsl/colcon-clean \
-  git+https://github.com/timonegk/colcon-core.git@colors \
-  git+https://github.com/timonegk/colcon-notification.git@colors \
-  git+https://github.com/timonegk/colcon-output.git@colors
+  python3-virtualenv \
+  ros-jazzy-camera-calibration \
+  ros-jazzy-desktop \
+  ros-jazzy-joint-state-publisher-gui \
+  ros-jazzy-plotjuggler \
+  ros-jazzy-plotjuggler-msgs \
+  ros-jazzy-plotjuggler-ros \
+  ros-jazzy-rmw-cyclonedds-cpp \
+  ros-jazzy-rqt-robot-monitor \
+  ros-jazzy-soccer-vision-3d-rviz-markers
 
 # Set zsh as default shell
 SHELL ["/bin/zsh", "-c"]
 
-# Create home directory and colcon workspace
-RUN mkdir -p "/root/colcon_ws"
+# Remove the users group, because when it exists on the host system
+# the devcontainer will not dynamically update the containerUser GID,
+# when the host user is part of the users group.
+# Then create a bitbots user with home directory and add allow it to use sudo
+RUN groupdel users \
+  && userdel -r ubuntu \
+  && useradd -m -U -u "$uid" -G sudo -s /bin/zsh $user \
+  && groupmod -g "$gid" $user \
+  && echo "$user ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
+
+USER $user
+
+# Install pip colcon extensions / patches as user
+RUN python3 -m pip install --user --break-system-packages \
+    git+https://github.com/ruffsl/colcon-clean \
+    git+https://github.com/timonegk/colcon-core.git@colors \
+    git+https://github.com/timonegk/colcon-notification.git@colors \
+    git+https://github.com/timonegk/colcon-output.git@colors
+
+# Create colcon workspace
+RUN mkdir -p /home/$user/colcon_ws/src
 
 # Install oh-my-zsh for pretty terminal
 RUN sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" && \
-  git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
+  git clone https://github.com/zsh-users/zsh-autosuggestions "${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/zsh-autosuggestions"
 
-# Add zshrc
-COPY zshrc "/root/.zshrc"
+# Add zshrc to bitbots home directory
+COPY --chown=$user:$user zshrc /home/$user/.zshrc
 
 # This is required for sharing Xauthority
 ENV QT_X11_NO_MITSHM=1
 
 # Switch to the workspace directory
-WORKDIR "/root/colcon_ws"
+WORKDIR /home/$user/colcon_ws

.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
-  "name": "Bit-Bots Iron Dev",
+  "name": "Bit-Bots Jazzy Dev",
 
   "build": { "dockerfile": "Dockerfile" },
 
@@ -14,14 +14,16 @@
     "vscode": {
       "settings": {
         "terminal.integrated.defaultProfile.linux": "zsh",
-        "terminal.integrated.profiles.linux": { "zsh": { "path": "/bin/zsh" } }
+        "terminal.integrated.profiles.linux": { "zsh": { "path": "/bin/zsh" } },
+        "dev.containers.copyGitConfig": false,
+        "dev.containers.gitCredentialHelperConfigLocation": "none"
       },
       "extensions": ["ms-iot.vscode-ros"]
     }
   },
 
-  "workspaceMount": "type=bind,source=${localWorkspaceFolder},target=/root/colcon_ws/src/bitbots_main",
-  "workspaceFolder": "/root/colcon_ws/src/bitbots_main",
+  "workspaceMount": "type=bind,source=${localWorkspaceFolder},target=/home/bitbots/colcon_ws/src/bitbots_main",
+  "workspaceFolder": "/home/bitbots/colcon_ws/src/bitbots_main",
 
   "mounts": [
     "type=bind,source=${localEnv:HOME},target=/srv/host_home,consistency=cached"

.devcontainer/zshrc

@@ -50,12 +50,12 @@ bindkey "^[[1;5D" backward-word
 
 
 # Settings for the prompt to show that we are in a docker container
-export PROMPT="%K{black} 🐋 %K{blue}%F{black}%/ %f%k%F{blue}%f "  # Prefix the prompt with DOCKER
+export PROMPT="%K{black} 🐋 %K{blue}%F{black} %~ %f%k%F{blue}%f "  # Prefix the prompt with DOCKER
 
 # >>> bit-bots initialize >>>
 
 # Ignore some deprecation warnings
-export PYTHONWARNINGS=ignore:::setuptools.command.install,ignore:::setuptools.command.easy_install,ignore:::pkg_resources
+export PYTHONWARNINGS="ignore:::setuptools.command.install,ignore:::setuptools.command.easy_install,ignore:::pkg_resources,ignore:easy_install command is deprecated,ignore:setup.py install is deprecated"
 
 # Limit ROS 2 communication to localhost (can be overridden when needed)
 export ROS_DOMAIN_ID=24

.git-blame-ignore-revs

@@ -11,3 +11,4 @@ f29fb619aef9f416cbbdc74ec77c23423dcefe07
 3b9f322183bed2cb271bf6bd07d803a93c398c3e
 ae9fbef74c50ba1e462d1b76da16779c76aa0d5b
 476e75e3f3d17c35ac89b17f513d93078687d613
+cd3280273363807e1b5df2ade0138d48178cb06b

.github/workflows/ci.yml

@@ -4,17 +4,27 @@ on:
     - cron: '0 0 * * *'
   push:
 
+env:
+  PYTHONWARNINGS: "ignore:::setuptools.command.install,ignore:::setuptools.command.easy_install,ignore:::pkg_resources,ignore:easy_install command is deprecated,ignore:setup.py install is deprecated"
+
 jobs:
   build:
     runs-on: ubuntu-latest
     container:
-      image: ubuntu:jammy
+      image: ubuntu:noble
 
     steps:
       - name: Cancel outdated jobs
         uses: fkirc/skip-duplicate-actions@v5
         with:
           cancel_others: 'true'
+     
+     # Remove comments to spawn an interactive debigging ssh shell in the ci 
+     #- name: Setup tmate session
+     #   uses: mxschmitt/action-tmate@v3
+     #   with:   
+     #     detached: true
+      
       - name: Set up ROS ecosystem
         uses: ros-tooling/setup-ros@v0.7
 
@@ -30,7 +40,9 @@ jobs:
           echo "PATH=$PATH:/github/home/.local/bin" >> "$GITHUB_ENV"
 
       - name: Pull source code for libraries and install dependencies
-        run: make install HTTPS=true ARGS="--ci"
+        run: |
+          sudo apt-get remove -y python3-pytest-repeat  #TODO remove once the upstream apt package reports the correct version on the newest pip version
+          make install HTTPS=true ARGS="--ci"
 
       - name: Set up colcon workspace
         run: |
@@ -39,14 +51,14 @@ jobs:
 
       - name: Build packages
         run: |
-          . /opt/ros/iron/setup.sh
+          . /opt/ros/jazzy/setup.sh
           colcon build --symlink-install
         working-directory: /colcon_ws
 
       - name: Test packages
         run: |
           # Source workspace
-          . /opt/ros/iron/setup.sh
+          . /opt/ros/jazzy/setup.sh
           . install/setup.sh
           # Run tests for all packages
           colcon test --event-handlers console_direct+ --return-code-on-test-failure --parallel-workers 1

.github/workflows/pre-commit.yml

@@ -7,10 +7,10 @@ on:
 
 jobs:
   pre-commit:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
       - name: Install cppcheck
         run: sudo apt install cppcheck -y
-      - uses: pre-commit/action@v3.0.0
+      - uses: pre-commit/action@v3.0.1

.gitignore

@@ -97,8 +97,6 @@ qtcreator-*
 # Emacs
 .#*
 
-# Catkin custom files
-CATKIN_IGNORE
 ### Python template
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -220,10 +218,11 @@ doku/*
 # library subdirectories
 /lib/
 
-# Path to the protocol buffer definitions, which are a diffrerent repository and managed by vcstool
+# Path to the protocol buffer definitions, which are a different repository and managed by vcstool
 /bitbots_team_communication/bitbots_team_communication/bitbots_team_communication/RobocupProtocol
 # Protobuf generated file
 /bitbots_team_communication/bitbots_team_communication/bitbots_team_communication/robocup_extension_pb2.py
+/bitbots_team_communication/bitbots_team_communication/bitbots_team_communication/robocup_extension_pb2.pyi
 
 # Workspace git status file from the deploy tool
 **/workspace_status.json

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.6
+    rev: v0.9.6
     hooks:
       - id: ruff
         args:
@@ -16,18 +16,18 @@ repos:
       - id: cppcheck
         args:
           - "--inline-suppr"
-          - "--suppress=missingInclude"
+          - "--suppress=missingIncludeSystem"
           - "--suppress=unmatchedSuppression"
           - "--suppress=unusedFunction"
           - "--suppress=unusedStructMember"
           - "--suppress=useStlAlgorithm"
   - repo: https://github.com/cheshirekow/cmake-format-precommit
-    rev: v0.6.10
+    rev: v0.6.13
     hooks:
       - id: cmake-format
       - id: cmake-lint
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-merge-conflict
       - id: check-toml

.vscode/settings.json

@@ -117,6 +117,7 @@
         "unpenalize",
         "unpenalized",
         "urdf",
+        "vcstool",
         "walkready",
         "wandb",
         "webots",
@@ -219,13 +220,13 @@
     },
     // Tell the ROS extension where to find the setup.bash
     // This also utilizes the COLCON_WS environment variable, which needs to be set
-    "ros.distro": "iron",
+    "ros.distro": "jazzy",
     "search.useIgnoreFiles": false,
     "python.autoComplete.extraPaths": [
-        "/opt/ros/iron/lib/python3.10/site-packages"
+        "/opt/ros/jazzy/lib/python3.12/site-packages"
     ],
     "python.analysis.extraPaths": [
-        "/opt/ros/iron/lib/python3.10/site-packages"
+        "/opt/ros/jazzy/lib/python3.12/site-packages"
     ],
     "cmake.configureOnOpen": false,
     "editor.formatOnSave": true,
@@ -237,4 +238,8 @@
     "[json]": {
         "editor.defaultFormatter": "vscode.json-language-features"
     },
+    "makefile.configureOnOpen": true,
+    "[jsonc]": {
+        "editor.defaultFormatter": "vscode.json-language-features"
+    },
 }

Makefile

@@ -17,8 +17,8 @@ install-no-root: pull-init update-no-root
 
 pip:
 	# Install and upgrade pip dependencies
-	pip install --upgrade pip --user
-	pip install --upgrade -r requirements/dev.txt --user -v
+	pip install --upgrade pip --user --break-system-packages -v
+	pip install --upgrade -r requirements/dev.txt --user --break-system-packages -v
 
 pre-commit:
 	# Install pre-commit hooks for all submodules that have a .pre-commit-config.yaml file
@@ -91,8 +91,8 @@ rosdep:
 	# Initialize rosdep if not already done
 	[ -f /etc/ros/rosdep/sources.list.d/20-default.list ] || sudo rosdep init
 	# Update rosdep and install dependencies from meta directory
-	rosdep update --include-eol-distros
-	rosdep install --from-paths . --ignore-src --rosdistro iron -y
+	rosdep update
+	rosdep install --from-paths . --ignore-src --rosdistro jazzy -y
 
 status:
 	# Show status of all repositories