puppet_litmus 0.16.0 → 0.18.3

data/spec/lib/puppet_litmus/rake_helper_spec.rb

@@ -2,27 +2,62 @@
 
 require 'spec_helper'
 
+RSpec.shared_examples 'supported provisioner' do |args|
+  let(:provisioner) { args[:provisioner] }
+  let(:platform) { args[:platform] }
+  let(:inventory_vars) { args[:inventory_vars] }
+  let(:provision_hash) { args[:provision_hash] }
+  let(:results) { args[:results] }
+  let(:params) { args[:params] }
+
+  it 'calls function' do
+    allow(File).to receive(:directory?).and_call_original
+    allow(File).to receive(:directory?)
+      .with(File.join(described_class::DEFAULT_CONFIG_DATA['modulepath'], 'provision'))
+      .and_return(true)
+    allow_any_instance_of(BoltSpec::Run).to receive(:run_task)
+      .with("provision::#{provisioner}", 'localhost', params, config: described_class::DEFAULT_CONFIG_DATA, inventory: nil)
+      .and_return(results)
+    result = provision(provisioner, platform, inventory_vars)
+    expect(result).to eq(results)
+  end
+end
+
 RSpec.describe PuppetLitmus::RakeHelper do
   context 'with provision_list' do
     let(:provision_hash) { { 'default' => { 'provisioner' => 'docker', 'images' => ['waffleimage/centos7'] } } }
     let(:results) { [] }
 
     it 'calls function' do
-      expect(described_class).to receive(:provision).with('docker', 'waffleimage/centos7', nil).and_return(results)
-      described_class.provision_list(provision_hash, 'default')
+      expect(self).to receive(:provision).with('docker', 'waffleimage/centos7', nil).and_return(results)
+      provision_list(provision_hash, 'default')
     end
   end
 
   context 'with provision' do
-    let(:provision_hash) { { 'default' => { 'provisioner' => 'docker', 'images' => ['waffleimage/centos7'] } } }
-    let(:results) { [] }
-    let(:params) { { 'action' => 'provision', 'platform' => 'waffleimage/centos7', 'inventory' => Dir.pwd } }
-
-    it 'calls function' do
-      allow(File).to receive(:directory?).and_call_original
-      allow(File).to receive(:directory?).with(File.join(DEFAULT_CONFIG_DATA['modulepath'], 'provision')).and_return(true)
-      allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with('provision::docker', 'localhost', params, config: DEFAULT_CONFIG_DATA, inventory: nil).and_return(results)
-      described_class.provision('docker', 'waffleimage/centos7', nil)
+    examples = [
+      {
+        provisioner: 'docker',
+        platform: 'waffleimage/centos7',
+        inventory_vars: nil,
+        provision_hash: { 'default' => { 'provisioner' => 'docker', 'images' => ['waffleimage/centos7'] } },
+        results: [],
+        params: { 'action' => 'provision', 'platform' => 'waffleimage/centos7', 'inventory' => Dir.pwd },
+      },
+      {
+        provisioner: 'vagrant',
+        platform: 'centos7',
+        inventory_vars: nil,
+        provision_hash: { 'default' => { 'provisioner' => 'vagrant', 'images' => ['centos7'] } },
+        results: [],
+        params: { 'action' => 'provision', 'platform' => 'centos7', 'inventory' => Dir.pwd },
+      },
+    ].freeze
+
+    examples.each do |e|
+      describe e[:provisioner] do
+        it_behaves_like 'supported provisioner', e
+      end
     end
   end
 
@@ -36,9 +71,9 @@ RSpec.describe PuppetLitmus::RakeHelper do
     let(:params) { { 'action' => 'tear_down', 'node_name' => 'some.host', 'inventory' => Dir.pwd } }
 
     it 'calls function' do
-      allow(File).to receive(:directory?).with(File.join(DEFAULT_CONFIG_DATA['modulepath'], 'provision')).and_return(true)
-      allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with('provision::docker', 'localhost', params, config: DEFAULT_CONFIG_DATA, inventory: nil).and_return([])
-      described_class.tear_down_nodes(targets, inventory_hash)
+      allow(File).to receive(:directory?).with(File.join(described_class::DEFAULT_CONFIG_DATA['modulepath'], 'provision')).and_return(true)
+      allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with('provision::docker', 'localhost', params, config: described_class::DEFAULT_CONFIG_DATA, inventory: nil).and_return([])
+      tear_down_nodes(targets, inventory_hash)
     end
   end
 
@@ -52,9 +87,9 @@ RSpec.describe PuppetLitmus::RakeHelper do
     let(:params) { { 'collection' => 'puppet6' } }
 
     it 'calls function' do
-      allow(File).to receive(:directory?).with(File.join(DEFAULT_CONFIG_DATA['modulepath'], 'puppet_agent')).and_return(true)
-      allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with('puppet_agent::install', targets, params, config: DEFAULT_CONFIG_DATA, inventory: inventory_hash).and_return([])
-      described_class.install_agent('puppet6', targets, inventory_hash)
+      allow(File).to receive(:directory?).with(File.join(described_class::DEFAULT_CONFIG_DATA['modulepath'], 'puppet_agent')).and_return(true)
+      allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with('puppet_agent::install', targets, params, config: described_class::DEFAULT_CONFIG_DATA, inventory: inventory_hash).and_return([])
+      install_agent('puppet6', targets, inventory_hash)
     end
   end
 
@@ -65,15 +100,20 @@ RSpec.describe PuppetLitmus::RakeHelper do
         [{ 'name' => 'ssh_nodes', 'targets' =>
           [{ 'uri' => 'some.host', 'facts' => { 'provisioner' => 'docker', 'container_name' => 'foo', 'platform' => 'some.host' } }] }] }
     end
-    let(:module_tar) { '/tmp/foo.tar.gz' }
+    let(:module_tar) { 'foo.tar.gz' }
     let(:targets) { ['some.host'] }
-    let(:install_module_command) { "puppet module install /tmp/#{File.basename(module_tar)}" }
+    let(:uninstall_module_command) { 'puppet module uninstall foo --force' }
+    let(:install_module_command) { "puppet module install --module_repository 'https://forgeapi.example.com' #{module_tar}" }
 
     it 'calls function' do
-      allow(Open3).to receive(:capture3).with("bundle exec bolt file upload \"#{module_tar}\" /tmp/#{File.basename(module_tar)} --nodes all --inventoryfile inventory.yaml")
+      allow_any_instance_of(BoltSpec::Run).to receive(:upload_file).with(module_tar, module_tar, targets, options: {}, config: nil, inventory: inventory_hash).and_return([])
+      allow(File).to receive(:exist?).with(File.join(Dir.pwd, 'metadata.json')).and_return(true)
+      allow(File).to receive(:read).with(File.join(Dir.pwd, 'metadata.json')).and_return(JSON.dump({ name: 'foo' }))
+      allow(Open3).to receive(:capture3).with("bundle exec bolt file upload \"#{module_tar}\" #{File.basename(module_tar)} --targets all --inventoryfile inventory.yaml")
                                         .and_return(['success', '', 0])
+      allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(uninstall_module_command, targets, config: nil, inventory: inventory_hash).and_return([])
       allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(install_module_command, targets, config: nil, inventory: inventory_hash).and_return([])
-      described_class.install_module(inventory_hash, nil, module_tar)
+      install_module(inventory_hash, nil, module_tar, 'https://forgeapi.example.com')
     end
   end
 
@@ -89,12 +129,12 @@ RSpec.describe PuppetLitmus::RakeHelper do
     it 'node available' do
       allow(Open3).to receive(:capture3).with('cd .').and_return(['success', '', 0])
       allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(command, targets, config: nil, inventory: inventory_hash).and_return([{ 'target' => 'some.host', 'status' => 'success' }])
-      described_class.check_connectivity?(inventory_hash, nil)
+      check_connectivity?(inventory_hash, 'some.host')
     end
 
     it 'node unavailable' do
       allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(command, targets, config: nil, inventory: inventory_hash).and_return([{ 'target' => 'some.host', 'status' => 'failure' }])
-      expect { described_class.check_connectivity?(inventory_hash, nil) }.to raise_error(RuntimeError, %r{Connectivity has failed on:})
+      expect { check_connectivity?(inventory_hash, 'some.host') }.to raise_error(RuntimeError, %r{Connectivity has failed on:})
     end
   end
 
@@ -109,13 +149,13 @@ RSpec.describe PuppetLitmus::RakeHelper do
 
     it 'uninstalls module' do
       allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(uninstall_module_command, targets, config: nil, inventory: inventory_hash).and_return([])
-      expect(described_class).to receive(:metadata_module_name).and_return('foo-bar')
-      described_class.uninstall_module(inventory_hash, nil)
+      expect(self).to receive(:metadata_module_name).and_return('foo-bar')
+      uninstall_module(inventory_hash, nil)
     end
 
     it 'and custom name' do
       allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(uninstall_module_command, targets, config: nil, inventory: inventory_hash).and_return([])
-      described_class.uninstall_module(inventory_hash, nil, 'foo-bar')
+      uninstall_module(inventory_hash, nil, 'foo-bar')
     end
   end
 
@@ -125,8 +165,20 @@ RSpec.describe PuppetLitmus::RakeHelper do
     it 'reads module name' do
       allow(File).to receive(:exist?).with(File.join(Dir.pwd, 'metadata.json')).and_return(true)
       allow(File).to receive(:read).with(File.join(Dir.pwd, 'metadata.json')).and_return(metadata)
-      name = described_class.metadata_module_name
+      name = metadata_module_name
       expect(name).to eq('foo-bar')
     end
   end
+
+  context 'with provisioner_task' do
+    described_class::SUPPORTED_PROVISIONERS.each do |supported_provisioner|
+      it "returns supported provisioner task name for #{supported_provisioner}" do
+        expect(provisioner_task(supported_provisioner)).to eq("provision::#{supported_provisioner}")
+      end
+    end
+
+    it 'returns an unsupported provisioner name' do
+      expect(provisioner_task('my_org::custom_provisioner')).to eql('my_org::custom_provisioner')
+    end
+  end
 end

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -28,19 +28,22 @@ describe 'litmus rake tasks' do
 
   context 'with litmus:install_modules_from_directory' do
     let(:inventory_hash) { { 'groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'uri' => 'some.host' }] }] } }
-    let(:target_folder) { File.join(Dir.pwd, 'spec/fixtures/modules') }
-    let(:dummy_tar) { File.new('spec/data/doot.tar.gz') }
+    let(:target_dir) { File.join(Dir.pwd, 'spec/fixtures/modules') }
+    let(:dummy_tar) { 'spec/data/doot.tar.gz' }
 
     it 'happy path' do
+      allow(File).to receive(:exist?).with(File.join(Dir.pwd, 'metadata.json')).and_return(true)
+      allow(File).to receive(:read).with(File.join(Dir.pwd, 'metadata.json')).and_return(JSON.dump({ name: 'foo' }))
+
       stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
       expect_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-      expect(File).to receive(:directory?).with(target_folder).and_return(true)
-      expect_any_instance_of(Object).to receive(:build_modules_in_folder).with(target_folder).and_return([dummy_tar])
-      expect(STDOUT).to receive(:puts).with('Building')
-      expect(STDOUT).to receive(:puts).with("\nSending")
-      expect_any_instance_of(Object).to receive(:upload_file).once
-      expect(STDOUT).to receive(:puts).with("\nInstalling")
-      expect_any_instance_of(Object).to receive(:run_command).once
+      expect(File).to receive(:directory?).with(target_dir).and_return(true)
+      expect_any_instance_of(Object).to receive(:build_modules_in_dir).with(target_dir).and_return([dummy_tar])
+      expect(STDOUT).to receive(:puts).with(start_with('Building all modules in'))
+      expect_any_instance_of(Object).to receive(:upload_file).once.and_return([])
+      expect(STDOUT).to receive(:puts).with(start_with('Installing \'spec/data/doot.tar.gz\''))
+      expect_any_instance_of(Object).to receive(:run_command).twice.and_return([])
+      expect(STDOUT).to receive(:puts).with(start_with('Installed \'spec/data/doot.tar.gz\''))
       Rake::Task['litmus:install_modules_from_directory'].invoke('./spec/fixtures/modules')
     end
   end
@@ -57,12 +60,11 @@ describe 'litmus rake tasks' do
 
   context 'with litmus:provision task' do
     it 'happy path' do
-      results = [{ 'node' => 'localhost',
-                   'target' => 'localhost',
+      results = [{ 'target' => 'localhost',
                    'action' => 'task',
                    'object' => 'provision::docker',
                    'status' => 'success',
-                   'result' => { 'status' => 'ok', 'node_name' => 'localhost:2222' } }]
+                   'value' => { 'status' => 'ok', 'node_name' => 'localhost:2222' } }]
 
       allow(File).to receive(:directory?).with(any_args).and_return(true)
       allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with(any_args).and_return(results)

data/spec/spec_helper.rb

@@ -1,12 +1,6 @@
 # frozen_string_literal: true
 
 require 'rspec'
-require 'puppet_litmus'
-
-# Unfortunately this needs to be included as this is
-# how Litmus functions. We only include once here instead
-# of including for every single spec file.
-include PuppetLitmus # rubocop:disable Style/MixinUsage
 
 if ENV['COVERAGE'] == 'yes'
   require 'simplecov'
@@ -37,3 +31,10 @@ if ENV['COVERAGE'] == 'yes'
     end
   end
 end
+
+# This is basically how `configure!` sets up RSpec in tests.
+require 'puppet_litmus'
+RSpec.configure do |config|
+  config.include PuppetLitmus
+  config.extend PuppetLitmus
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.3
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -16,34 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +132,60 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_honeycomb_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: "    Providing a simple command line tool for puppet content creators,
   to enable simple and complex test deployments.\n"
 email:
@@ -179,13 +239,13 @@ specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable
   simple and complex test deployments.
 test_files:
-- spec/spec_helper.rb
-- spec/lib/puppet_litmus/rake_tasks_spec.rb
-- spec/lib/puppet_litmus/version_spec.rb
+- spec/data/doot.tar.gz
+- spec/data/inventory.yaml
+- spec/data/jim.yaml
 - spec/lib/puppet_litmus/util_spec.rb
+- spec/lib/puppet_litmus/version_spec.rb
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
-- spec/lib/puppet_litmus/rake_helper_spec.rb
 - spec/lib/puppet_litmus/puppet_helpers_spec.rb
-- spec/data/doot.tar.gz
-- spec/data/jim.yaml
-- spec/data/inventory.yaml
+- spec/lib/puppet_litmus/rake_helper_spec.rb
+- spec/lib/puppet_litmus/rake_tasks_spec.rb
+- spec/spec_helper.rb