[pull] main from osrf:main

.github/workflows/basic-ci.yaml

@@ -4,25 +4,52 @@ on: [push, pull_request]
 jobs:
   basic_ci:
     name: Basic CI
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
-        python-version: [3.8]
+        python-version: ['3.8', 3.x]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install Dependencies And Self
+    - name: Install Test Dependencies And Self
       run: |
         python -m pip install --upgrade pip setuptools wheel
-        # Workaround for https://github.com/docker/docker-py/issues/2807
-        python -m pip install six
         python -m pip install -e .[test] codecov pytest-cov
     - name: Run headless tests
-      uses: GabrielBB/xvfb-action@v1
+      uses: coactions/setup-xvfb@v1
       with:
         run: python -m pytest -s -v --cov=rocker -m "not nvidia"
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v3
+  cli_smoke_tests:
+    name: CLI smoke tests
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: [3.8, '3.x']
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies And Self
+      run: |
+        python -m pip install --upgrade pip setuptools wheel
+        python -m pip install -e .
+    - name: Check os_detector script
+      run: |
+        detect_docker_image_os ubuntu
+    - name: Check detector help
+      run: |
+        detect_docker_image_os ubuntu -h
+    - name: Check main runs
+      run: |
+        rocker ubuntu 'true'
+    - name: Check rocker help
+      run: |
+        rocker -h
+

README.md

@@ -21,7 +21,7 @@ Whereas with `rocker` you can invoke your specific plugins and it will use multi
 
 
 
-## Know extensions
+## Known extensions
 
 Rocker supports extensions via entry points there are some built in but you can add your own.
 
@@ -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`, and `privileged`.
+As well as access to many of the docker arguments as well such as `device`, `env`, `volume`, `name`, `network`, `ipc`, and `privileged`.
 
 ### Externally maintained extensions
 
@@ -47,8 +47,21 @@ Here's a list of public repositories with extensions.
 - Off-your-rocker: https://github.com/sloretz/off-your-rocker
 - 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
 
@@ -153,7 +166,7 @@ Then you can run pytest.
 Notes:
 
 - Make sure to use the python3 instance of pytest from inside the environment.
-- The tests include an nvidia test which assumes you're using a machine with an nvidia gpu.
+- The tests include an nvidia test which assumes you're using a machine with an nvidia gpu. To skip them use `-m "not nvidia"`
 
 
 # Example usage
@@ -169,15 +182,6 @@ After the ekf converges,
 
 You can send a takeoff command and then click to command the vehicle to fly to a point on the map.
 
-
-## Fly a plane
-
-Example usage with a plane 
-
-    rocker --nvidia --x11 --user --home --pull --pulse tfoote/drone_demo roslaunch sitl_launcher plane_demo.launch world_name:=worlds/plane.world gui:=false
-
-In QGroundControl go ahead and make a mission, upload it, and then start the mission.
-
 ## ROS 2 rviz
 
     rocker --nvidia --x11 osrf/ros:crystal-desktop rviz2

codecov.yml

@@ -0,0 +1,3 @@
+comment:
+  layout: "reach, diff, flags, files"
+  behavior: default

setup.py

@@ -3,10 +3,14 @@
 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
+
 install_requires = [
     'empy',
+    'importlib-metadata; python_version < "3.8"',
     'pexpect',
     'packaging',
+    'urllib3',
 ]
 
 # docker API used to be in a package called `docker-py` before the 2.0 release
@@ -31,35 +35,41 @@
 
 kwargs = {
     'name': 'rocker',
-    'version': '0.2.10',
+    'version': '0.2.18',
     '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': [
             'cuda = rocker.nvidia_extension:Cuda',
             'devices = rocker.extensions:Devices',
             'dev_helpers = rocker.extensions:DevHelpers',
             'env = rocker.extensions:Environment',
             'expose = rocker.extensions:Expose',
             'git = rocker.git_extension:Git',
+            'group_add = rocker.extensions:GroupAdd',
             'home = rocker.extensions:HomeDir',
+            'hostname = rocker.extensions:Hostname',
+            'ipc = rocker.extensions:Ipc',
             '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.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': '[email protected]',
     'keywords': ['Docker'],
@@ -83,4 +93,3 @@
 }
 
 setup(**kwargs)
-

src/rocker/cli.py

@@ -20,6 +20,7 @@
 from .core import get_rocker_version
 from .core import RockerExtensionManager
 from .core import DependencyMissing
+from .core import ExtensionError
 
 from .os_detector import detect_os
 
@@ -34,6 +35,7 @@ def main():
     parser.add_argument('--noexecute', action='store_true', help='Deprecated')
     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())
@@ -54,9 +56,11 @@ 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')
 
-    active_extensions = extension_manager.get_active_extensions(args_dict)
-    # Force user to end if present otherwise it will break other extensions
-    active_extensions.sort(key=lambda e:e.get_name().startswith('user'))
+    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])
 
     base_image = args.image
@@ -65,10 +69,16 @@ def main():
     exit_code = dig.build(**vars(args))
     if exit_code != 0:
         print("Build failed exiting")
+        if not args_dict['persist_image']:
+            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']:
+        print(f'Clearing Image: {dig.image_id}s\nTo not clean up use --persist-images')
+        dig.clear_image()
+    return result
 
 
 def detect_image_os():