Merge pull request #22 from turlucode/develop

Version 3.0.1

Author: turlucode

.github/workflows/build_and_publish.yaml

@@ -1,4 +1,6 @@
-# More info https://github.com/orgs/python-poetry/discussions/4205
+# More info: 
+# - https://github.com/orgs/python-poetry/discussions/4205
+# - https://github.com/orgs/python-poetry/discussions/4205#discussioncomment-911983
 
 # Some info on variables:
 # github.event.workflow_run.head_branch will give you the tag or branch name here
@@ -17,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.9', '3.10', '3.11', '3.12' ]
+        python-version: [ '3.9' ]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

CHANGELOG

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.1] - 2024-07-12
+
+### Changed
+- Allow requests.get() to skip verification of the server's TLS certificate. Solves issues with self-signed certification in the chain.
+
+### Fixed
+- Wrong functionality of the 'turludock --version'
+- Wrong helper messages in the argument parser
+
 ## [3.0.0] - 2024-06-01
 
 ### Added

README.md

@@ -8,7 +8,7 @@ You can use _any_ version of ROS with _any_ Linux distribution, thanks to the am
 power of Docker!
 
 # TL;DR
-## Install tool
+## Install tool - Python >= 3.9
 ```
 pip install turludock
 ```
@@ -25,10 +25,10 @@ turludock which ros
 turludock which cuda ROS_CODENAME
 ```
 All commands have a `--help` support.
-> [Example YAML config](examples/noetic_nvidia_custom.yaml)
+> [Example YAML config](https://github.com/turlucode/ros-docker-gui/blob/master/examples/noetic_nvidia_custom.yaml)
 
 ## Run container
-[See here](#running-the-image-as-current-user) how to run a container.
+[See "Running the image (as current user)"](#running-the-image-as-current-user) on how to run a container.
 
 # Getting Started
 The idea is to have HW accelerated GUIs with Docker. Generally it has proven that this is 
@@ -71,7 +71,7 @@ Docker run --rm --runtime=nvidia --gpus all ubuntu nvidia-smi
 
 ROS related GUI programs seem to working fine. Other programs like `meld` or `vscode` also seem to be working fine. There might be cases where some GUIs do not work as expected. Feel free to open a ticket so we can look into it.
 
-For example, we know RViz is not ready for Wayland; hence we will need to use the `xcb` (X11) plugin instead of the one for Wayland and therefore we will use `QT_QPA_PLATFORM=xcb` for all QT applications. More info [here](#rviz-wayland-known-issues).
+For example, we know RViz is not ready for Wayland; hence we will need to use the `xcb` (X11) plugin instead of the one for Wayland and therefore we will use `QT_QPA_PLATFORM=xcb` for all QT applications. More info in section ["RViz Wayland known issues"](#rviz-wayland-known-issues).
 
 ## Supported ROS Images
 
@@ -109,7 +109,7 @@ turludock generate --help
 ## Tool is based on YAML configurations
 This tool uses a specific `.yaml` configuration to generate Dockerfiles or build Docker images.
 
-You can find a [typical configuration](examples/noetic_nvidia_custom.yaml) in the examples folder.
+You can find a [typical configuration](https://github.com/turlucode/ros-docker-gui/blob/master/examples/noetic_nvidia_custom.yaml) in the examples folder.
 
 ### Build or generate from presets
 This tool already provides preconfigured `.yaml` files that can be used directly to generate
@@ -142,7 +142,7 @@ No problemo, use:
 ```sh
 turludock build -c custom.yaml --tag CUSTOM_TAG
 ```
-> How to create a custom yaml configuration? [Check the example.](examples/noetic_nvidia_custom.yaml)
+> How to create a custom yaml configuration? [Check the example.](https://github.com/turlucode/ros-docker-gui/blob/master/examples/noetic_nvidia_custom.yaml)
 
 Or if you want to generate the Dockerfile and its required assets for manual build use:
 ```sh
@@ -152,7 +152,7 @@ The `FOLDER_PATH` now contains all necessary files to run a custom `Docker build
 
 # Running the image (as current user)
 ## Mesa
-> :pineapple: **Important:** Make sure your YAML configuration uses: [`gpu_driver: mesa`](examples/noetic_nvidia_custom.yaml#L15)
+> :pineapple: **Important:** Make sure your YAML configuration uses: [`gpu_driver: mesa`](https://github.com/turlucode/ros-docker-gui/blob/master/examples/noetic_nvidia_custom.yaml#L15)
 
 ### X11
 To run the ROS Docker container with X11 support use:
@@ -174,14 +174,14 @@ _Important Remarks_:
 - The `DOCKER_USER_*` variables are used to run the container as the current user.
 - Please note that you need to pass the `Xauthority` to the correct user's home directory.
 - You may need to run `xhost si:localuser:$USER` or worst case `xhost local:root` if get errors like `Error: cannot open display`.
-- See also [this section](#other-options) for other options.
+- See also section ["Other options"](#other-options) for other options.
 
 ### Wayland
-> **NOTE:** Wayland support is still a bit experimental! See [known limitations](#known-wayland-limitations).
+> **NOTE:** Wayland support is still a bit experimental! See section ["Known Wayland limitations"](#known-wayland-limitations).
 
 ROS GUI on Wayland is still problematic and that is why we are going to use [`xwayland`](https://wayland.freedesktop.org/xserver.html).
 Make sure you have installed `xhost`.
-Make also sure the user has the rights to draw to the display; [more info here](#x11-error-cannot-open-display).
+Make also sure the user has the rights to draw to the display; more info in section ["X11: Error: cannot open display"](#x11-error-cannot-open-display).
 
 To run the ROS Docker container with Wayland support use:
 
@@ -218,10 +218,10 @@ _Important Remarks_:
 - We need to start `terminator` with `dbus-launch` for Ubuntu versions less than 24.04, i.e. for versions < `jazzy`.
 - The `QT_QPA_PLATFORM=xcb` is for now intentionally as discussed.
 For this reason also the `qtwayland5` package is not installed in our Docker images.
-- See also [this section](#other-options) for other options.
+- See also section ["Other options"](#other-options) for other options.
 
 ## NVIDIA GPU
-> :pineapple: **Important:** Make sure your YAML configuration uses: [`gpu_driver: nvidia`](examples/noetic_nvidia_custom.yaml#L15)
+> :pineapple: **Important:** Make sure your YAML configuration uses: [`gpu_driver: nvidia`](https://github.com/turlucode/ros-docker-gui/blob/master/examples/noetic_nvidia_custom.yaml#L15)
 
 For machines that are using NVIDIA graphics cards we need to have the [nvidia-container-toolkit] installed.
 
@@ -246,14 +246,14 @@ _Important Remarks_:
 - Please note that you need to pass the `Xauthority` to the correct user's home directory.
 - You may need to run `xhost si:localuser:$USER` or worst case `xhost local:root` if get errors like `Error: cannot open display`
 - Adapt `--gpus all` to your needs
-- See also [this section](#other-options) for other options.
+- See also section ["Other options"](#other-options) for other options.
 
 ### Wayland
-> **NOTE:** Wayland support is still a bit experimental! See [known limitations](#known-wayland-limitations).
+> **NOTE:** Wayland support is still a bit experimental! See section ["Known Wayland limitations"](#known-wayland-limitations).
 
 ROS GUI on Wayland is still problematic and that is why we are going to use [`xwayland`](https://wayland.freedesktop.org/xserver.html).
 Make sure you have installed `xhost`.
-Make also sure the user has the rights to draw to the display; [more info here](#x11-error-cannot-open-display).
+Make also sure the user has the rights to draw to the display; more info in section ["X11: Error: cannot open display"](#x11-error-cannot-open-display).
 
 To run the ROS Docker container with X11 support use:
 ````sh
@@ -288,7 +288,7 @@ For this reason also the `qtwayland5` package is not installed in our Docker ima
 - Please note that you need to pass the `Xauthority` to the correct user's home directory.
 - You may need to run `xhost si:localuser:$USER` or worst case `xhost local:root` if get errors like `Error: cannot open display`
 - Adapt `--gpus all` to your needs
-- See also [this section](#other-options) for other options.
+- See also section ["Other options"](#other-options) for other options.
 
 ## Other options
 ### Mount your ssh-keys
@@ -396,6 +396,7 @@ After [installing poetry](https://python-poetry.org/docs/#installation) you can
 poetry install 
 ```
 After that, you are good to go!
+> Hint: You can [install pynev](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation) if you want to check multiple python versions.
 ### Coding style enforcement
 Check and enforce the coding style with static analysis:
 ```sh

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "turludock"
-version = "3.0.0"
+version = "3.0.1"
 description = "Builds ROS docker images that support GUI with either X11 or Wayland."
 authors = [
     "Athanasios <[email protected]>",

turludock/command_line_arguments_parser.py

@@ -7,6 +7,15 @@
 from turludock.helper_functions import get_program_version
 
 
+class PrintVersionAction(argparse.Action):
+    """Action class to print the version of the program."""
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        """The actual call to the action."""
+        logger.info(f"turludock v{get_program_version()}")
+        parser.exit()
+
+
 def print_command_help(args: argparse.Namespace, parser: dict) -> None:
     """Print help message for the command specified by the user.
 
@@ -83,7 +92,9 @@ def parse_command_line_args() -> Tuple[argparse.Namespace, bool]:
     parser["main"] = argparse.ArgumentParser(
         description="ROS docker container generator " + f"| turludock v{get_program_version()} | TurluCode"
     )
-    parser["main"].add_argument("--version", action="store_true", default=False, help="Enable debug mode")
+    parser["main"].add_argument(
+        "--version", action=PrintVersionAction, nargs=0, help="Show the program version and exit"
+    )
 
     subparsers = parser["main"].add_subparsers(title="Commands", description="", help="additional help", dest="command")
     subparsers.required = True  # Ensure that a sub-command is required
@@ -97,7 +108,7 @@ def parse_command_line_args() -> Tuple[argparse.Namespace, bool]:
         "-e",
         type=str,
         metavar="CONFIG_NAME",
-        help='Choose an existing pre-configuration. Check with "list-pre-configs"',
+        help='Choose an existing pre-configuration. Check with "turludock which presets"',
     )
     parser["build"].add_argument(
         "--tag", type=str, metavar="TAG", help='Name and optionally a tag (format: "name:tag")'
@@ -122,7 +133,7 @@ def parse_command_line_args() -> Tuple[argparse.Namespace, bool]:
         "-e",
         type=str,
         metavar="CONFIG_NAME",
-        help='Choose an existing pre-configuration. Check with "list-pre-configs"',
+        help='Choose an existing pre-configuration. Check with "turludock which presets"',
     )
     parser["gen"].add_argument(
         "path",

turludock/helper_functions.py

@@ -122,7 +122,11 @@ def get_llvm_supported_versions() -> List[int]:
     """
     # Get LLVM install script which contains info about the supported versions
     url = "https://apt.llvm.org/llvm.sh"
-    response = requests.get(url, timeout=10)
+    try:
+        response = requests.get(url, timeout=10, verify=False)
+    except Exception as e:
+        logger.error(f"Could not get supported LLVM versions. Requests.get() error: {e}")
+        raise
 
     # Check if the request was successful
     if response.status_code != 200: