beaker-docker 3.1.1 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20458b7863defa8965bb32ebf8509c39cb8879b6a3d77c738fe76c55ad80b7b0
-  data.tar.gz: de353c5f2b2a75edefed8e4926eeb07792717173db68cfa3081fa5e747920a17
+  metadata.gz: 9f1ee5ab53b86ffda7555b85471e7427d811d910ae943fdc60618dc71247780d
+  data.tar.gz: b88d72d90e95dbe4a986cf9444fedd2eca6eeee3c59efea73ad1e044afe72da0
 SHA512:
-  metadata.gz: b17e5c8962e810565652fd962a7240c2d328e3ac08793da48416040fa7b4351863b85d0e0043518c57e1b31db7cd5c433103e394bc262504fae6f7d42485c4f2
-  data.tar.gz: 38928914ecb2b8b5bbfc9fff9dacfce07a852d0c937e22b5ebea97dcccba77a7442ca0c9c61ad23bd0b224a6c26037cf2f9b08e34a984c39fe0aa3207b5e4e30
+  metadata.gz: 404f1d4b7d9c644583a76d4e4be545c613126d80be170b464a69a64d54abaec614697b728ffb52685d0c29bdca0970f2df3d9cfb6711ac3071d7433e3be196fa
+  data.tar.gz: c0634e2844595b1e691042ad3f65041fffa9a218e47c47214ddb9eff0de1d1ba4569a692a2c27d74cd09927be3a609e1648f825caf34e06b68ce68cdc8f7b7fc

data/.github/workflows/release.yml

@@ -15,16 +15,16 @@ jobs:
     name: Build the gem
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - name: Install Ruby
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: 'ruby'
       - name: Build gem
         shell: bash
         run: gem build --verbose *.gemspec
       - name: Upload gem to GitHub cache
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
           name: gem-artifact
           path: '*.gem'
@@ -39,7 +39,7 @@ jobs:
       contents: write # clone repo and create release
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           name: gem-artifact
       - name: Create Release
@@ -56,7 +56,7 @@ jobs:
       packages: write # publish to rubygems.pkg.github.com
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           name: gem-artifact
       - name: Publish gem to GitHub packages
@@ -73,10 +73,10 @@ jobs:
       id-token: write # rubygems.org authentication
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           name: gem-artifact
-      - uses: rubygems/configure-rubygems-credentials@v1.0.0
+      - uses: rubygems/configure-rubygems-credentials@dc5a8d8553e6ee01fc26761a49e99e733d17954a # v2.1.0
       - name: Publish gem to rubygems.org
         shell: bash
         run: gem push *.gem
@@ -92,11 +92,11 @@ jobs:
       - release-to-rubygems
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           name: gem-artifact
       - name: Install Ruby
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: 'ruby'
       - name: Wait for release to propagate

data/.github/workflows/test.yml

@@ -16,16 +16,16 @@ jobs:
     outputs:
       ruby: ${{ steps.ruby.outputs.versions }}
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - name: Install Ruby 4.0
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: '4.0'
           bundler-cache: true
       - name: Run Rubocop
         run: bundle exec rake rubocop
       - id: ruby
-        uses: voxpupuli/ruby-version@v2
+        uses: voxpupuli/ruby-version@be0467ce7366d206b2e87f5b7a032a030120b7cb # 2.0.0
 
   rspec:
     runs-on: ubuntu-24.04
@@ -36,9 +36,9 @@ jobs:
         ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
     name: RSpec - Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - name: Install Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
@@ -56,9 +56,9 @@ jobs:
         ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
     name: Docker on Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - name: Install Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
@@ -71,7 +71,7 @@ jobs:
   #  needs: rubocop_and_matrix
   #  name: Docker - Beaker in container connection test
   #  steps:
-  #    - uses: actions/checkout@v6
+  #    - uses: actions/checkout@v7
   #    # use this and not container key from gha to not have a docker network from github
   #    - name: Run Beaker in docker container
   #      uses: addnab/docker-run-action@v3
@@ -99,9 +99,9 @@ jobs:
         run: |
           sudo systemctl stop docker.service docker.socket && systemctl start --user podman.socket
           echo "DOCKER_HOST=unix:///run/user/$(id -u)/podman/podman.sock" >> "$GITHUB_ENV"
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - name: Install Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
@@ -109,6 +109,7 @@ jobs:
         run: bundle exec rake test:acceptance
 
   tests:
+    if: always()
     needs:
       - rubocop_and_matrix
       - docker
@@ -118,4 +119,7 @@ jobs:
     runs-on: ubuntu-24.04
     name: Test suite
     steps:
-      - run: echo Test suite completed
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [3.1.3](https://github.com/voxpupuli/beaker-docker/tree/3.1.3) (2026-08-21)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/3.1.2...3.1.3)
+
+**Fixed bugs:**
+
+- Fix ssh connection routing under Podman: network naming and container detection [\#194](https://github.com/voxpupuli/beaker-docker/pull/194) ([miharp](https://github.com/miharp))
+
+**Closed issues:**
+
+- `in_container?` only checks `/.dockerenv`, so the gateway connection path never triggers under Podman [\#193](https://github.com/voxpupuli/beaker-docker/issues/193)
+- `DOCKER_IN_DOCKER=true` crashes with NoMethodError on Podman 5: `Networks[NetworkMode]` lookup assumes Docker's network naming [\#192](https://github.com/voxpupuli/beaker-docker/issues/192)
+
+## [3.1.2](https://github.com/voxpupuli/beaker-docker/tree/3.1.2) (2026-02-27)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/3.1.1...3.1.2)
+
+**Fixed bugs:**
+
+- fix: complete the support for docker-ce \>= v29 network configuration [\#183](https://github.com/voxpupuli/beaker-docker/pull/183) ([mxey](https://github.com/mxey))
+- Handle empty IPAddress when setting host vm\_ip [\#182](https://github.com/voxpupuli/beaker-docker/pull/182) ([uvNikita](https://github.com/uvNikita))
+
 ## [3.1.1](https://github.com/voxpupuli/beaker-docker/tree/3.1.1) (2026-01-31)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/3.1.0...3.1.1)

data/docker.md

@@ -200,4 +200,17 @@ The tests should then run as normal from there.
 
 
 ### Docker-in-Docker (dind) ###
-If you are using docker in docker, set the environment variable DOCKER_IN_DOCKER=true. Beaker-docker will then not try to use the DOCKER_HOST address for the ssh connection to the containers.
+If beaker itself runs inside a container (for example in a CI job) and the test
+containers are created as siblings on the same host, beaker-docker detects
+this automatically (via `/.dockerenv` on docker or `/run/.containerenv` on
+podman) and connects through the bridge gateway and each test container's
+published ssh port. No configuration is needed as long as the published port
+is reachable via the gateway address.
+
+If gateway routing does not work in your environment (ssh port not published
+to the host, or a firewall blocking traffic to the gateway), set the
+environment variable DOCKER_IN_DOCKER=true. Beaker-docker then ignores the
+DOCKER_HOST address and published ports, and connects to each test
+container's network IP directly; make sure the beaker container is attached
+to the same network as the test containers. This works with podman as well
+as docker, and is also enabled automatically under WSL.

data/lib/beaker/hypervisor/docker.rb

@@ -151,6 +151,10 @@ module Beaker
       elsif in_container? && !nested_docker?
         # Swarm or local docker host
         gw = network_settings['Gateway']
+
+        # also handle scenarios where network_settings['Gateway'] is not set (e.g. docker-ce >= v29)
+        gw = container_network(network_settings, host_config)['Gateway'] if gw.nil? || gw.empty?
+
         ip = gw unless gw.nil? || gw.empty?
       else
         # The many faces of container networking
@@ -166,7 +170,7 @@ module Beaker
         unless ip && port
           ip = network_settings['IPAddress'] # podman
           # also handle scenarios where network_settings['IPAddress'] is not set (e.g. docker-ce >= v29)
-          ip = network_settings['Networks'][host_config['NetworkMode']]['IPAddress'] if ip.nil? || ip.empty?
+          ip = container_network(network_settings, host_config)['IPAddress'] if ip.nil? || ip.empty?
           port = (ip && !ip.empty?) ? 22 : nil
         end
 
@@ -356,7 +360,11 @@ module Beaker
         @logger.debug("node available as ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no root@#{ip} -p #{port}")
         host['docker_container_id'] = container.id
         host['docker_image_id'] = image.id
-        host['vm_ip'] = container.json['NetworkSettings']['IPAddress'].to_s
+        host_config = container.json['HostConfig']
+        vm_ip = container.json['NetworkSettings']['IPAddress']
+        # handle scenarios where network_settings['IPAddress'] is not set (e.g. docker-ce >= v29)
+        vm_ip = container_network(container.json['NetworkSettings'], host_config)['IPAddress'] if vm_ip.nil? || vm_ip.empty?
+        host['vm_ip'] = vm_ip.to_s
 
         def host.reboot
           @logger.warn('Rebooting containers is ineffective...ignoring')
@@ -455,6 +463,15 @@ module Beaker
 
     private
 
+    # Look up the network a container is attached to. Podman's Docker-compatible
+    # API reports HostConfig.NetworkMode as 'bridge' but keys
+    # NetworkSettings.Networks by the actual network name, so fall back to the
+    # first attached network when the NetworkMode key is missing.
+    def container_network(network_settings, host_config)
+      networks = network_settings['Networks'] || {}
+      networks[host_config['NetworkMode']] || networks.values.first || {}
+    end
+
     def root_password
       'root'
     end
@@ -631,9 +648,9 @@ module Beaker
       nil
     end
 
-    # return true if we are inside a docker container
+    # return true if we are inside a docker or podman container
     def in_container?
-      File.file?('/.dockerenv')
+      File.file?('/.dockerenv') || File.file?('/run/.containerenv')
     end
   end
 end

data/lib/beaker-docker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BeakerDocker
-  VERSION = '3.1.1'
+  VERSION = '3.1.3'
 end

data/spec/beaker/hypervisor/docker_spec.rb

@@ -686,17 +686,27 @@ module Beaker
                   expect(hosts[0]['port']).to eq 8022
                 end
               end
+
+              it 'connects to gateway ip inside a podman container' do
+                FakeFS do
+                  FileUtils.mkdir_p('/run')
+                  FileUtils.touch('/run/.containerenv')
+                  docker.provision
+
+                  expect(hosts[0]['ip']).to eq '192.0.2.254'
+                  expect(hosts[0]['port']).to eq 8022
+                end
+              end
             end
           end
 
-          context 'when IPAddress is empty but available in Networks' do
+          context 'when using newer docker-ce where IPs are only in Networks' do
             let(:container_config) do
               {
                 'HostConfig' => {
                   'NetworkMode' => 'bridge',
                 },
                 'NetworkSettings' => {
-                  'IPAddress' => '',
                   'Ports' => {
                     '22/tcp' => [
                       {
@@ -705,9 +715,9 @@ module Beaker
                       },
                     ],
                   },
-                  'Gateway' => '192.0.2.254',
                   'Networks' => {
                     'bridge' => {
+                      'Gateway' => '192.0.2.254',
                       'IPAddress' => '192.0.2.10',
                     },
                   },
@@ -723,8 +733,67 @@ module Beaker
 
                 expect(hosts[0]['ip']).to eq '192.0.2.10'
                 expect(hosts[0]['port']).to eq 22
+                expect(hosts[0]['vm_ip']).to eq '192.0.2.10'
               end
             end
+
+            it 'stills finds gateway' do
+              ENV['DOCKER_IN_DOCKER'] = nil
+              ENV['DOCKER_HOST'] = nil
+              FakeFS do
+                FileUtils.touch('/.dockerenv')
+                docker.provision
+
+                expect(hosts[0]['ip']).to eq '192.0.2.254'
+                expect(hosts[0]['port']).to eq 8022
+                expect(hosts[0]['vm_ip']).to eq '192.0.2.10'
+              end
+            end
+          end
+
+          context 'when using podman where Networks is keyed by network name instead of NetworkMode' do
+            let(:container_config) do
+              {
+                'HostConfig' => {
+                  'NetworkMode' => 'bridge',
+                },
+                'NetworkSettings' => {
+                  'Ports' => {
+                    '22/tcp' => [
+                      {
+                        'HostIp' => '0.0.0.0',
+                        'HostPort' => 8022,
+                      },
+                    ],
+                  },
+                  'Networks' => {
+                    'podman' => {
+                      'Gateway' => '192.0.2.254',
+                      'IPAddress' => '192.0.2.10',
+                    },
+                  },
+                },
+              }
+            end
+
+            it 'falls back to the first network for the container IP' do
+              ENV['DOCKER_IN_DOCKER'] = 'true'
+              docker.provision
+
+              expect(hosts[0]['ip']).to eq '192.0.2.10'
+              expect(hosts[0]['port']).to eq 22
+              expect(hosts[0]['vm_ip']).to eq '192.0.2.10'
+            end
+
+            it 'still connects via the published port from the host' do
+              ENV['DOCKER_IN_DOCKER'] = nil
+              ENV['DOCKER_HOST'] = nil
+              docker.provision
+
+              expect(hosts[0]['ip']).to eq '127.0.0.1'
+              expect(hosts[0]['port']).to eq 8022
+              expect(hosts[0]['vm_ip']).to eq '192.0.2.10'
+            end
           end
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker-docker
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.3
 platform: ruby
 authors:
 - Vox Pupuli
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Docker hypervisor for Beaker acceptance testing framework
 test_files: []