control_spec_helper 0.0.1 → 0.0.2

data/spec/support/shared_contexts/rake.rb

@@ -0,0 +1,26 @@
+require 'rake'
+require 'English'
+require './lib/slalom'
+
+shared_context 'rake' do
+  Dir.chdir('fixtures/puppet-control') do
+    let(:rake)       { Rake::Application.new }
+    let(:task_name)  { self.class.top_level_description }
+    let(:task_path)  { "lib/tasks/#{task_name.split(':').first}" }
+    let(:ssh_config) { vagrant_ssh_config }
+    subject          { rake[task_name] }
+
+    def loaded_files_excluding_current_rake_file
+      $LOADED_FEATURES.reject do |file|
+        file == Rails_root.join("#{task_path}.rake").to_s
+      end
+    end
+
+    before do
+      Rake.application = rake
+      Rake.application.rake_require(
+        task_path, [Rails_root.to_s], loaded_files_excluding_current_rake_file
+      )
+    end
+  end
+end

data/spec/tasks/vplugins_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'net/ssh'
+
+@config = nil
+@original_dir = nil
+@ssh = nil
+
+describe :vplugins do
+  include_context 'rake'
+
+  before(:all) do
+    @original_dir = Dir.pwd
+    Dir.chdir('fixtures/puppet-control')
+  end
+
+  after(:all) do
+    Dir.chdir(@original_dir)
+  end
+
+  context 'when run on CentOS 7' do
+    cached_env_debug = ''
+    original_stderr = $stderr
+    original_stdout = $stdout
+
+    let(:conf) { ssh_config }
+
+    before(:each) do
+      $stderr = File.open(File::NULL, 'w')
+      $stdout = File.open(File::NULL, 'w')
+    end
+
+    after(:each) do
+      $stderr = original_stderr
+      $stdout = original_stdout
+    end
+
+    it 'should install successfully' do
+      expect(Net::SSH.start(
+        conf['HostName'],
+        conf['User'],
+        port: conf['Port'],
+        password: 'vagrant'
+      ) do |ssh|
+        ssh_exec!(ssh,
+                  'cd /vagrant && unset RUBYLIB ; bundle exec rake vplugins')
+      end[2]).to eq(0)
+    end
+
+    it 'should install the vagrant-auto_network plugin' do
+      expect(Net::SSH.start(
+        conf['HostName'],
+        conf['User'],
+        port: conf['Port'],
+        password: 'vagrant'
+      ) do |ssh|
+        ssh_exec!(ssh, 'unset RUBYLIB ; vagrant plugin list')
+      end[0].split("\n")).to include(/vagrant-auto_network/)
+    end
+
+    it 'should install the vagrant-hosts plugin' do
+      expect(Net::SSH.start(
+        conf['HostName'],
+        conf['User'],
+        port: conf['Port'],
+        password: 'vagrant'
+      ) do |ssh|
+        ssh_exec!(ssh, 'unset RUBYLIB ; vagrant plugin list')
+      end[0].split("\n")).to include(/vagrant-hosts/)
+    end
+  end
+end

data/spec/unit/class_from_path_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+class DummyClass
+  include ControlSpecHelper
+end
+
+describe 'control_spec_helper' do
+  before do
+    @dummy_class = DummyClass.new
+  end
+
+  describe 'when passed a file path' do
+    describe 'if the path does not include manifests' do
+      let(:path) { '/test_path/foobar.pp' }
+
+      it 'should return nil' do
+        expect(@dummy_class.class_from_path(path)).to eq(nil)
+      end
+    end
+
+    describe 'if the path does not end in pp' do
+      let(:path) { '/test_path/manifests/foobar' }
+      it 'should return nil' do
+        expect(@dummy_class.class_from_path(path)).to eq(nil)
+      end
+    end
+
+    context 'when path is simple profile path' do
+      let(:path) { '/test_path/site/profiles/manifests/klass.pp' }
+      it 'should extrapolate a puppet class name' do
+        allow(@dummy_class).to receive(:project_root).and_return('/test_path')
+        expect(@dummy_class.class_from_path(path)).to eq('profiles::klass')
+      end
+    end
+
+    context 'when path is namespaced profile path' do
+      let(:path) { '/test_path/site/profiles/manifests/klass/subklass.pp' }
+      it 'should extrapolate a namespaced puppet class name' do
+        allow(@dummy_class).to receive(:project_root).and_return('/test_path')
+        expect(@dummy_class.class_from_path(path))
+          .to eq('profiles::klass::subklass')
+      end
+    end
+
+    context 'when path is simple role path' do
+      let(:path) { '/test_path/site/role/manifests/klass.pp' }
+      it 'should extrapolate a puppet class name' do
+        allow(@dummy_class).to receive(:project_root).and_return('/test_path')
+        expect(@dummy_class.class_from_path(path)).to eq('role::klass')
+      end
+    end
+
+    context 'when path is namespaced role path' do
+      let(:path) { '/test_path/site/role/manifests/klass/subklass.pp' }
+      it 'should extrapolate a namespaced puppet class name' do
+        allow(@dummy_class).to receive(:project_root).and_return('/test_path')
+        expect(@dummy_class.class_from_path(path))
+          .to eq('role::klass::subklass')
+      end
+    end
+  end
+end

data/spec/unit/control_spec_helper_spec.rb

@@ -18,8 +18,69 @@ describe 'control_spec_helper' do
     expect(@dummy_class.basepath).to eq('dist')
   end
 
+  it 'should have a default basebranch' do
+    expect(@dummy_class.basebranch).to eq('master')
+  end
+
+  it 'should allow you to set basebranch' do
+    @dummy_class.basebranch = 'production'
+    expect(@dummy_class.basebranch).to eq('production')
+  end
+
+  describe 'when debug environmental variable is set' do
+    it 'should print properly-formatted debugging messages' do
+      cached_env_debug = ENV['debug']
+      ENV['debug'] = 'true'
+      expect { @dummy_class.debug('spec') }.to output("DEBUG: spec\n").to_stderr
+      ENV['debug'] = cached_env_debug
+    end
+  end
+
+  describe 'when debug environmental variable is not set' do
+    it 'should suppress debugging messages' do
+      cached_env_debug = ENV['debug']
+      ENV.delete('debug')
+      expect { @dummy_class.debug('spec') }.to_not output('DEBUG: spec')
+        .to_stderr
+      ENV['debug'] = cached_env_debug
+    end
+  end
+
   it 'should print the puppet command' do
-    cmd = "puppet apply manifests/site.pp \\\n      --modulepath $(echo `pwd`/modules:`pwd`/site) --hiera_config hiera.yaml"
+    cmd = "puppet apply manifests/site.pp \\\n      --modulepath " \
+          '$(echo `pwd`/modules:`pwd`/site) --hiera_config hiera.yaml'
     expect(@dummy_class.puppet_cmd).to eq(cmd)
   end
+
+  context 'if role_path is already set' do
+    it 'should return the predefined role_path' do
+      @dummy_class.instance_variable_set(:@role_path, '/role')
+      @dummy_class.basepath = 'dist'
+      expect(@dummy_class.role_path).to eq('/role')
+    end
+  end
+
+  context 'if role_path is not locally set' do
+    it 'should return a role_path based on basepath' do
+      @dummy_class.instance_variable_set(:@root, '/projroot')
+      @dummy_class.basepath = 'dist'
+      expect(@dummy_class.role_path).to eq('/projroot/dist/role')
+    end
+  end
+
+  context 'if profile_path is already set' do
+    it 'should return the predefined profile_path' do
+      @dummy_class.instance_variable_set(:@profile_path, '/prof')
+      @dummy_class.basepath = 'dist'
+      expect(@dummy_class.profile_path).to eq('/prof')
+    end
+  end
+
+  context 'if profile_path is not locally set' do
+    it 'should return a profile_path based on basepath' do
+      @dummy_class.instance_variable_set(:@root, '/projroot')
+      @dummy_class.basepath = 'dist'
+      expect(@dummy_class.profile_path).to eq('/projroot/dist/profile')
+    end
+  end
 end

data/spec/unit/debug_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+class DummyClass
+  include ControlSpecHelper
+end
+
+describe 'control_spec_helper' do
+  before do
+    @dummy_class = DummyClass.new
+  end
+
+  describe 'when debug environmental variable is set' do
+    it 'should print properly-formatted debugging messages' do
+      cached_env_debug = ENV['debug']
+      ENV['debug'] = 'true'
+      expect { @dummy_class.debug('spec') }.to output("DEBUG: spec\n").to_stderr
+      ENV['debug'] = cached_env_debug
+    end
+  end
+
+  describe 'when debug environmental variable is not set' do
+    it 'should suppress debugging messages' do
+      cached_env_debug = ENV['debug']
+      ENV.delete('debug')
+      expect { @dummy_class.debug('spec') }.to_not output('DEBUG: spec')
+        .to_stderr
+      ENV['debug'] = cached_env_debug
+    end
+  end
+end

data/spec/unit/diff_from_base_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class DummyClass
+  include ControlSpecHelper
+end
+
+describe 'control_spec_helper' do
+  before do
+    @dummy_class = DummyClass.new
+  end
+
+  describe 'when diff_from_base is called' do
+    git_command = 'git diff production --cached --diff-filter=ACMR --name-only'
+
+    it 'should call the appropriate git command' do
+      @dummy_class.basebranch = 'production'
+      expect(@dummy_class).to receive(:`).with(git_command)
+        .and_return("a\nb\nc")
+      @dummy_class.diff_from_base
+    end
+
+    describe 'result' do
+      before do
+        @dummy_class.basebranch = 'production'
+        allow(@dummy_class).to receive(:`).with(git_command)
+          .and_return("a\nb\nc")
+      end
+
+      it 'should return an array' do
+        expect(@dummy_class.diff_from_base).to eq(%w(a b c))
+      end
+    end
+  end
+end

data/spec/unit/diff_profile_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class DummyClass
+  include ControlSpecHelper
+end
+
+describe 'control_spec_helper' do
+  before do
+    @dummy_class = DummyClass.new
+  end
+
+  describe 'when diff_profile is called' do
+    it 'should return a diff from base as a map' do
+      allow(@dummy_class).to receive(:diff_from_base)
+        .and_return([
+                      'a',
+                      '/tmp/foo/site/profile/manifests/foo.pp',
+                      '/tmp/foo/site/profile/manifests/bar.pp'
+                    ])
+      expect(@dummy_class).to receive(:diff_profile)
+        .and_return(['profile::foo', 'profile::bar'])
+      @dummy_class.diff_profile
+    end
+
+    it 'should ignore classes in base that are not profiles' do
+      allow(@dummy_class).to receive(:diff_from_base)
+        .and_return([
+                      '/tmp/foo/site/profile/manifests/foo.pp',
+                      '/tmp/foo/site/role/manifests/bar.pp',
+                      '/tmp/foo/modules/baz/manifests/baz.pp',
+                      '/tmp/foo/site/profile/manifests/fubar.pp'
+                    ])
+      expect(@dummy_class).to receive(:diff_roles)
+        .and_return(['profile::foo', 'profile::fubar'])
+      @dummy_class.diff_roles
+    end
+  end
+end

data/spec/unit/diff_roles_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class DummyClass
+  include ControlSpecHelper
+end
+
+describe 'control_spec_helper' do
+  before do
+    @dummy_class = DummyClass.new
+  end
+
+  describe 'when diff_roles is called' do
+    it 'should return a diff from base as an array' do
+      allow(@dummy_class).to receive(:diff_from_base)
+        .and_return([
+                      'a',
+                      '/tmp/foo/site/role/manifests/foo.pp',
+                      '/tmp/foo/site/role/manifests/bar.pp'
+                    ])
+      expect(@dummy_class).to receive(:diff_roles)
+        .and_return(['role::foo', 'role::bar'])
+      @dummy_class.diff_roles
+    end
+
+    it 'should ignore classes in base that are not roles' do
+      allow(@dummy_class).to receive(:diff_from_base)
+        .and_return([
+                      '/tmp/foo/site/profile/manifests/foo.pp',
+                      '/tmp/foo/site/role/manifests/bar.pp',
+                      '/tmp/foo/modules/baz/manifests/baz.pp',
+                      '/tmp/foo/site/role/manifests/fubar.pp'
+                    ])
+      expect(@dummy_class).to receive(:diff_roles)
+        .and_return(['role::bar', 'role::fubar'])
+      @dummy_class.diff_roles
+    end
+  end
+end

data/spec/unit/profile_fixtures_spec.rb

@@ -0,0 +1,185 @@
+require 'spec_helper'
+
+class DummyClass
+  include ControlSpecHelper
+end
+
+describe 'control_spec_helper' do
+  before do
+    @dummy_class = DummyClass.new
+  end
+
+  describe 'when profile_fixtures is called' do
+    describe 'when debug environmental variable is set' do
+      cached_env_debug = ''
+
+      before(:each) do
+        allow(@dummy_class).to receive(:profile_path).and_return('/')
+        allow(File).to receive(:symlink)
+          .with('/', '/tmp/spec/fixtures/modules/profile')
+      end
+
+      context 'if a profile link already exists' do
+        it 'should not try to symlink the profile path' do
+          allow(Dir).to receive(:glob).with('/tmp/../../modules/*')
+            .and_return([])
+          allow(File).to receive(:exists?)
+            .with('/tmp/spec/fixtures/modules/profile').and_return(true)
+          expect(File).to_not receive(:symlink)
+            .with('/', '/tmp/spec/fixtures/modules/profile')
+          allow(FileUtils).to receive(:mkpath)
+            .with('/tmp/spec/fixtures/modules/')
+          expect { @dummy_class.profile_fixtures }
+        end
+      end
+
+      context 'if a profile link does not already exist' do
+        it 'should symlink the profile path' do
+          allow(Dir).to receive(:glob).with('/tmp/../../modules/*')
+            .and_return([])
+          allow(File).to receive(:exists?)
+            .with('/tmp/spec/fixtures/modules/profile').and_return(false)
+          allow(@dummy_class).to receive(:file_name).and_return('/tmp/foo.rb')
+          expect(File).to receive(:symlink)
+            .with('/', '/tmp/spec/fixtures/modules/profile')
+          allow(FileUtils).to receive(:mkpath)
+            .with('/tmp/spec/fixtures/modules/')
+          @dummy_class.profile_fixtures
+        end
+      end
+
+      context 'when iterating through available modules' do
+        before(:each) do
+          allow(Dir).to receive(:glob).with('/tmp/../../modules/*')
+            .and_return(%w(foo bar))
+          allow(File).to receive(:exists?)
+            .with('/tmp/spec/fixtures/modules/profile').and_return(true)
+        end
+
+        context 'if discovered file is not a directory' do
+          it 'should not try to perform module operations on that file' do
+            allow(File).to receive(:directory?)
+              .with('/tmp/spec/fixtures/modules').and_return(true)
+            allow(File).to receive(:directory?).with('foo').and_return(false)
+            allow(File).to receive(:directory?).with('bar').and_return(false)
+            allow(@dummy_class).to receive(:file_name).and_return('/tmp/foo.rb')
+            expect(File).to_not receive(:symlink)
+              .with('/tmp/foo', '/tmp/spec/fixtures/modules/foo')
+            expect(File).to_not receive(:symlink)
+              .with('/tmp/bar', '/tmp/spec/fixtures/modules/bar')
+            @dummy_class.profile_fixtures
+          end
+        end
+
+        context 'if discovered file is a directory' do
+          context 'if modules directories already are symlinks' do
+            it 'should not try to symlink the module path' do
+              allow(File).to receive(:directory?)
+                .with('/tmp/spec/fixtures/modules').and_return(true)
+              allow(File).to receive(:directory?).with('foo').and_return(true)
+              allow(File).to receive(:directory?).with('bar').and_return(true)
+              allow(@dummy_class).to receive(:file_name)
+                .and_return('/tmp/foo.rb')
+              allow(File).to receive(:symlink?)
+                .with('/tmp/spec/fixtures/modules/foo').and_return(true)
+              allow(File).to receive(:symlink?)
+                .with('/tmp/spec/fixtures/modules/bar').and_return(true)
+              @dummy_class.profile_fixtures
+            end
+          end
+
+          context 'if modules directories do not already have symlinks' do
+            it 'should symlink the module path' do
+              allow(@dummy_class).to receive(:file_name)
+                .and_return('/tmp/control_spec_helper.rb')
+              allow(File).to receive(:directory?)
+                .with('/tmp/spec/fixtures/modules').and_return(true)
+              allow(File).to receive(:directory?)
+                .with('foo').and_return(true)
+              allow(File).to receive(:directory?)
+                .with('bar').and_return(true)
+              allow(File).to receive(:symlink?)
+                .with('/tmp/spec/fixtures/modules/foo').and_return(false)
+              allow(File).to receive(:symlink?)
+                .with('/tmp/spec/fixtures/modules/bar').and_return(false)
+              expect(File).to receive(:symlink)
+                .with('/tmp/foo', '/tmp/spec/fixtures/modules/foo')
+              expect(File).to receive(:symlink)
+                .with('/tmp/bar', '/tmp/spec/fixtures/modules/bar')
+              @dummy_class.profile_fixtures
+            end
+          end
+
+          describe 'when debug environmental variable is set' do
+            before(:each) do
+              allow(@dummy_class).to receive(:profile_path).and_return('/')
+              allow(@dummy_class).to receive(:file_name)
+                .and_return('/tmp/foo.rb')
+              allow(Dir).to receive(:glob).with('/tmp/../../modules/*')
+                .and_return([])
+              allow(Dir).to receive(:pwd).and_return('/foo')
+              allow(File).to receive(:exists?)
+                .with('/tmp/spec/fixtures/modules/profile').and_return(true)
+              allow(FileUtils).to receive(:mkpath)
+                .with('/tmp/spec/fixtures/modules/')
+              cached_env_debug = ENV['debug']
+              ENV['debug'] = 'true'
+            end
+
+            after(:each) do
+              ENV['debug'] = cached_env_debug
+            end
+
+            it 'should print its current profile_path directory' do
+              expect { @dummy_class.profile_fixtures }
+                .to output(%r{DEBUG: cd to /}).to_stderr
+            end
+
+            it 'should print its actual working directory' do
+              expect { @dummy_class.profile_fixtures }
+                .to output(%r{DEBUG: cd to /foo}).to_stderr
+            end
+          end
+
+          context 'when debug environmental variable is not set' do
+            before(:each) do
+              allow(@dummy_class).to receive(:profile_path).and_return('/')
+              allow(@dummy_class).to receive(:file_name)
+                .and_return('/tmp/foo.rb')
+              allow(Dir).to receive(:glob).with('/tmp/../../modules/*')
+                .and_return([])
+              allow(Dir).to receive(:pwd).and_return('/foo')
+              allow(File).to receive(:exists?)
+                .with('/tmp/spec/fixtures/modules/profile').and_return(true)
+              allow(FileUtils).to receive(:mkpath)
+                .with('/tmp/spec/fixtures/modules/')
+            end
+
+            it 'should not print its current profile_path directory' do
+              cached_env_debug = ENV['debug']
+              ENV.delete('debug')
+              expect { @dummy_class.profile_fixtures }
+                .to_not output(%r{DEBUG: cd to /}).to_stderr
+              ENV['debug'] = cached_env_debug
+            end
+
+            it 'should not print its actual working directory' do
+              cached_env_debug = ENV['debug']
+              ENV.delete('debug')
+              expect { @dummy_class.profile_fixtures }
+                .to_not output(%r{DEBUG: cd to /foo}).to_stderr
+              ENV['debug'] = cached_env_debug
+            end
+          end
+
+          it 'should create a modules directory inside fixtures' do
+            allow(@dummy_class).to receive(:file_name).and_return('/tmp/foo.rb')
+            expect(FileUtils).to receive(:mkpath)
+              .with('/tmp/spec/fixtures/modules/')
+            @dummy_class.profile_fixtures
+          end
+        end
+      end
+    end
+  end
+end