specinfra 2.88.2 → 2.89.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48bd86bb191af636b611f48c76a248d5171bc0d54573fa7af8063ed6c43aa7ce
-  data.tar.gz: 249f7068c068d8ce33dea8388408e34eacafe48efe1c3df97392ba91b975ee62
+  metadata.gz: 9e50bdeee324833215a1b15370cfc44ef242b6c52dfd9dac888bd2391fb9e7de
+  data.tar.gz: a99274248ab6323eea1f84a5692bb73aab86288169e70ee71d743a981b0a5e13
 SHA512:
-  metadata.gz: fd3e32a0d9f7157a131436dfb0d28f83cd4937ff01af7bde937c03ef11fe035af03f379d646f456810d5af2b7f404531e87c7a072fa1a06741624bd7b2e20f8d
-  data.tar.gz: c3daafc7d09fcdd4e665fc8c794a3e61b8267ca7a0b38edf1f6c34d290f80f23cdde69bd56dd49bbeab373e82880cfc40afd8459fe58f6fc33454cd16def6aef
+  metadata.gz: 9fa6eacae5f42b7dca7743d83b052e0bdd9e3077649baa0638c3ba9bc7e7f6f3d2f8faa743c5bf3a36fdda7e7d068868f57830cdcf19b33a21f3519aa08a3849
+  data.tar.gz: 97227f5e2114863c8afee052c8dd207fa4a2f20bc07b5e4c8b43a030cd44811764f7fb1ab0c16267dfc4bcf2c8968d6b87cd7c0944b567db0f8d0a025edac503

data/lib/specinfra/backend/dockercli.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Specinfra
+  module Backend
+    # Docker command line transport
+    class Dockercli < Exec
+      def build_command(cmd)
+        docker_cmd = %w[docker exec]
+        docker_cmd << '--interactive' if get_config(:interactive_shell)
+        docker_cmd << '--tty' if get_config(:request_pty)
+        docker_cmd << instance
+        (docker_cmd << super(cmd)).join(' ')
+      end
+
+      def send_file(from, to)
+        to = Pathname.new(to).dirname.to_s if File.directory?(from)
+        cmd = %W[docker cp #{from} #{instance}:#{to}]
+        spawn_command(cmd.join(' '))
+      end
+
+      def send_directory(from, to)
+        send_file(from, to)
+      end
+
+      private
+
+      def instance
+        raise 'Please specify docker_container' unless (container = get_config(:docker_container))
+
+        container
+      end
+    end
+  end
+end

data/lib/specinfra/backend.rb

@@ -5,6 +5,7 @@ require 'specinfra/backend/powershell/script_helper'
 require 'specinfra/backend/powershell/command'
 require 'specinfra/backend/cmd'
 require 'specinfra/backend/docker'
+require 'specinfra/backend/dockercli'
 require 'specinfra/backend/lxc'
 require 'specinfra/backend/lxd'
 require 'specinfra/backend/winrm'

data/lib/specinfra/version.rb

@@ -1,5 +1,5 @@
 module Specinfra
-  VERSION = "2.88.2"
+  VERSION = "2.89.0"
 
   def self.ruby_is_older_than?(*version)
     (RUBY_VERSION.split('.').map(&:to_i) <=> version) < 0

data/lib/specinfra.rb

@@ -35,6 +35,7 @@ if defined?(RSpec)
     c.add_setting :scp,           :default => nil
     c.add_setting :sudo_password, :default => nil
     c.add_setting :winrm,         :default => nil
+    c.add_setting :docker_container, :default => nil
     c.add_setting :architecture,  :default => :x86_64
     Specinfra.configuration.defaults.each { |k, v| c.add_setting k, :default => v }
     c.before :each do

data/spec/backend/dockercli/build_command_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'shellwords'
+
+describe Specinfra::Backend::Dockercli do
+  let(:interactive_shell) { false }
+  let(:login_shell) { false }
+  let(:request_pty) { false }
+  let(:shell) { '/bin/sh' }
+  let(:docker_container) { 'instance' }
+  let(:path) { nil }
+  let(:docker_exec) do
+    cmd = %w[docker exec]
+    cmd << '--interactive' if interactive_shell
+    cmd << '--tty' if request_pty
+    cmd << docker_container
+    cmd << "env PATH=\"#{path}\"" if path
+    cmd << shell.shellescape
+    cmd << '-i' if interactive_shell
+    cmd << '-l' if login_shell
+    cmd << '-c'
+    cmd.join(' ')
+  end
+
+  before(:each) do
+    set :backend, :dockercli
+    RSpec.configure do |c|
+      c.request_pty = request_pty
+      c.interactive_shell = interactive_shell
+      c.docker_container = docker_container
+      c.path = path
+    end
+  end
+
+  after(:each) do
+    Specinfra::Backend::Dockercli.clear
+  end
+
+  describe '#build_command' do
+    context 'without required docker_container set' do
+      let(:docker_container) { nil }
+      it {
+        expect { subject.build_command('true') }.to raise_error(RuntimeError, /docker_container/)
+      }
+    end
+
+    context 'with simple command' do
+      it 'should escape spaces' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{docker_exec} test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with complex command' do
+      it 'should escape special chars' do
+        expect(subject.build_command('test ! -f /etc/selinux/config || (getenforce | grep -i -- disabled && grep -i -- ^SELINUX=disabled$ /etc/selinux/config)'))
+          .to eq "#{docker_exec} test\\ \\!\\ -f\\ /etc/selinux/config\\ \\|\\|\\ \\(getenforce\\ \\|\\ grep\\ -i\\ --\\ disabled\\ \\&\\&\\ grep\\ -i\\ --\\ \\^SELINUX\\=disabled\\$\\ /etc/selinux/config\\)"
+      end
+
+      it 'should escape quotes' do
+        if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.7')
+          expect(subject.build_command(%Q(find /etc/apt/ -name \*.list | xargs grep -o -E "^deb +[\\"']?http://ppa.launchpad.net/gluster/glusterfs-3.7"))).to eq("#{docker_exec} find\\ /etc/apt/\\ -name\\ \\*.list\\ \\|\\ xargs\\ grep\\ -o\\ -E\\ \\\"\\^deb\\ \\+\\[\\\\\\\"\\'\\]\\?http://ppa.launchpad.net/gluster/glusterfs-3.7\\\"")
+        else
+          # Since Ruby 2.7, `+` is not escaped.
+          expect(subject.build_command(%Q(find /etc/apt/ -name \*.list | xargs grep -o -E "^deb +[\\"']?http://ppa.launchpad.net/gluster/glusterfs-3.7"))).to eq("#{docker_exec} find\\ /etc/apt/\\ -name\\ \\*.list\\ \\|\\ xargs\\ grep\\ -o\\ -E\\ \\\"\\^deb\\ +\\[\\\\\\\"\\'\\]\\?http://ppa.launchpad.net/gluster/glusterfs-3.7\\\"")
+        end
+      end
+    end
+
+    context 'with custom shell' do
+      let(:shell) { '/usr/local/bin/tcsh' }
+
+      it 'should use custom shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{docker_exec} test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with custom shell that needs escaping' do
+      let(:shell) { '/usr/test & spec/bin/sh' }
+
+      it 'should use custom shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{docker_exec} test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with an interactive shell' do
+      let(:interactive_shell) { true }
+
+      it 'should emulate an interactive shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{docker_exec} test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with an login shell' do
+      let(:login_shell) { true }
+
+      it 'should emulate an login shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{docker_exec} test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with custom path' do
+      let(:path) { '/opt/bin:/opt/foo/bin:$PATH' }
+
+      it 'should use custom path' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{docker_exec} test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with custom path that needs escaping' do
+      let(:path) { '/opt/bin:/opt/test & spec/bin:$PATH' }
+
+      it 'should use custom path' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{docker_exec} test\\ -f\\ /etc/passwd"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specinfra
 version: !ruby/object:Gem::Version
-  version: 2.88.2
+  version: 2.89.0
 platform: ruby
 authors:
 - Gosuke Miyashita
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-scp
@@ -124,6 +124,7 @@ files:
 - lib/specinfra/backend/base.rb
 - lib/specinfra/backend/cmd.rb
 - lib/specinfra/backend/docker.rb
+- lib/specinfra/backend/dockercli.rb
 - lib/specinfra/backend/dockerfile.rb
 - lib/specinfra/backend/exec.rb
 - lib/specinfra/backend/jexec.rb
@@ -515,6 +516,7 @@ files:
 - lib/specinfra/properties.rb
 - lib/specinfra/runner.rb
 - lib/specinfra/version.rb
+- spec/backend/dockercli/build_command_spec.rb
 - spec/backend/exec/build_command_spec.rb
 - spec/backend/exec/child_process_spec.rb
 - spec/backend/exec/consume_exited_process_spec.rb
@@ -665,6 +667,7 @@ test_files:
 - Gemfile
 - specinfra.gemspec
 - Rakefile
+- spec/backend/dockercli/build_command_spec.rb
 - spec/backend/exec/build_command_spec.rb
 - spec/backend/exec/child_process_spec.rb
 - spec/backend/exec/consume_exited_process_spec.rb