beaker-task_helper 1.7.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f6d8f14889f34d8454b6b7c3edacb8ccd5fef898
-  data.tar.gz: c5cb9326641991c2ba2c7802aa9d8e8275f0de37
+SHA256:
+  metadata.gz: 7bcf5930a20707c66d650da88128840336b2a410d695cf725a03324d4c15383b
+  data.tar.gz: 938bfb0ac2ad710fe28be83a5ef7e0a2321e5830bfe8147b2fbf3ee119da4d6f
 SHA512:
-  metadata.gz: 6e5001028885a733480e6b98b2afcccc5bea4dfec1aedd8415bc71642583f16f2ea5c0286cd1617e6486e9d619a780658f03d390da73149cee389aaed2681a56
-  data.tar.gz: 58af4abbbf3eab20be6c31e43b96cefec8da0d67c14876490c689f1fee7705aebdb52253cfdd46df1c936ec5dd4f232f0a4acc67df740195af13bcac151f72de
+  metadata.gz: 708f25c7c19660a84ca4bcfb96f02b6fb4c731d6835efdcc9684cee581ad7eb7e6dc10e2206caa35bf000b445ffa8dd02251581a1c66d83201db8441d5f19752
+  data.tar.gz: 60798664cf9d835a1045299f1064021a523d9ac46e149ca8605a836f7286748a6d42ccddae2002461feec7486c6a1c0fc8ef88ad25b25f4274a0d098632d46d7

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/CHANGELOG.md

@@ -1,4 +1,22 @@
 # Change Log
+
+### 1.9.0
+### Added
+- Added `BEAKER_BOLT_VERSION` environment variable to set the version of Bolt used to generate an inventory file.
+
+### Changed
+- Updated the helper to query the version of Bolt installed on the Beaker host when generating an inventory file.
+
+### 1.8.0
+### Changed
+- Updated the helper to be compatible with [Bolt 2.0 changes](https://github.com/puppetlabs/bolt/blob/master/CHANGELOG.md). *Bolt 2.0 introduced some [backwards-incompatible changes](https://github.com/puppetlabs/bolt/blob/master/CHANGELOG.md#bolt-200-2020-02-19) that you should be aware of before upgrading to this version.*
+
+### 1.7.1-4
+### Fixed
+- `.ssh` directory path on OSX 10.12/10.13/10.14 and Solaris 10
+- Puppet 6 collection handling fix
+- PE `puppet access login` fixes
+
 ## 1.7.0
 ### Added
 - (maint) - Work around for [BOLT-845](https://tickets.puppetlabs.com/browse/BOLT-845), installing ffi on el5 machines).

data/CODEOWNERS

@@ -0,0 +1,2 @@
+# This repo is owned by the Installer team
+* @puppetlabs/installer-and-management

data/README.md

@@ -1,3 +1,4 @@
 beaker-task_helper
 
 Accepts Bolt password via the `BEAKER_password` environment variable.
+Accepts Bolt version via the `BEAKER_BOLT_VERSION` environment variable.

data/beaker-task_helper.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'beaker', '>= 3.0.0'
   spec.add_development_dependency 'beaker-rspec'

data/lib/beaker-task_helper.rb

@@ -8,6 +8,40 @@ module Beaker::TaskHelper # rubocop:disable Style/ClassAndModuleChildren
     (on default, puppet('--version')).output.chomp
   end
 
+  def bolt_path
+    if fact_on(default, 'osfamily') == 'windows'
+      if ENV['BEAKER_PUPPET_COLLECTION'].nil? || %w[pc1 puppet5 puppet6].include?(ENV['BEAKER_PUPPET_COLLECTION'])
+        '/cygdrive/c/Program\ Files/Puppet\ Labs/Puppet/sys/ruby/bin/bolt.bat'
+      else
+        '/cygdrive/c/Program\ Files/Puppet\ Labs/Puppet/puppet/bin/bolt.bat'
+      end
+    else
+      # If bolt was installed as a package
+      if File.exist?('/opt/puppetlabs/puppet/bin/bolt')
+        '/opt/puppetlabs/puppet/bin/bolt'
+      else
+      # Or as a gem
+        'bolt'
+      end
+    end
+  end
+
+  # Returns the version of Bolt installed on the beakerhost. Used to determine
+  # which inventory file version to generate.
+  #
+  def self.bolt_version(beakerhost = nil)
+    return ENV['BEAKER_BOLT_VERSION'] if ENV['BEAKER_BOLT_VERSION']
+
+    beakerhost ||= default
+    begin
+      on(beakerhost, "#{bolt_path} --version")
+    rescue Beaker::Host::CommandFailure
+      # If bolt isn't installed, default to 1.18.0 which is the latest version
+      # to support only v1 inventory
+      '1.18.0'
+    end
+  end
+
   DEFAULT_PASSWORD = if ENV.has_key?('BEAKER_password')
                        ENV['BEAKER_password']
                      elsif !defined?(default)
@@ -18,14 +52,15 @@ module Beaker::TaskHelper # rubocop:disable Style/ClassAndModuleChildren
                        'root'
                      end
 
-  BOLT_VERSION = if ENV['BEAKER_PUPPET_COLLECTION'].nil? || ENV['BEAKER_PUPPET_COLLECTION'] == 'pc1'
-                  # puppet4 uses an older version of ruby (2.1.9) that bolt has stopped supporting
-                    '0.16.1'.freeze
-                  else
-                    '0.23.0'.freeze
-                  end
+  DEFAULT_BOLT_VERSION = if ENV['BEAKER_PUPPET_COLLECTION'].nil? || ENV['BEAKER_PUPPET_COLLECTION'] == 'pc1'
+                           # puppet4 uses an older version of ruby (2.1.9) that bolt has stopped supporting
+                           '0.16.1'.freeze
+                         else
+                           # CODEREVIEW: Can we update this to 1.x?
+                           '0.23.0'.freeze
+                         end
 
-  def install_bolt_on(hosts, version = BOLT_VERSION, source = nil)
+  def install_bolt_on(hosts, version = DEFAULT_BOLT_VERSION, source = nil)
     unless default[:docker_image_commands].nil?
       if default[:docker_image_commands].to_s.include? 'yum'
         on(hosts, 'yum install -y make gcc ruby-devel', acceptable_exit_codes: [0, 1]).stdout
@@ -64,7 +99,17 @@ INSTALL_BOLT_PP
     ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i
   end
 
+  def target_flag(host=default)
+    if version_is_less('1.18.0', self.bolt_version(host))
+      '--targets'
+    else
+      '--nodes'
+    end
+  end
+
   def run_puppet_access_login(user:, password: '~!@#$%^*-/ aZ', lifetime: '5y')
+    peconf_password = get_unwrapped_pe_conf_value("console_admin_password")
+    password = peconf_password if peconf_password != nil && peconf_password != ""
     on(master, puppet('access', 'login', '--username', user, '--lifetime', lifetime), stdin: password)
   end
 
@@ -83,7 +128,7 @@ INSTALL_BOLT_PP
         case node.platform
         when /solaris-10/
             ssh_dir_path = '/.ssh/'
-        when /osx-1012/
+        when /osx-10\.1(2|3|4)/
             ssh_dir_path = '/var/root/.ssh/'
         else
             ssh_dir_path = '/root/.ssh'
@@ -115,23 +160,17 @@ INSTALL_BOLT_PP
   def run_bolt_task(task_name:, params: nil, password: DEFAULT_PASSWORD,
                     host: '127.0.0.1', format: 'human', module_path: nil)
     if fact_on(default, 'osfamily') == 'windows'
-      bolt_path = if ENV['BEAKER_PUPPET_COLLECTION'].nil? || ENV['BEAKER_PUPPET_COLLECTION'] == 'pc1' || ENV['BEAKER_PUPPET_COLLECTION'] == 'puppet5'
-                    '/cygdrive/c/Program\ Files/Puppet\ Labs/Puppet/sys/ruby/bin/bolt.bat'
-                  else
-                    '/cygdrive/c/Program\ Files/Puppet\ Labs/Puppet/puppet/bin/bolt.bat'
-                  end
       module_path ||= 'C:/ProgramData/PuppetLabs/code/modules'
 
-      if version_is_less('0.15.0', BOLT_VERSION)
+      if version_is_less('0.15.0', self.bolt_version)
         check = '--no-ssl'
       else
         check = '--insecure'
       end
     else
-      bolt_path = '/opt/puppetlabs/puppet/bin/bolt'
       module_path ||='/etc/puppetlabs/code/modules'
 
-      if version_is_less('0.15.0', BOLT_VERSION)
+      if version_is_less('0.15.0', self.bolt_version)
         check = '--no-host-key-check'
       else
         check = '--insecure'
@@ -139,7 +178,7 @@ INSTALL_BOLT_PP
     end
 
     bolt_full_cli = "#{bolt_path} task run #{task_name} #{check} -m #{module_path} " \
-                    "--nodes #{host} --password #{password}"
+                    "#{target_flag} #{host} --password #{password}"
     bolt_full_cli << " --format #{format}" if format != 'human'
     bolt_full_cli << if params.class == Hash
                        " --params '#{params.to_json}'"
@@ -155,7 +194,7 @@ INSTALL_BOLT_PP
   end
 
   def run_puppet_task(task_name:, params: nil, host: '127.0.0.1', format: 'human')
-    args = ['task', 'run', task_name, '--nodes', host]
+    args = ['task', 'run', task_name, target_flag(master), host]
     if params.class == Hash
       args << '--params'
       args << params.to_json
@@ -176,7 +215,7 @@ INSTALL_BOLT_PP
   end
 
   def task_summary_line(total_hosts: 1, success_hosts: 1)
-    "Job completed. #{success_hosts}/#{total_hosts} nodes succeeded|Ran on #{total_hosts} node"
+    "Job completed. #{success_hosts}/#{total_hosts} targets succeeded|Ran on #{total_hosts} target"
   end
 end
 

data/lib/beaker-task_helper/inventory.rb

@@ -1,8 +1,25 @@
 require 'beaker'
+require 'beaker-task_helper'
 
 module Beaker
   module TaskHelper
     module Inventory
+      def inventory_version
+        if version_is_less('1.18.0', Beaker::TaskHelper.bolt_version)
+          2
+        else
+          1
+        end
+      end
+
+      def target_key
+        inventory_version == 2 ? 'targets' : 'nodes'
+      end
+      
+      def uri_key
+        inventory_version == 2 ? 'uri' : 'name'
+      end
+
       # This attempts to make a bolt inventory hash from beakers hosts
       # roles should be targetable by bolt as groups
       def hosts_to_inventory
@@ -12,10 +29,10 @@ module Beaker
           if group_name =~ %r{\A[a-z0-9_]+\Z}
             group = groups.find { |g| g['name'] == group_name }
             unless group
-              group = { 'name' => group_name, 'nodes' => [] }
+              group = { 'name' => group_name, target_key => [] }
               groups << group
             end
-            group['nodes'] << node
+            group[target_key] << node
           else
             puts "invalid group name #{group_name} skipping"
           end
@@ -33,9 +50,12 @@ module Beaker
           else
             config = { 'transport' => 'ssh',
                        'ssh' => { 'host-key-check' => false } }
-            %i[password user port].each do |k|
+            %i[password user].each do |k|
               config['ssh'][k.to_s] = host[:ssh][k] if host[:ssh][k]
             end
+            if host[:ssh][:port]
+              config['ssh']['port'] = host[:ssh][:port].to_i
+            end
 
             case host[:hypervisor]
             when 'docker'
@@ -61,18 +81,20 @@ module Beaker
           end
 
           {
-            'name' => node_name,
+            uri_key => node_name,
             'config' => config
           }
         end
 
-        { 'nodes' => nodes,
-          'groups' => groups,
-          'config' => {
-            'ssh' => {
-              'host-key-check' => false
-            }
-          } }
+        inv = { target_key => nodes,
+                'groups' => groups,
+                'config' => {
+                  'ssh' => {
+                    'host-key-check' => false
+                  }
+                } }
+        inv.merge!({'version' => 2}) if inventory_version == 2
+        inv
       end
     end
   end

data/lib/beaker-task_helper/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module TaskHelper
-    VERSION = '1.7.1'.freeze
+    VERSION = '1.9.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-task_helper
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.9.0
 platform: ruby
 authors:
 - puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,11 +101,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODEOWNERS
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -135,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby gem to help testing tasks with Beaker