vagrant-r10k 0.2.0 → 0.3.0

data/spec/acceptance/skeletons/no_puppet_dir/Vagrantfile

@@ -0,0 +1,18 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "vagrantr10kspec"
+  config.vm.network "private_network", type: "dhcp"
+
+  # r10k plugin to deploy puppet modules
+  config.r10k.puppet_dir = "puppet"
+  config.r10k.puppetfile_path = "puppet/Puppetfile"
+
+  # Provision the machine with the appliction
+  config.vm.provision "puppet" do |puppet|
+    puppet.manifests_path = "puppet/manifests"
+    puppet.manifest_file  = "default.pp"
+    puppet.module_path = "puppet/modules"
+  end
+end

data/spec/acceptance/skeletons/no_puppet_dir/gitcheck.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+# helper script to determine if a git clone is checked out to a
+# PR, tag, or branch, and then output some information about the status
+if [ $# -gt 0 ]; then
+    cd $1
+fi
+origin=$(git remote show -n origin | grep 'Fetch URL:' | awk '{print $3}')
+if tmp=$(git status | grep "refs/pull/origin"); then
+    foo=$(echo "$tmp" | awk '{print $4}' | awk -F / '{print $4}')
+    echo "PR: ${foo} @ $(git rev-parse HEAD) (origin: ${origin})"
+elif tagname=$(git describe --exact-match --tags $(git log -n1 --pretty='%h') 2>/dev/null); then
+    echo "tag: ${tagname} @ $(git rev-parse HEAD) (origin: ${origin})"
+elif git symbolic-ref -q HEAD &>/dev/null; then
+    branch_name=$(git symbolic-ref -q HEAD)
+    branch_name=${branch_name##refs/heads/}
+    branch_name=${branch_name:-HEAD}
+    echo "branch: ${branch_name} @ $(git rev-parse HEAD) (origin: ${origin})"
+else
+    echo "sha: $(git rev-parse HEAD) (origin: ${origin})"
+fi

data/spec/acceptance/skeletons/no_vagrant_r10k/Vagrantfile

@@ -0,0 +1,14 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "vagrantr10kspec"
+  config.vm.network "private_network", type: "dhcp"
+
+  # Provision the machine with the appliction
+  config.vm.provision "puppet" do |puppet|
+    puppet.manifests_path = "puppet/manifests"
+    puppet.manifest_file  = "default.pp"
+    puppet.module_path = "puppet/modules"
+  end
+end

data/spec/acceptance/skeletons/no_vagrant_r10k/gitcheck.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+# helper script to determine if a git clone is checked out to a
+# PR, tag, or branch, and then output some information about the status
+if [ $# -gt 0 ]; then
+    cd $1
+fi
+origin=$(git remote show -n origin | grep 'Fetch URL:' | awk '{print $3}')
+if tmp=$(git status | grep "refs/pull/origin"); then
+    foo=$(echo "$tmp" | awk '{print $4}' | awk -F / '{print $4}')
+    echo "PR: ${foo} @ $(git rev-parse HEAD) (origin: ${origin})"
+elif tagname=$(git describe --exact-match --tags $(git log -n1 --pretty='%h') 2>/dev/null); then
+    echo "tag: ${tagname} @ $(git rev-parse HEAD) (origin: ${origin})"
+elif git symbolic-ref -q HEAD &>/dev/null; then
+    branch_name=$(git symbolic-ref -q HEAD)
+    branch_name=${branch_name##refs/heads/}
+    branch_name=${branch_name:-HEAD}
+    echo "branch: ${branch_name} @ $(git rev-parse HEAD) (origin: ${origin})"
+else
+    echo "sha: $(git rev-parse HEAD) (origin: ${origin})"
+fi

data/spec/acceptance/skeletons/no_vagrant_r10k/puppet/Puppetfile

@@ -0,0 +1,12 @@
+# This is currently a noop but will be supported in the future.
+forge 'forge.puppetlabs.com'
+
+# v1.0.1 -> cdb8d7a186846b49326cec1cfb4623bd77529b04
+mod 'reviewboard',
+  :git => 'https://github.com/jantman/puppet-reviewboard.git',
+  :ref => 'v1.0.1'
+
+# 0.1.0 -> 3a504b5f66ebe1853bda4ee065fce18118958d84
+mod 'nodemeister',
+  :git => 'https://github.com/jantman/puppet-nodemeister.git',
+  :ref => '0.1.0'

data/spec/acceptance/skeletons/no_vagrant_r10k/puppet/manifests/default.pp

@@ -0,0 +1 @@
+notify {'vagrant-r10k puppet run': }

data/spec/acceptance/skeletons/puppetfile_syntax_error/Vagrantfile

@@ -0,0 +1,18 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "vagrantr10kspec"
+  config.vm.network "private_network", type: "dhcp"
+
+  # r10k plugin to deploy puppet modules
+  config.r10k.puppet_dir = "puppet"
+  config.r10k.puppetfile_path = "puppet/Puppetfile"
+
+  # Provision the machine with the appliction
+  config.vm.provision "puppet" do |puppet|
+    puppet.manifests_path = "puppet/manifests"
+    puppet.manifest_file  = "default.pp"
+    puppet.module_path = "puppet/modules"
+  end
+end

data/spec/acceptance/skeletons/puppetfile_syntax_error/gitcheck.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+# helper script to determine if a git clone is checked out to a
+# PR, tag, or branch, and then output some information about the status
+if [ $# -gt 0 ]; then
+    cd $1
+fi
+origin=$(git remote show -n origin | grep 'Fetch URL:' | awk '{print $3}')
+if tmp=$(git status | grep "refs/pull/origin"); then
+    foo=$(echo "$tmp" | awk '{print $4}' | awk -F / '{print $4}')
+    echo "PR: ${foo} @ $(git rev-parse HEAD) (origin: ${origin})"
+elif tagname=$(git describe --exact-match --tags $(git log -n1 --pretty='%h') 2>/dev/null); then
+    echo "tag: ${tagname} @ $(git rev-parse HEAD) (origin: ${origin})"
+elif git symbolic-ref -q HEAD &>/dev/null; then
+    branch_name=$(git symbolic-ref -q HEAD)
+    branch_name=${branch_name##refs/heads/}
+    branch_name=${branch_name:-HEAD}
+    echo "branch: ${branch_name} @ $(git rev-parse HEAD) (origin: ${origin})"
+else
+    echo "sha: $(git rev-parse HEAD) (origin: ${origin})"
+fi

data/spec/acceptance/skeletons/puppetfile_syntax_error/puppet/Puppetfile

@@ -0,0 +1 @@
+this is not a valid puppetfile

data/spec/acceptance/skeletons/puppetfile_syntax_error/puppet/manifests/default.pp

@@ -0,0 +1 @@
+notify {'vagrant-r10k puppet run': }

data/spec/acceptance/vagrant-r10k/vagrant-r10k_spec.rb

@@ -0,0 +1,255 @@
+include VagrantPlugins::R10k
+shared_examples 'provider/vagrant-r10k' do |provider, options|
+  # NOTE: vagrant-spec's acceptance framework (specifically IsolatedEnvironment)
+  # creates an isolated environment for each 'it' block and tears it down afterwards.
+  # This *only* works with the layout below. As such, quite unfortunately, we have a
+  # bunch of assertions in each 'it' block; they're not isolated the way they should be.
+  # The alternative is to run a complete up/provision/assert/destroy cycle for each
+  # assertion we want to make, and also therefore lose the ability to make multiple
+  # assertions about one provisioning run.
+
+  if !File.file?(options[:box])
+    raise ArgumentError,
+      "A box file #{options[:box]} must be downloaded for provider: #{provider}. The rake task should have done this."
+  end
+
+  include_context 'acceptance'
+
+  let(:box_ip) { '10.10.10.29' }
+  let(:name)   { 'single.testbox.spec' }
+
+  before do
+    ENV['VAGRANT_DEFAULT_PROVIDER'] = provider
+  end
+
+  describe 'configured correctly' do
+    before do
+      setup_before('correct', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'deploys Puppetfile modules' do
+      status("Test: vagrant up")
+      up_result = assert_execute('vagrant', 'up', "--provider=#{provider}", '--debug')
+      ensure_successful_run(up_result, environment.workdir)
+      status("Test: reviewboard module")
+      rb_dir = File.join(environment.workdir, 'puppet', 'modules', 'reviewboard')
+      expect(File.directory?(rb_dir)).to be_truthy
+      rb_result = assert_execute('bash', 'gitcheck.sh', 'puppet/modules/reviewboard')
+      expect(rb_result).to exit_with(0)
+      expect(rb_result.stdout).to match(/tag: v1\.0\.1 @ cdb8d7a186846b49326cec1cfb4623bd77529b04 \(origin: https:\/\/github\.com\/jantman\/puppet-reviewboard\.git\)/)
+      
+      status("Test: nodemeister module")
+      nm_dir = File.join(environment.workdir, 'puppet', 'modules', 'nodemeister')
+      expect(File.directory?(nm_dir)).to be_truthy
+      nm_result = assert_execute('bash', 'gitcheck.sh', 'puppet/modules/nodemeister')
+      expect(nm_result).to exit_with(0)
+      expect(nm_result.stdout).to match(/tag: 0\.1\.0 @ 3a504b5f66ebe1853bda4ee065fce18118958d84 \(origin: https:\/\/github\.com\/jantman\/puppet-nodemeister\.git\)/)
+    end
+  end
+
+  describe 'destroy when configured correctly' do
+    before do
+      setup_before('correct', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'does not deploy modules' do
+      status("Test: vagrant up destroy")
+      assert_execute('vagrant', 'up', "--provider=#{provider}", '--debug')
+      destroy_result = assert_execute("vagrant", "destroy", "--force", '--debug')
+      expect(destroy_result.stdout).to_not include("vagrant-r10k: Beginning r10k deploy of puppet modules")
+      expect(destroy_result.stdout).to_not include('vagrant-r10k: Building the r10k module path')
+      expect(destroy_result.stdout).to_not include('vagrant-r10k: Deploy finished')
+      expect(destroy_result.stderr).to_not include("vagrant-r10k: Beginning r10k deploy of puppet modules")
+      expect(destroy_result.stderr).to_not include('vagrant-r10k: Building the r10k module path')
+      expect(destroy_result.stderr).to_not include('vagrant-r10k: Deploy finished')
+    end
+  end
+
+  describe 'puppet directory missing' do
+    # this is a complete failure
+    before do
+      setup_before('no_puppet_dir', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'errors during config validation' do
+      status("Test: vagrant up")
+      up_result = execute('vagrant', 'up', "--provider=#{provider}", '--debug')
+      ensure_r10k_didnt_run(up_result, environment.workdir)
+      expect(up_result).to exit_with(1)
+      expect(up_result.stderr).to match(/puppetfile '[^']+' does not exist/)
+      ensure_puppet_didnt_run(up_result)
+    end
+  end
+
+  describe 'module path different from Puppet provisioner' do
+    # this just doesn't run the r10k portion
+    before do
+      setup_before('different_mod_path', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'throws RuntimeError' do
+      status("Test: vagrant up")
+      up_result = execute('vagrant', 'up', "--provider=#{provider}")
+      expect(up_result).to exit_with(1)
+      expect(up_result.stderr).to match('RuntimeError: vagrant-r10k: module_path "puppet/NOTmodules" is not the same as in puppet provisioner; please correct this condition')
+      ensure_r10k_didnt_run(up_result, environment.workdir)
+      ensure_puppet_didnt_run(up_result)
+    end
+  end
+
+  describe 'no module path set' do
+    # this just doesn't run the r10k portion
+    before do
+      setup_before('no_mod_path', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'skips r10k deploy' do
+      status("Test: vagrant up")
+      up_result = execute('vagrant', 'up', "--provider=#{provider}", '--debug')
+      expect(up_result).to exit_with(1)
+      ensure_r10k_didnt_run(up_result, environment.workdir)
+      ensure_puppet_didnt_run(up_result)
+    end
+  end
+
+  describe 'no r10k configuration' do
+    # this just doesn't run the r10k portion
+    before do
+      setup_before('no_vagrant_r10k', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'skips r10k deploy' do
+      status("Test: vagrant up")
+      up_result = execute('vagrant', 'up', "--provider=#{provider}")
+      expect(up_result).to exit_with(0)
+      expect(up_result.stdout).to include("vagrant-r10k not configured; skipping")
+      ensure_r10k_didnt_run(up_result, environment.workdir)
+      ensure_puppet_ran(up_result)
+    end
+  end
+
+  describe 'Puppetfile syntax error' do
+    # r10k runtime failure
+    before do
+      setup_before('puppetfile_syntax_error', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'fails during module deploy' do
+      status("Test: vagrant up")
+      up_result = execute('vagrant', 'up', "--provider=#{provider}")
+      expect(up_result).to exit_with(1)
+      expect(up_result.stderr).to match(%r"SyntaxError: .*puppet/Puppetfile:1: syntax error, unexpected tIDENTIFIER, expecting '\('\s+this is not a valid puppetfile\s+\^")
+      ensure_r10k_didnt_run(up_result, environment.workdir)
+      ensure_puppet_didnt_run(up_result)
+    end
+  end
+
+  describe 'could not resolve git host' do
+    before do
+      setup_before('could_not_resolve_host', options)
+    end
+    after do
+      assert_execute("vagrant", "destroy", "--force")
+    end
+
+    it 'fails with error including how to skip provisioning' do
+      status("Test: vagrant up")
+      up_result = execute('vagrant', 'up', "--provider=#{provider}", '--debug')
+      expect(up_result).to exit_with(1)
+      expect(up_result.stderr).to match(%r"RuntimeError: Couldn't update git cache for https://invalidhost\.jasonantman\.com/jantman/puppet-reviewboard\.git: \"fatal: unable to access 'https://invalidhost\.jasonantman\.com/jantman/puppet-reviewboard\.git/': Could not resolve host: invalidhost\.jasonantman\.com\"\n\nIf you don't have connectivity to the host, running 'vagrant up --no-provision' will skip r10k deploy and all provisioning")
+      ensure_puppet_didnt_run(up_result)
+    end
+  end
+
+  # setup skeleton, add box
+  def setup_before(skel_name, options)
+    environment.skeleton(skel_name)
+    environment.env['VBOX_USER_HOME'] = environment.homedir.to_s
+    assert_execute('vagrant', 'box', 'add', "vagrantr10kspec", options[:box])
+  end
+
+  # checks for a successful up run with r10k deployment and puppet provisioning
+  def ensure_successful_run(up_result, workdir)
+    expect(up_result).to exit_with(0)
+    # version checks
+    expect(up_result.stderr).to include('global:   - r10k = 1.2.1')
+    expect(up_result.stderr).to include("global:   - vagrant-r10k = #{VagrantPlugins::R10k::VERSION}")
+    expect(up_result.stderr).to include('Registered plugin: vagrant-r10k')
+    expect(up_result.stderr).to include('vagrant::r10k::validate called')
+    expect(up_result.stderr).to include('vagrant::r10k::deploy called')
+    expect(up_result.stderr).to match_num_times(1, %r"DEBUG config: vagrant-r10k-config: validate.*DEBUG validate: vagrant::r10k::validate called.*Running action: provisioner_run"m), "config and validate run before provisioner"
+    expect(up_result.stderr).to match_num_times(1, %r"DEBUG deploy: vagrant::r10k::deploy called.*Running action: provisioner_run"m), "deploy runs before provisioners"
+    # provisioning runs
+    expect(up_result.stdout).to include_num_times(1, '==> default: vagrant-r10k: Beginning r10k deploy of puppet modules into'), "provisioning runs once"
+    # modulegetter runs before provisioning
+    expect(up_result.stdout).to match_num_times(1, %r"vagrant-r10k: Deploy finished.*\s+Running provisioner: puppet"m), "deploy runs before puppet provisioner"
+    # modulegetter BEFORE ConfigValidate
+    expect(up_result.stderr).to match(%r"(?!ConfigValidate)+default: vagrant-r10k: Deploy finished.*Vagrant::Action::Builtin::ConfigValidate"m), "modulegetter runs before ConfigValidate"
+    # other checks
+    expect(up_result.stdout).to include('vagrant-r10k: Building the r10k module path with puppet provisioner module_path "puppet/modules"')
+    expect(up_result.stdout).to include("vagrant-r10k: Beginning r10k deploy of puppet modules into #{workdir}/puppet/modules using #{workdir}/puppet/Puppetfile")
+    expect(up_result.stdout).to include('vagrant-r10k: Deploy finished')
+    # file tests
+    expect(File).to exist("#{workdir}/puppet/modules/reviewboard/Modulefile")
+    expect(File).to exist("#{workdir}/puppet/modules/nodemeister/Modulefile")
+    expect(File).to exist("#{workdir}/puppet/modules/nodemeister/manifests/init.pp")
+
+    # ensure puppet ran
+    ensure_puppet_ran(up_result)
+  end
+
+  # ensure that r10k didnt run
+  def ensure_r10k_didnt_run(up_result, workdir)
+    expect(up_result.stdout).to_not include("vagrant-r10k: Beginning r10k deploy of puppet modules")
+    expect(up_result.stdout).to_not include('vagrant-r10k: Deploy finished')
+
+    # file tests
+    expect(File).to_not exist("#{workdir}/puppet/modules/reviewboard/Modulefile")
+    expect(File).to_not exist("#{workdir}/puppet/modules/nodemeister/Modulefile")
+    expect(File).to_not exist("#{workdir}/puppet/modules/nodemeister/manifests/init.pp")
+  end
+
+  # ensure that the puppet provisioner ran with default.pp
+  def ensure_puppet_ran(up_result)
+    expect(up_result.stdout).to include('Running provisioner: puppet')
+    expect(up_result.stdout).to include('Running Puppet with default.pp')
+    expect(up_result.stdout).to include('vagrant-r10k puppet run')
+  end
+
+  # ensure that the puppet provisioner DIDNT run
+  def ensure_puppet_didnt_run(up_result)
+    expect(up_result.stdout).to_not include('Running provisioner: puppet')
+    expect(up_result.stdout).to_not include('Running Puppet with default.pp')
+    expect(up_result.stdout).to_not include('vagrant-r10k puppet run')
+  end
+
+  # method to print output
+  def print_output(up_result)
+    puts "################# STDOUT #####################"
+    puts up_result.stdout
+    puts "################# STDERR #####################"
+    puts up_result.stderr
+    puts "################# END #####################"
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/spec/"
+end
+
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 
 # Disable Vagrant autoloading so that other plugins defined in the Gemfile for
@@ -5,14 +11,11 @@ $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 ENV['VAGRANT_NO_PLUGINS'] = '1'
 
 require 'vagrant-spec/unit'
+require 'rspec_matcher_num_times'
 
-require 'simplecov'
-SimpleCov.start do
-  add_filter "/vendor/"
-  if ENV['CI']=='true'
-    require 'codecov'
-    formatter = SimpleCov::Formatter::Codecov
-  end
+require 'codecov'
+if ENV['CI']=='true'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
 require 'vagrant-r10k'

data/spec/unit/action_base_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require_relative 'sharedcontext'
+require_relative 'shared_expectations'
+require 'vagrant-r10k/action/base'
+
+include SharedExpectations
+
+describe VagrantPlugins::R10k::Action::Base do
+  include_context 'vagrant-unit'
+  context 'instantiation' do
+
+    it 'has app and env instance variables' do
+      x = described_class.new(:app, :env)
+      expect(x.instance_variable_get(:@app)).to equal(:app)
+      expect(x.instance_variable_get(:@env)).to equal(:env)
+    end
+
+    it 'has a logger' do
+      x = described_class.new(:app, :env)
+      expect(x.instance_variable_get(:@logger)).to be_a_kind_of(Log4r::Logger)
+      expect(x.instance_variable_get(:@logger).fullname).to eq('vagrant::r10k::base')
+    end
+
+    it 'sets logging levels to 3 when not running in debug mode' do
+      allow(ENV).to receive(:[]).with("VAGRANT_LOG").and_return('no')
+      x = described_class.new(:app, :env)
+      expect(R10K::Logging.level).to eq(3)
+    end
+
+    it 'sets logging levels to 0 when running in debug mode' do
+      allow(ENV).to receive(:[]).with("VAGRANT_LOG").and_return('debug')
+      x = described_class.new(:app, :env)
+      expect(R10K::Logging.level).to eq(0)
+      expect(x.instance_variable_get(:@logger).level).to eq(0)
+    end
+  end
+
+  context 'validate' do
+    it 'returns Vagrant::Action::Builder with Action::Validate' do
+      res = described_class.validate
+      expect(res).to be_a_kind_of(Vagrant::Action::Builder)
+      expect(res.stack).to eq([[VagrantPlugins::R10k::Action::Validate, [], nil]])
+    end
+  end
+
+  context 'deploy' do
+    it 'returns Vagrant::Action::Builder with Action::Validate and Action::Deploy' do
+      res = described_class.deploy
+      expect(res).to be_a_kind_of(Vagrant::Action::Builder)
+      expect(res.stack).to eq([
+                                [VagrantPlugins::R10k::Action::Validate, [], nil],
+                                [VagrantPlugins::R10k::Action::Deploy, [], nil]
+                              ])
+    end
+
+  end
+end