vagrant_spec 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bd559c7081c147b71b1e3616f6f78532aa54a1c
-  data.tar.gz: a003a4044ca5cbe33f27772dfea6d9b57cfacfed
+  metadata.gz: fb07a53bcd6698b0ad2af73417b1fb2235489274
+  data.tar.gz: 776a3dfe81a097b90e4c2a6ab68bf7803ec7c1a8
 SHA512:
-  metadata.gz: ccea26d0ec98831823d8d0eb5e5c354550cf584cdc48be8a89cee634ba2f11654bd40864c2369c569df9dd5fff380decdc3861a9f39a6d0781a393309931a279
-  data.tar.gz: d0f95a9c8536df17d1c0dbf3fc9724073df97a2193802bfed1770900244154790d7584047cec63e043ad700c3fc20fac4107126633d951cd220e8c5b579183db
+  metadata.gz: bed91f539ff20534a965e36b6300dc7c90c2ef10d0e2e189031cae58bbaa66cfc56068e3b9b815850b38bdf4b69d2a23b2f29413cee16313581cdac084b737cb
+  data.tar.gz: b44fb0bbe52e6223e5bfb97a0c6af652a8106fd0285f5c41e84f4b2644449d55e711958e0410fd4b513e30cab71a7a8277f50695c44eb189c57524bb87049ecf

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # Change Log
 
-## [Unreleased](https://github.com/miroswan/vagrant_spec/tree/HEAD)
+## [v0.0.5](https://github.com/miroswan/vagrant_spec/tree/v0.0.5) (2016-08-10)
+[Full Changelog](https://github.com/miroswan/vagrant_spec/compare/v0.0.4...v0.0.5)
 
-[Full Changelog](https://github.com/miroswan/vagrant_spec/compare/v0.0.3...HEAD)
+**Closed issues:**
+
+- SSH Issue [\#14](https://github.com/miroswan/vagrant_spec/issues/14)
+- Fix spelling and grammatical issues in the documentation [\#7](https://github.com/miroswan/vagrant_spec/issues/7)
+
+**Merged pull requests:**
+
+- Fixing SSH [\#13](https://github.com/miroswan/vagrant_spec/pull/13) ([miroswan](https://github.com/miroswan))
+
+## [v0.0.4](https://github.com/miroswan/vagrant_spec/tree/v0.0.4) (2016-08-10)
+[Full Changelog](https://github.com/miroswan/vagrant_spec/compare/v0.0.3...v0.0.4)
 
 **Implemented enhancements:**
 
@@ -12,9 +23,20 @@
 
 - License info needs to be added to the gemspec [\#4](https://github.com/miroswan/vagrant_spec/issues/4)
 
+**Merged pull requests:**
+
+- Preparation for v0.0.4  [\#12](https://github.com/miroswan/vagrant_spec/pull/12) ([miroswan](https://github.com/miroswan))
+- Updating the documentation [\#11](https://github.com/miroswan/vagrant_spec/pull/11) ([miroswan](https://github.com/miroswan))
+- Adding version sub-command [\#10](https://github.com/miroswan/vagrant_spec/pull/10) ([miroswan](https://github.com/miroswan))
+
 ## [v0.0.3](https://github.com/miroswan/vagrant_spec/tree/v0.0.3) (2016-08-09)
 [Full Changelog](https://github.com/miroswan/vagrant_spec/compare/v0.0.2...v0.0.3)
 
+**Merged pull requests:**
+
+- Prepping for a v0.0.3 release [\#6](https://github.com/miroswan/vagrant_spec/pull/6) ([miroswan](https://github.com/miroswan))
+- Feature/machine data [\#5](https://github.com/miroswan/vagrant_spec/pull/5) ([miroswan](https://github.com/miroswan))
+
 ## [v0.0.2](https://github.com/miroswan/vagrant_spec/tree/v0.0.2) (2016-08-06)
 [Full Changelog](https://github.com/miroswan/vagrant_spec/compare/v0.0.1...v0.0.2)
 
@@ -23,6 +45,10 @@
 - Help output for init needs to be updated [\#2](https://github.com/miroswan/vagrant_spec/issues/2)
 - Needs tests [\#1](https://github.com/miroswan/vagrant_spec/issues/1)
 
+**Merged pull requests:**
+
+- Updates [\#3](https://github.com/miroswan/vagrant_spec/pull/3) ([miroswan](https://github.com/miroswan))
+
 ## [v0.0.1](https://github.com/miroswan/vagrant_spec/tree/v0.0.1) (2016-08-06)
 
 

data/README.md

@@ -92,9 +92,11 @@ your cluster of nodes.
 
 * version: Print the current version of vagrant_spec
 
-* init: This will generate your spec_helper.rb for serverspec testing and your
-ansible inventory file. You'll typically want to run this after a vagrant up,
-and before your deployment and testing tasks. 
+* init: This will generate your ansible inventory file if you've configured your
+config.spec.ansible_inventory directive. Additionally, it'll generate your
+.vagrantspec_machine_data file if set to enabled via 
+config.spec.generate_machine_data. You'll typically want to run this after a 
+vagrant up and before your deployment and testing tasks. 
 
 * test: This will run the tests specified in your Vagrantfile. Tests are
 executed against each node in your fleet and the exit code is stored if an error
@@ -104,9 +106,9 @@ to the shell. Otherwise, it will return zero.
 ## Sample Output
 
 ```
-> bundle exec vagrant spec init
+> vagrant spec init
 
-> bundle exec vagrant spec test
+> vagrant spec test
 
 *******************************************************
 ***************** ServerSpec Test Run *****************
@@ -114,45 +116,22 @@ to the shell. Otherwise, it will return zero.
 
 [test_ansible]
 
-ssh
-  ssh should be running
+Test Hostname
+  hostname is test_ansible
 
-Finished in 0.46065 seconds (files took 1.68 seconds to load)
+Finished in 0.43356 seconds (files took 1.61 seconds to load)
 1 example, 0 failures
 
 [test_pansible]
 
-Thing that fails
-  dumb_service totally fails (FAILED - 1)
+Test Hostname
+  hostname is test_pansible
 
-Failures:
-
-  1) Thing that fails dumb_service totally fails
-     On host `127.0.0.1'
-     Failure/Error: expect(service('dumb_service')).to be_running
-       expected Service "dumb_service" to be running
-       sudo -p 'Password: ' /bin/sh -c ps\ aux\ \|\ grep\ -w\ --\ dumb_service\ \|\ grep\ -qv\ grep
-
-     # ./serverspec/fail_spec.rb:5:in `block (2 levels) in <top (required)>'
-     # ./lib/vagrant_spec/test_plan.rb:62:in `execute_plan_tests'
-     # ./lib/vagrant_spec/test_plan.rb:31:in `block (2 levels) in run'
-     # ./lib/vagrant_spec/test_plan.rb:31:in `each'
-     # ./lib/vagrant_spec/test_plan.rb:31:in `block in run'
-     # ./lib/vagrant_spec/test_plan.rb:30:in `each'
-     # ./lib/vagrant_spec/test_plan.rb:30:in `run'
-     # ./lib/vagrant_spec/command/test.rb:18:in `execute'
-     # ./lib/vagrant_spec/command/base.rb:61:in `parse_subcommand'
-     # ./lib/vagrant_spec/command/base.rb:25:in `execute'
-
-Finished in 0.05726 seconds (files took 0.58135 seconds to load)
-1 example, 1 failure
-
-Failed examples:
-
-rspec ./serverspec/fail_spec.rb:4 # Thing that fails dumb_service totally fails
+Finished in 0.22762 seconds (files took 0.59837 seconds to load)
+1 example, 0 failures
 
 > echo $?
-1
+0
 ```
 
 ## Testing Resources

data/Vagrantfile

@@ -1,11 +1,12 @@
 
 Vagrant.configure(2) do |config|
+  config.vm.box = 'ubuntu/trusty64'
   config.vm.define 'test_ansible' do |b|
-    b.vm.box = 'ubuntu/trusty64'
+    b.vm.hostname = 'ansible'
   end
 
   config.vm.define 'test_pansible' do |b|
-    b.vm.box = 'ubuntu/trusty64'
+    b.vm.hostname = 'pansible'
   end
 
   # key: Ansible Group Name
@@ -17,11 +18,11 @@ Vagrant.configure(2) do |config|
   config.spec.test_plan = [
     {
       'nodes' => /test_ansi/,
-      'flags' => '--format documentation --color --pattern serverspec/ssh*'
+      'flags' => '--format documentation --color --pattern serverspec/ansi*'
     },
     {
       'nodes' => /test_pansi/,
-      'flags' => '--format documentation --color --pattern serverspec/fail*'
+      'flags' => '--format documentation --color --pattern serverspec/pansi*'
     }
   ]
 end

data/lib/vagrant_spec/command/init.rb

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 
 require 'vagrant_spec/ansible_inventory'
-require 'vagrant_spec/spec_helper'
 require 'vagrant_spec/machine_data'
 require 'vagrant_spec/config'
 
@@ -31,7 +30,6 @@ module VagrantSpec
 
       def execute
         return unless parse_opts
-        VagrantSpec::SpecHelper.new(@env).generate
         unless @ansible_inventory == DEFAULTS['ansible_inventory']
           VagrantSpec::AnsibleInventory.new(@env).generate
         end

data/lib/vagrant_spec/templates/init_help

@@ -1,9 +1,5 @@
 The init subcommand initializes state-based configuration for vagrant_spec. 
 
-It creates a spec_helper.rb file under the configured ServerSpec directory. This 
-file is used to setup ServerSpec backend configuration and ease ServerSpec 
-testing. 
-
 If the config.spec.ansible_inventory configuration directive is used within the 
 Vagrantfile, then init will generate a test inventory file 
 vagrantspec_inventory. This file can be used for ansible orchestration against 

data/lib/vagrant_spec/test_plan.rb

@@ -1,6 +1,9 @@
 # encoding: UTF-8
 
 require 'rspec'
+require 'serverspec'
+require 'specinfra'
+require 'specinfra/backend'
 
 require 'vagrant_spec/config'
 require 'vagrant_spec/machine_finder'
@@ -47,18 +50,37 @@ module VagrantSpec
       end
     end
 
+    # Close existing SSH
+    def close_ssh
+      if ::Specinfra::Backend::Ssh.instance.get_config(:ssh)
+        ::Specinfra::Backend::Ssh.instance.get_config(:ssh).close
+        ::Specinfra::Backend::Ssh.instance.set_config(:ssh, nil)
+      end
+    end
+
+    # Configures ServerSpec
+    #
+    # node [Vagrant::Machine]
+    def configure_serverspec(node)
+      set :backend, :ssh
+      host           = node.ssh_info[:host].to_s
+      options        = Net::SSH::Config.for(host)
+      options[:user] = node.ssh_info[:username].to_s
+      options[:keys] = node.ssh_info[:private_key_path][0].to_s
+      options[:port] = node.ssh_info[:port].to_s
+
+      set :host,        host
+      set :ssh_options, options
+    end
+
     # Execute a test_suite and return the code
     #
     # node [Vagrant::Machine]
     # plan [Hash] item in the @config.spec.test_plan
-    #
-    # return [@ret_code]
     def execute_plan_tests(node, plan)
       @env.ui.info("[#{node.name}]")
-      ENV['VAGRANT_HOST'] = node.ssh_info[:host].to_s
-      ENV['VAGRANT_PORT'] = node.ssh_info[:port].to_s
-      ENV['VAGRANT_KEY']  = node.ssh_info[:private_key_path][0].to_s
-      ENV['VAGRANT_USER'] = node.ssh_info[:username].to_s
+      close_ssh
+      configure_serverspec(node)
       plan['flags'].prepend "-I #{@config.spec.directory} "
       ret_code = RSpec::Core::Runner.run(plan['flags'].split, $stderr, $stdout)
       RSpec.clear_examples

data/lib/vagrant_spec/version.rb

@@ -2,5 +2,5 @@
 
 # Requisite version info
 module VagrantSpec
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.5'.freeze
 end

data/scripts/poor_mans_smoke_test.sh

@@ -19,5 +19,5 @@ rm -f ".vagrantspec_machine_data"
 bundle exec vagrant up
 bundle exec vagrant spec init
 ansible-playbook site.yml -i vagrantspec_inventory
-bundle exec vagrant spec test || true
+bundle exec vagrant spec test
 bundle exec vagrant destroy -f 

data/serverspec/ansible_spec.rb

@@ -0,0 +1,6 @@
+
+describe 'Test Hostname' do
+  it 'hostname is test_ansible' do
+    expect(command('printf "$(hostname)"').stdout).to eq('ansible')
+  end
+end

data/serverspec/pansible_spec.rb

@@ -0,0 +1,6 @@
+
+describe 'Test Hostname' do
+  it 'hostname is test_pansible' do
+    expect(command('printf "$(hostname)"').stdout).to eq('pansible')
+  end
+end

data/spec/unit/spec_helper.rb

@@ -21,6 +21,8 @@ require 'vagrant_spec'
 require 'unit/support/shared/base_context'
 require 'unit/support/shared/virtualbox_context'
 
+require 'serverspec'
+
 # Build methods to retrieve plugins against VagrantSpec::Plugin.
 #
 # Example: get_commands(VagrantSpec::Plugin)
@@ -54,6 +56,9 @@ RSpec.shared_examples 'shared_mocks' do
     EOF
   end
 
+  # Silence ServerSpec
+  set :backend, :ssh
+
   let(:mock_vf_obj) { double(Vagrant::Vagrantfile)      }
   let(:mock_ui)     { double(Vagrant::UI)               }
   let(:mock_config) { double(Vagrant::Config)           }

data/spec/unit/vagrant_spec_test/command_spec/init_spec.rb

@@ -7,10 +7,6 @@ describe VagrantSpec::Command::Init do
   include_context  'unit'
   include_examples 'shared_mocks'
 
-  let(:mock_spec_helper) do
-    double(VagrantSpec::SpecHelper)
-  end
-
   let(:mock_ansible_inventory) do
     double(VagrantSpec::AnsibleInventory)
   end
@@ -32,10 +28,8 @@ describe VagrantSpec::Command::Init do
 
   def execute_proc
     proc do
-      allow_any_instance_of(VagrantSpec::SpecHelper).to       receive(:generate)
       allow_any_instance_of(VagrantSpec::AnsibleInventory).to receive(:generate)
       allow_any_instance_of(VagrantSpec::MachineData).to      receive(:generate)
-      allow(mock_spec_helper).to       receive(:generate)
       allow(mock_ansible_inventory).to receive(:generate)
       allow(mock_machine_data).to      receive(:generate)
     end
@@ -53,7 +47,6 @@ describe VagrantSpec::Command::Init do
     def execute_protection_proc
       proc do
         allow(subject).to receive(:parse_opts) { 'not_nil' }
-        allow(VagrantSpec::SpecHelper).to receive(:new) { mock_spec_helper }
         allow(VagrantSpec::AnsibleInventory).to receive(:new) do
           mock_ansible_inventory
         end
@@ -66,8 +59,6 @@ describe VagrantSpec::Command::Init do
       it '#execute creates an instance of VagrantSpec::SpecHelper' do
         execute_protection_proc.call
         subject.ansible_inventory = {}
-
-        expect(mock_spec_helper).to           receive(:generate)
         expect(mock_ansible_inventory).to_not receive(:generate)
         subject.execute
       end
@@ -78,7 +69,6 @@ describe VagrantSpec::Command::Init do
         execute_protection_proc.call
         subject.ansible_inventory = { 'all' => /node/ }
 
-        expect(mock_spec_helper).to       receive(:generate)
         expect(mock_ansible_inventory).to receive(:generate)
         subject.execute
       end

data/spec/unit/vagrant_spec_test/test_plan_spec.rb

@@ -38,6 +38,8 @@ describe VagrantSpec::TestPlan do
     }
   end
 
+  let(:mock_ssh_backend) { double(Specinfra::Backend::Ssh) }
+
   ##############################################################################
   # Stubs
 
@@ -47,6 +49,8 @@ describe VagrantSpec::TestPlan do
     allow_any_instance_of(VagrantSpec::MachineFinder)
       .to receive(:machine)     { double(Vagrant::Machine)   }
 
+    allow(::Specinfra::Backend::Ssh).to receive(:instance) { mock_ssh_backend }
+
     allow(RSpec::Core::Runner).to receive(:run) { 0 }
     allow(iso_env).to             receive(:ui)
     allow(mock_node).to           receive(:name)
@@ -59,9 +63,6 @@ describe VagrantSpec::TestPlan do
 
   subject { VagrantSpec::TestPlan.new(iso_env) }
 
-  ##############################################################################
-  # Testing #nodes
-
   context 'when passing a Regexp object' do
     it '#nodes calls match_nodes on a machine_finder instance' do
       expect(subject.m_finder).to receive(:match_nodes)
@@ -81,6 +82,17 @@ describe VagrantSpec::TestPlan do
     end
   end
 
+  context 'when ssh config is truthy' do
+    it '#close_ssh closes the pre-existing SSH connection' do
+      ssh_obj = double(Object.new)
+      allow(mock_ssh_backend).to receive(:get_config).with(:ssh) { ssh_obj }
+      allow(mock_ssh_backend).to receive(:set_config)
+      expect(ssh_obj).to receive(:close)
+      expect(mock_ssh_backend).to receive(:set_config)
+      subject.close_ssh
+    end
+  end
+
   ##############################################################################
   # Testing #execute_plan_tests
   #
@@ -88,8 +100,16 @@ describe VagrantSpec::TestPlan do
   # executes clear_examples. clear_examples modifies global state, so we must
   # contain it.
 
+  def execute_plan_tests_proc
+    proc do
+      allow(subject).to receive(:close_ssh)
+      allow(subject).to receive(:configure_serverspec)
+    end
+  end
+
   it '#execute_plan_tests runs the RSPec tests' do
     in_sub_process do
+      execute_plan_tests_proc.call
       expect(RSpec::Core::Runner).to receive(:run)
       subject.execute_plan_tests(mock_node, mock_plan[0])
     end
@@ -97,8 +117,16 @@ describe VagrantSpec::TestPlan do
 
   it '#execute adds the spec.directory to the load path' do
     in_sub_process do
+      execute_plan_tests_proc.call
       subject.execute_plan_tests(mock_node, mock_plan[0])
-      expect(subject.test_plan[0]['flags']).to include('-I serverspec')
+      expect(subject.test_plan[0]['flags']).to match(/-I serverspec/)
+    end
+  end
+
+  it '#execute calls close_ssh and configure_serverspec' do
+    in_sub_process do
+      expect(subject).to receive(:close_ssh)
+      expect(subject).to receive(:configure_serverspec)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant_spec
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Demitri
@@ -127,17 +127,15 @@ files:
 - lib/vagrant_spec/config/base.rb
 - lib/vagrant_spec/machine_data.rb
 - lib/vagrant_spec/machine_finder.rb
-- lib/vagrant_spec/spec_helper.rb
 - lib/vagrant_spec/templates/init_help
-- lib/vagrant_spec/templates/spec_helper.erb
 - lib/vagrant_spec/templates/test_help
 - lib/vagrant_spec/templates/vagrantspec_inventory.erb
 - lib/vagrant_spec/test_plan.rb
 - lib/vagrant_spec/utils.rb
 - lib/vagrant_spec/version.rb
 - scripts/poor_mans_smoke_test.sh
-- serverspec/fail_spec.rb
-- serverspec/ssh_spec.rb
+- serverspec/ansible_spec.rb
+- serverspec/pansible_spec.rb
 - site.yml
 - spec/unit/spec_helper.rb
 - spec/unit/vagrant_spec_spec.rb
@@ -150,7 +148,6 @@ files:
 - spec/unit/vagrant_spec_test/config_spec/base_spec.rb
 - spec/unit/vagrant_spec_test/machine_data_spec.rb
 - spec/unit/vagrant_spec_test/machine_finder_spec.rb
-- spec/unit/vagrant_spec_test/spec_helper_spec.rb
 - spec/unit/vagrant_spec_test/test_plan_spec.rb
 - spec/unit/vagrant_spec_test/utils_spec.rb
 - vagrant_spec.gemspec
@@ -190,6 +187,5 @@ test_files:
 - spec/unit/vagrant_spec_test/config_spec/base_spec.rb
 - spec/unit/vagrant_spec_test/machine_data_spec.rb
 - spec/unit/vagrant_spec_test/machine_finder_spec.rb
-- spec/unit/vagrant_spec_test/spec_helper_spec.rb
 - spec/unit/vagrant_spec_test/test_plan_spec.rb
 - spec/unit/vagrant_spec_test/utils_spec.rb

data/lib/vagrant_spec/spec_helper.rb

@@ -1,42 +0,0 @@
-# encoding: UTF-8
-
-require 'erb'
-
-require 'vagrant_spec/config'
-require 'vagrant_spec/utils'
-
-module VagrantSpec
-  # Generates a spec_helper.rb for integration testing
-  #
-  # env [Vagrant::Environment]
-  class SpecHelper
-    include VagrantSpec::Utils
-    def initialize(env)
-      @env = env
-      @directory = VagrantSpec::Config.load(env).spec.directory
-    end
-
-    # Generate the spec_helper.rb
-    def generate
-      create_directory
-      return if File.exist? spec_helper_path
-      sh = ERB.new(IO.read(spec_helper_template), 0, '<>').result binding
-      IO.write(spec_helper_path, sh)
-    end
-
-    # return [String]
-    def create_directory
-      Dir.mkdir @directory unless Dir.exist? @directory
-    end
-
-    # return [String]
-    def spec_helper_path
-      File.join(@directory, 'spec_helper.rb')
-    end
-
-    # return [String]
-    def spec_helper_template
-      File.join(template_dir, 'spec_helper.erb')
-    end
-  end
-end

data/lib/vagrant_spec/templates/spec_helper.erb

@@ -1,19 +0,0 @@
-# encoding: UTF-8
-
-require 'serverspec'
-require 'net/ssh'
-require 'rspec'
-
-###################
-# Serverspec Config
-
-set :backend, :ssh
-
-host               = ENV['VAGRANT_HOST']
-options            = Net::SSH::Config.for(host)
-options[:user]     = ENV['VAGRANT_USER']
-options[:keys]     = ENV['VAGRANT_KEY']
-options[:port]     = ENV['VAGRANT_PORT']
-
-set :host,        host
-set :ssh_options, options

data/serverspec/fail_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe 'Thing that fails' do
-  it 'dumb_service totally fails' do
-    expect(service('dumb_service')).to be_running
-  end
-end

data/serverspec/ssh_spec.rb

@@ -1,10 +0,0 @@
-
-# encoding: UTF-8
-
-require 'spec_helper'
-
-describe 'ssh' do
-  it 'ssh should be running' do
-    expect(service('ssh')).to be_running
-  end
-end

data/spec/unit/vagrant_spec_test/spec_helper_spec.rb

@@ -1,41 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'vagrant_spec/spec_helper'
-require 'vagrant_spec/utils'
-
-describe VagrantSpec::SpecHelper do
-  include_context  'unit'
-  include_examples 'shared_mocks'
-
-  subject { VagrantSpec::SpecHelper.new(iso_env) }
-
-  context 'when @directory does not exist' do
-    it '#create_directory creates the directory' do
-      allow(Dir).to  receive(:exist?) { false }
-      allow(Dir).to  receive(:mkdir)
-      expect(Dir).to receive(:mkdir)
-
-      subject.create_directory
-    end
-  end
-
-  context 'when @directory does exist' do
-    it '#create_directory does not create the directory' do
-      allow(Dir).to      receive(:exist?) { true }
-      allow(Dir).to      receive(:mkdir)
-      expect(Dir).not_to receive(:mkdir)
-
-      subject.create_directory
-    end
-  end
-
-  it '#spec_helper_path returns serverspec/spec_helper.rb' do
-    expect(subject.spec_helper_path).to eq('serverspec/spec_helper.rb')
-  end
-
-  it '#spec_helper_template includes vagrant_spec/templates/spec_helper.erb' do
-    result = subject.spec_helper_template
-    expect(result).to match(%r{vagrant_spec/templates/spec_helper.erb})
-  end
-end