beaker 4.36.1 → 4.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a512100e3bdfe558337d1571372ef7131aa8466b05995f36dba8ecf7b6091996
-  data.tar.gz: 60a43e396d5b1b2354bd26174e4281045ea828e7ca3d0a464bd685ba17b58dbe
+  metadata.gz: 147352406c9fe42bb99fad85f3c583a2be345385191eafe9e685dce331025c21
+  data.tar.gz: 4fe85be2e9ef2e81d59be68d7c83f573648f3d36bc25e3c67fbf8c53e3786de0
 SHA512:
-  metadata.gz: 84e4bd854ef9aa7fc63ca24f61d2062b6dcac4a3cb462cadc8da430bcb92936854b30c9c3aa1ece761f17ca28a5138f4891224c1882b9f8d19b291ba56ecaa8d
-  data.tar.gz: 5572e704bd0fb2d44632c8a1c196d11886e7966545d6f7e8b9adcea130b152b5bf0da4091b31efd04d687b9720baccc1ce2466a9313543cb9c612f0420c7a686
+  metadata.gz: b2d94a7dccbc611478c859ca640c317e7624a3f6c9ac5d2857c91f24b15c36e52537ab99a412676c7bf7978b6fcf85bfc67a7c1931183e64b080fb86b38b4bd0
+  data.tar.gz: 3af90b7213b32d74a5f5340132ae428eab9a991fc93bbafb69a4a2a6db4d3f9f5e255d3da0bb965401fb05ba552f8d9deafef2c7c5d3899e404e04975e504149

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [4.37.0](https://github.com/voxpupuli/beaker/tree/4.37.0) (2022-06-27)
+
+## Added
+
+- Add support for Win32-OpenSSH ([#1744](https://github.com/voxpupuli/beaker/pull/1744))
+
+## Fixed
+
+- Create ~/.ssh on Windows if it doesn't exist ([#1745](https://github.com/voxpupuli/beaker/pull/1745))
+
 ## [4.36.1](https://github.com/voxpupuli/beaker/tree/4.36.1) (2022-06-16)
 
 ## Fixed

data/lib/beaker/host/windows/exec.rb

@@ -120,10 +120,16 @@ module Windows::Exec
   end
 
   # Create the provided directory structure on the host
-  # @param [String] dir The directory structure to create on the host
+  # @param [String,Pathname] dir The directory structure to create on the host
   # @return [Boolean] True, if directory construction succeeded, otherwise False
-  def mkdir_p dir
-    cmd = "mkdir -p \"#{dir}\""
+  def mkdir_p(dir)
+    # single or double quotes will disable ~ expansion, so only quote if we have to
+    str = dir.to_s
+    cmd = if str.start_with?('~') && !str.include?(' ')
+            "mkdir -p #{str}"
+          else
+            "mkdir -p \"#{str}\""
+          end
     result = exec(Beaker::Command.new(cmd), :acceptable_exit_codes => [0, 1])
     result.exit_code == 0
   end

data/lib/beaker/host/windows/file.rb

@@ -59,11 +59,13 @@ module Windows::File
     case determine_ssh_server
     when :bitvise
       # swap out separators
-      network_path = path.gsub('\\', scp_separator)
+      path.gsub('\\', scp_separator)
     when :openssh
       path
+    when :win32_openssh
+      path.gsub('\\', '/')
     else
-      raise ArgumentError("windows/file.rb:scp_path: ssh server not recognized: '#{determine_ssh_server}'")
+      raise ArgumentError, "windows/file.rb:scp_path: ssh server not recognized: '#{determine_ssh_server}'"
     end
   end
 

data/lib/beaker/host/windows.rb

@@ -38,8 +38,14 @@ module Windows
       return @ssh_server if @ssh_server
       @ssh_server = :openssh
       status = execute('cmd.exe /c sc query BvSshServer', :accept_all_exit_codes => true)
-      @ssh_server = :bitvise if status =~ /4  RUNNING/
-      logger.debug("windows.rb:determine_ssh_server: determined ssh server: '#{@ssh_server}'")
+      if status =~ /4  RUNNING/
+        @ssh_server = :bitvise
+      else
+        status = execute('cmd.exe /c sc qc sshd', :accept_all_exit_codes => true)
+        if status =~ /C:\\Windows\\System32\\OpenSSH\\sshd\.exe/
+          @ssh_server = :win32_openssh
+        end
+      end
       @ssh_server
     end
 

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '4.36.1'
+    STRING = '4.37.0'
   end
 end

data/spec/beaker/host/windows/exec_spec.rb

@@ -96,5 +96,35 @@ module Beaker
          expect( instance.mv(origin, destination, false) ).to be === 0
       end
     end
+
+    context 'mkdir_p' do
+      let(:path) { '~/.ssh' }
+      let(:result) do
+        result = Beaker::Result.new(nil, '')
+        result.exit_code = 0
+        result
+      end
+
+      it 'accepts Pathname arguments' do
+        expect( instance ).to receive(:exec).with(having_attributes(command: "mkdir -p #{path}"), anything).and_return(result)
+        expect(instance.mkdir_p(Pathname.new(path))).to eq(true)
+      end
+
+      it 'omits quotes if the path starts with ~ and does not contain spaces' do
+        expect( instance ).to receive(:exec).with(having_attributes(command: "mkdir -p #{path}"), anything).and_return(result)
+        expect(instance.mkdir_p(path)).to eq(true)
+      end
+
+      it 'double quotes paths containing spaces' do
+        expect( instance ).to receive(:exec).with(having_attributes(command: "mkdir -p \"~/.foo bar\""), anything).and_return(result)
+        expect(instance.mkdir_p("~/.foo bar")).to eq(true)
+      end
+
+      it 'returns false if the command failed' do
+        result.exit_code = 1
+        expect( instance ).to receive(:exec).with(having_attributes(command: "mkdir -p #{path}"), anything).and_return(result)
+        expect(instance.mkdir_p(path)).to eq(false)
+      end
+    end
   end
 end

data/spec/beaker/host/windows/file_spec.rb

@@ -51,5 +51,37 @@ module Beaker
         host.ls_ld( path )
       end
     end
+
+    describe "#scp_to" do
+      let(:path) { 'C:\Windows' }
+
+      it 'replaces backslashes with ??? when using BitVise and cmd' do
+        allow(host).to receive(:determine_ssh_server).and_return(:bitvise)
+        expect(host.scp_path(path)).to eq('C:\Windows')
+      end
+
+      it 'replaces backslashes with forward slashes when using BitVise and powershell' do
+        host = make_host('name', platform: 'windows', is_cygwin: false)
+        allow(host).to receive(:determine_ssh_server).and_return(:bitvise)
+        expect(host.scp_path(path)).to eq('C:/Windows')
+      end
+
+      it 'leaves backslashes as is when using cygwin' do
+        allow(host).to receive(:determine_ssh_server).and_return(:openssh)
+        expect(host.scp_path(path)).to eq('C:\Windows')
+      end
+
+      it 'replace backslashes with forward slashes when using Win32-OpenSSH' do
+        allow(host).to receive(:determine_ssh_server).and_return(:win32_openssh)
+        expect(host.scp_path(path)).to eq('C:/Windows')
+      end
+
+      it 'raises if the server can not be recognized' do
+        allow(host).to receive(:determine_ssh_server).and_return(:unknown)
+        expect {
+          host.scp_path(path)
+        }.to raise_error(ArgumentError, "windows/file.rb:scp_path: ssh server not recognized: 'unknown'")
+      end
+    end
   end
 end

data/spec/beaker/host/windows_spec.rb

@@ -37,7 +37,7 @@ module Windows
 
     describe '#determine_ssh_server' do
       it 'does not care about return codes from the execute call' do
-        expect( host ).to receive( :execute ).with( anything, :accept_all_exit_codes => true )
+        expect( host ).to receive( :execute ).with( anything, :accept_all_exit_codes => true ).twice
         host.determine_ssh_server
       end
 
@@ -53,6 +53,28 @@ module Windows
         expect( host.determine_ssh_server ).to be === :bitvise
       end
 
+      it 'reads Windows OpenSSH status correctly' do
+        allow(host).to receive(:execute)
+          .with('cmd.exe /c sc query BvSshServer', anything).and_return(bitvise_check_output(:failure))
+        allow(host).to receive(:execute)
+          .with('cmd.exe /c sc qc sshd', anything).and_return(<<~END)
+        [SC] QueryServiceConfig SUCCESS
+
+        SERVICE_NAME: sshd
+                TYPE               : 10  WIN32_OWN_PROCESS 
+                START_TYPE         : 2   AUTO_START
+                ERROR_CONTROL      : 1   NORMAL
+                BINARY_PATH_NAME   : C:\\Windows\\System32\\OpenSSH\\sshd.exe
+                LOAD_ORDER_GROUP   : 
+                TAG                : 0
+                DISPLAY_NAME       : OpenSSH SSH Server
+                DEPENDENCIES       : 
+                SERVICE_START_NAME : LocalSystem
+        END
+
+        expect(host.determine_ssh_server).to eq :win32_openssh
+      end
+
       it 'returns old value if it has already determined before' do
         ssh_server_before = host.instance_variable_get( :@ssh_server )
         test_value = :test916

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 4.36.1
+  version: 4.37.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec