specinfra 2.88.0 → 2.88.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5653294259d7e35a26af3b0841cb507c5a7bd69668d022af79f4f32ae7299810
-  data.tar.gz: c0c2cef79bb876c01ce2dc8fbb21ab138a6a0e367186c34ba94e7f35772ec12d
+  metadata.gz: 2dff075bae4d6b20fa9332f60a6bd8e6da8d68dd7c6fb42e5d43d4a86f2d4b7d
+  data.tar.gz: 7703a50eddfa431bc02f8b84e10dbf88bd6065b5f50b4c7264114da23e9a1d6f
 SHA512:
-  metadata.gz: 18f97e98b911c4354b87de096cc6af94d8d4c7e793d8fab46ed72cea47b95ee4803cce160e2dcd54d7c61e3b076877018d904641050d99fa28b3a354afff4a58
-  data.tar.gz: 14eebac1837c79a17e352eada2496dbea730463de4a94782fe366e6f72f172e37715ec7c6068bc1c63259882f0865124f8fafc12d61171e6dc586b2d8c462acf
+  metadata.gz: dfec33e4e99f8cd09444db43371ab805c50d588cd66787e3c37d8a2631d15141fd9fb91f9fde6b8a2a223374ab49d0bc4f3709b4d7a0f1059bd7005b134b1c63
+  data.tar.gz: 1a23d2c920e4b8fd5f05826c8a80b3bb1c3053025c1d3e4d8d81500ebb4bb360037e0819bd9c81e037d360533dc97bdd9c7ae1a52fac3f9d3c71bec3d8ad93fd

data/Rakefile

@@ -18,7 +18,7 @@ if defined?(RSpec)
 
     task :backend => 'backend:all'
     namespace :backend do
-      backends = %w[exec ssh]
+      backends = Dir.glob("spec/backend/*").map { |path| File.basename(path) }
 
       task :all => backends
 

data/lib/specinfra/backend/lxd.rb

@@ -9,56 +9,30 @@ module Specinfra
   module Backend
     # LXD transport
     class Lxd < Exec
-      def initialize(config = {})
-        super
-
-        raise 'Please specify lxd_instance' unless (@instance = get_config(:lxd_instance))
-        raise 'Please specify lxd_remote' unless (@remote = get_config(:lxd_remote))
-
-        @remote_instance = [@remote, @instance].compact.join(':')
+      def build_command(cmd)
+        lxc_cmd = %W[lxc exec #{instance}]
+        lxc_cmd << '-t' if get_config(:interactive_shell)
+        lxc_cmd << '--'
+        (lxc_cmd << super(cmd)).join(' ')
       end
 
-      class << self
-        protected
-
-        def run_command(cmd, opts = {})
-          cmd = build_command(cmd)
-          run_pre_command(opts)
-          stdout, stderr, exit_status = with_env do
-            spawn_command(cmd)
-          end
-
-          if @example
-            @example.metadata[:command] = cmd
-            @example.metadata[:stdout]  = stdout
-          end
-
-          CommandResult.new :stdout => stdout, :stderr => stderr, :exit_status => exit_status
-        end
-
-        def build_command(cmd)
-          cmd = super(cmd)
-          "lxc exec #{@remote_instance} -- #{cmd}"
-        end
-
-        def send_file(source, destination)
-          flags = %w[--create-dirs]
-          if File.directory?(source)
-            flags << '--recursive'
-            destination = Pathname.new(destination).dirname.to_s
-          end
-          cmd = %W[lxc file push #{source} #{@remote_instance}#{destination}] + flags
-          spawn_command(cmd.join(' '))
+      def send_file(source, destination)
+        flags = %w[--create-dirs]
+        if File.directory?(source)
+          flags << '--recursive'
+          destination = Pathname.new(destination).dirname.to_s
         end
+        cmd = %W[lxc file push #{source} #{instance}#{destination}] + flags
+        spawn_command(cmd.join(' '))
+      end
 
-        private
+      private
 
-        def run_pre_command(_opts)
-          return unless get_config(:pre_command)
+      def instance
+        raise 'Please specify lxd_instance' unless (instance = get_config(:lxd_instance))
+        raise 'Please specify lxd_remote' unless (remote = get_config(:lxd_remote))
 
-          cmd = build_command(get_config(:pre_command))
-          spawn_command(cmd)
-        end
+        [remote, instance].compact.join(':')
       end
     end
   end

data/lib/specinfra/version.rb

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

data/spec/backend/lxd/build_command_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Specinfra::Backend::Lxd do
+  let(:lxd_instance) { 'instance' }
+  let(:lxd_remote) { 'remote' }
+  let(:lxc_exec) { "lxc exec #{lxd_remote}:#{lxd_instance}" }
+
+  before(:each) do
+    set :backend, :lxd
+    RSpec.configure do |c|
+      c.lxd_instance = lxd_instance
+      c.lxd_remote = lxd_remote
+    end
+  end
+
+  after(:each) do
+    Specinfra::Backend::Lxd.clear
+  end
+
+  describe '#build_command' do
+    context 'without required lxd_instance set' do
+      let(:lxd_instance) { nil }
+      it {
+        expect { subject.build_command('true') }.to raise_error(RuntimeError, /lxd_instance/)
+      }
+    end
+
+    context 'without required lxd_remote set' do
+      let(:lxd_remote) { nil }
+      it {
+        expect { subject.build_command('true') }.to raise_error(RuntimeError, /lxd_remote/)
+      }
+    end
+
+    context 'with simple command' do
+      it 'should escape spaces' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{lxc_exec} -- /bin/sh -c 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 "lxc exec #{lxd_remote}:#{lxd_instance} -- /bin/sh -c 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("#{lxc_exec} -- /bin/sh -c 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("#{lxc_exec} -- /bin/sh -c 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
+      before { RSpec.configure { |c| c.shell = '/usr/local/bin/tcsh' } }
+      after { RSpec.configure { |c| c.shell = nil } }
+
+      it 'should use custom shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{lxc_exec} -- /usr/local/bin/tcsh -c test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with custom shell that needs escaping' do
+      before { RSpec.configure { |c| c.shell = '/usr/test & spec/bin/sh' } }
+      after { RSpec.configure { |c| c.shell = nil } }
+
+      it 'should use custom shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{lxc_exec} -- /usr/test\\ \\&\\ spec/bin/sh -c test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with an interactive shell' do
+      before { RSpec.configure { |c| c.interactive_shell = true } }
+      after { RSpec.configure { |c| c.interactive_shell = nil } }
+
+      it 'should emulate an interactive shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{lxc_exec} -t -- /bin/sh -i -c test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with an login shell' do
+      before { RSpec.configure { |c| c.login_shell = true } }
+      after { RSpec.configure { |c| c.login_shell = nil } }
+
+      it 'should emulate an login shell' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{lxc_exec} -- /bin/sh -l -c test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with custom path' do
+      before { RSpec.configure { |c| c.path = '/opt/bin:/opt/foo/bin:$PATH' } }
+      after { RSpec.configure { |c| c.path = nil } }
+
+      it 'should use custom path' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{lxc_exec} -- env PATH=\"/opt/bin:/opt/foo/bin:$PATH\" /bin/sh -c test\\ -f\\ /etc/passwd"
+      end
+    end
+
+    context 'with custom path that needs escaping' do
+      before { RSpec.configure { |c| c.path = '/opt/bin:/opt/test & spec/bin:$PATH' } }
+      after { RSpec.configure { |c| c.path = nil } }
+
+      it 'should use custom path' do
+        expect(subject.build_command('test -f /etc/passwd')).to eq "#{lxc_exec} -- env PATH=\"/opt/bin:/opt/test & spec/bin:$PATH\" /bin/sh -c 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.0
+  version: 2.88.1
 platform: ruby
 authors:
 - Gosuke Miyashita
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-scp
@@ -521,6 +521,7 @@ files:
 - spec/backend/exec/env_spec.rb
 - spec/backend/exec/read_noblock_spec.rb
 - spec/backend/exec/stdxxx_handler_spec.rb
+- spec/backend/lxd/build_command_spec.rb
 - spec/backend/ssh/build_command_spec.rb
 - spec/command/alpine/service_spec.rb
 - spec/command/amazon/interface_spec.rb
@@ -670,6 +671,7 @@ test_files:
 - spec/backend/exec/env_spec.rb
 - spec/backend/exec/read_noblock_spec.rb
 - spec/backend/exec/stdxxx_handler_spec.rb
+- spec/backend/lxd/build_command_spec.rb
 - spec/backend/ssh/build_command_spec.rb
 - spec/command/alpine/service_spec.rb
 - spec/command/amazon/interface_spec.rb