vagrant_spec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbb7993f86c2fd21b7943bf6109f3fd0bb9fe5b6
+  data.tar.gz: 0bc50057dc57d35882ae4fb5d31eb7b15023cbc5
+SHA512:
+  metadata.gz: 2715c4b9b32916f0b9818200e5048b71585ef59bd2bcff8b3023bd94ff63bf6c269bd33ad211e1d02b0362647a9f2d3569179f4bd937c47d59a1f8603c5c71b7
+  data.tar.gz: 56e0e9e7f840fc370b35319696a8f8a87ef51ae62e80b886fb455a1b698ef731cf32540123163959e7b53211cac50273c8a88e7d52f8cd17978695b5f7a222b5

data/.gitignore

@@ -0,0 +1,6 @@
+.vagrant
+Gemfile.lock
+vagrantspec_inventory
+serverspec/spec_helper.rb
+coverage
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/AbcSize:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+
+#addons:
+#  apt:
+#    packages:
+#      - virtualbox
+#      - vagrant
+
+script: bundle exec rake travis

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :development do
+  gemspec
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+end
+
+group :plugins do
+  gem 'vagrant_spec', path: '.'
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright [2016] [Demitri Swan]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,146 @@
+# vagrant_spec
+
+[![Build Status](https://travis-ci.org/miroswan/vagrant_spec.svg?branch=master)](https://travis-ci.org/miroswan/vagrant_spec) 
+[![Coverage Status](https://coveralls.io/repos/github/miroswan/vagrant_spec/badge.svg?branch=master)](https://coveralls.io/github/miroswan/vagrant_spec?branch=master)
+
+Vagrant Spec is a Vagrant plugin that makes integration testing for deployments
+to clustered systems a breeze. It also separates the build and deployment steps
+to clearly delineate pipeline tasks. 
+
+## Why not use TestKitchen or vagrant-serverspec?
+
+* Test Kitchen is an excellent integration testing system developed by Chef.
+However, it is designed to provision, test, and destroy each system one at a
+time. The directory structure it expects makes sharing tests across nodes 
+difficult to manager. This is undesireable for testing clustered or 
+distributed systems. vagrant-serverspec has similar pitfalls. 
+
+* vagrant_spec allows you to leverage your deployment tools just like you would
+in staging and production. It generates an ansible inventory file after all
+nodes are brought up. This allows you to run the same ansible_playbook commands
+against the local node set as you would elsewhere. 
+
+* routing tests to nodes is flexible and simple. 
+
+* vagrant_spec allows you to provision your nodes with configuration management
+and leverage ansible for orchestration and deployment. TestKitchen currently
+does not support this scenario without much trouble. 
+
+Here is a sample Vagrantfile:
+
+```
+Vagrant.configure(2) do |config|
+  config.vm.define 'test_ansible' do |b|
+    b.vm.box = 'ubuntu/trusty64'
+  end
+
+  config.vm.define 'test_pansible' do |b|
+    b.vm.box = 'ubuntu/trusty64'
+  end
+
+  # key: Ansible Group Name
+  # value: Regexp matching your node names or an array of nodes
+  config.spec.ansible_inventory = { 'all' => /test/ }
+
+  # nodes: Regexp matching the desired nodes or array of nodes
+  # flags: Command line flags you would pass to rspec 
+  config.spec.test_plan = [
+    {
+      'nodes' => /test_ansi/,
+      'flags' => '--format documentation --color --pattern serverspec/ssh*'
+    },
+    {
+      'nodes' => /test_pansi/,
+      'flags' => '--format documentation --color --pattern serverspec/fail*'
+    }
+  ]
+end
+```
+
+## Configuration
+
+* config.spec.directory: relative path to your serverspec test files. This 
+defaults to serverspec. 
+
+* config.spec.ansible_inventory: a hash that maps ansible groups to your nodes.
+You can specify as many groups as you need. You can match nodes by regular 
+expression or explicitly provide an array of node names. This will generate 
+an vagrantspec_inventory based on your active nodes. You use this file for 
+running ansible playbooks against your Vagrant instances. 
+
+* config.spec.test_plan: an array of hashes. nodes can either be a regular 
+expression object that matches your desired nodes or an explicit array of 
+nodes. flags is a string that matches the desired flags you would pass to
+rspec. The last argument is typically a pattern that maps to the tests you'd 
+like to run. This allows you to split out what tests you'd like to run across
+your cluster of nodes. 
+
+## Sub Commands
+
+* 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. 
+
+* 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
+occurs. All tests will run. The exit code of the last failed run will return
+to the shell. Otherwise, it will return zero. 
+
+## Sample Output
+
+```
+> bundle exec vagrant spec init
+
+> bundle exec vagrant spec test
+
+*******************************************************
+***************** ServerSpec Test Run *****************
+*******************************************************
+
+[test_ansible]
+
+ssh
+  ssh should be running
+
+Finished in 0.46065 seconds (files took 1.68 seconds to load)
+1 example, 0 failures
+
+[test_pansible]
+
+Thing that fails
+  dumb_service totally fails (FAILED - 1)
+
+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
+
+> echo $?
+1
+```
+
+## Development
+
+* Fork the development branch
+* ```bundle exec rake test```

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: %i(unit)
+
+desc 'Run unit tests'
+RSpec::Core::RakeTask.new(:unit)
+
+desc 'Run rubocop'
+RuboCop::RakeTask.new(:cop)
+
+desc 'Run smoke test'
+task :smoke_test do
+  system('scripts/poor_mans_smoke_test.sh')
+end
+
+desc 'Run rubocop and unit tests'
+task travis: %i(cop unit)
+
+desc 'Run all tests'
+task test: %i(cop unit smoke_test)
+
+Dir.chdir(File.expand_path('../', __FILE__))
+Bundler::GemHelper.install_tasks

data/Vagrantfile

@@ -0,0 +1,27 @@
+
+Vagrant.configure(2) do |config|
+  config.vm.define 'test_ansible' do |b|
+    b.vm.box = 'ubuntu/trusty64'
+  end
+
+  config.vm.define 'test_pansible' do |b|
+    b.vm.box = 'ubuntu/trusty64'
+  end
+
+  # key: Ansible Group Name
+  # value: Regexp matching your node names or an array of nodes
+  config.spec.ansible_inventory = { 'all' => /test/ }
+
+  # nodes: Regexp matching the desired nodes or array of nodes
+  # flags: Command line flags you would pass to rspec
+  config.spec.test_plan = [
+    {
+      'nodes' => /test_ansi/,
+      'flags' => '--format documentation --color --pattern serverspec/ssh*'
+    },
+    {
+      'nodes' => /test_pansi/,
+      'flags' => '--format documentation --color --pattern serverspec/fail*'
+    }
+  ]
+end

data/lib/vagrant_spec/ansible_inventory.rb

@@ -0,0 +1,80 @@
+# encoding: UTF-8
+
+require 'erb'
+
+require 'vagrant_spec/utils'
+require 'vagrant_spec/machine_finder'
+
+module VagrantSpec
+  # Generate ansible ansible_inventory file
+  #
+  # env [Vagrant::Environment]
+  class AnsibleInventory
+    include VagrantSpec::Utils
+    attr_accessor :env, :config, :ansible_inventory, :inventory, :m_finder
+    def initialize(env)
+      @env               = env
+      @config            = env.vagrantfile.config
+      @ansible_inventory = @config.spec.ansible_inventory
+      @inventory         = {}
+      @m_finder          = VagrantSpec::MachineFinder.new(env)
+    end
+
+    def generate
+      load_ansible_inventory
+      template_path = File.join(template_dir, 'vagrantspec_inventory.erb')
+      template      = IO.read(template_path)
+      f             = ERB.new(template, 0, '<>').result(binding)
+      IO.write('vagrantspec_inventory', f)
+    end
+
+    def load_ansible_inventory
+      @ansible_inventory.each do |group, nodes|
+        if nodes.is_a?(Array)
+          handle_array(group, nodes)
+        elsif nodes.is_a?(Regexp)
+          handle_regexp(group, nodes)
+        end
+      end
+    end
+
+    # group [String]
+    # nodes [Array<String>]
+    def handle_array(group, nodes)
+      @inventory[group] = nodes.collect do |name|
+        generate_machine_config(name)
+      end
+    end
+
+    # group [String]
+    # nodes [Array<String>]
+    def handle_regexp(group, nodes)
+      machines = @m_finder.match_nodes(nodes)
+      if machines
+        @inventory[group] = machines.collect do |name|
+          generate_machine_config(name.name)
+        end
+      end
+    end
+
+    # name [String]
+    def generate_machine_config(name)
+      node = @m_finder.machine(name.to_sym)
+      return nil unless node
+      ssh_config = machine_ssh_config(node)
+      { name => ssh_config }
+    end
+
+    # machine [Vagrant::Machine]
+    def machine_ssh_config(machine)
+      ssh_config = machine.ssh_info
+      key = ssh_config[:private_key_path][0]
+      config = {}
+      config['ansible_host']                 = ssh_config[:host]
+      config['ansible_port']                 = ssh_config[:port]
+      config['ansible_user']                 = ssh_config[:username]
+      config['ansible_ssh_private_key_file'] = key
+      config
+    end
+  end
+end

data/lib/vagrant_spec/command/base.rb

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+
+module VagrantSpec
+  module Command
+    # This command plugin routes to the available subcommands
+    class Base < Vagrant.plugin(2, :command)
+      def self.synopsis
+        'test deployments to clustered systems'
+      end
+
+      attr_accessor :valid_commands, :subcommands, :env, :opts
+      def initialize(argv, env)
+        super
+        @main_args,
+        @sub_command,
+        @sub_args       = split_main_and_subcommand(argv)
+        @valid_commands = Dir.glob(File.join(File.dirname(__FILE__), '*'))
+                             .collect { |f| File.basename(f).gsub(/\.rb$/, '') }
+                             .select  { |f| f != 'base' }
+        @subcommands    = Vagrant::Registry.new
+        @env            = env
+        @opts           = nil
+      end
+
+      def execute
+        register_subcommands
+        return unless parse_main_args
+        return unless parse_subcommand
+      end
+
+      def register_subcommands
+        @valid_commands.each do |cmd|
+          @subcommands.register cmd.to_sym do
+            cmd_str = cmd.to_s
+            require "vagrant_spec/command/#{cmd_str}"
+            Object.const_get "VagrantSpec::Command::#{cmd_str.capitalize}"
+          end
+        end
+      end
+
+      def help
+        opts = OptionParser.new do |o|
+          o.banner = "\nUsage: vagrant spec <command> [<args>]"
+          o.separator ''
+          o.separator 'Available subcommands:'
+          @valid_commands.sort.each { |cmd| o.separator "     #{cmd}" }
+          o.separator ''
+          o.separator 'For help on any individual command run `vagrant spec ' \
+                      '<command> -h`'
+        end
+        parse_options(opts) && @opts = opts
+      end
+
+      def print_help
+        help
+        @env.ui.info @opts
+      end
+
+      def parse_main_args
+        if @main_args.include?('-h') || @main_args.include?('--help')
+          return help
+        end
+        true
+      end
+
+      def parse_subcommand
+        klass = @subcommands.get(@sub_command.to_sym) if @sub_command
+        return print_help if @sub_command.nil? || klass.nil?
+        klass.new(@sub_args, @env).execute
+        true
+      end
+    end
+  end
+end

data/lib/vagrant_spec/command/init.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+require 'vagrant_spec/ansible_inventory'
+require 'vagrant_spec/spec_helper'
+require 'vagrant_spec/config'
+
+module VagrantSpec
+  module Command
+    # This command instantiates serveral files for deployment and testing
+    #
+    # argv
+    # env [Vagrant::Environment]
+    class Init < Vagrant.plugin(2, :command)
+      include VagrantSpec::Utils
+
+      DEFAULTS = VagrantSpec::Config::DEFAULTS
+
+      attr_accessor :config, :directory, :ansible_inventory
+      def initialize(argv, env)
+        super
+        @config            = VagrantSpec::Config.load env
+        @directory         = @config.spec.directory
+        @ansible_inventory = @config.spec.ansible_inventory
+      end
+
+      def execute
+        return unless parse_opts
+        VagrantSpec::SpecHelper.new(@env).generate
+        unless @ansible_inventory == DEFAULTS['ansible_inventory']
+          VagrantSpec::AnsibleInventory.new(@env).generate
+        end
+      end
+
+      def parse_opts
+        opts = OptionParser.new do |o|
+          o.banner = "\nCreates the spec/spec_helper.rb file for testing"
+          o.separator ''
+          o.separator 'Usage: vagrant spec init'
+          o.separator ''
+        end
+        parse_options(opts)
+      end
+    end
+  end
+end

data/lib/vagrant_spec/command/test.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+require 'vagrant_spec/test_plan'
+
+module VagrantSpec
+  module Command
+    # This command instantiates serveral files for deployment and testing
+    #
+    # argv
+    # env [Vagrant::Environment]
+    class Test < Vagrant.plugin(2, :command)
+      def initialize(argv, env)
+        super
+      end
+
+      def execute
+        return unless parse_opts
+        VagrantSpec::TestPlan.new(@env).run
+      end
+
+      def parse_opts
+        opts = OptionParser.new do |o|
+          o.banner = "\nRun the tests configured in the Vagrantfile"
+          o.separator ''
+          o.separator 'Usage: vagrant spec test'
+          o.separator ''
+        end
+        parse_options(opts)
+      end
+    end
+  end
+end

data/lib/vagrant_spec/command.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module VagrantSpec
+  # Autoload
+  module Command
+    autoload :Base, 'vagrant_spec/command/base'
+    autoload :Init, 'vagrant_spec/command/init'
+  end
+end

data/lib/vagrant_spec/config/base.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+
+require 'vagrant_spec/config'
+
+module VagrantSpec
+  module Config
+    # This class handles the configuration options in the Vagrantfile
+    class Base < Vagrant.plugin(2, :config)
+      DEFAULTS = VagrantSpec::Config::DEFAULTS
+
+      attr_accessor :directory
+      attr_accessor :ansible_inventory
+      attr_accessor :test_plan
+
+      def initialize
+        @directory         = UNSET_VALUE
+        @ansible_inventory = UNSET_VALUE
+        @test_plan         = UNSET_VALUE
+      end
+
+      def final_directory
+        @directory = DEFAULTS['directory'] if @directory == UNSET_VALUE
+      end
+
+      def final_ansible_inventory
+        if @ansible_inventory == UNSET_VALUE
+          @ansible_inventory = DEFAULTS['ansible_inventory']
+        end
+      end
+
+      def final_test_plan
+        @test_plan = DEFAULTS['test_plan'] if @test_plan == UNSET_VALUE
+      end
+
+      def finalize!
+        final_directory
+        final_ansible_inventory
+        final_test_plan
+      end
+    end
+  end
+end

data/lib/vagrant_spec/config.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+module VagrantSpec
+  # Autoload
+  module Config
+    autoload :Base, 'vagrant_spec/config/base'
+
+    DEFAULTS = {
+      'directory'         => 'serverspec',
+      'ansible_inventory' => {},
+      'test_plan'         => []
+    }.freeze
+
+    class << self
+      def load(env)
+        env.vagrantfile.config
+      end
+    end
+  end
+end

data/lib/vagrant_spec/machine_finder.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+module VagrantSpec
+  # Convenience methods for discovering machines
+  #
+  # env [Vagrant::Environment]
+  class MachineFinder
+    def initialize(env)
+      @env = env
+    end
+
+    # name [Symbol]
+    #
+    # return [Vagrant::Machine]
+    def machine(name)
+      @env.active_machines.each do |m|
+        node = @env.machine(*m)
+        return node if node.name == name
+      end
+      nil
+    end
+
+    # reg [Regexp]
+    #
+    # return [Array<Vagrant::Machine>]
+    def match_nodes(reg)
+      @env.active_machines.collect { |m| machine(m[0]) }
+          .select { |m| m if reg.match(m.name.to_s) }
+    end
+  end
+end

data/lib/vagrant_spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# 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

@@ -0,0 +1,19 @@
+# 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/lib/vagrant_spec/templates/vagrantspec_inventory.erb

@@ -0,0 +1,12 @@
+
+<% @inventory.each do |group, nodes| %>
+[<%= group %>]
+<% nodes.each do |node| %>
+<% node.each do |node_name, data| %>
+<%= node_name %> <%= data.collect { |k, v| "#{k}=#{v}" }.join(' ') %>
+
+<% end %>
+<% end %>
+
+
+<% end %>