serverspec-runner 1.2.2 → 1.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2E3MjEzYmE1NGQyYTQxODk2ZGJlODNmOGRiZDJkMTgyMTY4NzM4Nw==
-  data.tar.gz: !binary |-
-    Y2I3MDliZTAwZmQ3YzMxYzNlZTAyMzA2MDA2Y2U1OTA1YWVhN2JkNw==
+SHA256:
+  metadata.gz: 501b9ebe71d9843ce7b2395c9aadd866d216691a33f1ccc833c87290fcc363dc
+  data.tar.gz: 6aef5a317e062fdde40b9651ed01b61ed4fb9d03ae5c5ed519771b12f7b08d7d
 SHA512:
-  metadata.gz: !binary |-
-    OTVjZTg5M2FlNDkyNzdmMTZhYzc5NzE0MzM1YzZhZmY1N2M1MGUyNjgzM2Ix
-    YzhjYWU3ZWE0ODliYTNlYmU2OTcxMWZmZWI2OTM5MTIyN2VjYzU2M2FiYjA3
-    MjE0Nzg1MDUwM2VlY2U3MGM1ZjQ3NjI1N2VhYjQ0M2UzODcxNjk=
-  data.tar.gz: !binary |-
-    MjJmYmM2YjdmNWE2NGUxNDY5NWUzNDBiZTFmOTg2OTAyMjEyN2UyZDY0ZjRk
-    NDNkNzJjYWY1YmYzOTM0YjE0ZTcwMzgzNzliZDFkOWNlZGM3ZjlmODE1NDMz
-    ZGRhMzU2MTRiNjc0MjcwODY4ODk3NzU3MjY3YzE2OGExNzhlYjk=
+  metadata.gz: 2dfec5c6a8c0f7a1317afa51185f74186b760fb57e543828688e5553df91e2c9454f4b20c84ca6a0cd5c6a2cbb239faee1889881ca8ff9d3b7bd3c094b5c2cfc
+  data.tar.gz: 5bc13affbfbda46d6404ece51317bb076167f478ba2a4cbb44de079e22dbb07961622f86dd626853e41364420bdbd0b13058819629355475a1191ba3012ee901

data/.gitignore

@@ -17,3 +17,6 @@ test/version_tmp
 tmp
 .DS_Store
 .rvmrc
+
+_platforms.yml
+_serverspec_result.csv

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 
 rvm:
-  - 1.9.3
+#  - 1.9.3
   - 2.0.0
   - 2.1.5
   - 2.2.0

data/README.md

@@ -1,7 +1,7 @@
 serverspec-runner [![Gem Version](https://badge.fury.io/rb/serverspec-runner.svg)](http://badge.fury.io/rb/serverspec-runner)  [![BuildStatus](https://secure.travis-ci.org/hiracy/serverspec-runner.png)](http://travis-ci.org/hiracy/serverspec-runner)
 ======================
 
-Simple execution framework for [serverspec](http://serverspec.org/).
+Simple execution framework for [serverspec](http://serverspec.org/) run.
 
 ----
 
@@ -21,7 +21,7 @@ Edit your [spec-files](http://serverspec.org/resource_types.html).
 
     $ vim  /path/to/your_serverspec_root/test_top_dir/.../your_serverspec_test.rb
 
-Edit your infrastructure or middleware tests scenario to "scenario.yml".
+Edit your infrastructure or middleware tests scenario to "[scenario.yml](scenario.yml)".
 
 ```
 test_top_dir:                # test directory top

data/Rakefile

@@ -7,6 +7,7 @@ require 'net/ssh'
 require 'open-uri'
 require 'serverspec-runner'
 require 'serverspec-runner/util/hash'
+require 'serverspec-runner/ansible/inventory'
 
 desc "Run serverspec to all scenario"
 task :spec => 'spec:all'
@@ -128,6 +129,9 @@ namespace :spec do
           t.fail_on_error = false
           ENV['TARGET_HOST'] = host_alias
           ENV['TARGET_SSH_HOST'] = platform[host_alias.to_sym][:host] || host_alias
+          if platform[host_alias.to_sym].key?(:ssh_opts) && platform[host_alias.to_sym][:ssh_opts].key?(:port)
+            ENV['TARGET_CONNECTION'] = 'ssh'
+          end
         end
       end
 
@@ -161,21 +165,41 @@ namespace :spec do
     ENV['scenario'] = ENV['scenario_tmp']
   end
 
+  if !File.file?(ENV['scenario']) && !File.file?("#{ENV['specroot']}/scenario.yml")
+    print "\e[31m"
+    puts "scenario.yml is not found.(--help option can display manual))"
+    print "\e[m"
+    exit 1
+  end
+
   File.open(ENV['scenario'] || "#{ENV['specroot']}/scenario.yml") do |f|
     YAML.load_documents(f).each_with_index do |data, idx|
       if idx == 0
         scenarios = data
       else
-        data.each do |k, v|
-          platform[k.to_sym] = v.deep_symbolize_keys
+        if data != nil
+          data.each do |k, v|
+            platform[k.to_sym] = v.deep_symbolize_keys
+          end
         end
       end
     end
   end
 
+  if ENV['inventory']
+    if !File.file?(ENV['inventory'])
+      print "\e[31m"
+      puts "inventory file is not found.(--help option can display manual))"
+      print "\e[m"
+      exit 1
+    end
+
+    platform = Inventory.inventory_to_platform(YAML.load_file(ENV['inventory']))
+  end
+
   if !scenarios
     print "\e[31m"
-    puts "scenario.yml is empty."
+    puts "scenario is empty."
     print "\e[m"
     exit 1
   end

data/bin/serverspec-runner

@@ -11,6 +11,7 @@ showtasks = false
 
 opts = GetoptLong.new(
   ["--scenario",     "-s", GetoptLong::REQUIRED_ARGUMENT],
+  ["--inventory",    "-i", GetoptLong::REQUIRED_ARGUMENT],
   ["--specroot",     "-r", GetoptLong::REQUIRED_ARGUMENT],
   ["--ssh_options",  "-o", GetoptLong::REQUIRED_ARGUMENT],
   ["--explain",      "-e", GetoptLong::REQUIRED_ARGUMENT],
@@ -26,6 +27,8 @@ opts.each do |opt, arg|
   case opt
   when '--scenario'
     ENV['scenario'] = arg
+  when '--inventory'
+    ENV['inventory'] = arg
   when '--specroot'
     ENV['specroot'] = arg
   when '--ssh_options'
@@ -45,6 +48,7 @@ opts.each do |opt, arg|
   else
     puts "Usage: serverspec-runner (options)"
     puts "-s, --scenario     SCENARIO_FILE        path to scenario yml file"
+    puts "-i, --inventory    INVENTORY_FILE       path to ansible inventory yml file"
     puts "-r, --specroot     SPEC_ROOT            path to spec tests root dir"
     puts "-o, --ssh_options  SSH_OPTIONS_FILE     path to ssh options yml file"
     puts "-e, --explain      (short|long)         specify result explain length(default: short)"

data/lib/serverspec-runner/ansible/inventory.rb

@@ -0,0 +1,52 @@
+module Inventory
+  def self.inventory_to_platform(data)
+    platform = {}
+
+    data.each do |k, v|
+      v.each do |gk, gv|
+        if gk == 'hosts'
+          if gv.kind_of?(Hash)
+            gv.each do |hk, hv|
+              platform[hk] = convert_ssh_opt(v['vars']).merge(convert_ssh_opt(hv))
+            end
+          elsif gv.kind_of?(Array)
+            gv.each do |h|
+              platform[h.to_sym] = convert_ssh_opt(v['vars'])
+            end
+          end
+        end
+      end
+    end
+
+    platform
+  end
+
+  private
+
+  def self.convert_ssh_opt(src)
+    serverspec_opt = {}
+    serverspec_opt[:ssh_opts] = {}
+    src.each do |k, v|
+      case k
+      when 'ansible_host'
+        serverspec_opt[:host] = v
+      when 'ansible_user'
+        serverspec_opt[:ssh_opts][:user] = v
+      when 'ansible_port'
+        serverspec_opt[:ssh_opts][:port] = v
+      when 'ansible_ssh_private_key_file'
+        serverspec_opt[:ssh_opts][:keys] = Array(v)
+      when 'ansible_ssh_pass'
+        serverspec_opt[:ssh_opts][:password] = v
+      when 'ansible_ssh_common_args'
+        if v.include?('StrictHostKeyChecking=no')
+          serverspec_opt[:ssh_opts][:verify_host_key] = false
+        elsif v.include?('UserKnownHostsFile=/dev/null')
+          serverspec_opt[:ssh_opts][:user_known_hosts_file] = '/dev/null'
+        end
+      end
+    end
+
+    serverspec_opt
+  end
+end

data/lib/serverspec-runner/version.rb

@@ -1,3 +1,3 @@
 module ServerspecRunner
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/spec/example_win/default.rb

@@ -0,0 +1,18 @@
+require 'spec_helper_win'
+
+describe command('hostname') do
+  its(:stdout) { should match /HOSTNAME/ }
+end
+
+describe file('c:/windows') do
+  it { should be_directory }
+end
+
+describe command('tzutil /g') do
+  its(:stdout) { should match /Tokyo Standard Time/ }
+end
+
+describe windows_feature('notepad') do
+  it{ should be_installed }
+end
+

data/spec/spec_helper.rb

@@ -52,7 +52,7 @@ RSpec.configure do |c|
 
   set_property (YAML.load_file(ENV['platforms_tmp']))[ENV['TARGET_HOST'].to_sym]
 
-  if ENV['TARGET_SSH_HOST'] !~ /localhost|127\.0\.0\.1/
+  if ENV['TARGET_CONNECTION'] == 'ssh' || ENV['TARGET_SSH_HOST'] !~ /localhost|127\.0\.0\.1/
     c.host = ENV['TARGET_SSH_HOST']
     options = Net::SSH::Config.for(c.host, files=["~/.ssh/config"])
     ssh_opts ||= ssh_opts_default

data/spec/spec_helper_win.rb

@@ -0,0 +1,132 @@
+require 'serverspec'
+require 'pathname'
+require 'net/ssh'
+require 'net/ssh/proxy/command'
+require 'yaml'
+require 'csv'
+require 'serverspec-runner/util/hash'
+require 'winrm'
+
+# require extension libraries
+Dir.glob([
+  ENV['specroot'] + '/lib/extension/serverspec/**/*.rb',
+  ENV['specroot'] + '/lib/extension/specinfra/**/*.rb']).each {|f| require f}
+
+ssh_opts_default = YAML.load_file(ENV['ssh_options'])
+csv_path = ENV['result_csv']
+explains = []
+results = []
+row_num = []
+spacer_char = '  ' unless ENV['tableformat'] == 'csv'
+spacer_char = ',' if ENV['tableformat'] == 'csv'
+
+def get_example_desc(example_group, descriptions)
+
+  descriptions << example_group[:description]
+  return descriptions if example_group[:parent_example_group] == nil
+
+  get_example_desc(example_group[:parent_example_group], descriptions)
+end
+
+RSpec.configure do |c|
+
+  c.expose_current_running_example_as :example
+  c.path = ENV['EXEC_PATH']
+
+  run_path = c.files_to_run[0].split('/')
+
+  speck_i = 0
+  run_path.reverse.each_with_index do |r,i|
+    if r == 'spec'
+      speck_i = ((run_path.size - 1) - i)
+    end
+  end
+  sliced = run_path.slice((speck_i + 1)..(run_path.size - 2))
+  role_name = sliced.join('/')
+
+  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
+
+  set_property (YAML.load_file(ENV['platforms_tmp']))[ENV['TARGET_HOST'].to_sym]
+
+  if ENV['TARGET_SSH_HOST'] !~ /localhost|127\.0\.0\.1/
+    c.host = ENV['TARGET_SSH_HOST']
+    options = Net::SSH::Config.for(c.host, files=["~/.ssh/config"])
+    ssh_opts ||= ssh_opts_default
+    property[:ssh_opts].each { |k, v| ssh_opts[k.to_sym] = v } if property[:ssh_opts]
+    ssh_opts[:proxy] = Kernel.eval(ssh_opts[:proxy]) if ssh_opts[:proxy]
+    user    = options[:user] || ssh_opts[:user] || Etc.getlogin
+    options.merge!(ssh_opts)
+    set :ssh_options, options
+    set :backend, :ssh
+    set :request_pty, true
+  else
+    set :backend, :exec
+  end
+
+  prev_desc_hierarchy = nil
+
+  c.before(:suite) do
+    entity_host = (((ENV['TARGET_HOST'] != ENV['TARGET_SSH_HOST']) && (ENV['TARGET_SSH_HOST'] != nil)) ? "(#{ENV['TARGET_SSH_HOST']})" : "")
+    puts "\e[33m"
+    puts "### start [#{role_name}@#{ENV['TARGET_HOST']}] #{entity_host} serverspec... ###"
+    print "\e[m"
+
+    explains << "#{role_name}@#{ENV['TARGET_HOST']}#{entity_host}"
+    results << ""
+    row_num << 1
+  end
+
+  c.after(:each) do
+
+    if ENV['explain'] == 'long'
+      explains << spacer_char + example.metadata[:full_description]
+      results << (self.example.exception ? 'NG' : 'OK')
+      row_num << 1
+    else
+
+      spacer = ''
+      desc_hierarchy = get_example_desc(self.example.metadata[:example_group], []).reverse
+      desc_hierarchy.each_with_index do |ex, i|
+        spacer += spacer_char
+
+        if prev_desc_hierarchy != nil && prev_desc_hierarchy.length > i && prev_desc_hierarchy[i] == desc_hierarchy[i]
+        else
+          explains << spacer + ex
+          results << ''
+          row_num << i + 1
+        end
+      end
+
+      explains << spacer + spacer_char + (self.example.metadata[:description] || '')
+      results << (self.example.exception ? 'NG' : 'OK')
+      row_num << desc_hierarchy.length + 1
+
+      prev_desc_hierarchy = desc_hierarchy
+    end
+  end
+
+  c.after(:suite) do
+    CSV.open(csv_path, 'a') do |writer|
+      explains.each_with_index do |v, i|
+        writer << [v, results[i], row_num[i]]
+      end
+    end
+  end
+end
+
+set :backend, :winrm
+
+opts = {
+  user: "Username", # ex.) Administrator
+  password: "Password", # connection password
+  endpoint: "http://IPaddress:5985/wsman", 
+  operation_timeout: 300,
+}
+
+winrm = WinRM::Connection.new(opts)
+Specinfra.configuration.winrm = winrm

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: serverspec-runner
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - hiracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: simple execution framework for serverspec
@@ -88,9 +88,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -103,12 +103,15 @@ files:
 - lib/extension/specinfra/command/base/file.rb
 - lib/extension/specinfra/command/linux/base/mysql.rb
 - lib/serverspec-runner.rb
+- lib/serverspec-runner/ansible/inventory.rb
 - lib/serverspec-runner/util/hash.rb
 - lib/serverspec-runner/version.rb
 - scenario.yml
 - serverspec-runner.gemspec
 - spec/example/default.rb
+- spec/example_win/default.rb
 - spec/spec_helper.rb
+- spec/spec_helper_win.rb
 - ssh_options_default.yml
 homepage: https://github.com/hiracy/serverspec-runner
 licenses:
@@ -120,20 +123,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: simple execution framework for serverspec
 test_files:
 - spec/example/default.rb
+- spec/example_win/default.rb
 - spec/spec_helper.rb
+- spec/spec_helper_win.rb