serverspec 0.8.1 → 0.9.0

data/lib/serverspec/commands/windows.rb

@@ -0,0 +1,211 @@
+module Serverspec
+  module Commands
+    class Windows
+      class NotSupportedError < Exception; end
+      REGISTRY_KEY_TYPES = {
+        :type_string       => 'String',
+        :type_binary       => 'Binary',
+        :type_dword        => 'DWord',
+        :type_qword        => 'QWord',
+        :type_multistring  => 'MultiString',
+        :type_expandstring => 'ExpandString'
+      }
+
+      def method_missing method, *args
+        raise NotSupportedError.new "#{method} currently not supported in Windows os" if method.to_s =~ /^check_.+/
+        super(method, *args)
+      end
+
+      def check_file(file)
+        cmd = item_has_attribute file, 'Archive'
+        Backend::PowerShell::Command.new do
+          exec cmd
+        end
+      end
+
+      def check_file_hidden(file)
+        cmd = item_has_attribute file, 'Hidden'
+        Backend::PowerShell::Command.new do
+          exec cmd
+        end
+      end
+
+      def check_file_readonly(file)
+        cmd = item_has_attribute file, 'ReadOnly'
+        Backend::PowerShell::Command.new do
+          exec cmd
+        end
+      end
+
+      def check_file_system(file)
+        cmd = item_has_attribute file, 'System'
+        Backend::PowerShell::Command.new do
+          exec cmd
+        end
+      end
+      
+      def check_directory(dir)
+        cmd = item_has_attribute dir, 'Directory'
+        Backend::PowerShell::Command.new do
+          exec cmd
+        end
+      end
+
+      def check_file_contain(file, pattern)
+        Backend::PowerShell::Command.new do
+          exec "[Io.File]::ReadAllText('#{file}') -match '#{convert_regexp(pattern)}'"
+        end
+      end
+
+      def check_file_contain_within file, pattern, from=nil, to=nil
+        from ||= '^'
+        to ||= '$'
+        Backend::PowerShell::Command.new do
+          using 'crop_text.ps1'
+          exec %Q[(CropText -text ([Io.File]::ReadAllText('#{file}')) -fromPattern '#{convert_regexp(from)}' -toPattern '#{convert_regexp(to)}') -match '#{pattern}']
+        end
+      end
+
+      def check_access_by_user(file, user, access)
+        case access
+        when 'r'
+          check_readable(file, user)
+        when 'w'
+          check_writable(file, user)
+        when 'x'
+          check_executable(file, user)
+        end
+      end
+
+      def check_readable(file, by_whom)
+        Backend::PowerShell::Command.new do
+          using 'check_file_access_rules.ps1'
+          exec "CheckFileAccessRules -path '#{file}' -identity '#{get_identity by_whom}' -rules @('FullControl', 'Modify', 'ReadAndExecute', 'Read', 'ListDirectory')"
+        end
+      end
+
+      def check_writable(file, by_whom)
+        Backend::PowerShell::Command.new do
+          using 'check_file_access_rules.ps1'
+          exec "CheckFileAccessRules -path '#{file}' -identity '#{get_identity by_whom}' -rules @('FullControl', 'Modify', 'Write')"
+        end
+      end
+
+      def check_executable(file, by_whom)
+        Backend::PowerShell::Command.new do
+          using 'check_file_access_rules.ps1'
+          exec "CheckFileAccessRules -path '#{file}' -identity '#{get_identity by_whom}' -rules @('FullControl', 'Modify', 'ReadAndExecute', 'ExecuteFile')"
+        end
+      end
+
+      def check_installed(package, version=nil)
+        version_selection = version.nil? ? "" : "-appVersion '#{version}'"
+        Backend::PowerShell::Command.new do
+          using 'find_installed_application.ps1'
+          exec "(FindInstalledApplication -appName '#{package}' #{version_selection}) -ne $null"
+        end
+      end
+
+      def check_enabled(service, level=nil)
+        Backend::PowerShell::Command.new do
+          using 'find_service.ps1'
+          exec "(FindService -name '#{service}').StartMode -eq 'Auto'"
+        end
+      end
+
+      def check_running(service)
+        Backend::PowerShell::Command.new do
+          using 'find_service.ps1'
+          exec "(FindService -name '#{service}').State -eq 'Running'"
+        end
+      end
+
+      def check_process(process)
+        Backend::PowerShell::Command.new do
+          exec "(Get-Process '#{process}') -ne $null"
+        end
+      end
+
+      def check_listening(port)
+        Backend::PowerShell::Command.new do
+          using 'is_port_listening.ps1'
+          exec "IsPortListening -portNumber #{port}"
+        end
+      end
+
+      def check_listening_with_protocol(port, protocol)
+        Backend::PowerShell::Command.new do
+          using 'is_port_listening.ps1'
+          exec "IsPortListening -portNumber #{port} -protocol '#{protocol}'"
+        end
+      end
+
+      def check_user(user)
+        user_id, domain = windows_account user
+        Backend::PowerShell::Command.new do
+          using 'find_user.ps1'
+          exec "(FindUser -userName '#{user_id}'#{domain.nil? ? "" : " -domain '#{domain}'"}) -ne $null"
+        end
+      end
+
+      def check_group(group)
+        group_id, domain = windows_account group
+        Backend::PowerShell::Command.new do
+          using 'find_group.ps1'
+          exec "(FindGroup -groupName '#{group_id}'#{domain.nil? ? "" : " -domain '#{domain}'"}) -ne $null"
+        end
+      end
+
+      def check_belonging_group(user, group)
+        user_id, user_domain = windows_account user
+        group_id, group_domain = windows_account group
+        Backend::PowerShell::Command.new do
+          using 'find_user.ps1'
+          using 'find_group.ps1'
+          using 'find_usergroup.ps1'
+          exec "(FindUserGroup -userName '#{user_id}'#{user_domain.nil? ? "" : " -userDomain '#{user_domain}'"} -groupName '#{group_id}'#{group_domain.nil? ? "" : " -groupDomain '#{group_domain}'"}) -ne $null"
+        end
+      end
+
+      def check_registry_key(key_name, key_property = {})
+        if key_property.empty?
+          cmd = "(Get-Item 'Registry::#{key_name}') -ne $null"
+        else
+          if key_property.key? :value
+            value = convert_key_property_value key_property
+            cmd = "(Compare-Object (Get-Item 'Registry::#{key_name}').GetValue('#{key_property[:name]}') #{value}) -eq $null"
+          else
+            cmd = "(Get-Item 'Registry::#{key_name}').GetValueKind('#{key_property[:name]}') -eq '#{REGISTRY_KEY_TYPES[key_property[:type]]}'"
+          end
+        end
+        Backend::PowerShell::Command.new { exec cmd }
+      end
+
+      private
+
+      def item_has_attribute item, attribute
+        "((Get-Item -Path '#{item}' -Force).attributes.ToString() -Split ', ') -contains '#{attribute}'"
+      end
+
+      def convert_key_property_value property
+        case property[:type]
+        when :type_binary
+          byte_array = [property[:value]].pack('H*').bytes.to_a
+          "([byte[]] #{byte_array.join(',')})"
+        when:type_dword, :type_qword
+          property[:value].hex
+        else
+          string_array = property[:value].split("\n").map {|s| "'#{s}'"}.reduce {|acc, s| "#{acc},#{s}"}
+          "@(#{string_array})"
+        end
+      end
+
+      def windows_account account
+        match = /((.+)\\)?(.+)/.match account
+        domain = match[2]
+        name = match[3]
+        [name, domain]
+      end
+    end
+  end
+end

data/lib/serverspec/helper/cmd.rb

@@ -0,0 +1,15 @@
+module Serverspec
+  module Helper
+    module Cmd
+      def backend(commands_object=nil)
+        if ! respond_to?(:commands)
+          commands_object = Serverspec::Commands::Windows.new
+        end
+        instance = Serverspec::Backend::Cmd.instance
+        instance.set_commands(commands_object || commands)
+        instance
+      end
+    end
+  end
+end
+

data/lib/serverspec/helper/type.rb

@@ -4,7 +4,7 @@ module Serverspec
       types = %w(
         base yumrepo service package port file cron command linux_kernel_parameter iptables host
         routing_table default_gateway selinux user group zfs ipnat ipfilter kernel_module interface php_config
-        mail_alias
+        mail_alias windows_registry_key
       )
 
       types.each {|type| require "serverspec/type/#{type}" }

data/lib/serverspec/helper/windows.rb

@@ -0,0 +1,9 @@
+module Serverspec
+  module Helper
+    module Windows
+      def commands
+        Serverspec::Commands::Windows.new
+      end
+    end
+  end
+end

data/lib/serverspec/helper/winrm.rb

@@ -0,0 +1,15 @@
+module Serverspec
+  module Helper
+    module WinRM
+      def backend(commands_object=nil)
+        if ! respond_to?(:commands)
+          commands_object = Serverspec::Commands::Windows.new
+        end
+        instance = Serverspec::Backend::WinRM.instance
+        instance.set_commands(commands_object || commands)
+        instance
+      end
+    end
+  end
+end
+

data/lib/serverspec/helper.rb

@@ -3,6 +3,8 @@ require 'etc'
 # Backend helpers
 require 'serverspec/helper/ssh'
 require 'serverspec/helper/exec'
+require 'serverspec/helper/cmd'
+require 'serverspec/helper/winrm'
 require 'serverspec/helper/puppet'
 
 # Command helpers
@@ -14,6 +16,7 @@ require 'serverspec/helper/solaris10'
 require 'serverspec/helper/solaris11'
 require 'serverspec/helper/smartos'
 require 'serverspec/helper/darwin'
+require 'serverspec/helper/windows'
 require 'serverspec/helper/detect_os'
 
 # Attributes helper

data/lib/serverspec/setup.rb

@@ -1,21 +1,18 @@
 require 'fileutils'
+require 'erb'
 
 module Serverspec
   class Setup
     def self.run
-      prompt = <<-EOF
-Select a backend type:
 
-  1) SSH
-  2) Exec (local)
+      ask_os_type
 
-Select number: 
-EOF
-      print prompt.chop
-      num = gets.to_i - 1
-      puts
+      if @os_type == 'UN*X'
+        ask_unix_backend
+      else
+        ask_windows_backend
+      end
 
-      @backend_type = [ 'Ssh', 'Exec' ][num]
       if @backend_type == 'Ssh'
         print "Vagrant instance y/n: "
         @vagrant = gets.chomp
@@ -37,14 +34,63 @@ EOF
       else
         @hostname = 'localhost'
       end
+
       [ 'spec', "spec/#{@hostname}" ].each { |dir| safe_mkdir(dir) }
       safe_create_spec
       safe_create_spec_helper
       safe_create_rakefile
     end
 
-    def self.safe_create_spec
+    def self.ask_os_type
+      prompt = <<-EOF
+Select OS type:
+
+  1) UN*X
+  2) Windows
+
+Select number: 
+EOF
+
+      print prompt.chop
+      num = gets.to_i - 1
+      puts
+
+      @os_type = [ 'UN*X', 'Windows' ][num] || 'UN*X'
+    end
+
+    def self.ask_unix_backend
+      prompt = <<-EOF
+Select a backend type:
+
+  1) SSH
+  2) Exec (local)
+
+Select number: 
+EOF
+      print prompt.chop
+      num = gets.to_i - 1
+      puts
+
+      @backend_type = [ 'Ssh', 'Exec' ][num] || 'Exec'
+    end
+
+    def self.ask_windows_backend
+      prompt = <<-EOF
+Select a backend type:
+
+  1) WinRM
+  2) Cmd (local)
+
+Select number: 
+EOF
+      print prompt.chop
+      num = gets.to_i - 1
+      puts
+
+      @backend_type = [ 'WinRM', 'Cmd' ][num] || 'Exec'
+    end
 
+    def self.safe_create_spec
       content = <<-EOF
 require 'spec_helper'
 
@@ -92,77 +138,8 @@ EOF
     end
 
     def self.safe_create_spec_helper
-      content = <<-EOF
-require 'serverspec'
-require 'pathname'
-### include requirements ###
-
-### include backend helper ###
-include Serverspec::Helper::DetectOS
-
-RSpec.configure do |c|
-  if ENV['ASK_SUDO_PASSWORD']
-    require 'highline/import'
-    c.sudo_password = ask("Enter sudo password: ") { |q| q.echo = false }
-  else
-    c.sudo_password = ENV['SUDO_PASSWORD']
-  end
-  ### include backend conf ###
-end
-EOF
-
-        if not @backend_type.nil?
-          content.gsub!(/### include backend helper ###/, "include Serverspec::Helper::#{@backend_type}")
-          case @backend_type
-            when 'Ssh'
-              content.gsub!(/### include requirements ###/, "require 'net/ssh'")
-              content.gsub!(/### include backend conf ###/, "c.before :all do
-    block = self.class.metadata[:example_group_block]
-    if RUBY_VERSION.start_with?('1.8')
-      file = block.to_s.match(/.*@(.*):[0-9]+>/)[1]
-    else
-      file = block.source_location.first
-    end
-    host  = File.basename(Pathname.new(file).dirname)
-    if c.host != host
-      c.ssh.close if c.ssh
-      c.host  = host
-      options = Net::SSH::Config.for(c.host)
-      user    = options[:user] || Etc.getlogin
-      ### include vagrant conf ###
-      c.ssh   = Net::SSH.start(c.host, user, options)
-    end
-  end")
-            if @vagrant
-              content.gsub!(/### include vagrant conf ###/,"
-      vagrant_up = `vagrant up #{@hostname}`
-      config = `vagrant ssh-config #{@hostname}`
-      if config != ''
-        config.each_line do |line|
-          if match = /HostName (.*)/.match(line)
-            c.host = match[1]
-          elsif  match = /User (.*)/.match(line)
-            user = match[1]
-          elsif match = /IdentityFile (.*)/.match(line)
-            options[:keys] =  [match[1].gsub(/\"/,'')]
-          elsif match = /Port (.*)/.match(line)
-            options[:port] = match[1]
-          end
-        end
-      end
-    ")
-            else
-              content.gsub!(/### include vagrant conf ###/,'')
-            end
-            when 'Exec'
-              content.gsub!(/### include backend conf ###/, "c.before :all do
-  end")
-            when 'Puppet'
-              content.gsub!(/### include requirements ###/, "require 'puppet'\nrequire 'serverspec/backend/puppet'
-")
-          end
-        end
-
+      requirements = []
+      content = ERB.new(DATA.read, nil, '-').result(binding)
       if File.exists? 'spec/spec_helper.rb'
         old_content = File.read('spec/spec_helper.rb')
         if old_content != content
@@ -233,6 +210,5 @@ EOF
         exit 1
       end
     end
-
   end
 end

data/lib/serverspec/type/windows_registry_key.rb

@@ -0,0 +1,21 @@
+module Serverspec
+  module Type
+    class WindowsRegistryKey < Base
+      def exists?
+        backend.check_registry_key(@name)
+      end
+
+      def has_property?(property_name, property_type = :type_string)
+        backend.check_registry_key(@name, {:name => property_name, :type => property_type})
+      end
+
+      def has_value?(value)
+        backend.check_registry_key(@name, {:name => '', :type => :type_string, :value => value})
+      end
+
+      def has_property_value?(property_name, property_type, value)
+        backend.check_registry_key(@name, {:name => property_name, :type => property_type, :value => value})
+      end
+    end
+  end
+end

data/lib/serverspec/version.rb

@@ -1,3 +1,3 @@
 module Serverspec
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/lib/serverspec.rb

@@ -16,6 +16,7 @@ require 'serverspec/commands/solaris10'
 require 'serverspec/commands/solaris11'
 require 'serverspec/commands/smartos'
 require 'serverspec/commands/darwin'
+require 'serverspec/commands/windows'
 require 'serverspec/configuration'
 require 'rspec/core/formatters/base_formatter'
 
@@ -39,10 +40,12 @@ RSpec.configure do |c|
   c.include(Serverspec::Helper::Solaris11, :os => :solaris11)
   c.include(Serverspec::Helper::SmartOS,   :os => :smartos)
   c.include(Serverspec::Helper::Darwin,    :os => :darwin)
+  c.include(Serverspec::Helper::Windows,   :os => :windows)
   c.add_setting :os,            :default => nil
   c.add_setting :host,          :default => nil
   c.add_setting :ssh,           :default => nil
   c.add_setting :sudo_password, :default => nil
+  c.add_setting :winrm,         :default => nil
   Serverspec.configuration.defaults.each { |k, v| c.add_setting k, :default => v }
   c.before :each do
     backend.set_example(example)

data/spec/backend/cmd/configuration_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'support/powershell_command_runner'
+
+include Serverspec::Helper::Cmd
+include Serverspec::Helper::Windows
+
+describe "Cmd" do
+  it_behaves_like "a powershell command runner"
+end

data/spec/backend/powershell/script_helper_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+include Serverspec::Backend::PowerShell::ScriptHelper
+
+describe 'build command with path' do
+  before :each do
+    RSpec.configure do |c|
+      c.path = 'c:/test/path/bin'
+    end
+  end
+
+  it "should prefix the command with the path instruction" do 
+    cmd = build_command('run_script -f param')
+    cmd.should eq <<-eof
+$env:path = "c:/test/path/bin;$env:path"
+run_script -f param
+eof
+  end
+
+  after :each do
+    RSpec.configure do |c|
+      c.path = nil
+    end
+  end
+end
+
+describe 'add pre-command' do
+  before :each do
+    Serverspec.configuration.pre_command = 'test_pre_command'
+  end
+
+  it "should add the test for pre_command before the command" do
+    cmd = add_pre_command('run_script -f param')
+    cmd.should eq <<-eof
+if (test_pre_command)
+{
+run_script -f param
+}
+eof
+  end
+
+  context "with path" do
+    before :each do
+      RSpec.configure do |c|
+        c.path = 'c:/test/path/bin'
+      end
+    end
+
+  it "should add the path instruction and the test for pre_command before the command" do
+    cmd = add_pre_command('run_script -f param')
+    cmd.should eq <<-eof
+$env:path = "c:/test/path/bin;$env:path"
+if (test_pre_command)
+{
+run_script -f param
+}
+eof
+  end
+
+    after :each do
+      RSpec.configure do |c|
+        c.path = nil
+      end
+    end
+  end
+
+  after :each do
+    Serverspec.configuration.pre_command = nil
+  end
+end
+
+describe "script encoding" do
+  it "should encode the given script" do
+    script = encode_script("test_powershell_script")
+    script.should == "dABlAHMAdABfAHAAbwB3AGUAcgBzAGgAZQBsAGwAXwBzAGMAcgBpAHAAdAA="
+  end
+end

data/spec/backend/winrm/configuration_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'support/powershell_command_runner'
+
+include Serverspec::Helper::WinRM
+include Serverspec::Helper::Windows
+
+describe "WinRM" do
+  it_behaves_like "a powershell command runner"
+end

data/spec/spec_helper.rb

@@ -11,10 +11,8 @@ Dir[PROJECT_ROOT.join("spec/support/**/*.rb")].each { |file| require(file) }
 
 module Serverspec
   module Backend
-    class Exec
-      def run_command(cmd)
-        cmd = build_command(cmd)
-        cmd = add_pre_command(cmd)
+    module TestCommandRunner
+      def do_run cmd
         if @example
           @example.metadata[:subject].set_command(cmd)
         end
@@ -36,29 +34,23 @@ module Serverspec
         end
       end
     end
-
-    class Ssh
-      def run_command(cmd)
-        cmd = build_command(cmd)
-        cmd = add_pre_command(cmd)
-        if @example
-          @example.metadata[:subject].set_command(cmd)
+    [Exec, Ssh].each do |clz|
+      clz.class_eval do
+        include TestCommandRunner
+        def run_command(cmd)
+          cmd = build_command(cmd)
+          cmd = add_pre_command(cmd)
+          do_run cmd
         end
-
-        if cmd =~ /invalid/
-          {
-            :stdout      => ::Serverspec.configuration.stdout,
-            :stderr      => ::Serverspec.configuration.stderr,
-            :exit_status => 1,
-            :exit_signal => nil
-          }
-        else
-          {
-            :stdout      => ::Serverspec.configuration.stdout,
-            :stderr      => ::Serverspec.configuration.stderr,
-            :exit_status => 0,
-            :exit_signal => nil
-          }
+      end
+    end
+    [Cmd, WinRM].each do |clz|
+      clz.class_eval do
+        include TestCommandRunner
+        def run_command(cmd)
+          cmd = build_command(cmd.script)
+          cmd = add_pre_command(cmd)
+          do_run cmd
         end
       end
     end