Merge pull request #2 from IOES-Lab/osrf-main

Osrf main

Author: woensug-choi

.github/workflows/basic-ci.yaml

@@ -9,9 +9,9 @@ jobs:
       matrix:
         python-version: ['3.8', 3.x]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Test Dependencies And Self
@@ -31,9 +31,9 @@ jobs:
       matrix:
         python-version: [3.8, '3.x']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Dependencies And Self

CHANGELOG.md

@@ -6,6 +6,40 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [v0.2.19](https://github.com/osrf/rocker/releases/tag/v0.2.19) - 2025-02-06
+
+<small>[Compare with v0.2.18](https://github.com/osrf/rocker/compare/v0.2.18...v0.2.19)</small>
+
+### Added
+
+- add rmw zenoh support to rmw plugin (#315) ([5c6e8e7](https://github.com/osrf/rocker/commit/5c6e8e7fe45b34868bb74a40610c69b293341505) by Tully Foote).
+
+- Improve robustness of image cleanup (#313) ([149d4ef
+](https://github.com/osrf/rocker/commit/149d4ef86ab5b42e7373066ba84ca1e985555011))
+
+- Enable redirecting non-interactive run console output to file (#317) ([66fe159](https://github.com/osrf/rocker/commit/66fe159e3be5a80d3ba189320bf064da84371e73))
+
+## [v0.2.18](https://github.com/osrf/rocker/releases/tag/v0.2.18) - 2025-01-10
+
+<small>[Compare with v0.2.17](https://github.com/osrf/rocker/compare/v0.2.17...v0.2.18)</small>
+
+### Added
+
+- Add UI feedback that image is being cleaned up, and how to avoid. ([3b21f78](https://github.com/osrf/rocker/commit/3b21f78fd4372a5451611a2a3e607f6941bcc398) by Tully Foote).
+- Add clear_image to ImageGenerator to enable non-persistence and not taking up all disk space. Especially for the tests. ([24dd5e1](https://github.com/osrf/rocker/commit/24dd5e1e7a6387e6c9b6c1df3644bf493f04b5c5) by Tully Foote).
+- Add support for ulimit flag (#291) ([cff5cb2](https://github.com/osrf/rocker/commit/cff5cb27c04f4db8d115493c2e2704c6a10726df) by Felipe Padula Sanches).
+- Add support for --shm-size flag (#306)
+
+### Fixed
+
+- fix test for new cuda installation package ([3449afa](https://github.com/osrf/rocker/commit/3449afabd700c4723d21c22163e73f9cbf9b358d) by Tully Foote).
+- Removed deprecation warning from volume extensino (#292)
+- Updated and simplified CUDA installation (#299 by jonazpiazu)
+
+### Removed
+
+- Remove default value for defaults (#289) ([3f02bdc](https://github.com/osrf/rocker/commit/3f02bdcc542c786eb08bdb3b324887bfa21698a2) by Tully Foote).
+
 ## [v0.2.17](https://github.com/osrf/rocker/releases/tag/v0.2.17) - 2024-08-28
 
 <small>[Compare with v0.2.16](https://github.com/osrf/rocker/compare/v0.2.16...v0.2.17)</small>

README.md

@@ -38,7 +38,7 @@ You can get full details on the extensions from the main `rocker --help` command
 - pulse -- Mount pulse audio into the container
 - ssh -- Pass through ssh access to the container.
 
-As well as access to many of the docker arguments as well such as `device`, `env`, `volume`, `name`, `network`, `ipc`, and `privileged`.
+As well as access to many of the docker arguments as well such as `device`, `env`, `volume`, `name`, `network`, `ipc`, `privileged`, and resource limits (`cpus`, `memory`, `shm-size`).
 
 ### Externally maintained extensions
 
@@ -48,8 +48,20 @@ Here's a list of public repositories with extensions.
 - mp_rocker: https://github.com/miguelprada/mp_rocker
 - ghrocker: https://github.com/tfoote/ghrocker
 - novnc_rocker: https://github.com/tfoote/novnc-rocker
+- template_rocker: https://github.com/blooop/template_rocker
+- deps_rocker: https://github.com/blooop/deps_rocker
+- pixi_rocker: https://github.com/blooop/pixi_rocker
+- conda_rocker: https://github.com/blooop/conda_rocker
+- palanteer_rocker: https://github.com/blooop/palanteer_rocker
+- lazygit_rocker: https://github.com/blooop/lazygit_rocker
 
 
+### Externally maintained rocker wrappers
+
+Here is a list of public repositories that wrap rocker and extend its functionality.  These tools are meant to be a drop in replacement of rocker so that all the existing behavior stays the same.
+
+- rockerc: https://github.com/blooop/rockerc wraps rocker to enable putting rocker commands into a yaml config file.
+- rockervsc: https://github.com/blooop/rockervsc wraps rocker so that a vscode instance attaches to the launched container.
 
 # Prerequisites
 

setup.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 import os
+
 from setuptools import setup
 
 # importlib-metadata dependency can be removed when RHEL8 and other 3.6 based systems are not in support cycles
@@ -35,17 +36,19 @@
 
 kwargs = {
     'name': 'rocker',
-    'version': '0.2.18',
+    'version': '0.2.19',
     'packages': ['rocker'],
     'package_dir': {'': 'src'},
     'package_data': {'rocker': ['templates/*.em']},
     'entry_points': {
         'console_scripts': [
             'rocker = rocker.cli:main',
             'detect_docker_image_os = rocker.cli:detect_image_os',
-	    ],
+        ],
         'rocker.extensions': [
+            'cpu_limits = rocker.constraint_extensions:CpuLimits',
             'cuda = rocker.nvidia_extension:Cuda',
+            'detach = rocker.extensions:Detach',
             'devices = rocker.extensions:Devices',
             'dev_helpers = rocker.extensions:DevHelpers',
             'env = rocker.extensions:Environment',
@@ -55,19 +58,22 @@
             'home = rocker.extensions:HomeDir',
             'hostname = rocker.extensions:Hostname',
             'ipc = rocker.extensions:Ipc',
+            'memory_limits = rocker.constraint_extensions:MemoryLimits',
             'name = rocker.extensions:Name',
             'network = rocker.extensions:Network',
             'nvidia = rocker.nvidia_extension:Nvidia',
             'port = rocker.extensions:Port',
             'privileged = rocker.extensions:Privileged',
             'pulse = rocker.extensions:PulseAudio',
             'rmw = rocker.rmw_extension:RMW',
+            'shm_size = rocker.constraint_extensions:ShmSize',
             'ssh = rocker.ssh_extension:Ssh',
+            'ulimit = rocker.ulimit_extension:Ulimit',
             'user = rocker.extensions:User',
             'volume = rocker.volume_extension:Volume',
             'x11 = rocker.nvidia_extension:X11',
         ]
-	},
+    },
     'author': 'Tully Foote',
     'author_email': 'tfoote@osrfoundation.org',
     'keywords': ['Docker'],
@@ -91,4 +97,3 @@
 }
 
 setup(**kwargs)
-

src/rocker/cli.py

@@ -16,12 +16,11 @@
 import os
 import sys
 
-from .core import DockerImageGenerator
-from .core import get_rocker_version
-from .core import RockerExtensionManager
-from .core import DependencyMissing
-from .core import ExtensionError
-
+from .core import (OPERATION_MODES, OPERATIONS_DRY_RUN, OPERATIONS_INTERACTIVE,
+                   OPERATIONS_NON_INTERACTIVE, DependencyMissing,
+                   DockerImageGenerator, ExtensionError,
+                   RockerExtensionManager, base_image_exists,
+                   get_rocker_version)
 from .os_detector import detect_os
 
 
@@ -32,9 +31,10 @@ def main():
         formatter_class=argparse.ArgumentDefaultsHelpFormatter)
     parser.add_argument('image')
     parser.add_argument('command', nargs='*', default='')
-    parser.add_argument('--noexecute', action='store_true', help='Deprecated')
+    parser.add_argument('--noexecute', action='store_true', help='Deprecated') # TODO(tfoote) add when 3.13 is minimum supported, deprecated=True 
     parser.add_argument('--nocache', action='store_true')
     parser.add_argument('--nocleanup', action='store_true', help='do not remove the docker container when stopped')
+    parser.add_argument('--persist-image', action='store_true', help='do not remove the docker image when stopped', default=False) #TODO(tfoote) Add a name to it if persisting
     parser.add_argument('--pull', action='store_true')
     parser.add_argument('--version', action='version',
         version='%(prog)s ' + get_rocker_version())
@@ -45,7 +45,7 @@ def main():
         extension_manager.extend_cli_parser(parser, default_args)
     except DependencyMissing as ex:
         # Catch errors if docker is missing or inaccessible.
-        parser.error("DependencyMissing encountered: %s" % ex)
+        parser.error(str(ex))
 
     args = parser.parse_args()
     args_dict = vars(args)
@@ -55,23 +55,76 @@ def main():
         args_dict['mode'] = OPERATIONS_DRY_RUN
         print('DEPRECATION Warning: --noexecute is deprecated for --mode dry-run please switch your usage by December 2020')
 
+    # validate_operating_mode
+    operating_mode = args_dict.get('mode')
+    # Don't try to be interactive if there's no tty
+    if not os.isatty(sys.__stdin__.fileno()):
+        if operating_mode == OPERATIONS_INTERACTIVE:
+            parser.error("No tty detected cannot operate in interactive mode")
+        elif not operating_mode:
+            print("No tty detected for stdin defaulting mode to non-interactive")
+            args_dict['mode'] = OPERATIONS_NON_INTERACTIVE
+    
+    # Check if detach extension is active and deconflict with interactive
+    detach_active = args_dict.get('detach')
+    operating_mode = args_dict.get('mode')
+    if detach_active:
+        if operating_mode == OPERATIONS_INTERACTIVE:
+            parser.error("Command line option --mode=interactive and --detach are mutually exclusive")
+        elif not operating_mode:
+            print(f"Detach extension active, defaulting mode to {OPERATIONS_NON_INTERACTIVE}")
+            args_dict['mode'] = OPERATIONS_NON_INTERACTIVE
+    # TODO(tfoote) Deal with the case of dry-run + detach
+    # Right now the printed results will include '-it'
+    # But based on testing the --detach overrides -it in docker so it's ok.
+
+    # Default to interactive if unset
+    if args_dict.get('mode') not in OPERATION_MODES:
+        print("Mode unset, defaulting to interactive")
+        args_dict['mode'] = OPERATIONS_INTERACTIVE
+
     try:
         active_extensions = extension_manager.get_active_extensions(args_dict)
     except ExtensionError as e:
         print(f"ERROR! {str(e)}")
         return 1
     print("Active extensions %s" % [e.get_name() for e in active_extensions])
 
+    # Give active extensions a chance to validate the arguments
+    for e in active_extensions:
+        try:
+            e.validate_environment(args_dict, parser)
+        except TypeError as ex:
+            import traceback
+            print("DEPRECATION WARNING: validate_environment takes 3 arguments and is now invoked. This error is indicative of using the old prototype with two arguments.")
+            traceback.print_exc()
+            print("DEPRECATION WARNING: validation of the environment not successfully acomplished, but continuing. Please fix your implmentation similar to https://github.com/osrf/rocker/pull/350"
+                  " This warning will be maintained until at least Jan 2027. On removal it will cause a traceback.")
+
+
     base_image = args.image
 
+    # Check if base image exists before proceeding (will attempt to pull if missing)
+    try:
+        if not base_image_exists(base_image, output_callback=print):
+            parser.error(f"ERROR: Base Docker image '{base_image}' not found locally and could not be pulled. Please verify the image name and try 'docker pull {base_image}' manually.")
+    except DependencyMissing as ex:
+        parser.error(f"DependencyMissing encountered: {ex}")
+
     dig = DockerImageGenerator(active_extensions, args_dict, base_image)
     exit_code = dig.build(**vars(args))
     if exit_code != 0:
         print("Build failed exiting")
+        if not (args_dict['persist_image'] or args_dict.get('image_name')):
+            dig.clear_image()
         return exit_code
     # Convert command into string
     args.command = ' '.join(args.command)
-    return dig.run(**args_dict)
+    result = dig.run(**args_dict)
+    if not (args_dict['persist_image'] or args_dict.get('image_name')):
+        print(f'Clearing Image: {dig.image_id}s\nTo not clean up use --persist-image')
+        dig.clear_image()
+    return result
 
 
 def detect_image_os():