serverspec 0.10.6 → 0.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22e4b599ab3a4fc8ff81faf1e55f41712e109631
-  data.tar.gz: 7dd6658d68a7ab903add025a20225b151985e9c6
+  metadata.gz: 05c1dc06b5b4833b7e537d596b488b3bb07aba0e
+  data.tar.gz: c8fa93b1eab1507daa911da2a1e1b55c20dcac9c
 SHA512:
-  metadata.gz: e929ccd2fd728a64bfd5e612319ec8d17c247f8dd7d1bc08bb590a70c8afc2c47c9deb69a0c8d101e8d98d7af004bb843c6d66e063a3817f9aa3188e4d334556
-  data.tar.gz: 79b9091221264fb2ae68cdd43d3170acf804024bf2b5028d8f879a9e621f177c8f52c00f577b7193b8314588e0cf60ed705f1af653c757f00894caec2a761b58
+  metadata.gz: eeab306443ccc7261c6dacf25553d98481fed15453e650c55f79c574223485a02dab66ac73751b8ca7468275defb4fbf5de8d66dbc763b941023c26f4a00c5e4
+  data.tar.gz: 7c53f323cfcee38681c359ce7bdbef51b0e85089cec4dda10537a11aebf1af200ec93f1ca8a88a4d26e7a1084f5533b8483f57d44eba993737ccadf66ee2ba60

data/{WindowsSupport.md → WINDOWS_SUPPORT.md}

@@ -33,7 +33,7 @@ RSpec.configure do |c|
 end
 ```
 
-For different authentication mechanisms check the Microsoft WinRM documentation and verify the ones that are supported by [WinRb/WinRM](https://github.com/WinRb/WinRM)
+For how to configure the guest to accept WinRM connections and the different authentication mechanisms check the Microsoft WinRM documentation and verify the ones that are supported by [WinRb/WinRM](https://github.com/WinRb/WinRM).
 
 
 ###RSpec Examples for windows target hosts
@@ -75,6 +75,10 @@ describe group('MYDOMAIN\Domain Users') do
   it { should exist }
 end
 
+describe command('& "ipconfig"') do
+  it { should return_stdout(/IPv4 Address(\.| )*: 192\.168\.1\.100/) }
+end
+
 describe windows_registry_key('HKEY_USERS\S-1-5-21-1319311448-2088773778-316617838-32407\Test MyKey') do
   it { should exist }
   it { should have_property('string value') }
@@ -85,4 +89,9 @@ describe windows_registry_key('HKEY_USERS\S-1-5-21-1319311448-2088773778-3166178
   it { should have_property_value('qword value', :type_qword, 'adff32') }
   it { should have_property_value('binary value', :type_binary, 'dfa0f066') }
 end
-```
+```
+
+###Notes:
+* Not all the matchers you are used to in Linux-like OS are supported in Windows, some because of differences between the operating systems (e.g. users and permissions model), some because they haven't been yet implemented.
+* All commands in the windows backend are run via powershell, so the output in case of stderr is a pretty ugly xml-like thing. Still it should contain some information to help troubleshooting.
+* The *command* type is executed again through powershell, so bear that in mind if you mean to run old CMD windows batch or programs. (i.e run the command using the **Invoke-Expression** Cmdlet, or the **&** Call Operator)

data/lib/serverspec/backend/cmd.rb

@@ -7,7 +7,7 @@ module Serverspec
 
       def run_command(cmd, opts={})
         script = create_script(cmd)
-        result = execute_script script
+        result = execute_script %Q{powershell -encodedCommand #{encode_script(script)}}
 
         if @example
           @example.metadata[:command] = script
@@ -18,15 +18,14 @@ module Serverspec
       end
 
       def execute_script script
-        ps_script = %Q{powershell -encodedCommand #{encode_script(script)}}
         if Open3.respond_to? :capture3
-          stdout, stderr, status = Open3.capture3(ps_script)
+          stdout, stderr, status = Open3.capture3(script)
           # powershell still exits with 0 even if there are syntax errors, although it spits the error out into stderr
           # so we have to resort to return an error exit code if there is anything in the standard error
           status = 1 if status == 0 and !stderr.empty?
           { :stdout => stdout, :stderr => stderr, :status => status }
         else
-          stdout = `#{ps_script} 2>&1`
+          stdout = `#{script} 2>&1`
           { :stdout => stdout, :stderr => nil, :status => $? }
         end
       end

data/lib/serverspec/backend/powershell/command.rb

@@ -30,6 +30,10 @@ module Serverspec
           raise "You must provide a specific Windows user/group" if id =~ /(owner|group|others)/
           identity = id || 'Everyone'
         end
+
+        def to_s
+          @script
+        end
       end
     end
   end

data/lib/serverspec/backend/powershell/script_helper.rb

@@ -47,10 +47,11 @@ EOF
         end
 
         def create_script command
-          script = build_command(command.script)
-          script = add_pre_command(script)
-          ps_functions = command.import_functions.map { |f| File.read(File.join(File.dirname(__FILE__), 'support', f)) }
-        <<-EOF
+          if command.is_a? Command
+            ps_functions = command.import_functions.map { |f| File.read(File.join(File.dirname(__FILE__), 'support', f)) }
+            script = build_command(command.script)
+            script = add_pre_command(script)
+            <<-EOF
 $exitCode = 1
 try {
   #{ps_functions.join("\n")}
@@ -62,6 +63,21 @@ try {
 Write-Output "Exiting with code: $exitCode"
 exit $exitCode
           EOF
+          else
+            script = build_command(command.to_s)
+            add_pre_command(script)
+          end
+        end
+
+        def check_running(process)
+          ret = run_command(commands.check_running(process))
+
+          # If the service is not registered, check the process
+          if ret[:exit_status] == 1
+            ret = run_command(commands.check_process(process))
+          end
+
+          ret[:exit_status] == 0
         end
       end
     end

data/lib/serverspec/backend/powershell/support/check_file_access_rules.ps1

@@ -2,11 +2,7 @@ function CheckFileAccessRules
 {
   param($path, $identity, $rules)
   
-  $result = $false
-  $accessRules = (Get-Acl $path).access | Where-Object {$_.AccessControlType -eq 'Allow' -and $_.IdentityReference -eq $identity }
-  if ($accessRules) {
-    $match = $accessRules.FileSystemRights.ToString() -Split (', ') | ?{$rules -contains $_}
-    $result = $match -ne $null -or $match.length -gt 0
-  }
-  $result
+  $accessRules = @((Get-Acl $path).access | Where-Object {$_.AccessControlType -eq 'Allow' -and $_.IdentityReference -eq $identity })
+  $match = @($accessRules | Where-Object {($_.FileSystemRights.ToString().Split(',') | % {$_.trim()} | ? {$rules -contains $_}) -ne $null})
+  $match.count -gt 0
 }

data/lib/serverspec/backend/powershell/support/is_port_listening.ps1

@@ -6,7 +6,7 @@ function IsPortListening
   foreach ($ipaddress in $networkIPs)
   {
     $matchExpression = ("$ipaddress" + ":" + $portNumber)
-    if ($protocol) { $matchExpression = ($protocol.toUpper() + "\s+$matchExpression") }    
+    if ($protocol) { $matchExpression = ($protocol.toUpper() + "\s+$matchExpression") }
     if ($netstatOutput -match $matchExpression) { return $true }
   }
   $false

data/lib/serverspec/commands/windows.rb

@@ -192,7 +192,9 @@ module Serverspec
         when :type_binary
           byte_array = [property[:value]].pack('H*').bytes.to_a
           "([byte[]] #{byte_array.join(',')})"
-        when:type_dword, :type_qword
+        when :type_dword
+          [property[:value].scan(/[0-9a-f]{2}/i).reverse.join].pack("H*").unpack("l").first
+        when :type_qword
           property[:value].hex
         else
           string_array = property[:value].split("\n").map {|s| "'#{s}'"}.reduce {|acc, s| "#{acc},#{s}"}

data/lib/serverspec/version.rb

@@ -1,3 +1,3 @@
 module Serverspec
-  VERSION = "0.10.6"
+  VERSION = "0.10.7"
 end

data/spec/backend/powershell/script_helper_spec.rb

@@ -75,3 +75,30 @@ describe "script encoding" do
     script.should == "dABlAHMAdABfAHAAbwB3AGUAcgBzAGgAZQBsAGwAXwBzAGMAcgBpAHAAdAA="
   end
 end
+
+describe 'script creation' do
+  context "powershell command" do
+    File.should_receive(:read).with(/test_function1.ps1/).and_return 'function test1'
+    command = Backend::PowerShell::Command.new do
+      using 'test_function1.ps1'
+      exec 'test command'
+    end
+    script = create_script command
+    script.should == <<-eof
+$exitCode = 1
+try {
+  function test1
+  $success = (test command)
+  if ($success -is [Boolean] -and $success) { $exitCode = 0 }
+} catch {
+  Write-Output $_.Exception.Message
+}
+Write-Output "Exiting with code: $exitCode"
+exit $exitCode
+eof
+  end
+
+  context 'simple command' do
+    create_script('test command').should == 'test command'
+  end
+end

data/spec/spec_helper.rb

@@ -39,10 +39,7 @@ module Serverspec
       clz.class_eval do
         include TestCommandRunner
         def run_command(cmd)
-          if RSpec.configuration.os =~ /Windows/
-            cmd = cmd.script
-          end
-          cmd = build_command(cmd)
+          cmd = build_command(cmd.to_s)
           cmd = add_pre_command(cmd)
           do_run cmd
         end

data/spec/windows/command_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+include Serverspec::Helper::Cmd
+RSpec.configure do |c|
+  c.os = 'Windows'
+end
+
+describe command('test_cmd /test/path/file') do
+  let(:stdout) { "test output 1.2.3\r\n" }
+  it { should return_stdout("test output 1.2.3") }
+  its(:command) { should eq 'test_cmd /test/path/file' }
+end
+
+describe 'complete matching of stdout' do
+  context command('test_cmd /test/path/file') do
+    let(:stdout) { "foocontent-should-be-includedbar\r\n" }
+    it { should_not return_stdout('content-should-be-included') }
+  end
+end
+
+describe 'regexp matching of stdout' do
+  context command('test_cmd /test/path/file') do
+    let(:stdout) { "test output 1.2.3\r\n" }
+    it { should return_stdout(/1\.2\.3/) }
+  end
+end
+
+describe command('test_cmd /test/path/file') do
+  let(:stdout) { "No such file or directory\r\n" }
+  it { should return_stderr("No such file or directory") }
+  its(:command) { should eq 'test_cmd /test/path/file' }
+end
+
+describe 'complete matching of stderr' do
+  context command('test_cmd /test/path/file') do
+    let(:stdout) { "No such file or directory\r\n" }
+    it { should_not return_stdout('file') }
+  end
+end
+
+describe 'regexp matching of stderr' do
+  context command('test_cmd /test/path/file') do
+    let(:stdout) { "No such file or directory\r\n" }
+    it { should return_stderr(/file/) }
+  end
+end
+
+describe command('test_cmd /test/path/file') do
+  it { should return_exit_status 0 }
+  its(:command) { should eq 'test_cmd /test/path/file' }
+end
+
+describe command('dir "c:\"') do
+  let(:stdout) { <<EOF
+    Directory: C:\
+
+Mode                LastWriteTime     Length Name
+----                -------------     ------ ----
+d-r--        23/09/2013  10:46 AM            Program Files
+d-r--        23/09/2013   1:21 PM            Program Files (x86)
+d----        17/10/2013   8:46 PM            temp
+d-r--        23/09/2013  11:52 AM            Users
+d----        23/09/2013   1:21 PM            Windows
+EOF
+    }
+
+  its(:stdout) { should match /Program Files/ }
+  its(:stderr) { should match /Program Files/ }
+
+  its(:stdout) { should eq stdout }
+end

data/spec/windows/service_spec.rb

@@ -22,3 +22,12 @@ end
 describe service('invalid-daemon') do
   it { should_not be_running }
 end
+
+describe service('Test service') do
+  it "should raise error if trying to check service process controller" do
+   expect { should be_running.under('supervisor') }.to raise_error
+ end
+  it "should raise error if trying to check service monitoring" do
+   expect { should_not be_monitored_by('monit') }.to raise_error
+ end
+end

data/spec/windows/windows_registry_key_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+include Serverspec::Helper::Cmd
+RSpec.configure do |c|
+  c.os = 'Windows'
+end
+
+describe windows_registry_key('PATH/TO/THE_KEY') do
+  it { should exist }
+  its(:command) { should == "(Get-Item 'Registry::PATH/TO/THE_KEY') -ne $null" }
+end
+
+describe windows_registry_key('PATH/TO/THE_KEY') do
+  it { should have_value('Test Value') }
+  its(:command) { should == "(Compare-Object (Get-Item 'Registry::PATH/TO/THE_KEY').GetValue('') @('Test Value')) -eq $null" }
+end
+
+describe 'Key value types' do
+  context 'default type' do
+    describe windows_registry_key('PATH/TO/THE_KEY') do
+      it { should have_property('TestProperty') }
+      its(:command) { should == "(Get-Item 'Registry::PATH/TO/THE_KEY').GetValueKind('TestProperty') -eq 'String'" }
+    end
+  end
+
+  {
+    :type_string       => 'String',
+    :type_binary       => 'Binary',
+    :type_dword        => 'DWord',
+    :type_qword        => 'QWord',
+    :type_multistring  => 'MultiString',
+    :type_expandstring => 'ExpandString'
+  }.each do |sym, type|
+    context "type #{type}" do
+      describe windows_registry_key('PATH/TO/THE_KEY') do
+        it { should have_property('TestProperty', sym) }
+        its(:command) { should == "(Get-Item 'Registry::PATH/TO/THE_KEY').GetValueKind('TestProperty') -eq '#{type}'" }
+      end
+    end
+  end
+end
+
+describe windows_registry_key('PATH/TO/THE_KEY') do
+  it { should have_property_value('TestProperty', :type_binary, '12a07b') }
+  its(:command) { should == "(Compare-Object (Get-Item 'Registry::PATH/TO/THE_KEY').GetValue('TestProperty') ([byte[]] 18,160,123)) -eq $null" }
+end
+
+describe windows_registry_key('PATH/TO/THE_KEY') do
+  it { should have_property_value('TestProperty', :type_dword, 'fffffd6c') }
+  its(:command) { should == "(Compare-Object (Get-Item 'Registry::PATH/TO/THE_KEY').GetValue('TestProperty') -660) -eq $null" }
+end
+
+describe windows_registry_key('PATH/TO/THE_KEY') do
+  it { should have_property_value('TestProperty', :type_qword, '1e240') }
+  its(:command) { should == "(Compare-Object (Get-Item 'Registry::PATH/TO/THE_KEY').GetValue('TestProperty') 123456) -eq $null" }
+end
+
+describe windows_registry_key('PATH/TO/THE_KEY') do
+  it {
+    value = <<-EOF
+test line1
+test line2
+test line3
+EOF
+    should have_property_value('TestProperty', :type_multistring, value)
+  }
+  its(:command) { should == "(Compare-Object (Get-Item 'Registry::PATH/TO/THE_KEY').GetValue('TestProperty') @('test line1','test line2','test line3')) -eq $null" }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverspec
 version: !ruby/object:Gem::Version
-  version: 0.10.6
+  version: 0.10.7
 platform: ruby
 authors:
 - Gosuke Miyashita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -95,7 +95,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- WindowsSupport.md
+- WINDOWS_SUPPORT.md
 - bin/serverspec-init
 - lib/serverspec.rb
 - lib/serverspec/attributes.rb
@@ -368,11 +368,13 @@ files:
 - spec/solaris11/zfs_spec.rb
 - spec/spec_helper.rb
 - spec/support/powershell_command_runner.rb
+- spec/windows/command_spec.rb
 - spec/windows/file_spec.rb
 - spec/windows/group_spec.rb
 - spec/windows/port_spec.rb
 - spec/windows/service_spec.rb
 - spec/windows/user_spec.rb
+- spec/windows/windows_registry_key_spec.rb
 homepage: http://serverspec.org/
 licenses:
 - MIT
@@ -564,8 +566,10 @@ test_files:
 - spec/solaris11/zfs_spec.rb
 - spec/spec_helper.rb
 - spec/support/powershell_command_runner.rb
+- spec/windows/command_spec.rb
 - spec/windows/file_spec.rb
 - spec/windows/group_spec.rb
 - spec/windows/port_spec.rb
 - spec/windows/service_spec.rb
 - spec/windows/user_spec.rb
+- spec/windows/windows_registry_key_spec.rb