nodespec 0.1.9 → 0.1.10

data/spec/node_configurations_spec.rb

@@ -0,0 +1,41 @@
+require 'nodespec/node_configurations'
+
+module NodeSpec
+  describe NodeConfigurations do
+    before do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(YAML).to receive(:load_file).and_return({
+        'test_node1' => { foo: 'bar' },
+        'test_node2' => { foo: 'baz' },
+        'test_node3' => { foo: 'qaz' }
+      })
+    end
+
+    describe 'current settings' do
+      context 'anything but string or hash' do
+        before do
+          allow(Node).to receive(:new).with('node_name', {}).and_return('node')
+        end
+        [nil, true, 1, [], Object.new].each do |options|
+          it 'returns a default Node' do
+            expect(NodeConfigurations.instance.get('node_name')).to eq('node')
+          end
+        end
+      end
+
+      context 'configuration name' do
+        it 'returns a Node for the given configuration name' do
+          allow(Node).to receive(:new).with('node_name', {foo: 'baz'}).and_return('node')
+          expect(NodeConfigurations.instance.get('node_name', 'test_node2')).to eq('node')
+        end
+      end
+
+      context 'configuration hash' do
+        it 'returns a Node with the given configuration' do
+          allow(Node).to receive(:new).with('node_name', {foo: 'baz'}).and_return('node')
+          expect(NodeConfigurations.instance.get('node_name', {foo: 'baz'})).to eq('node')
+        end
+      end
+    end
+  end
+end

data/spec/node_spec.rb

@@ -0,0 +1,110 @@
+require 'nodespec/node'
+
+module NodeSpec
+  describe Node do
+    shared_examples 'node os' do |os|
+      it "has the expected os" do
+        expect(subject.os).to eq(os)
+      end
+    end
+
+    shared_examples 'run commands' do
+      it "runs a command through the backend proxy" do
+        expect(backend_proxy).to receive(:execute).with('test command')
+        
+        subject.execute('test command')
+      end
+
+      it "creates a directory with a path relative to the temporary directory" do
+        expect(backend_proxy).to receive(:temp_directory).ordered.and_return('/temp/dir')
+        expect(backend_proxy).to receive(:create_directory).ordered.with('/temp/dir/test_dir')
+        
+        expect(subject.create_temp_directory('test_dir')).to eq('/temp/dir/test_dir')
+      end
+
+      it "creates a directory with a path relative to the node working directory" do
+        expect(backend_proxy).to receive(:create_directory).ordered.with('.nodespec')
+        expect(backend_proxy).to receive(:create_directory).ordered.with('.nodespec/test_dir')
+        
+        expect(subject.create_directory('test_dir')).to eq('.nodespec/test_dir')
+      end
+
+      it "writes to a file with a path relative to the node working directory" do
+        expect(backend_proxy).to receive(:create_directory).ordered.with('.nodespec')
+        expect(backend_proxy).to receive(:create_file).ordered.with('.nodespec/test/file', 'test content')
+        
+        expect(subject.create_file('test/file', 'test content')).to eq('.nodespec/test/file')
+      end
+
+      it "creates a directory with an absolute path" do
+        expect(backend_proxy).to receive(:create_directory).with('/test/dir')
+        
+        expect(subject.create_directory('/test/dir')).to eq('/test/dir')
+      end
+
+      it "writes to a file with an absolute path" do
+        expect(backend_proxy).to receive(:create_file).with('/test/file', 'test content')
+        
+        expect(subject.create_file('/test/file', 'test content')).to eq('/test/file')
+      end
+    end
+
+    let(:communicator) {double('communicator')}
+    let(:backend_proxy) {double('backend_proxy')}
+
+    it 'does not change the original options' do
+      Node.new('test_node', {'os' => 'test', 'foo' => 'bar'}.freeze)
+    end
+
+    describe 'node name' do
+      it 'replaces spaces with hyphen' do
+        subject = Node.new('test node description')
+        expect(subject.name).to eq('test-node-description')
+      end
+      it 'trims spaces at the end' do
+        subject = Node.new("test.node.description  ")
+        expect(subject.name).to eq('test.node.description')
+      end
+      it 'cannot contain punctuation characters' do
+        "!@#$%^&*()+={}[]\\|:;\"'<>?,/".each_char do |invalid_char|
+          expect {Node.new("test #{invalid_char} name")}.to raise_error
+        end
+      end
+      it 'cannot start with space, underscore or hyphen characters' do
+        " _-".each_char do |invalid_char|
+          expect {Node.new("#{invalid_char} name")}.to raise_error
+        end
+      end
+    end
+
+    describe 'running commands through the communicator' do
+      let(:adapter) {double('adapter')}
+      before do
+        allow(communicator).to receive(:session).and_return('remote session')
+        allow(communicator).to receive(:backend_proxy).and_return(backend_proxy)
+      end
+
+      context 'no os given' do
+        let(:subject) {Node.new('test_node', 'adapter' => 'test_adapter', 'foo' => 'bar')}
+
+        before do
+          allow(CommunicationAdapters).to receive(:get_communicator).with('test_node', nil, 'test_adapter', 'foo' => 'bar').and_return(communicator)
+        end
+
+        include_examples 'node os', nil
+        include_examples 'run commands'
+      end
+
+      context 'os given' do
+        let(:subject) {Node.new('test_node', 'os' => 'test_os', 'adapter' => 'test_adapter', 'foo' => 'bar')}
+
+        before do
+          allow(CommunicationAdapters).to receive(:get_communicator).with('test_node', 'test_os', 'test_adapter', 'foo' => 'bar').and_return(communicator)
+        end
+
+        include_examples 'node os', 'test_os'
+        include_examples 'run commands'
+      end
+    end
+  end
+end

data/spec/provisioning/ansible_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+require 'nodespec/provisioning/ansible'
+
+module NodeSpec
+  module Provisioning
+    describe Ansible, init_with_current_node: true do
+      shared_context 'create temp file' do |prefix, path, content|
+        let(:tmp_file) {double('temp file')}
+        before do
+          allow(Tempfile).to receive(:new).with(prefix).and_return(tmp_file)
+          allow(tmp_file).to receive(:path).and_return(path)
+          expect(tmp_file).to receive(:write).ordered.with(content)
+          expect(tmp_file).to receive(:flush).ordered
+          expect(tmp_file).to receive(:close!).ordered
+        end
+      end
+      before do
+        allow(current_node).to receive(:name).and_return('test_host')
+        allow(current_node).to receive_message_chain(:communicator, :session, :options).and_return({
+          user: 'test_user',
+          keys: 'path/to user/key'
+        })
+      end
+
+      describe 'executing an ansible playbook' do
+        it_executes_the_local_command('ansible-playbook /path\ to/playbook -l test_host -u test_user --private-key=path/to\ user/key --sudo --opt1 --opt2') do
+          ansible_playbook '/path to/playbook', %w[--opt1 --opt2]
+        end
+
+        describe 'setting playbook variables' do
+          it_executes_the_local_command(/^ansible-playbook .* -e '\{"pacman":"mrs","ghosts":\["inky","pinky","clyde","sue"\]\}'$/) do
+            set_extra_vars pacman: 'mrs', ghosts: %w[inky pinky clyde sue]
+            ansible_playbook '/path to/playbook'
+          end
+        end
+      end
+
+      describe 'executing an ansible module' do
+        before do
+          allow(current_node).to receive_message_chain(:communicator, :session, :transport, :host).and_return('test.host')
+          allow(current_node).to receive_message_chain(:communicator, :session, :transport, :port).and_return(1234)
+          
+        end
+
+        it_executes_the_local_command('ansible test_host -m module -a module\ arguments -u test_user --private-key=path/to\ user/key --sudo --opt1 --opt2') do
+          ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+        end
+
+        describe 'running ansible' do
+          context 'multiples keys' do
+            before do
+              allow(current_node).to receive_message_chain(:communicator, :session, :options).and_return({
+                user: 'test_user',
+                keys: ['path/to user/key1', 'path/to user/key2']
+              })
+            end
+            it_executes_the_local_command('ansible test_host -m module -a module\ arguments -u test_user --private-key=path/to\ user/key1,path/to\ user/key2 --sudo --opt1 --opt2') do
+              ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+            end
+          end
+
+          context 'disable sudo' do
+            it_executes_the_local_command('ansible test_host -m module -a module\ arguments -u test_user --private-key=path/to\ user/key --opt1 --opt2') do
+              run_as_sudo(false)
+              ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+            end
+          end
+
+          context 'enable sudo' do
+            it_executes_the_local_command('ansible test_host -m module -a module\ arguments -u test_user --private-key=path/to\ user/key --sudo --opt1 --opt2') do
+              run_as_sudo
+              ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+            end
+          end
+
+          context 'runs as root without sudo' do
+            before do
+              allow(current_node).to receive_message_chain(:communicator, :session, :options).and_return({
+                user: 'root',
+                keys: 'path/to user/key'
+              })
+            end
+            it_executes_the_local_command('ansible test_host -m module -a module\ arguments -u root --private-key=path/to\ user/key --opt1 --opt2') do
+              ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+            end
+          end
+        end
+
+        describe 'setting a path to an inventory' do
+          it_executes_the_local_command(/^ansible test_host .* -i path\/to\\ custom\/hosts .*/) do
+            set_hostfile_path 'path/to custom/hosts'
+            ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+          end
+
+          describe 'enabling inventory host auto detection' do
+            context 'no groups specified' do
+              include_context 'create temp file', 'nodespec_ansible_hosts', '/path/to/inventory', /test_host ansible_ssh_host=test.host ansible_ssh_port=1234/
+
+              it_executes_the_local_command(/^ansible test_host .* -i \/path\/to\/inventory .*/) do
+                enable_host_auto_discovery
+                ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+              end
+            end
+  
+            context 'group specified' do
+              include_context 'create temp file', 'nodespec_ansible_hosts', '/path/to/inventory', <<-eos
+[test-group]
+test_host ansible_ssh_host=test.host ansible_ssh_port=1234
+eos
+
+              it_executes_the_local_command(/^ansible test_host .* -i \/path\/to\/inventory .*/) do
+                enable_host_auto_discovery('test-group')
+                ansible_module 'module', 'module arguments', %w[--opt1 --opt2]
+              end
+            end
+          end
+        end
+
+        describe 'configuring ansible' do
+          it_executes_the_local_command(/^ANSIBLE_HOST_KEY_CHECKING=False ansible .*/) do
+            set_host_key_checking(false)
+            ansible_module 'module', 'module arguments'
+          end
+
+          it_executes_the_local_command(/^ANSIBLE_CONFIG=\/path\\ to\/config ANSIBLE_HOST_KEY_CHECKING=False ansible .*/) do
+            set_config_path('/path to/config')
+            set_host_key_checking(false)
+            ansible_module 'module', 'module arguments'
+          end
+
+          describe 'inline custom configuration' do
+            include_context 'create temp file', 'nodespec_ansible_cfg', '/path/to/cfg', 'test config'
+
+            it_executes_the_local_command(/^ANSIBLE_CONFIG=\/path\/to\/cfg ansible .*/) do
+              ansible_config('test config')
+              ansible_module 'module', 'module arguments'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/provisioning/chef_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'nodespec/provisioning/chef'
+
+module NodeSpec
+  module Provisioning
+    describe Chef, init_with_current_node: true do
+      describe 'running chef-apply' do
+        it_executes_the_node_command('chef-apply --opt1 --opt2 -e include_recipe\ \"main::cron\"') do
+          chef_apply_execute 'include_recipe "main::cron"', %w[--opt1 --opt2]
+        end
+
+        it_executes_the_node_command('chef-apply /test\ path/to/recipe --opt1 --opt2') do
+          chef_apply_recipe '/test path/to/recipe', %w[--opt1 --opt2]
+        end
+      end
+
+      describe 'running chef-client' do
+        context 'specified node path' do
+          describe 'custom configuration' do
+            before do
+              expect(current_node).to receive(:create_file).with('chef_client.rb', "node_path '/path/to/nodes'").ordered.and_return('config/chef_client.rb')
+            end
+
+            it_executes_the_node_command(
+              'chef-client -z --opt1 --opt2 -c config/chef_client.rb -o recipe1,recipe2'
+            ) do
+              chef_client_config "node_path '/path/to/nodes'"
+              chef_client_runlist 'recipe1', 'recipe2', %w[--opt1 --opt2]
+            end
+          end
+        end
+
+        context 'implicit node path' do
+          before do
+            expect(current_node).to receive(:create_temp_directory).with('chef_nodes').and_return('/tmp/dir/chef_nodes')
+            allow(current_node).to receive(:create_file).with('chef_client.rb', /^node_path '\/tmp\/dir\/chef_nodes'$/).and_return('config/chef_client.rb')
+          end
+
+          it_executes_the_node_command('chef-client -z --opt1 --opt2 -c config/chef_client.rb -o recipe1,recipe2') do
+            chef_client_runlist 'recipe1', 'recipe2', %w[--opt1 --opt2]
+          end
+
+          describe 'custom configuration' do
+            before do
+              expect(current_node).to receive(:create_file).with('chef_client.rb', /^test config$/).ordered.and_return('config/chef_client.rb')
+            end
+
+            it_executes_the_node_command(
+              'chef-client -z --opt1 --opt2 -c config/chef_client.rb -o recipe1,recipe2'
+            ) do
+              chef_client_config 'test config'
+              chef_client_runlist 'recipe1', 'recipe2', %w[--opt1 --opt2]
+            end
+          end
+
+          describe 'custom cookbook path' do
+            before do
+              expect(current_node).to receive(:create_file).with('chef_client.rb', /^cookbook_path \['\/var\/chef\/cookbooks','\/var\/chef\/site-cookbooks'\]$/).ordered.and_return('config/chef_client.rb')
+            end
+
+            it_executes_the_node_command(
+              'chef-client -z --opt1 --opt2 -c config/chef_client.rb -o recipe1,recipe2'
+            ) do
+              set_cookbook_paths '/var/chef/cookbooks', '/var/chef/site-cookbooks'
+
+              chef_client_runlist 'recipe1', 'recipe2', %w[--opt1 --opt2]
+            end
+          end
+
+          describe 'setting custom attributes' do
+            before do
+              expect(current_node).to receive(:create_file).with('chef_client_attributes.json', %q[{"test_attributes":{"attr1":"foo","attr2":"bar"}}]).ordered.and_return('config/chef_client_attributes.json')
+            end
+
+            it_executes_the_node_command(
+              'chef-client -z -c config/chef_client.rb -j config/chef_client_attributes.json -o recipe1,recipe2'
+            ) do
+              set_attributes test_attributes: {attr1: 'foo', attr2: 'bar'}
+
+              chef_client_runlist 'recipe1', 'recipe2'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/provisioning/puppet_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper.rb'
+require 'nodespec/provisioning/puppet'
+
+module NodeSpec
+  module Provisioning
+    describe Puppet, init_with_current_node: true do
+      describe 'executing a puppet inline code' do
+        it_executes_the_node_command(/^puppet apply\s+ --opt1 --opt2 -e include\\ testmodule::testclass$/) do
+          puppet_apply_execute 'include testmodule::testclass', %w[--opt1 --opt2]
+        end
+      end
+
+      describe 'executing a puppet manifest file' do
+        it_executes_the_node_command(/^puppet apply .* \/test\/path\\ to\/manifest$/) do
+          puppet_apply_manifest '/test/path to/manifest'
+        end
+      end
+
+      describe 'setting facts' do
+        it_executes_the_node_command(/^FACTER_foo=bar\\ baz puppet apply .*$/) do
+          set_facts 'foo' => 'bar baz'
+          puppet_apply_manifest '/test/path/to/manifest'
+        end
+      end
+
+      describe 'setting the module path' do
+        it_executes_the_node_command(/puppet apply --modulepath \/test\\ path\/1:\/test\\ path\/2 .*/) do
+          set_modulepaths '/test path/1', '/test path/2'
+          puppet_apply_execute 'include testmodule::testclass'
+        end
+      end
+
+      describe 'setting hiera data' do
+        before do
+          expect(current_node).to receive(:create_directory).with('puppet_hieradata').ordered.and_return('config/puppet_hieradata')
+          expect(current_node).to receive(:create_file).with('puppet_hieradata/common.yaml', "---\ntest: hiera data\n").ordered.and_return('config/puppet_hieradata/common.yaml')
+          expect(current_node).to receive(:create_file).with('puppet_hiera.yaml', ":backends:\n  - yaml\n:yaml:\n  :datadir: config/puppet_hieradata\n:hierarchy:\n  - common\n").ordered.and_return('config/puppet_hiera.yaml')
+        end
+
+        it_executes_the_node_command(
+          'puppet apply --modulepath /test/module/path --hiera_config config/puppet_hiera.yaml --opts /test/path/to/manifest'
+        ) do
+          set_modulepaths '/test/module/path'
+          set_hieradata('test' => 'hiera data')
+
+          puppet_apply_manifest '/test/path/to/manifest', %w[--opts]
+        end
+      end
+
+      describe 'setting hiera config' do
+      end
+    end
+  end
+end

data/spec/provisioning/shellscript_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'nodespec/provisioning/shellscript'
+
+module NodeSpec
+  module Provisioning
+    describe Shellscript, init_with_current_node: true do
+      # let()
+      it_executes_the_node_command('/path/to/test/script.sh') do
+        execute_file('/path/to/test/script.sh')
+      end
+      it_executes_the_node_command("sh -c mkdir\\ /tmp/test_dir'\n'cd\\ /tmp/test_dir'\n'touch\\ test.txt'\n'") do
+        execute_script <<-EOS
+mkdir /tmp/test_dir
+cd /tmp/test_dir
+touch test.txt
+        EOS
+      end
+    end
+  end
+end

data/spec/provisioning_spec.rb

@@ -0,0 +1,52 @@
+require 'nodespec/provisioning'
+
+module NodeSpec
+  describe Provisioning do
+    available_provisioners = {
+      'puppet'      => Provisioning::Puppet,
+      'chef'        => Provisioning::Chef,
+      'ansible'     => Provisioning::Ansible,
+      'shellscript' => Provisioning::Shellscript
+    }
+
+    let(:subject) {Object.new.extend Provisioning}
+    let(:provisioning_block) {Proc.new {}}
+    
+    before do
+      allow(NodeSpec).to receive(:current_node).and_return('current node')
+    end
+    
+    context 'multiple invocations to same provisioner' do
+      let(:provisioner_instance){double('provisioner instance')}
+      available_provisioners.each do |name, clazz|
+        it "instantiate the #{clazz} provisioner once only" do
+          allow(clazz).to receive(:new).with('current node').once.and_return(provisioner_instance)
+          expect(provisioner_instance).to receive(:instance_eval).twice
+
+          subject.send("provision_node_with_#{name}", &provisioning_block)
+          subject.send("provision_node_with_#{name}", &provisioning_block)
+        end
+
+        it "executes the #{clazz} command" do
+          allow(clazz).to receive(:new).with('current node').and_return(provisioner_instance)
+          expect(provisioner_instance).to receive(:instance_eval) do |&b|
+            expect(b).to be provisioning_block
+          end
+
+          subject.send("provision_node_with_#{name}", &provisioning_block)
+        end
+      end
+    end
+
+    context "multiple provisioners" do
+      it 'allows to run multiple provisioners on the same node' do
+        available_provisioners.each do |name, clazz|
+          provisioner_instance = double("#{name} provisioner instance")
+          allow(clazz).to receive(:new).with('current node').once.and_return(provisioner_instance)
+          expect(provisioner_instance).to receive(:instance_eval)
+          subject.send("provision_node_with_#{name}", &provisioning_block)
+        end
+      end
+    end
+  end
+end

data/spec/runtime_gem_loader_spec.rb

@@ -0,0 +1,33 @@
+require 'nodespec/runtime_gem_loader'
+
+module NodeSpec
+  describe RuntimeGemLoader do
+    it 'requires the gem successfully and executes the block' do
+      success = false
+      RuntimeGemLoader.require_or_fail('rspec') do
+        success = true
+      end
+      expect(success).to be_truthy
+    end
+
+    it 'fails to require the gem and prints a default error message' do
+      success = false
+      expect do
+        RuntimeGemLoader.require_or_fail('a-gem-that/does-not-exist') do
+          success = true
+        end
+      end.to raise_error(/Consider installing the missing gem\s+gem install 'a-gem-that\/does-not-exist'/)
+      expect(success).to be_falsy
+    end
+
+    it 'fails to require the gem and prints a custom error message' do
+      success = false
+      expect do
+        RuntimeGemLoader.require_or_fail('a-gem-that/does-not-exist', 'this is wrong') do
+          success = true
+        end
+      end.to raise_error(/this is wrong\s+gem install 'a-gem-that\/does-not-exist'/)
+      expect(success).to be_falsy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+Dir[File.join(File.dirname(__FILE__), 'support/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  config.extend NodeSpec::RSpecExtensions
+end

data/spec/support/backend.rb

@@ -0,0 +1,10 @@
+shared_examples 'providing a backend' do |expected_backend|
+  it "returns #{expected_backend} backend" do
+    expect(subject.backend).to eq(expected_backend)
+  end
+
+  it "returns BackendProxy::#{expected_backend} as backend proxy" do
+    expect(subject.backend_proxy).to be_a(NodeSpec::BackendProxy.const_get(expected_backend))
+  end
+end
+

data/spec/support/init_with_current_node.rb

@@ -0,0 +1,4 @@
+shared_context 'initialize with current node', init_with_current_node: true do
+  let(:current_node) {double('current node')}
+  let(:subject) {described_class.new(current_node)}
+end

data/spec/support/local_command.rb

@@ -0,0 +1,12 @@
+module NodeSpec
+  module RSpecExtensions
+    def it_executes_the_local_command(*command_matches, &instructions)
+      it 'runs the commands' do
+        command_matches.each do |command_match|
+          expect(subject).to receive(:run_command).with(command_match)
+        end
+        subject.instance_eval(&instructions)
+      end
+    end
+  end
+end

data/spec/support/node_command.rb

@@ -0,0 +1,12 @@
+module NodeSpec
+  module RSpecExtensions
+    def it_executes_the_node_command(*command_matches, &provisioning_instructions)
+      it 'runs the commands' do
+        command_matches.each do |command_match|
+          expect(current_node).to receive(:execute).with(command_match)
+        end
+        subject.instance_eval(&provisioning_instructions)
+      end
+    end
+  end
+end

data/spec/support/ssh_communicator.rb

@@ -0,0 +1,9 @@
+require 'nodespec/communication_adapters/ssh_communicator'
+
+shared_examples 'new_ssh_communicator' do |hostname, os, options|
+  before do
+    allow(NodeSpec::CommunicationAdapters::SshCommunicator).to receive(:new).with(
+      hostname, os, options
+    ).and_return('ssh communicator')
+  end
+end

data/spec/support/winrm_communicator.rb

@@ -0,0 +1,9 @@
+require 'nodespec/communication_adapters/winrm_communicator'
+
+shared_context 'new_winrm_communicator' do |hostname, os, options|
+  before do
+    allow(NodeSpec::CommunicationAdapters::WinrmCommunicator).to receive(:new).with(
+      hostname, os, options
+    ).and_return('winrm communicator')
+  end
+end