nodespec 0.1.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be7328ed95144b05ecb62ff63b1bd38101d626ae
-  data.tar.gz: fd27d50ae085de35513cdef5cf12e4b6223e9180
+  metadata.gz: c521201ce3c84255c9eadcf6f4e120601f2c6782
+  data.tar.gz: b5128627491fd84aae37789dca3560d77531284d
 SHA512:
-  metadata.gz: 38a821a5b1a5db66e89d88aa04b751e34a432dfcbba50eee6dc294a59b493863628507a1a060cb93012557ac6adb433eb431aa1e5aef08c6df54cd540e7e02bd
-  data.tar.gz: 50f522db6244b8509713abffc8adf6f07e4c6abb1908f6ed6597af760b6062c31201492e5bc4dfda8bdd38118bd5246c3ad8aaeebb51f6d7d7c7cea4c04f38b8
+  metadata.gz: 6e08d0e4dc3acf0545ec32f0e4ada934e7899df36d6225028995589b8a8ffa992dc2b19760afefa90faa2d55a9bfa973c13f47c41cb055a3af3bb32468f71ce7
+  data.tar.gz: f5e3b4ae194e6f943ba560e33abb43d4bc823f0309f09d7e0a8bd2a4ce07077ee8a0f1fb106aba5cfc61cf8532a484a72edf2c394633f771dfb7f5becc9fabf4

data/.gitignore

@@ -1,3 +1,4 @@
 .rspec
 .ruby-version
-pkg/
+pkg/
+TODO.txt

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    nodespec (0.1.9)
+    nodespec (1.0.0)
       net-ssh
-      serverspec
-      specinfra (>= 1.18.4)
+      os
+      serverspec (~> 2.3)
+      specinfra (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -22,7 +23,6 @@ GEM
       ffi (>= 1.0.1)
     gyoku (1.1.1)
       builder (>= 2.1.2)
-    highline (1.6.21)
     httpclient (2.4.0)
     httpi (0.9.7)
       rack
@@ -33,24 +33,30 @@ GEM
       multi_json (>= 1.8.4)
     mini_portile (0.6.0)
     multi_json (1.10.1)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
     net-ssh (2.9.1)
     nokogiri (1.6.2.1)
       mini_portile (= 0.6.0)
     nori (1.1.5)
+    os (0.9.6)
     rack (1.5.2)
     rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.2)
+      rspec-support (~> 3.1.0)
+    rspec-its (1.0.1)
+      rspec-core (>= 2.99.0.beta1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
     rubyntlm (0.1.1)
     savon (0.9.5)
       akami (~> 1.0)
@@ -60,12 +66,14 @@ GEM
       nokogiri (>= 1.4.0)
       nori (~> 1.0)
       wasabi (~> 1.0)
-    serverspec (0.15.4)
-      highline
+    serverspec (2.3.1)
+      multi_json
+      rspec (~> 3.0)
+      rspec-its
+      specinfra (~> 2.3)
+    specinfra (2.4.1)
+      net-scp
       net-ssh
-      rspec (>= 2.13.0)
-      specinfra (>= 0.7.1)
-    specinfra (1.22.0)
     uuidtools (2.1.4)
     wasabi (1.0.0)
       nokogiri (>= 1.4.0)
@@ -86,5 +94,5 @@ DEPENDENCIES
   bundler
   nodespec!
   rake
-  rspec (~> 3.0)
+  rspec (~> 3.1)
   winrm

data/README.md

@@ -1,11 +1,13 @@
 nodespec
 ========
 
-RSpec style tests for multiple nodes/server instances with support for provisioning with puppet, chef, ansible
+RSpec style tests for multiple nodes/server instances with support for provisioning with puppet, chef, ansible.
+
+- [**Read the documentation**](https://github.com/smontanari/nodespec/wiki)
 
 ## Nodespec vs Serverspec
 [Serverspec](http://serverspec.org) is a popular gem that allows you to write rspec tests to validate your servers/hosts configuration.
-  
+
 Nodespec is not an alternative to Serverspec, rather it's build on top of it, so you can still leverage all of its features while enjoying some extra goodies.
 
 #### What's different
@@ -37,7 +39,7 @@ end
 No more ruby code and create programmatically SSH objects, just a quick and easy inline (or file/yaml based) configuration:
 
 ```ruby
-describe "test.example1.com", nodespec: {
+describe "test.example.com", nodespec: {
     'adapter' => 'ssh',
     'user'    => 'testuser',
     'keys'    => 'path/to/key'
@@ -48,10 +50,10 @@ end
 #### Support connections to Windows & Un*x servers
 One of the major limitations of serverspec is that you have to make a hard decision beforehand on which OS/backend you are targeting with your tests. In particular you have to include specific specinfra modules in your `spec_helper` depending on whether you're connecting to Un\*x or Windows machines, and you cannot test both OS as part of the same spec run (unless you start hacking some conditional logic in your spec_helper, that is).
 
-With Nodespec that problem is resolved and you can easily connect and test multiple OS and multiple backends in the same rspec run. For instance, to connect to a windows box:
+With Nodespec that problem is resolved and you can easily connect and test multiple OS and multiple backends in the same rspec run. For instance, to connect to a Gentoo box:
 ```ruby
 describe "test.example2.com", nodespec: {
-    'os'              => 'Windows',
+    'os'              => 'Gentoo',
     'adapter'         => 'winrm',
     'user'            => 'testuser',
     'pass'            => 'somepass',
@@ -80,15 +82,15 @@ end
 
 #### Puppet
 ```ruby
-describe "server1", nodespec: {'adapter' => 'vagrant'} do
+describe "test.server", nodespec: {'adapter' => 'ssh'} do
   before :all do
     provision_node_with_puppet do
       set_modulepaths '/vshared/src/modules'
       set_hieradata('users' => {'roger' => {'uid' => 5801}, 'peter' => {'uid' => 5802}})
       puppet_apply_execute "include demo::wheel_users"
-    end
+    end    
   end
-...    
+...
 end
 ```
 

data/lib/nodespec/backend_proxy/ssh.rb

@@ -5,7 +5,7 @@ module NodeSpec
   module BackendProxy
     class Ssh < Base
       include UnixshellUtility
-      
+
       ROOT_USER = 'root'
 
       def initialize(ssh)

data/lib/nodespec/backend_proxy/winrm.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module NodeSpec
   module BackendProxy
-    class WinRM < Base
+    class Winrm < Base
       def initialize(winrm)
         @winrm_session = winrm
       end

data/lib/nodespec/backend_proxy.rb

@@ -0,0 +1,23 @@
+require 'specinfra/backend'
+%w[exec cmd ssh winrm].each {|f| require_relative "backend_proxy/#{f}"}
+
+module NodeSpec
+  module BackendProxy
+    PROXIES = {
+      exec:  'Exec',
+      ssh:   'Ssh',
+      cmd:   'Cmd',
+      winrm: 'Winrm'
+    }
+    class SpecinfraCompatibilityError < StandardError; end
+
+    PROXIES.values.each do |name|
+      raise SpecinfraCompatibilityError.new("Specinfra::Backend::#{name} is not defined!") unless Specinfra::Backend.const_defined?(name)
+    end
+
+    def self.create(backend, *args)
+      class_name = PROXIES.fetch(backend, PROXIES[:exec])
+      self.const_get(class_name).send(:new, *args)
+    end
+  end
+end

data/lib/nodespec/communication_adapters/aws_ec2.rb

@@ -6,16 +6,16 @@ module NodeSpec
   module CommunicationAdapters
     class AwsEc2
       GEMLOAD_ERROR = 'In order to use any aws adapter you must install the Amazon Web Service gem'
-      def self.communicator_for(node_name, os = nil, options = {})
+      def self.communicator_for(node_name, options = {})
         RuntimeGemLoader.require_or_fail('aws-sdk', GEMLOAD_ERROR) do
           instance_name = options['instance'] || node_name
           ec2_instance = AWS.ec2.instances[instance_name]
 
           raise "EC2 Instance #{instance_name} is not reachable" unless ec2_instance.exists? && ec2_instance.status == :running
           if options.has_key?('winrm')
-            WinrmCommunicator.new(ec2_instance.public_dns_name, os, options['winrm'])
+            WinrmCommunicator.new(ec2_instance.public_dns_name, options['winrm'])
           else
-            SshCommunicator.new(ec2_instance.public_dns_name, os, options['ssh'] || {})
+            SshCommunicator.new(ec2_instance.public_dns_name, options['ssh'] || {})
           end
         end
       end

data/lib/nodespec/communication_adapters/native_communicator.rb

@@ -1,31 +1,24 @@
+require 'os'
 require 'nodespec/verbose_output'
-require_relative 'local_backend'
+require 'nodespec/backend_proxy'
 
 module NodeSpec
   module CommunicationAdapters
     class NativeCommunicator
-      include LocalBackend
       include VerboseOutput
 
-      attr_reader :os
-
-      def initialize(os = nil)
-        @os = os
+      def bind_to(configuration)
+        configuration.unbind_ssh_session
+        configuration.unbind_winrm_session
+        verbose_puts "\nRunning on local host..."
       end
 
-      def bind_to(configuration)
-        if configuration.ssh
-          msg = "\nClosing connection to #{configuration.ssh.host}"
-          msg << ":#{configuration.ssh.options[:port]}" if configuration.ssh.options[:port]
-          verbose_puts msg
-          configuration.ssh.close
-          configuration.ssh = nil
-          verbose_puts "\nRunning on local host..."
-        end
+      def backend_proxy
+        BackendProxy.create(backend)
+      end
 
-        if configuration.winrm
-          configuration.winrm = nil
-        end
+      def backend
+        OS.windows? ? :cmd : :exec
       end
     end
   end

data/lib/nodespec/communication_adapters/ssh.rb

@@ -1,13 +1,12 @@
-require 'net/ssh'
 require_relative 'ssh_communicator'
 
 module NodeSpec
   module CommunicationAdapters
     class Ssh
-      def self.communicator_for(node_name, os = nil, options = {})
+      def self.communicator_for(node_name, options = {})
         opts = options.dup
         host = opts.delete('host') || node_name
-        SshCommunicator.new(host, os, opts)
+        SshCommunicator.new(host, opts)
       end
     end
   end

data/lib/nodespec/communication_adapters/ssh_communicator.rb

@@ -1,17 +1,15 @@
 require 'net/ssh'
 require 'nodespec/verbose_output'
-require_relative 'remote_backend'
+require 'nodespec/backend_proxy'
 
 module NodeSpec
   module CommunicationAdapters
     class SshCommunicator
       include VerboseOutput
-      include RemoteBackend
-      attr_reader :session, :os
+      attr_reader :session
 
-      def initialize(host, os = nil, options = {})
+      def initialize(host, options = {})
         @host = host
-        @os = os
         @ssh_options = Net::SSH.configuration_for(@host)
         @user = options['user'] || @ssh_options[:user]
         %w[port password keys].each do |param|
@@ -20,34 +18,23 @@ module NodeSpec
       end
 
       def bind_to(configuration)
-        configuration.winrm = nil if configuration.winrm
-        current_session = configuration.ssh
-
-        close_ssh_session(current_session) if current_session && (current_session.host != @host || current_session.options[:port] != @ssh_options[:port])
-
-        if current_session.nil? || current_session.closed?
-          current_session = start_new_ssh_session
-          configuration.host = @host
-          configuration.ssh = current_session
+        configuration.unbind_winrm_session
+
+        @session = configuration.bind_ssh_session_for(@host, @ssh_options[:port]) do
+          msg = "\nConnecting to #{@host}"
+          msg << ":#{@ssh_options[:port]}" if @ssh_options[:port]
+          msg << " as #{@user}..."
+          verbose_puts msg
+          Net::SSH.start(@host, @user, @ssh_options)
         end
-        @session = current_session
       end
 
-      private
-
-      def close_ssh_session(session)
-        msg = "\nClosing connection to #{session.host}"
-        msg << ":#{session.options[:port]}" if session.options[:port]
-        verbose_puts msg
-        session.close
+      def backend_proxy
+        BackendProxy.create(:ssh, @session)
       end
 
-      def start_new_ssh_session
-        msg = "\nConnecting to #{@host}"
-        msg << ":#{@ssh_options[:port]}" if @ssh_options[:port]
-        msg << " as #{@user}..."
-        verbose_puts msg
-        Net::SSH.start(@host, @user, @ssh_options)
+      def backend
+        :ssh
       end
     end
   end

data/lib/nodespec/communication_adapters/vagrant.rb

@@ -4,10 +4,10 @@ require_relative 'ssh_communicator'
 module NodeSpec
   module CommunicationAdapters
     class Vagrant
-      def self.communicator_for(node_name, os = nil, options = {})
+      def self.communicator_for(node_name, options = {})
         vm_name = options['vm_name'] || node_name
         fetch_connection_details(vm_name) do |host, opts|
-          SshCommunicator.new(host, os, opts)
+          SshCommunicator.new(host, opts)
         end
       end
 

data/lib/nodespec/communication_adapters/winrm.rb

@@ -3,10 +3,10 @@ require_relative 'winrm_communicator'
 module NodeSpec
   module CommunicationAdapters
     class Winrm
-      def self.communicator_for(node_name, os = nil, options = {})
+      def self.communicator_for(node_name, options = {})
         opts = options.dup
         hostname = opts.delete('host') || node_name
-        WinrmCommunicator.new(hostname, os, opts)
+        WinrmCommunicator.new(hostname, opts)
       end
     end
   end

data/lib/nodespec/communication_adapters/winrm_communicator.rb

@@ -1,24 +1,23 @@
+require 'winrm'
 require 'nodespec/verbose_output'
 require 'nodespec/runtime_gem_loader'
-require_relative 'remote_backend'
+require 'nodespec/backend_proxy'
 
 module NodeSpec
   module CommunicationAdapters
     class WinrmCommunicator
-      include RemoteBackend
       include VerboseOutput
       DEFAULT_PORT = 5985
       DEFAULT_TRANSPORT = :plaintext
       DEFAULT_TRANSPORT_OPTIONS = {disable_sspi: true}
-      
-      attr_reader :session, :os
 
-      def initialize(hostname, os = nil, options = {})
-        @os = os
-        @hostname = hostname
+      attr_reader :session
+
+      def initialize(host, options = {})
+        @host = host
         opts = options.dup
         port = opts.delete('port') || DEFAULT_PORT
-        @endpoint = "http://#{hostname}:#{port}/wsman"
+        @endpoint = "http://#{host}:#{port}/wsman"
 
         if opts.has_key?('transport')
           @transport = opts.delete('transport').to_sym
@@ -31,34 +30,22 @@ module NodeSpec
       end
 
       def bind_to(configuration)
-        if configuration.ssh
-          close_ssh_session(configuration.ssh)
-          configuration.ssh = nil
-        end
+        configuration.unbind_ssh_session
 
-        current_session = configuration.winrm
-        if current_session.nil? || current_session.endpoint != @endpoint
-          current_session = start_winrm_session
-          configuration.winrm = current_session
-          configuration.host = @hostname
+        @session = configuration.bind_winrm_session_for(@host, @endpoint) do
+          RuntimeGemLoader.require_or_fail('winrm') do
+            verbose_puts "\nConnecting to #{@endpoint}..."
+            WinRM::WinRMWebService.new(@endpoint, @transport, @options)
+          end
         end
-        @session = current_session
       end
 
-      private
-
-      def close_ssh_session(session)
-        msg = "\nClosing connection to #{session.host}"
-        msg << ":#{session.options[:port]}" if session.options[:port]
-        verbose_puts msg
-        session.close
+      def backend_proxy
+        BackendProxy.create(:winrm, @session)
       end
 
-      def start_winrm_session
-        RuntimeGemLoader.require_or_fail('winrm') do
-          verbose_puts "\nConnecting to #{@endpoint}..."
-          WinRM::WinRMWebService.new(@endpoint, @transport, @options)
-        end
+      def backend
+        :winrm
       end
     end
   end

data/lib/nodespec/communication_adapters.rb

@@ -2,13 +2,13 @@ require 'nodespec/communication_adapters/native_communicator'
 
 module NodeSpec
   module CommunicationAdapters
-    def self.get_communicator(node_name, os = nil, adapter_name = nil, adapter_options = {})
+    def self.get_communicator(node_name, adapter_name = nil, adapter_options = {})
       if adapter_name
         require_relative "communication_adapters/#{adapter_name}.rb"
         clazz = adapter_class(adapter_name)
-        clazz.communicator_for(node_name, os, adapter_options)
+        clazz.communicator_for(node_name, adapter_options)
       else
-        NativeCommunicator.new(os)
+        NativeCommunicator.new
       end
     end
 

data/lib/nodespec/configuration_binding.rb

@@ -0,0 +1,48 @@
+require 'nodespec/verbose_output'
+
+module NodeSpec
+  class ConfigurationBinding
+    include VerboseOutput
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def bind_ssh_session_for(host, port)
+      current_session = @configuration.ssh
+      if current_session.nil? || current_session.host != host || current_session.options[:port] != port
+        unbind_ssh_session
+        current_session = yield
+        @configuration.ssh = current_session
+        @configuration.ssh_options = current_session.options
+        @configuration.host = current_session.host
+      end
+      current_session
+    end
+
+    def bind_winrm_session_for(host, endpoint)
+      current_session = @configuration.winrm
+      if current_session.nil? || current_session.endpoint != endpoint
+        unbind_winrm_session
+        current_session = yield
+        @configuration.winrm = current_session
+        @configuration.host = host
+      end
+      current_session
+    end
+
+    def unbind_ssh_session
+      if @configuration.ssh
+        msg = "\nClosing connection to #{@configuration.ssh.host}"
+        msg << ":#{@configuration.ssh.options[:port]}" if @configuration.ssh.options[:port]
+        verbose_puts msg
+        @configuration.ssh.close
+      end
+      @configuration.ssh = @configuration.ssh_options = @configuration.host =nil
+    end
+
+    def unbind_winrm_session
+      @configuration.winrm = @configuration.host = nil
+    end
+  end
+end

data/lib/nodespec/node.rb

@@ -1,6 +1,4 @@
-require 'specinfra/helper'
 require 'nodespec/communication_adapters'
-require 'nodespec/communication_adapters/native_communicator'
 
 module NodeSpec
   class Node
@@ -14,7 +12,7 @@ module NodeSpec
       opts = (options || {}).dup
       @os = opts.delete('os')
       adapter_name = opts.delete('adapter')
-      @communicator = CommunicationAdapters.get_communicator(@name, @os, adapter_name, opts)
+      @communicator = CommunicationAdapters.get_communicator(@name, adapter_name, opts)
     end
 
     def backend

data/lib/nodespec/provisioning/ansible.rb

@@ -75,7 +75,7 @@ EOS
           "#{options.join(' ')}",
           @extra_vars_option
           ].compact.join(' ')
-        
+
         run_command(cmd)
         @tmp_files.each(&:close!)
       end

data/lib/nodespec/version.rb

@@ -1,3 +1,3 @@
 module NodeSpec
-  VERSION = '0.1.10'
+  VERSION = '1.0.0'
 end

data/lib/nodespec.rb

@@ -1,7 +1,9 @@
 require 'rspec'
-
 require 'serverspec'
+require 'specinfra'
+
 require 'nodespec/node_configurations'
+require 'nodespec/configuration_binding'
 require 'nodespec/run_options'
 require 'nodespec/provisioning'
 
@@ -19,17 +21,13 @@ RSpec.configure do |config|
   config.before :all do |eg|
     if eg.class.metadata.key?(:nodespec)
       NodeSpec.set_current_node(eg.class.description, eg.class.metadata[:nodespec]) do |node|
-        config.os = node.os
-        node.communicator.bind_to(config) 
-      end 
-    end
-  end
+        property[:os] = nil # prevent os caching so we can switch os for any node test
+        config.os = Specinfra::Helper::DetectOs.const_get(node.os).detect if node.os
+
+        Specinfra.configuration.backend = node.backend
 
-  config.before :each do
-    subject_type = subject.class.name.rpartition('::').first
-    if subject_type == Serverspec::Type.name
-      subject.extend SpecInfra::Helper.const_get(NodeSpec.current_node.backend)
-      subject.extend SpecInfra::Helper.const_get(NodeSpec.current_node.os || 'DetectOS')
+        node.communicator.bind_to(NodeSpec::ConfigurationBinding.new(config))
+      end
     end
   end
 

data/nodespec.gemspec

@@ -8,9 +8,11 @@ Gem::Specification.new do |gem|
   gem.version       = NodeSpec::VERSION
   gem.summary       = 'RSpec style tests for multiple nodes/server instances with support for provisioning instructions'
   gem.description   = 'RSpec style tests for multiple nodes/server instances with support for provisioning instructions'
-  
+
   gem.authors       = ['Silvio Montanari']
   gem.homepage      = 'https://github.com/smontanari/nodespec'
+  gem.license       = 'MIT'
+
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
@@ -18,9 +20,10 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_runtime_dependency 'net-ssh'
-  gem.add_runtime_dependency 'serverspec'
-  gem.add_runtime_dependency 'specinfra', '>= 1.18.4'
-  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_runtime_dependency 'serverspec', '~> 2.3'
+  gem.add_runtime_dependency 'specinfra', '~> 2.4'
+  gem.add_runtime_dependency 'os'
+  gem.add_development_dependency 'rspec', '~> 3.1'
   gem.add_development_dependency 'aws-sdk'
   gem.add_development_dependency 'winrm'
   gem.add_development_dependency 'bundler'

data/spec/backend_proxy/exec_spec.rb

@@ -13,20 +13,20 @@ module NodeSpec
           allow(subject).to receive(:execute_within_timeout).with(actual_command).and_yield
         end
 
-        
+
         it 'returns true if the command succeeds' do
           allow(cmd_status).to receive(:success?).and_return(true)
-          
+
           expect(subject.execute(original_command)).to be_truthy
         end
 
         it 'returns false if the command fails' do
           allow(cmd_status).to receive(:success?).and_return(false)
-          
+
           expect(subject.execute(original_command)).to be_falsy
         end
       end
-      
+
       it_behaves_like 'a command run', 'test command', 'test command', false
       it_behaves_like 'a command run', 'test command', 'sudo test command', true
     end