beaker-docker 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68081b2882922ccbb645c18cd13793230a072aad07154d51da1fa5d1b2876186
-  data.tar.gz: 20894761944fb07007daacdaf6e466bc282a4a418d07d304776bdc77738a23d4
+  metadata.gz: 6264189ab77d7c85932a5e565c593365f07450b25d38796e1349c5304754b7cc
+  data.tar.gz: fa7f1dcde6a3b11121972a67a91c2c365db17f0ea2e22e36777cef1b07cb88c9
 SHA512:
-  metadata.gz: 3d12134709510c8508550b7b1b33e68138632ce0c7bc3fe5ac5d72d3a2e5e106933c769f9e9901ce37f27bde1b52c2f6f5f183883246c2e5d96f71214a1f01eb
-  data.tar.gz: d075fae3a65f02084ebc54f6dd5059381d60849b603cb268d1d55dfe6ba46f50fb6345a21af05eca1f3652398bcafbf1100ffe7d966f69bd3f736f724caefd09
+  metadata.gz: ff0d8b74a89100b457d1beed90cf9f53e33c93ca891b8c377ee795a06fc261154ee5fd9c88eddc5c68b6517d4129961109e874eac2925ca56907962cd26ad2d6
+  data.tar.gz: 4af9b0bd85a33e02c078f743fd9eeeacaed4862e8dfc3f4497713a0dbd630658fb68100a8fdad8d0e7022dfa998f34a57f55c727b0e1b2264fcdb7337ad23109

data/.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby 3.2
         uses: ruby/setup-ruby@v1
         with:
@@ -37,7 +37,7 @@ jobs:
       COVERAGE: ${{ matrix.coverage }}
     name: RSpec - Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -52,7 +52,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Docker
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby 3.2
         uses: ruby/setup-ruby@v1
         with:
@@ -65,7 +65,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Docker - Beaker in container connection test
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       # 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
@@ -83,7 +83,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Podman
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby 3.2
         uses: ruby/setup-ruby@v1
         with:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-05-05 14:11:54 UTC using RuboCop version 1.50.2.
+# on 2024-03-17 17:48:41 UTC using RuboCop version 1.62.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -26,6 +26,12 @@ RSpec/MultipleExpectations:
 RSpec/MultipleMemoizedHelpers:
   Max: 12
 
+# Offense count: 7
+# This cop supports unsafe autocorrection (--autocorrect-all).
+RSpec/ReceiveMessages:
+  Exclude:
+    - 'spec/beaker/hypervisor/docker_spec.rb'
+
 # Offense count: 26
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [2.2.1](https://github.com/voxpupuli/beaker-docker/tree/2.2.1) (2024-03-27)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/2.2.0...2.2.1)
+
+**Fixed bugs:**
+
+- Fix privileged remote docker port forward resolution  [\#126](https://github.com/voxpupuli/beaker-docker/pull/126) ([h0tw1r3](https://github.com/h0tw1r3))
+
+## [2.2.0](https://github.com/voxpupuli/beaker-docker/tree/2.2.0) (2024-03-17)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/2.1.0...2.2.0)
+
+**Implemented enhancements:**
+
+- Implement writing out a containerfile for a host [\#125](https://github.com/voxpupuli/beaker-docker/pull/125) ([ekohl](https://github.com/ekohl))
+- Support Amazon Linux 2023 [\#123](https://github.com/voxpupuli/beaker-docker/pull/123) ([treydock](https://github.com/treydock))
+
+**Merged pull requests:**
+
+- Rakefile: Use rubocop tasks from voxpupuli-rubocop [\#131](https://github.com/voxpupuli/beaker-docker/pull/131) ([bastelfreak](https://github.com/bastelfreak))
+- voxpupuli-rubocop: Update 1.2-\>2.6 [\#129](https://github.com/voxpupuli/beaker-docker/pull/129) ([bastelfreak](https://github.com/bastelfreak))
+- README.md: Document CLI; Add ToC [\#127](https://github.com/voxpupuli/beaker-docker/pull/127) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [2.1.0](https://github.com/voxpupuli/beaker-docker/tree/2.1.0) (2023-05-05)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-docker/compare/2.0.0...2.1.0)
@@ -84,7 +107,6 @@
 
 **Merged pull requests:**
 
-- Bump actions/checkout from 2 to 3 [\#90](https://github.com/voxpupuli/beaker-docker/pull/90) ([dependabot[bot]](https://github.com/apps/dependabot))
 - dependabot: check for github actions as well [\#89](https://github.com/voxpupuli/beaker-docker/pull/89) ([bastelfreak](https://github.com/bastelfreak))
 
 ## [1.3.0](https://github.com/voxpupuli/beaker-docker/tree/1.3.0) (2022-12-18)

data/README.md

@@ -10,6 +10,18 @@
 
 Beaker library to use docker hypervisor
 
+* [How to use this wizardry](#how-to-use-this-wizardry)
+  * [Nodeset Options](#nodeset-options)
+  * [Privileged containers](#privileged-containers)
+  * [Cleaning up after tests](#cleaning-up-after-tests)
+* [Working with `podman`](#working-with-podman)
+* [Generating a Dockerfile](#generating-a-dockerfile)
+* [Spec tests]()
+* [Acceptance tests]()
+* [Transfer Notice](#transfer-notice)
+* [License](#license)
+* [Release Information](#release-information)
+
 ## How to use this wizardry
 
 This gem that allows you to use hosts with [docker](docker.md) hypervisor with [beaker](https://github.com/voxpupuli/beaker).
@@ -102,6 +114,56 @@ See the
 [HostConfig](https://any-api.com/docker_com/engine/docs/Definitions/HostConfig)
 portion of the docker API for more information.
 
+## Generating a Dockerfile
+
+Usually beaker-docker is used to provision docker instances with beaker. During
+this step beaker-docker generates a Dockerfile and posts it to the docker daemon
+API.
+
+There's also a small CLI command to only generate the file:
+
+```
+bundle exec beaker-docker dockerfile archlinux-64
+```
+
+Will generate a local `Dockerfile`:
+
+```dockerfile
+FROM archlinux/archlinux
+ENV container docker
+RUN pacman --sync --refresh --noconfirm archlinux-keyring && pacman --sync --refresh --noconfirm --sysupgrade && pacman --sync --noconfirm curl ntp net-tools openssh && ssh-keygen -A && sed -ri 's/^#?UsePAM .*/UsePAM no/' /etc/ssh/sshd_config && systemctl enable sshd
+RUN mkdir -p /var/run/sshd && echo root:root | chpasswd
+RUN sed -ri -e 's/^#?PermitRootLogin .*/PermitRootLogin yes/' -e 's/^#?PasswordAuthentication .*/PasswordAuthentication yes/' -e 's/^#?UseDNS .*/UseDNS no/' -e 's/^#?MaxAuthTries.*/MaxAuthTries 1000/' /etc/ssh/sshd_config
+EXPOSE 22
+CMD ["/sbin/init"]
+```
+
+This works by calling
+(beaker-hostgenerator](https://github.com/voxpupuli/beaker-hostgenerator?tab=readme-ov-file#beaker-host-generator).
+So you can provide any host string that's supported by beaker-hostgenerator.
+
+For non-rolling release distros this is usually `$os$majorversion-$architecture`
+
+```
+beaker-docker dockerfile centos9-64
+```
+
+```dockerfile
+FROM quay.io/centos/centos:stream9
+ENV container docker
+RUN dnf clean all && dnf install -y sudo openssh-server openssh-clients chrony && ssh-keygen -A && sed 's@session *required *pam_loginuid.so@session optional pam_loginuid.so@g' -i /etc/pam.d/*
+RUN mkdir -p /var/run/sshd && echo root:root | chpasswd
+RUN sed -ri -e 's/^#?PermitRootLogin .*/PermitRootLogin yes/' -e 's/^#?PasswordAuthentication .*/PasswordAuthentication yes/' -e 's/^#?UseDNS .*/UseDNS no/' -e 's/^#?MaxAuthTries.*/MaxAuthTries 1000/' /etc/ssh/sshd_config
+RUN cp /bin/true /sbin/agetty
+RUN dnf install -y cronie crontabs initscripts iproute openssl wget which glibc-langpack-en hostname
+EXPOSE 22
+CMD ["/sbin/init"]
+```
+
+This requires a running docker daemon. You can also request a containerfile.
+This will currently generate a `Containerfile` but with the same content (this
+may change in the future, depending on the API spec).
+
 ## Spec tests
 
 Spec test live under the `spec` folder. There are the default rake task and therefore can run with a simple command:

data/Rakefile

@@ -3,16 +3,9 @@
 require 'rspec/core/rake_task'
 
 begin
-  require 'rubocop/rake_task'
+  require 'voxpupuli/rubocop/rake'
 rescue LoadError
-  # RuboCop is an optional group
-else
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    # These make the rubocop experience maybe slightly less terrible
-    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
-    # Use Rubocop's Github Actions formatter if possible
-    task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
-  end
+  # the voxpupuli-rubocop gem is optional
 end
 
 namespace :test do
@@ -73,7 +66,7 @@ rescue LoadError
   # Do nothing if no required gem installed
 else
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions]
     config.user = 'voxpupuli'
     config.project = 'beaker-docker'
     gem_version = Gem::Specification.load("#{config.project}.gemspec").version

data/beaker-docker.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'fakefs', '>= 1.3', '< 3.0'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'voxpupuli-rubocop', '~> 1.2'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.6.0'
 
   # Run time dependencies
   s.add_runtime_dependency 'beaker', '>= 4', '< 6'

data/bin/beaker-docker

@@ -2,8 +2,27 @@
 # frozen_string_literal: true
 
 require 'rubygems' unless defined?(Gem)
+require 'beaker'
 require 'beaker-docker'
 
+def dockerfile(hostspec, filename)
+  ENV['BEAKER_HYPERVISOR'] = 'docker'
+  options = Beaker::Options::Parser.new.parse_args(['--hosts', hostspec || '', '--no-provision'])
+  options[:logger] = Beaker::Logger.new(options)
+  network_manager = Beaker::NetworkManager.new(options, options[:logger])
+  network_manager.provision
+  hosts = network_manager.hosts
+
+  if hosts.size != 1
+    options[:logger].error "Found #{hosts.size} hosts, expected 1"
+    exit(1)
+  end
+
+  hypervisor = network_manager.hypervisors['docker']
+  # TODO: private method
+  File.write(filename, hypervisor.send(:dockerfile_for, hosts.first))
+end
+
 VERSION_STRING = <<'VER'
                                  _ .--.
                                 ( `    )
@@ -25,6 +44,13 @@ VERSION_STRING = <<'VER'
                      '=='
 VER
 
-puts VERSION_STRING % BeakerDocker::VERSION
+case ARGV[0]
+when 'containerfile'
+  dockerfile(ARGV[1], ARGV[2] || 'Containerfile')
+when 'dockerfile'
+  dockerfile(ARGV[1], ARGV[2] || 'Dockerfile')
+else
+  puts VERSION_STRING % BeakerDocker::VERSION
+end
 
 exit 0

data/lib/beaker/hypervisor/docker.rb

@@ -165,7 +165,7 @@ module Beaker
         # Container to container
         unless ip && port
           ip = network_settings['IPAddress']
-          port = ip && !ip.empty? ? 22 : nil
+          port = (ip && !ip.empty?) ? 22 : nil
         end
 
         # Container through gateway
@@ -188,14 +188,14 @@ module Beaker
         end
       end
 
-      if host_config['NetworkMode'] != 'slirp4netns' && network_settings['IPAddress'] && !network_settings['IPAddress'].empty?
-        ip = network_settings['IPAddress'] if ip.nil?
-      else
+      ip = network_settings['IPAddress'] if ip.nil? && host_config['NetworkMode'] != 'slirp4netns' && network_settings['IPAddress'] && !network_settings['IPAddress'].empty?
+
+      if port.nil?
         port22 = network_settings.dig('Ports', '22/tcp')
         port = port22[0]['HostPort'] if port22
       end
 
-      ssh_connection_info[:ip] = ip == '0.0.0.0' ? '127.0.0.1' : ip
+      ssh_connection_info[:ip] = (ip == '0.0.0.0') ? '127.0.0.1' : ip
       ssh_connection_info[:port] = port || '22'
       ssh_connection_info
     end
@@ -375,7 +375,7 @@ module Beaker
         container.exec(%w[apt-get update])
         container.exec(%w[apt-get install -y openssh-server openssh-client])
         container.exec(%w[sed 's@session\s*required\s*pam_loginuid.so@session optional pam_loginuid.so@g' -i /etc/pam.d/*])
-      when /el-[89]/, /fedora-(2[2-9]|3[0-9])/
+      when /el-[89]/, /fedora-(2[2-9]|3[0-9])/, /amazon-2023/
         container.exec(%w[dnf clean all])
         container.exec(%w[dnf install -y sudo openssh-server openssh-clients])
         container.exec(%w[ssh-keygen -A])
@@ -509,7 +509,7 @@ module Beaker
           RUN apt-get update \
           && apt-get install -y openssh-server openssh-client #{additional_packages.join(' ')}
         DF
-      when /el-[89]/, /fedora-(2[2-9]|3)/
+      when /el-[89]/, /fedora-(2[2-9]|3)/, /amazon-2023/
         dockerfile += <<~DF
           RUN dnf clean all \
           && dnf install -y sudo openssh-server openssh-clients #{additional_packages.join(' ')} \

data/lib/beaker-docker/version.rb

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

data/spec/beaker/hypervisor/docker_spec.rb

@@ -11,6 +11,7 @@ module Beaker
     'centos-7-x86_64',
     'sles-12-x86_64',
     'archlinux-2017.12.27-x86_64',
+    'amazon-2023-x86_64',
   ]
 
   describe Docker do
@@ -109,6 +110,12 @@ module Beaker
 
     before do
       allow(::Docker).to receive(:rootless?).and_return(true)
+      @docker_host = ENV.fetch('DOCKER_HOST', nil)
+      ENV.delete('DOCKER_HOST') if @docker_host
+    end
+
+    after do
+      ENV['DOCKER_HOST'] = @docker_host if @docker_host
     end
 
     context 'with connection failure' do
@@ -206,7 +213,7 @@ module Beaker
             end
           end
 
-          it 'will tag the image with the value of the tag' do
+          it 'tags the image with the value of the tag' do
             expect(image).to receive(:tag).with({ repo: 'my_tag' }).exactly(3).times
             docker.provision
           end
@@ -308,8 +315,8 @@ module Beaker
                                                                      },
                                                                    },
                                                                    'Labels' => {
-                                                                     'one' => (index == 2 ? 3 : 1),
-                                                                     'two' => (index == 2 ? 4 : 2),
+                                                                     'one' => ((index == 2) ? 3 : 1),
+                                                                     'two' => ((index == 2) ? 4 : 2),
                                                                    },
                                                                    'name' => /\Abeaker-/,
                                                                  })
@@ -339,8 +346,8 @@ module Beaker
                                                                      },
                                                                    },
                                                                    'Labels' => {
-                                                                     'one' => (index == 2 ? 3 : 1),
-                                                                     'two' => (index == 2 ? 4 : 2),
+                                                                     'one' => ((index == 2) ? 3 : 1),
+                                                                     'two' => ((index == 2) ? 4 : 2),
                                                                    },
                                                                  })
           end
@@ -396,8 +403,8 @@ module Beaker
                                                                      },
                                                                    },
                                                                    'Labels' => {
-                                                                     'one' => (index == 2 ? 3 : 1),
-                                                                     'two' => (index == 2 ? 4 : 2),
+                                                                     'one' => ((index == 2) ? 3 : 1),
+                                                                     'two' => ((index == 2) ? 4 : 2),
                                                                    },
                                                                    'name' => /\Abeaker-/,
                                                                  })
@@ -424,8 +431,8 @@ module Beaker
                                                                      'CapAdd' => %w[NET_ADMIN SYS_ADMIN],
                                                                    },
                                                                    'Labels' => {
-                                                                     'one' => (index == 2 ? 3 : 1),
-                                                                     'two' => (index == 2 ? 4 : 2),
+                                                                     'one' => ((index == 2) ? 3 : 1),
+                                                                     'two' => ((index == 2) ? 4 : 2),
                                                                    },
                                                                    'name' => /\Abeaker-/,
                                                                  })
@@ -458,8 +465,8 @@ module Beaker
                                                                      },
                                                                    },
                                                                    'Labels' => {
-                                                                     'one' => (index == 2 ? 3 : 1),
-                                                                     'two' => (index == 2 ? 4 : 2),
+                                                                     'one' => ((index == 2) ? 3 : 1),
+                                                                     'two' => ((index == 2) ? 4 : 2),
                                                                    },
                                                                    'name' => /\Abeaker-/,
                                                                  })
@@ -475,64 +482,46 @@ module Beaker
         end
 
         context 'when connecting to ssh' do
-          context 'when rootless' do
-            before { @docker_host = ENV.fetch('DOCKER_HOST', nil) }
-
-            after { ENV['DOCKER_HOST'] = @docker_host }
-
-            it 'exposes port 22 to beaker' do
-              ENV['DOCKER_HOST'] = nil
-              docker.provision
-
-              expect(hosts[0]['ip']).to eq '127.0.0.1'
-              expect(hosts[0]['port']).to eq 8022
-            end
-
-            it 'exposes port 22 to beaker when using DOCKER_HOST' do
-              ENV['DOCKER_HOST'] = 'tcp://192.0.2.2:2375'
-              docker.provision
-
-              expect(hosts[0]['ip']).to eq '192.0.2.2'
-              expect(hosts[0]['port']).to eq 8022
-            end
+          %w[rootless privileged].each do |mode|
+            context "when #{mode}" do
+              let(:container_mode) do
+                mode
+              end
 
-            it 'has ssh agent forwarding enabled' do
-              ENV['DOCKER_HOST'] = nil
-              docker.provision
+              it 'exposes port 22 to beaker' do
+                docker.provision
 
-              expect(hosts[0]['ip']).to eq '127.0.0.1'
-              expect(hosts[0]['port']).to eq 8022
-              expect(hosts[0]['ssh'][:password]).to eq 'root'
-              expect(hosts[0]['ssh'][:port]).to eq 8022
-              expect(hosts[0]['ssh'][:forward_agent]).to be true
-            end
+                expect(hosts[0]['ip']).to eq '127.0.0.1'
+                expect(hosts[0]['port']).to eq 8022
+              end
 
-            it 'connects to gateway ip' do
-              FakeFS do
-                FileUtils.touch('/.dockerenv')
+              it 'exposes port 22 to beaker when using DOCKER_HOST' do
+                ENV['DOCKER_HOST'] = 'tcp://192.0.2.2:2375'
                 docker.provision
 
-                expect(hosts[0]['ip']).to eq '192.0.2.254'
+                expect(hosts[0]['ip']).to eq '192.0.2.2'
                 expect(hosts[0]['port']).to eq 8022
               end
-            end
-          end
-
-          context 'when rootful' do
-            before { @docker_host = ENV.fetch('DOCKER_HOST', nil) }
 
-            after { ENV['DOCKER_HOST'] = @docker_host }
+              it 'has ssh agent forwarding enabled' do
+                docker.provision
 
-            let(:container_mode) do
-              'rootful'
-            end
+                expect(hosts[0]['ip']).to eq '127.0.0.1'
+                expect(hosts[0]['port']).to eq 8022
+                expect(hosts[0]['ssh'][:password]).to eq 'root'
+                expect(hosts[0]['ssh'][:port]).to eq 8022
+                expect(hosts[0]['ssh'][:forward_agent]).to be true
+              end
 
-            it 'exposes port 22 to beaker' do
-              ENV['DOCKER_HOST'] = nil
-              docker.provision
+              it 'connects to gateway ip' do
+                FakeFS do
+                  FileUtils.touch('/.dockerenv')
+                  docker.provision
 
-              expect(hosts[0]['ip']).to eq '127.0.0.1'
-              expect(hosts[0]['port']).to eq 8022
+                  expect(hosts[0]['ip']).to eq '192.0.2.254'
+                  expect(hosts[0]['port']).to eq 8022
+                end
+              end
             end
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker-docker
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Vox Pupuli
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakefs
@@ -67,14 +67,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: beaker
   requirement: !ruby/object:Gem::Requirement