puppet_litmus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 418acded5bb7ca19c9a011892b89b805aaedd642be7e94d004f038640d144c28
+  data.tar.gz: 20082a2cba1921b73cfb1a0324709253b6f74318916c8c302c8eb917cf7ad2f3
+SHA512:
+  metadata.gz: d55ceaa23d4df5e1aed93363f2d3ecd725817064003630728887fb5f10262f079e89e60dc69b86e05f22e560d98f9b9ea1dcf5cad4fc419ad2d56766b538e499
+  data.tar.gz: d27be055768592ccdbc603b374787a2f4ce555f6c8649bcee071a5beaece65e699bd4cc2b7b22ece8706cb1ecc3ffa26752afd6d61477b9dd443866d20c50e68

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,44 @@
+# Litmus
+
+## Overview
+Litmus provides a simple command line tool for Puppet content creators, to enable both simple and complex test deployments against specifically configured target systems. It is available as a gem, and can be installed by running ```gem install puppet-litmus```.
+
+Litmus allows Puppet module developers to:
+* provision targets to test against,
+* install the Puppet Agent, 
+* install a module,
+* run tests, and
+* tear down the infrastructure.
+
+The tool facilitates parallel test runs, running tests in isolation, and each step is standalone, allowing other operations between test runs, such as debugging, or configuration updates on the test targets.
+
+## Documentation
+
+All our documentation is currently available in the [Wiki](https://github.com/puppetlabs/puppet_litmus/wiki).
+
+* [Overview](https://github.com/puppetlabs/puppet_litmus/wiki/Overview-of-Litmus) of the main functions
+* [Architecture](https://github.com/puppetlabs/puppet_litmus/wiki/Architecture-of-puppet-litmus) with an explanation of what's going on under the hood
+* [Step-by-step guide](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)) of how to use Litmus with the popular and simple [MoTD Puppet module](https://forge.puppet.com/puppetlabs/motd).
+* [How to guide](https://github.com/puppetlabs/puppet_litmus/wiki/Converting-a-module-to-use-Litmus) walking through how to use Litmus in a module
+
+## Known issues
+
+### PDK and Bolt dependencies infers support on Ruby and Puppet versions
+
+We are actively working towards the point that where we declare our gem dependencies for PDK and Bolt gems in the puppet_litmus gemspec file [here](https://github.com/puppetlabs/puppet_litmus/blame/master/puppet_litmus.gemspec#L23)
+
+Bolt has a hard dependency on Puppet 6, and CRI 2.15.1 which is ruby version specific
+
+PDK depends on CRI 2.10.0 which is ruby version specific
+
+We have work in progress to create a pathway through this. A fix is up for PDK, which allows CRI 2.15 and 2.10 to be used (here)[https://github.com/puppetlabs/pdk/pull/638]. This also allows the use of multiple ruby versions.
+
+A PR (here)[https://github.com/puppetlabs/puppetlabs-motd/pull/200] shows what needs to happen within a module, to use litmus for puppet 5 unit tests, and puppet 6 unit tests. Also for running acceptance tests against puppet 5 and puppet 6 with litmus.
+
+(Gem changes for a module)[https://github.com/puppetlabs/puppetlabs-motd/blob/29d8c9b0ceceb4b0114a66077ce0f473a49481a5/Gemfile#L34-L39] it only installs litmus if your are running puppet 6 and system tests. Also to use a version of the pdk that has the CRI fixes. You can still test against puppet 5 targets in acceptance tests. IF you want to run unit tests against the puppet 5 gem you will have to run something like (this)[https://github.com/puppetlabs/puppetlabs-motd/blob/29d8c9b0ceceb4b0114a66077ce0f473a49481a5/.travis.yml#L107]
+
+Thank you for your patience. 
+
+## Other Resources
+
+* [Is it Worth the Time?](https://xkcd.com/1205/)

data/lib/puppet_litmus/rake_tasks.rb

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+require 'puppet_litmus'
+require 'bolt_spec/run'
+require 'open3'
+require 'pdk'
+require 'json'
+require 'parallel'
+
+def get_metadata_operating_systems(metadata)
+  return unless metadata.is_a?(Hash)
+  return unless metadata['operatingsystem_support'].is_a?(Array)
+
+  metadata['operatingsystem_support'].each do |os_info|
+    next unless os_info['operatingsystem'] && os_info['operatingsystemrelease']
+
+    os_name = case os_info['operatingsystem']
+              when 'Amazon', 'Archlinux', 'AIX', 'OSX'
+                next
+              when 'OracleLinux'
+                'oracle'
+              when 'Windows'
+                'win'
+              else
+                os_info['operatingsystem'].downcase
+              end
+
+    os_info['operatingsystemrelease'].each do |release|
+      version = case os_name
+                when 'ubuntu', 'osx'
+                  release.sub('.', '')
+                when 'sles'
+                  release.gsub(%r{ SP[14]}, '')
+                when 'win'
+                  release = release.delete('.') if release.include? '8.1'
+                  release.sub('Server', '').sub('10', '10-pro')
+                else
+                  release
+                end
+
+      yield "#{os_name}-#{version.downcase}-x86_64".delete(' ')
+    end
+  end
+end
+
+def run_local_command(command)
+  stdout, stderr, status = Open3.capture3(command)
+  error_message = "Attempted to run\ncommand:'#{command}'\nstdout:#{stdout}\nstderr:#{stderr}"
+  raise error_message unless status.to_i.zero?
+
+  stdout
+end
+
+namespace :litmus do
+  desc 'print all supported OSes from metadata'
+  task :metadata do
+    metadata = JSON.parse(File.read('metadata.json'))
+    get_metadata_operating_systems(metadata) do |os_and_version|
+      puts os_and_version
+    end
+  end
+
+  desc "provision all supported OSes on with abs eg 'bundle exec rake 'litmus:provision_from_metadata'"
+  task :provision_from_metadata, [:provisioner] do |_task, args|
+    metadata = JSON.parse(File.read('metadata.json'))
+    get_metadata_operating_systems(metadata) do |os_and_version|
+      puts os_and_version
+      include PuppetLitmus
+      Rake::Task['spec_prep'].invoke
+      config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
+      raise "the provision module was not found in #{config_data['modulepath']}, please amend the .fixtures.yml file" unless File.directory?(File.join(config_data['modulepath'], 'provision'))
+
+      params = { 'action' => 'provision', 'platform' => os_and_version, 'inventory' => Dir.pwd }
+      results = run_task("provision::#{args[:provisioner]}", 'localhost', params, config: config_data, inventory: nil)
+      results.each do |result|
+        if result['status'] != 'success'
+          puts "Failed on #{result['node']}\n#{result}"
+        else
+          puts "Provisioned #{result['result']['node_name']}"
+        end
+      end
+    end
+  end
+
+  desc "provision list of machines from provision.yaml file. 'bundle exec rake 'litmus:provision_list[default]'"
+  task :provision_list, [:key] do |_task, args|
+    provision_hash = YAML.load_file('./provision.yaml')
+    provisioner = provision_hash[args[:key]]['provisioner']
+    provision_hash[args[:key]]['images'].each do |image|
+      Rake::Task['litmus:provision'].invoke(provisioner, image)
+      Rake::Task['litmus:provision'].reenable
+    end
+  end
+
+  desc "provision container/VM - abs/docker/vmpooler eg 'bundle exec rake 'litmus:provision[vmpooler, ubuntu-1604-x86_64]'"
+  task :provision, [:provisioner, :platform] do |_task, args|
+    include PuppetLitmus
+    Rake::Task['spec_prep'].invoke
+    config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
+    raise "the provision module was not found in #{config_data['modulepath']}, please amend the .fixtures.yml file" unless File.directory?(File.join(config_data['modulepath'], 'provision'))
+
+    if %w[abs vmpooler].include?(args[:provisioner])
+      params = { 'action' => 'provision', 'platform' => args[:platform], 'inventory' => Dir.pwd }
+      results = run_task("provision::#{args[:provisioner]}", 'localhost', params, config: config_data, inventory: nil)
+      results.each do |result|
+        if result['status'] != 'success'
+          puts "Failed #{result['node']}\n#{result}"
+        else
+          puts "#{result['result']['node_name']}, #{args[:platform]}"
+        end
+      end
+    elsif args[:provisioner] == 'docker'
+      params = { 'action' => 'provision', 'platform' => args[:platform], 'inventory' => Dir.pwd }
+      results = run_task('provision::docker', 'localhost', params, config: config_data, inventory: nil)
+      results.each do |result|
+        if result['status'] != 'success'
+          puts "Failed #{result['node']}\n#{result}"
+        else
+          puts "#{result['result']['node_name']}, #{args[:platform]}"
+        end
+      end
+    else
+      raise "Unknown provisioner '#{args[:provisioner]}', try abs/docker/vmpooler"
+    end
+  end
+
+  desc 'install puppet agent, [:collection, :target_node_name]'
+  task :install_agent, [:collection, :target_node_name] do |_task, args|
+    puts 'install_agent'
+    include BoltSpec::Run
+    inventory_hash = inventory_hash_from_inventory_file
+    targets = find_targets(inventory_hash, args[:target_node_name])
+    Rake::Task['spec_prep'].invoke
+    config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
+    params = if args[:collection].nil?
+               {}
+             else
+               { 'collection' => args[:collection] }
+             end
+    raise "puppet_agent was not found in #{config_data['modulepath']}, please amend the .fixtures.yml file" unless File.directory?(File.join(config_data['modulepath'], 'puppet_agent'))
+
+    results = run_task('puppet_agent::install', targets, params, config: config_data, inventory: inventory_hash)
+    results.each do |result|
+      if result['status'] != 'success'
+        puts "Failed on #{result['node']}\n#{result}"
+      end
+    end
+
+    # fix the path on ssh_nodes
+    results = run_command('echo PATH="$PATH:/opt/puppetlabs/puppet/bin" > /etc/environment', 'ssh_nodes', config: nil, inventory: inventory_hash) unless inventory_hash['groups'].select { |group| group['name'] == 'ssh_nodes' }.size.zero? # rubocop:disable Metrics/LineLength
+    results.each do |result|
+      if result['status'] != 'success'
+        puts "Failed on #{result['node']}\n#{result}"
+      end
+    end
+  end
+
+  desc 'install_module - build and install module'
+  task :install_module, [:target_node_name] do |_task, args|
+    include BoltSpec::Run
+    # old cli_way
+    # pdk_build_command = 'bundle exec pdk build  --force'
+    # stdout, stderr, _status = Open3.capture3(pdk_build_command)
+    # raise "Failed to run 'pdk_build_command',#{stdout} and #{stderr}" if (stderr =~ %r{completed successfully}).nil?
+    require 'pdk/module/build'
+    opts = {}
+    opts[:force] = true
+    builder = PDK::Module::Build.new(opts)
+    module_tar = builder.build
+    puts 'Built'
+
+    inventory_hash = inventory_hash_from_inventory_file
+    target_nodes = find_targets(inventory_hash, args[:target_node_name])
+    # module_tar = Dir.glob('pkg/*.tar.gz').max_by { |f| File.mtime(f) }
+    raise "Unable to find package in 'pkg/*.tar.gz'" if module_tar.nil?
+
+    target_string = if args[:target_node_name].nil?
+                      'all'
+                    else
+                      args[:target_node_name]
+                    end
+    run_local_command("bundle exec bolt file upload #{module_tar} /tmp/#{File.basename(module_tar)} --nodes #{target_string} --inventoryfile inventory.yaml")
+    install_module_command = "puppet module install /tmp/#{File.basename(module_tar)}"
+    result = run_command(install_module_command, target_nodes, config: nil, inventory: inventory_hash)
+    # rubocop:disable Style/GuardClause
+    if result.is_a?(Array)
+      result.each do |node|
+        puts "#{node['node']} failed #{node['result']}" if node['status'] != 'success'
+      end
+    else
+      raise "Failed trying to run '#{install_module_command}' against inventory."
+    end
+    # rubocop:enable Style/GuardClause
+    puts 'Installed'
+  end
+
+  desc 'tear-down - decommission machines'
+  task :tear_down, [:target] do |_task, args|
+    Rake::Task['spec_prep'].invoke
+    config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
+    raise "the provision module was not found in #{config_data['modulepath']}, please amend the .fixtures.yml file" unless File.directory?(File.join(config_data['modulepath'], 'provision'))
+
+    inventory_hash = inventory_hash_from_inventory_file
+    targets = find_targets(inventory_hash, args[:target])
+    bad_results = []
+    targets.each do |node_name|
+      # how do we know what provisioner to use
+      node_facts = facts_from_node(inventory_hash, node_name)
+      next unless %w[abs docker vmpooler].include?(node_facts['provisioner'])
+
+      params = { 'action' => 'tear_down', 'node_name' => node_name, 'inventory' => Dir.pwd }
+      result = run_task("provision::#{node_facts['provisioner']}", 'localhost', params, config: config_data, inventory: nil)
+      if result.first['status'] != 'success'
+        bad_results << "#{node_name}, #{result.first['result']['_error']['msg']}"
+      else
+        print "#{node_name}, "
+      end
+    end
+    puts ''
+    # output the things that went wrong, after the successes
+    puts 'something went wrong:' unless bad_results.size.zero?
+    bad_results.each do |result|
+      puts result
+    end
+  end
+
+  namespace :acceptance do
+    include PuppetLitmus
+    if File.file?('inventory.yaml')
+      inventory_hash = inventory_hash_from_inventory_file
+      hosts = find_targets(inventory_hash, nil)
+
+      desc 'Run tests in parallel against all machines in the inventory file'
+      task :parallel do
+        args = []
+        hosts.each do |host|
+          args << ["TARGET_HOST=#{host} bundle exec rspec ./spec/acceptance --format progress --format html --out html/#{host}.html", host]
+        end
+        results = Parallel.map(args, progress: "Running against #{hosts.size} machines") do |test, host|
+          stdout, stderr, status = Open3.capture3(test)
+          ["================\n#{host}\n", stdout, stderr, status]
+        end
+        # if any result is nonzero, there were test failures
+        failures = false
+        results.each do |result|
+          failures = true unless result.last.exitstatus.zero?
+          puts result
+        end
+        exit 1 if failures
+      end
+
+      hosts.each do |host|
+        desc "Run serverspec against #{host}"
+        RSpec::Core::RakeTask.new(host.to_sym) do |t|
+          t.pattern = 'spec/acceptance/**{,/*/**}/*_spec.rb'
+          ENV['TARGET_HOST'] = host
+        end
+      end
+    end
+    # add localhost separately
+    desc 'Run serverspec against localhost, USE WITH CAUTION, this action can be potentially dangerous.'
+    host = 'localhost'
+    RSpec::Core::RakeTask.new(host.to_sym) do |t|
+      t.pattern = 'spec/acceptance/**{,/*/**}/*_spec.rb'
+      ENV['TARGET_HOST'] = host
+    end
+  end
+end

data/lib/puppet_litmus/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# version of this gem
+module PuppetLitmus
+  VERSION ||= '0.0.1'
+end

data/lib/puppet_litmus.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'bolt_spec/run'
+
+# Helper methods for testing puppet content
+module PuppetLitmus
+  include BoltSpec::Run
+  def apply_manifest(manifest, opts = {})
+    target_node_name = ENV['TARGET_HOST']
+    raise 'manifest and manifest_file_location in the opts hash are mutually exclusive arguments, pick one' if !manifest.nil? && !opts[:manifest_file_location].nil?
+    raise 'please pass a manifest or the manifest_file_location in the opts hash' if (manifest.nil? || manifest == '') && opts[:manifest_file_location].nil?
+
+    manifest_file_location = opts[:manifest_file_location] || create_manifest_file(manifest)
+    inventory_hash = if target_node_name.nil? || target_node_name == 'localhost'
+                       nil
+                     else
+                       inventory_hash_from_inventory_file
+                     end
+    command_to_run = "puppet apply #{manifest_file_location}"
+    command_to_run += " --modulepath #{Dir.pwd}/spec/fixtures/modules" if target_node_name.nil? || target_node_name == 'localhost'
+    command_to_run += ' --detailed-exitcodes' if !opts[:catch_changes].nil? && (opts[:catch_changes] == true)
+    # BOLT-608
+    if Gem.win_platform?
+      stdout, stderr, status = Open3.capture3(command_to_run)
+      status_text = if status.to_i.zero?
+                      'success'
+                    else
+                      'failure'
+                    end
+      result = [{ 'node' => 'localhost', 'status' => status_text, 'result' => { 'exit_code' => status.to_i, 'stderr' => stderr, 'stdout' => stdout } }]
+    else
+      result = run_command(command_to_run, target_node_name, config: nil, inventory: inventory_hash)
+    end
+
+    raise "apply mainfest failed\n`#{command_to_run}`\n======\n#{result}" if result.first['result']['exit_code'] != 0 && opts[:expect_failures] != true
+
+    result
+  end
+
+  # creates a temp manifest file locally & remote depending on target
+  def create_manifest_file(manifest)
+    target_node_name = ENV['TARGET_HOST']
+    manifest_file = Tempfile.new(['manifest_', '.pp'])
+    manifest_file.write(manifest)
+    manifest_file.close
+    if target_node_name.nil? || target_node_name == 'localhost'
+      # no need to transfer
+      manifest_file_location = manifest_file.path
+    else
+      # transfer to TARGET_HOST
+      command = "bundle exec bolt file upload #{manifest_file.path} /tmp/#{File.basename(manifest_file)} --nodes #{target_node_name} --inventoryfile inventory.yaml"
+      stdout, stderr, status = Open3.capture3(command)
+      error_message = "Attempted to run\ncommand:'#{command}'\nstdout:#{stdout}\nstderr:#{stderr}"
+      raise error_message unless status.to_i.zero?
+
+      manifest_file_location = "/tmp/#{File.basename(manifest_file)}"
+    end
+    manifest_file_location
+  end
+
+  def apply_manifest_and_idempotent(manifest)
+    manifest_file_location = create_manifest_file(manifest)
+    apply_manifest(nil, catch_failures: true, manifest_file_location: manifest_file_location)
+    apply_manifest(nil, catch_changes: true, manifest_file_location: manifest_file_location)
+  end
+
+  def run_shell(command_to_run, opts = {})
+    inventory_hash = inventory_hash_from_inventory_file
+    target_node_name = ENV['TARGET_HOST']
+    result = run_command(command_to_run, target_node_name, config: nil, inventory: inventory_hash)
+
+    raise "shell failed\n`#{command_to_run}`\n======\n#{result}" if result.first['result']['exit_code'] != 0 && opts[:expect_failures] != true
+
+    result
+  end
+
+  def inventory_hash_from_inventory_file(inventory_full_path = nil)
+    inventory_full_path = if inventory_full_path.nil?
+                            'inventory.yaml'
+                          else
+                            inventory_full_path
+                          end
+    raise "There is no inventory file at '#{inventory_full_path}'" unless File.exist?(inventory_full_path)
+
+    inventory_hash = YAML.load_file(inventory_full_path)
+    inventory_hash
+  end
+
+  def find_targets(inventory_hash, targets)
+    if targets.nil?
+      inventory = Bolt::Inventory.new(inventory_hash, nil)
+      targets = inventory.node_names.to_a
+    else
+      targets = [targets]
+    end
+    targets
+  end
+
+  def target_in_group(inventory_hash, node_name, group_name)
+    exists = false
+    inventory_hash['groups'].each do |group|
+      next unless group['name'] == group_name
+
+      group['nodes'].each do |node|
+        exists = true if node['name'] == node_name
+      end
+    end
+    exists
+  end
+
+  def config_from_node(inventory_hash, node_name)
+    inventory_hash['groups'].each do |group|
+      group['nodes'].each do |node|
+        if node['name'] == node_name
+          return node['config']
+        end
+      end
+    end
+    raise "No config was found for #{node_name}"
+  end
+
+  def facts_from_node(inventory_hash, node_name)
+    inventory_hash['groups'].each do |group|
+      group['nodes'].each do |node|
+        if node['name'] == node_name
+          return node['facts']
+        end
+      end
+    end
+    raise "No config was found for #{node_name}"
+  end
+
+  def add_node_to_group(inventory_hash, node_name, group_name)
+    inventory_hash['groups'].each do |group|
+      if group['name'] == group_name
+        group['nodes'].push node_name
+      end
+    end
+    inventory_hash
+  end
+
+  def remove_node(inventory_hash, node_name)
+    inventory_hash['groups'].each do |group|
+      group['nodes'].delete_if { |i| i['name'] == node_name }
+    end
+    inventory_hash
+  end
+
+  # Runs a selected task against the target host. Parameters should be passed in with a hash format.
+  def task_run(task_name, params)
+    config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
+    inventory_hash = inventory_hash_from_inventory_file
+    target_node_name = ENV['TARGET_HOST'] if target_node_name.nil?
+
+    result = run_task(task_name, target_node_name, params, config: config_data, inventory: inventory_hash)
+
+    raise "task failed\n`#{task_name}`\n======\n#{result}" if result.first['status'] != 'success'
+
+    result
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: puppet_litmus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Puppet, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bolt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.1
+    - - "<"
+      - !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.13.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: pdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+    - - "<"
+      - !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.10.0
+    - - "<"
+      - !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:
+- info@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet_litmus.rb
+- lib/puppet_litmus/rake_tasks.rb
+- lib/puppet_litmus/version.rb
+homepage: https://github.com/puppetlabs/puppet_litmus
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Providing a simple command line tool for puppet content creators, to enable
+  simple and complex test deployments.
+test_files: []