puppet_litmus 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b4b8f9d03595ac86920511bc3ec0429c34e99ebb54fce2e0dd80bce3d233145
-  data.tar.gz: c4a3bd340f4e215faa647111b6ba933d5669a43e4c06474ab4bc41766fb36235
+  metadata.gz: 28a5409c12ffc5d0ab3b083cabebff39be58c3ed41095cc9711a16f07f49852b
+  data.tar.gz: 9517425db215a6cbafdb1945260f09070dca8a550b2c511be0317c1c5097bac3
 SHA512:
-  metadata.gz: 848d4c8ea4ff3b7b6e02f1404cbbd255d847a259fab02db44032b3982127c5c9a0358366557454f03a85645eb4e9a2ef35bc0e0da90d5fae2d68fb2094912b5d
-  data.tar.gz: 85195c4df6ad10c37290acaba4d14cd4cb2d31950e8095a7afc5104e1a9d3050912dd4ff4a28b6bdcc90b3ff9cc7a956e5b0e1342bad4715ced75542ea0836c4
+  metadata.gz: 560edd1797551152c839db07af920345603d1a67d400301898b3e4b4841145892c50a0ffc18943c653712370cc1686612cb89503c6a8fc459524b803fcdc0bbf
+  data.tar.gz: 23c9cbf00d3f2af2343c1975b09eb5d43235d87b6cb32347a76db039d4f903aaa732b8ab7677eeeabea10ef08588e910032c2d9d9cf315a96b4aeef1cb8bd57c

data/lib/puppet_litmus/rake_tasks.rb

@@ -61,6 +61,34 @@ module LitmusRakeHelper
 
     stdout
   end
+
+  # Builds all the modules in a specified module
+  #
+  # @param source_folder [String] the folder to get the modules from
+  # @return [Array] an array of module tar's
+  def build_modules_in_folder(source_folder)
+    require 'pdk/module/build'
+    folder_list = Dir.entries(source_folder).reject { |f| File.directory? f }
+    module_tars = []
+    folder_list.each do |folder|
+      file = File.new(File.join(source_folder, folder))
+      next if File.symlink?(file)
+
+      opts = {}
+      opts[:module_dir] = file.path
+      opts[:'target-dir'] = File.join(Dir.pwd, 'pkg')
+      opts[:force] = true
+      builder = PDK::Module::Build.new(opts)
+
+      # remove old build folder if exists, before we build afresh
+      FileUtils.rm_rf(builder.build_dir) if File.directory?(builder.build_dir)
+
+      # build_module
+      module_tar = builder.build
+      module_tars.push(File.new(module_tar))
+    end
+    module_tars
+  end
 end
 
 namespace :litmus do
@@ -75,11 +103,16 @@ namespace :litmus do
   end
 
   # Provisions a list of OSes from provision.yaml file e.g. 'bundle exec rake litmus:provision_list[default]'.
+  # @See https://github.com/puppetlabs/puppet_litmus/wiki/Overview-of-Litmus#provisioning-via-yaml
   #
   # @param :key [String] key that maps to a value for a provisioner and an image to be used for each OS provisioned.
   desc "provision list of machines from provision.yaml file. 'bundle exec rake 'litmus:provision_list[default]'"
   task :provision_list, [:key] do |_task, args|
+    raise 'Cannot find provision.yaml file' unless File.file?('./provision.yaml')
+
     provision_hash = YAML.load_file('./provision.yaml')
+    raise "No key #{args[:key]} in ./provision.yaml, see https://github.com/puppetlabs/puppet_litmus/wiki/Overview-of-Litmus#provisioning-via-yaml for examples" if provision_hash[args[:key]].nil?
+
     provisioner = provision_hash[args[:key]]['provisioner']
     inventory_vars = provision_hash[args[:key]]['vars']
     # Splat the params into environment variables to pass to the provision task but only in this runspace
@@ -188,6 +221,45 @@ namespace :litmus do
     end
   end
 
+  # Install the puppet modules from a source directory to nodes. It does not install dependencies.
+  #
+  # @param :source [String] source directory to look in (ignores symlinks) defaults do './spec/fixtures/modules'.
+  # @param :target_node_name [Array] nodes on which to install a puppet module for testing.
+  desc 'install_module - build and install module'
+  task :install_modules_from_directory, [:source, :target_node_name] do |_task, args|
+    inventory_hash = inventory_hash_from_inventory_file
+    target_nodes = find_targets(inventory_hash, args[:target_node_name])
+    if target_nodes.empty?
+      puts 'No targets found'
+      exit 0
+    end
+    source_folder = if args[:source].nil?
+                      './spec/fixtures/modules'
+                    else
+                      File.expand_path(args[:source])
+                    end
+    raise "Source folder doesnt exist #{source_folder}" unless File.directory?(source_folder)
+
+    module_tars = build_modules_in_folder(source_folder)
+    puts 'Building'
+    module_tars.each do |module_tar|
+      print "#{File.basename(module_tar)} "
+    end
+    include BoltSpec::Run
+    puts "\nSending"
+    module_tars.each do |module_tar|
+      upload_file(module_tar.path, "/tmp/#{File.basename(module_tar)}", target_nodes, options: {}, config: nil, inventory: inventory_hash)
+      print "#{File.basename(module_tar)} "
+    end
+    puts "\nInstalling"
+    module_tars.each do |module_tar|
+      # install_module
+      install_module_command = "puppet module install --force /tmp/#{File.basename(module_tar)}"
+      run_command(install_module_command, target_nodes, config: nil, inventory: inventory_hash)
+      print "#{File.basename(module_tar)} "
+    end
+  end
+
   # Install the puppet module under test on a collection of nodes
   #
   # @param :target_node_name [Array] nodes on which to install a puppet module for testing.

data/lib/puppet_litmus/version.rb

@@ -2,5 +2,5 @@
 
 # version of this gem
 module PuppetLitmus
-  VERSION ||= '0.10.0'
+  VERSION ||= '0.11.0'
 end

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 require 'rake'
-
+# rubocop:disable RSpec/AnyInstance
 describe 'litmus rake tasks' do
   before(:all) do # rubocop:disable RSpec/BeforeAfterAll
     load File.expand_path('../../../lib/puppet_litmus/rake_tasks.rb', __dir__)
@@ -27,6 +27,25 @@ describe 'litmus rake tasks' do
     end
   end
 
+  context 'with litmus:install_modules_from_directory' do
+    let(:inventory_hash) { { 'groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'name' => 'some.host' }] }] } }
+    let(:target_folder) { File.join(Dir.pwd, 'spec/fixtures/modules') }
+    let(:dummy_tar) { File.new('spec/data/doot.tar.gz') }
+
+    it 'happy path' do
+      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
+      Rake::Task['litmus:install_modules_from_directory'].invoke('./spec/fixtures/modules')
+    end
+  end
+
   context 'with litmus:provision_install task' do
     it 'happy path' do
       expect(Rake::Task['spec_prep']).to receive(:invoke).and_return('').once
@@ -38,7 +57,7 @@ describe 'litmus rake tasks' do
   end
 
   context 'with litmus:provision task' do
-    it 'provisions' do
+    it 'happy path' do
       results = [{ 'node' => 'localhost',
                    'target' => 'localhost',
                    'action' => 'task',
@@ -47,9 +66,21 @@ describe 'litmus rake tasks' do
                    'result' => { '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) # rubocop:disable RSpec/AnyInstance
+      allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with(any_args).and_return(results)
       expect(STDOUT).to receive(:puts).with('localhost:2222, centos:7')
       Rake::Task['litmus:provision'].invoke('docker', 'centos:7')
     end
   end
+
+  context 'with litmus:provision_list task' do
+    let(:provision_file) { './provision.yaml' }
+    let(:provision_hash) { { 'default' => { 'provisioner' => 'docker', 'images' => ['waffleimage/centos7'] } } }
+
+    it 'no key in provision file' do
+      allow(File).to receive(:file?).with(any_args).and_return(true)
+      expect(YAML).to receive(:load_file).with(provision_file).and_return(provision_hash)
+      expect { Rake::Task['litmus:provision_list'].invoke('deet') }.to raise_error(%r{deet})
+    end
+  end
 end
+# rubocop:enable RSpec/AnyInstance

data/spec/lib/puppet_litmus/serverspec_spec.rb

@@ -145,6 +145,7 @@ RSpec.describe PuppetLitmus::Serverspec do
         expect(dummy_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_success)
         expect { dummy_class.bolt_upload_file(local, remote) }.not_to raise_error
       end
+
       it 'does upload_file against localhost without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
@@ -165,6 +166,7 @@ RSpec.describe PuppetLitmus::Serverspec do
         expect(dummy_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_failure)
         expect { dummy_class.bolt_upload_file(local, remote) }.to raise_error(RuntimeError, %r{upload file failed})
       end
+
       it 'returns the exit code and error message when expecting failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
@@ -249,6 +251,7 @@ RSpec.describe PuppetLitmus::Serverspec do
         expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_unstructured_task_success)
         expect { dummy_class.run_bolt_task(task_name, params, opts: {}) }.not_to raise_error
       end
+
       it 'returns stdout for unstructured-data tasks' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
@@ -258,6 +261,7 @@ RSpec.describe PuppetLitmus::Serverspec do
         method_result = dummy_class.run_bolt_task(task_name, params, opts: {})
         expect(method_result.stdout).to eq('SUCCESS!')
       end
+
       it 'returns structured output for structured-data tasks' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
@@ -280,6 +284,7 @@ RSpec.describe PuppetLitmus::Serverspec do
         expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_failure)
         expect { dummy_class.run_bolt_task(task_name, params, opts: {}) }.to raise_error(RuntimeError, %r{task failed})
       end
+
       it 'returns the exit code and error message when expecting failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -19,7 +19,7 @@ dependencies:
         version: 1.13.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.29.1
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.13.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.29.1
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: pdk
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.34'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.34'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: "    Providing a simple command line tool for puppet content creators,
   to enable simple and complex test deployments.\n"
 email:
@@ -85,6 +105,7 @@ files:
 - lib/puppet_litmus/rake_tasks.rb
 - lib/puppet_litmus/serverspec.rb
 - lib/puppet_litmus/version.rb
+- spec/data/doot.tar.gz
 - spec/data/inventory.yaml
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
@@ -122,4 +143,5 @@ test_files:
 - spec/lib/puppet_litmus/version_spec.rb
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
 - spec/lib/puppet_litmus/serverspec_spec.rb
+- spec/data/doot.tar.gz
 - spec/data/inventory.yaml