nodespec 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22522efb82f175e6aa68df1948c065319324497d
-  data.tar.gz: 40053aea1394efc150ca04382e3e302fe7286197
+  metadata.gz: be7328ed95144b05ecb62ff63b1bd38101d626ae
+  data.tar.gz: fd27d50ae085de35513cdef5cf12e4b6223e9180
 SHA512:
-  metadata.gz: fb1ad96f278e3e8337c978a4bd7b16aaacb1444ca5441de2227ad3dd5a929cc3cdca3c55a941f93e0ca3ce9f8e16bbd5af0dc0f71bb9e7595ace6937dee27a55
-  data.tar.gz: 1606e98c8e5b57a5163a5e12a2f6030f6f41c5fc613518490eaeaa4e7da15c346e90ac74ca7924a065d2ff7422bd8744f133c097c28369f3f4e3d18c817778ee
+  metadata.gz: 38a821a5b1a5db66e89d88aa04b751e34a432dfcbba50eee6dc294a59b493863628507a1a060cb93012557ac6adb433eb431aa1e5aef08c6df54cd540e7e02bd
+  data.tar.gz: 50f522db6244b8509713abffc8adf6f07e4c6abb1908f6ed6597af760b6062c31201492e5bc4dfda8bdd38118bd5246c3ad8aaeebb51f6d7d7c7cea4c04f38b8

data/.gitignore

@@ -0,0 +1,3 @@
+.rspec
+.ruby-version
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    nodespec (0.1.9)
+      net-ssh
+      serverspec
+      specinfra (>= 1.18.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.2.2)
+      gyoku (>= 0.4.0)
+      nokogiri
+    aws-sdk (1.44.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gssapi (1.0.3)
+      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
+    json (1.8.1)
+    little-plugger (1.1.3)
+    logging (1.8.2)
+      little-plugger (>= 1.1.3)
+      multi_json (>= 1.8.4)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    net-ssh (2.9.1)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    nori (1.1.5)
+    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)
+      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)
+    rubyntlm (0.1.1)
+    savon (0.9.5)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.0)
+      wasabi (~> 1.0)
+    serverspec (0.15.4)
+      highline
+      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)
+    winrm (1.1.3)
+      gssapi (~> 1.0.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (~> 1.6, >= 1.6.1)
+      nokogiri (~> 1.5)
+      rubyntlm (~> 0.1.1)
+      savon (= 0.9.5)
+      uuidtools (~> 2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk
+  bundler
+  nodespec!
+  rake
+  rspec (~> 3.0)
+  winrm

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Silvio Montanari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+nodespec
+========
+
+RSpec style tests for multiple nodes/server instances with support for provisioning with puppet, chef, ansible
+
+## 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
+Nodespec overcomes some of the limitations of Serverspec, such as mixed OS' support (Windows and UN*X), multiple backends (Ssh and Winrm) and easy configurability and connectivity to your target hosts.
+
+Nodespec enables a declarative way of configuring your remote connections, be it simple Ssh, a Vagrant box, or an Amazon EC2 instance.
+
+Nodespec adds support for issuing provisiong commands to your target hosts, that could be incorporated as part of your test setup.
+
+Below is a quick summary of the main features of nodespec. Refer to the [wiki](https://github.com/smontanari/nodespec/wiki) for more details and examples.
+
+## Nodespec features
+
+#### Hostname declared or inferred in specs
+
+In serverspec you would typically have to create folders named after your target servers, whereas in nodespec you can simply declare your target server names as your spec example group:
+
+```ruby
+describe "test.example1.com" do
+  ...
+end
+```
+```ruby
+describe "test.example2.com" do
+  ...
+end
+```
+#### Easy connection configuration
+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: {
+    'adapter' => 'ssh',
+    'user'    => 'testuser',
+    'keys'    => 'path/to/key'
+  } do
+...
+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:
+```ruby
+describe "test.example2.com", nodespec: {
+    'os'              => 'Windows',
+    'adapter'         => 'winrm',
+    'user'            => 'testuser',
+    'pass'            => 'somepass',
+    'transport'       => 'ssl'
+  	'basic_auth_only' => true
+  } do
+...
+end
+```
+## Provisioning (aka TDD your infrastructure)
+Nodespec provides support for running Chef, Puppet, Ansible or shellscript commands as part of your tests, e.g.:
+
+#### Chef
+```ruby
+describe "server1", nodespec: {'adapter' => 'vagrant'} do
+  before :all do
+    provision_node_with_chef do
+      set_cookbook_paths '/vshared/src/cookbooks'
+	  set_attributes demo: {crontab: {user: 'peter'}}
+      chef_client_runlist 'demo::folders', 'demo::crontab'
+    end
+  end
+...
+end
+```
+
+#### Puppet
+```ruby
+describe "server1", nodespec: {'adapter' => 'vagrant'} 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
+```
+
+#### Ansible
+```ruby
+describe "i-8f5e74r9", nodespec: {'adapter' => 'aws_ec2'} do
+  before :all do
+    provision_node_with_ansible do
+      enable_host_auto_discovery
+      set_host_key_checking false
+      ansible_playbook 'src/ansible/demo.yml', ['--sudo']
+    end
+  end
+...
+end
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+Rake::Task[:build].prerequisites << Rake::Task[:spec]

data/lib/nodespec/backend_proxy/base.rb

@@ -0,0 +1,20 @@
+require 'nodespec/verbose_output'
+require 'nodespec/command_execution'
+
+module NodeSpec
+  module BackendProxy
+    class Base
+      include CommandExecution
+
+      [:create_directory, :create_file].each do |m|
+        define_method(m) do |*args|
+          execute(send("cmd_#{m}", *args))
+        end
+      end
+
+      def execute(command)
+        raise "You must subclass #{self.class} and implement #execute"
+      end
+    end
+  end
+end

data/lib/nodespec/backend_proxy/cmd.rb

@@ -0,0 +1,9 @@
+module NodeSpec
+  module BackendProxy
+    class Cmd
+      def execute command
+        raise 'Not supported yet'
+      end
+    end
+  end
+end

data/lib/nodespec/backend_proxy/exec.rb

@@ -0,0 +1,21 @@
+require 'open3'
+require 'nodespec/run_options'
+require_relative 'base'
+require_relative 'unixshell_utility'
+
+module NodeSpec
+  module BackendProxy
+    class Exec < Base
+      include UnixshellUtility
+
+      def execute command
+        command = run_as_sudo(command) if NodeSpec::RunOptions.run_local_with_sudo?
+        execute_within_timeout(command) do
+          output, status = Open3.capture2e(command)
+          verbose_puts(output)
+          status.success?
+        end
+      end
+    end
+  end
+end

data/lib/nodespec/backend_proxy/ssh.rb

@@ -0,0 +1,28 @@
+require_relative 'base'
+require_relative 'unixshell_utility'
+
+module NodeSpec
+  module BackendProxy
+    class Ssh < Base
+      include UnixshellUtility
+      
+      ROOT_USER = 'root'
+
+      def initialize(ssh)
+        @ssh_session = ssh
+      end
+
+      def execute(command)
+        command = run_as_sudo(command) if @ssh_session.options[:user] != ROOT_USER
+        execute_within_timeout(command) do
+          success = true
+          @ssh_session.exec!(command) do |ch, stream, data|
+            verbose_puts(data)
+            success = stream != :stderr
+          end
+          success
+        end
+      end
+    end
+  end
+end

data/lib/nodespec/backend_proxy/unixshell_utility.rb

@@ -0,0 +1,32 @@
+require 'shellwords'
+
+module NodeSpec
+  module BackendProxy
+    module UnixshellUtility
+      SUDO_PREFIX = 'sudo'
+      TEMP_DIR = '/tmp'
+
+      def run_as_sudo(cmd)
+        "#{SUDO_PREFIX} #{cmd}"
+      end
+
+      def cmd_create_directory(path)
+        shellcmd("mkdir -p #{path.shellescape}")
+      end
+
+      def cmd_create_file(path, content)
+        shellcmd("cat > #{path.shellescape} << EOF\n#{content.strip.gsub('"', '\"')}\nEOF")
+      end
+
+      def temp_directory
+        TEMP_DIR
+      end
+
+      private
+
+      def shellcmd(cmd)
+        %Q[sh -c "#{cmd}"]
+      end
+    end
+  end
+end

data/lib/nodespec/backend_proxy/winrm.rb

@@ -0,0 +1,23 @@
+require 'nodespec/command_execution'
+require 'nodespec/run_options'
+require_relative 'base'
+
+module NodeSpec
+  module BackendProxy
+    class WinRM < Base
+      def initialize(winrm)
+        @winrm_session = winrm
+      end
+
+      def execute command
+        @winrm_session.set_timeout(NodeSpec::RunOptions.command_timeout)
+        result = @winrm_session.powershell(command)
+        stdout, stderr = [:stdout, :stderr].map do |s|
+          result[:data].select {|item| item.key? s}.map {|item| item[s]}.join
+        end
+        [stdout, stderr].each {|s| verbose_puts s}
+        result[:exitcode] == 0 and stderr.empty?
+      end
+    end
+  end
+end

data/lib/nodespec/backends.rb

@@ -0,0 +1,13 @@
+require 'specinfra/helper'
+%w[exec cmd ssh winrm].each {|f| require_relative "backend_proxy/#{f}"}
+
+module NodeSpec
+  module Backends
+    class SpecInfraCompatibilityError < StandardError; end
+
+    %w[Exec Ssh Cmd WinRM].each do |name|
+      raise SpecInfraCompatibilityError.new("module SpecInfra::Helper::#{name} is not defined!") unless SpecInfra::Helper.const_defined?(name)
+      const_set(name, name)
+    end
+  end
+end

data/lib/nodespec/command_execution.rb

@@ -0,0 +1,16 @@
+require 'timeout'
+require_relative 'verbose_output'
+require_relative 'run_options'
+
+module NodeSpec
+  module CommandExecution
+    class CommandExecutionError < StandardError; end
+    include VerboseOutput
+
+    def execute_within_timeout(command, timeout = NodeSpec::RunOptions.command_timeout, &block)
+      verbose_puts "\nExecuting command:\n#{command}"
+      command_success = Timeout::timeout(timeout, &block)
+      raise CommandExecutionError.new 'The command execution failed. Enable verbosity to check the output.' unless command_success
+    end
+  end
+end

data/lib/nodespec/communication_adapters/aws_ec2.rb

@@ -0,0 +1,24 @@
+require 'nodespec/runtime_gem_loader'
+require_relative 'ssh_communicator'
+require_relative 'winrm_communicator'
+
+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 = {})
+        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'])
+          else
+            SshCommunicator.new(ec2_instance.public_dns_name, os, options['ssh'] || {})
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nodespec/communication_adapters/local_backend.rb

@@ -0,0 +1,15 @@
+require 'nodespec/backends'
+
+module NodeSpec
+  module CommunicationAdapters
+    module LocalBackend
+      def backend_proxy
+        BackendProxy.const_get(backend).new
+      end
+
+      def backend
+        os == 'Windows' ? Backends::Cmd : Backends::Exec
+      end
+    end
+  end
+end

data/lib/nodespec/communication_adapters/native_communicator.rb

@@ -0,0 +1,32 @@
+require 'nodespec/verbose_output'
+require_relative 'local_backend'
+
+module NodeSpec
+  module CommunicationAdapters
+    class NativeCommunicator
+      include LocalBackend
+      include VerboseOutput
+
+      attr_reader :os
+
+      def initialize(os = nil)
+        @os = os
+      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
+
+        if configuration.winrm
+          configuration.winrm = nil
+        end
+      end
+    end
+  end
+end

data/lib/nodespec/communication_adapters/remote_backend.rb

@@ -0,0 +1,15 @@
+require 'nodespec/backends'
+
+module NodeSpec
+  module CommunicationAdapters
+    module RemoteBackend
+      def backend_proxy
+        BackendProxy.const_get(backend).new(session)
+      end
+
+      def backend
+        os == 'Windows' ? Backends::WinRM : Backends::Ssh
+      end
+    end
+  end
+end

data/lib/nodespec/communication_adapters/ssh.rb

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

data/lib/nodespec/communication_adapters/ssh_communicator.rb

@@ -0,0 +1,54 @@
+require 'net/ssh'
+require 'nodespec/verbose_output'
+require_relative 'remote_backend'
+
+module NodeSpec
+  module CommunicationAdapters
+    class SshCommunicator
+      include VerboseOutput
+      include RemoteBackend
+      attr_reader :session, :os
+
+      def initialize(host, os = nil, 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|
+          @ssh_options[param.to_sym] = options[param] if options[param]
+        end
+      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
+        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
+      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)
+      end
+    end
+  end
+end

data/lib/nodespec/communication_adapters/vagrant.rb

@@ -0,0 +1,37 @@
+require 'open3'
+require_relative 'ssh_communicator'
+
+module NodeSpec
+  module CommunicationAdapters
+    class Vagrant
+      def self.communicator_for(node_name, os = nil, options = {})
+        vm_name = options['vm_name'] || node_name
+        fetch_connection_details(vm_name) do |host, opts|
+          SshCommunicator.new(host, os, opts)
+        end
+      end
+
+      private
+
+      def self.fetch_connection_details(vm_name)
+        cmd = "vagrant --machine-readable ssh-config #{vm_name}"
+        output, status = Open3.capture2e(cmd)
+        raise parse_error_data(output) unless status.success?
+        yield(parse_ssh_config_data(output)) if block_given?
+      end
+
+      def self.parse_ssh_config_data(data)
+        /^\s*HostName\s+(?<hostname>.*)$/ =~ data
+        /^\s*Port\s+(?<port>\d+)$/ =~ data
+        /^\s*User\s+(?<username>.*)$/ =~ data
+        /^\s*IdentityFile\s+(?<private_key_path>.*)$/ =~ data
+        [hostname, {'port' => port.to_i, 'user' => username, 'keys' => private_key_path}]
+      end
+
+      def self.parse_error_data(data)
+        /^.*,error-exit,(?<error>.*)$/ =~ data
+        error
+      end
+    end
+  end
+end

data/lib/nodespec/communication_adapters/winrm.rb

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