beaker-module_install_helper 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c5192677947674c9afe89bc03271fd1496458140556f66ec5d5765a892c31e7
-  data.tar.gz: 318f11f4d52851391ea4f266cc84ce01a84799604066b9d7ea7fa4caa4bdc1cd
+  metadata.gz: eb8d10b9ccd4abf59f343eaf4531129ad640ba26ad3a1745a6f713985e4f7f6f
+  data.tar.gz: b35c1819e456c75dd5a79d5b8bd06a65f1646a6a76d60a11477e35d776bc297d
 SHA512:
-  metadata.gz: e9d605bc7dae5ea9c9f3e89c36c89423ca006bd61b3930513dbe970fcbe52e0827737ec7a119aa2c4ba559ed4aef3b23f6404b7264587ad95ecebe4e700b48a0
-  data.tar.gz: 9c1d699e742bd6f800b8841027b5261aa11fec41e381a82866fbec27a75ddaad0a3765e161e83b6e77f6106ca7d9a792bdfabf08f6d8a7e03aaf93fc1a8fdd04
+  metadata.gz: 94f450fa00745b80742289722a3480fab58c6453eda89b5f14b0ef898efc3d0feb9f42c8e58ceeb51514850210f75a4ab3a310dff67a79d2d5e967ce6b5d2c7a
+  data.tar.gz: ab84e00a031ed55a5c590f9e221cc180cf718b634ce70de2102b5d3747bbc2750030403879f2c606f158e9b2f6f0e255f3f4cf54e512e35d4689af7a11bcfed1

data/.github/dependabot.yml

@@ -1,8 +1,17 @@
 version: 2
 updates:
+# raise PRs for gem updates
 - package-ecosystem: bundler
   directory: "/"
   schedule:
     interval: daily
     time: "13:00"
   open-pull-requests-limit: 10
+
+# Maintain dependencies for GitHub Actions
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.github/workflows/release.yml

@@ -10,14 +10,14 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.0'
           bundler: 'none'
       - name: Build gem
-        run: gem build *.gemspec
+        run: gem build --strict --verbose *.gemspec
       - name: Publish gem to rubygems.org
         run: gem push *.gem
         env:

data/.github/workflows/test.yml

@@ -1,35 +1,57 @@
 name: Test
 
 on:
-  - pull_request
-  - push
+  pull_request: {}
+  push:
+    branches:
+      - master
 
 env:
   BUNDLE_WITHOUT: release
 
 jobs:
-  test:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rake rubocop
+  spec:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         include:
-          - ruby: "2.4"
-          - ruby: "2.5"
-          - ruby: "2.6"
           - ruby: "2.7"
-          - ruby: "3.0"
             coverage: "yes"
+          - ruby: "3.0"
+          - ruby: "3.1"
+          - ruby: "3.2"
     env:
       COVERAGE: ${{ matrix.coverage }}
+    name: RSpec - Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: Run tests
+      - name: spec tests
         run: bundle exec rake spec
-      - name: Verify gem builds
-        run: bundle exec gem build *.gemspec
+      - name: Build gem
+        run: gem build --strict --verbose *.gemspec
+
+  tests:
+    needs:
+      - spec
+      - rubocop
+    runs-on: ubuntu-latest
+    name: Test suite
+    steps:
+      - run: echo Test suite completed

data/.rubocop.yml

@@ -1,46 +1,8 @@
-require: rubocop-rspec
+---
+inherit_from: .rubocop_todo.yml
 
-AllCops:
-  TargetRubyVersion: 2.1
+inherit_gem:
+  voxpupuli-rubocop: rubocop.yml
 
-Bundler/OrderedGems:
-  Enabled: false
-
-RSpec/AnyInstance:
-  Enabled: false
-
-RSpec/DescribeClass:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Enabled: false
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/GlobalVars:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Bundler/DuplicatedGem:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ModuleLength:
+Style/Documentation:
   Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,25 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-05-05 15:14:01 UTC using RuboCop version 1.50.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 10
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/unit/beaker/module_install_helper_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Max.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/unit/beaker/module_install_helper_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Exclude:
+    - 'lib/beaker/module_install_helper.rb'
+    - 'spec/unit/beaker/module_install_helper_spec.rb'

data/CHANGELOG.md

@@ -1,10 +1,38 @@
-# Changelog
+      # Changelog
 
-All notable changes to this project will be documented in this file.
+      # All notable changes to this project will be documented in this file.
 
-## [1.0.0](https://github.com/voxpupuli/beaker-module_install_helper/tree/1.0.0) (2021-11-03)
 
-[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/v0.1.7...1.0.0)
+## [2.0.0](https://github.com/voxpupuli/beaker-module_install_helper/tree/2.0.0) (2023-05-05)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/v1.0.0...2.0.0)
+
+**Breaking changes:**
+
+- Drop Ruby 2.5/2.6 support; use voxpupuli-rubocop [\#42](https://github.com/voxpupuli/beaker-module_install_helper/pull/42) ([bastelfreak](https://github.com/bastelfreak))
+- add rubocop to CI / bump min ruby to 2.5 [\#33](https://github.com/voxpupuli/beaker-module_install_helper/pull/33) ([jhoblitt](https://github.com/jhoblitt))
+
+**Implemented enhancements:**
+
+- CI: Apply Vox Pupuli best practices & Add Ruby 3.2 support [\#39](https://github.com/voxpupuli/beaker-module_install_helper/pull/39) ([bastelfreak](https://github.com/bastelfreak))
+
+**Closed issues:**
+
+- Forge stubbing doesn't work for non-forge forges [\#23](https://github.com/voxpupuli/beaker-module_install_helper/issues/23)
+
+**Merged pull requests:**
+
+- CI: Build gems with strictness and verbosity & dependencies: add version constraints [\#43](https://github.com/voxpupuli/beaker-module_install_helper/pull/43) ([bastelfreak](https://github.com/bastelfreak))
+- Update beaker-puppet requirement from ~\> 1.0 to \>= 1, \< 3 [\#41](https://github.com/voxpupuli/beaker-module_install_helper/pull/41) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump actions/checkout from 2 to 3 [\#40](https://github.com/voxpupuli/beaker-module_install_helper/pull/40) ([dependabot[bot]](https://github.com/apps/dependabot))
+- dependabot: check for github actions and gems [\#38](https://github.com/voxpupuli/beaker-module_install_helper/pull/38) ([bastelfreak](https://github.com/bastelfreak))
+- Rubocop: Apply Vox Pupuli best practices & fix violations [\#37](https://github.com/voxpupuli/beaker-module_install_helper/pull/37) ([bastelfreak](https://github.com/bastelfreak))
+- Fix incorrect Apache-2 license [\#36](https://github.com/voxpupuli/beaker-module_install_helper/pull/36) ([bastelfreak](https://github.com/bastelfreak))
+- add basic Net::HTTP error handling [\#34](https://github.com/voxpupuli/beaker-module_install_helper/pull/34) ([jhoblitt](https://github.com/jhoblitt))
+
+## [v1.0.0](https://github.com/voxpupuli/beaker-module_install_helper/tree/v1.0.0) (2021-11-03)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-module_install_helper/compare/v0.1.7...v1.0.0)
 
 **Closed issues:**
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -7,8 +9,6 @@ group :test do
   gem 'bundler', '>= 1.9', '< 3'
   gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', require: false
-  gem 'rubocop-rspec', require: false
 end
 
 group :development do
@@ -16,11 +16,12 @@ group :development do
   gem 'pry-byebug'
 end
 
-group :coverage, optional: ENV['COVERAGE']!='yes' do
-  gem 'simplecov-console', :require => false
-  gem 'codecov', :require => false
+group :coverage, optional: ENV.fetch('COVERAGE', nil) != 'yes' do
+  gem 'codecov', require: false
+  gem 'simplecov-console', require: false
 end
 
 group :release do
-  gem 'github_changelog_generator', '>= 1.16.4', require: false if RUBY_VERSION >= '2.5'
+  gem 'faraday-retry', require: false
+  gem 'github_changelog_generator', require: false
 end

data/LICENSE

@@ -1,15 +1,201 @@
-Copyright (C) 2015 Puppet Labs Inc
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Puppet Labs can be contacted at: info@puppetlabs.com
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-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
+   1. Definitions.
 
-    http://www.apache.org/licenses/LICENSE-2.0
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
 
-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.
+      "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/Rakefile

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-task default: %i[lint spec]
-
 require 'rubocop/rake_task'
-desc 'Run rubocop'
-RuboCop::RakeTask.new(:lint) do |t|
-  t.requires << 'rubocop-rspec'
-end
+
+RuboCop::RakeTask.new
 
 require 'rspec/core/rake_task'
 desc 'Run spec tests using rspec'
@@ -23,10 +19,19 @@ rescue LoadError
   # github_changelog_generator isn't available, so we won't define a rake task with it
 else
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
+    config.header = <<-HEADER
+      # Changelog
+
+      # All notable changes to this project will be documented in this file.
+    HEADER
     config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
     config.user = 'voxpupuli'
     config.project = 'beaker-module_install_helper'
     config.future_release = Gem::Specification.load("#{config.project}.gemspec").version
   end
 end
+
+task default: %w[
+  rubocop
+  spec
+]

data/beaker-module_install_helper.gemspec

@@ -1,9 +1,11 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'beaker-module_install_helper'
-  spec.version       = '1.0.0'
+  spec.version       = '2.0.0'
   spec.authors       = ['Vox Pupuli']
   spec.email         = ['voxpupuli@groups.io']
 
@@ -17,18 +19,18 @@ Gem::Specification.new do |spec|
   spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files`.split("\n")
-  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.executables   = `git ls-files -- bin/*` \
-                       .split("\n") \
+  spec.executables   = `git ls-files -- bin/*`
+                       .split("\n")
                        .map { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   ## Testing dependencies
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'voxpupuli-rubocop', '~> 1.2'
 
   # Run time dependencies
-  spec.add_runtime_dependency 'beaker', '>= 2.0'
-  spec.add_runtime_dependency 'beaker-puppet', '~> 1.0'
+  spec.add_runtime_dependency 'beaker', '>= 2.0', '< 6'
+  spec.add_runtime_dependency 'beaker-puppet', '>= 1', '< 3'
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.7.0'
 end

data/lib/beaker/module_install_helper.rb

@@ -1,208 +1,216 @@
+# frozen_string_literal: true
+
 require 'beaker'
 require 'beaker-puppet'
 
 # Provides method for use in module test setup to install the module under
 # test and it's dependencies on the specified hosts
-module Beaker::ModuleInstallHelper
-  include Beaker::DSL
+module Beaker
+  module ModuleInstallHelper
+    include Beaker::DSL
+
+    # This method calls the install_module_on method for each host which is a
+    # master, or if no master is present, on all agent nodes.
+    def install_module(opts = {})
+      install_module_on(hosts_to_install_module_on, opts)
+    end
 
-  # This method calls the install_module_on method for each host which is a
-  # master, or if no master is present, on all agent nodes.
-  def install_module(opts = {})
-    install_module_on(hosts_to_install_module_on, opts)
-  end
+    # This method will install the module under test on the specified host(s) from
+    # the source on the local machine
+    def install_module_on(host, opts = {})
+      opts = {
+        source: $module_source_dir,
+        module_name: module_name_from_metadata,
+      }.merge(opts)
+      copy_module_to(host, opts)
+    end
 
-  # This method will install the module under test on the specified host(s) from
-  # the source on the local machine
-  def install_module_on(host, opts = {})
-    opts = {
-      source: $module_source_dir,
-      module_name: module_name_from_metadata
-    }.merge(opts)
-    copy_module_to(host, opts)
-  end
+    # This method calls the install_module_dependencies_on method for each
+    # host which is a master, or if no master is present, on all agent nodes.
+    def install_module_dependencies(deps = nil)
+      install_module_dependencies_on(hosts_to_install_module_on, deps)
+    end
 
-  # This method calls the install_module_dependencies_on method for each
-  # host which is a master, or if no master is present, on all agent nodes.
-  def install_module_dependencies(deps = nil)
-    install_module_dependencies_on(hosts_to_install_module_on, deps)
-  end
+    # This method will install the module under tests module dependencies on the
+    # specified host(s) from the dependencies list in metadata.json
+    def install_module_dependencies_on(hsts, deps = nil)
+      hsts = [hsts] if hsts.is_a?(Hash)
+      hsts = [hsts] unless hsts.respond_to?(:each)
+      deps = module_dependencies_from_metadata if deps.nil?
 
-  # This method will install the module under tests module dependencies on the
-  # specified host(s) from the dependencies list in metadata.json
-  def install_module_dependencies_on(hsts, deps = nil)
-    hsts = [hsts] if hsts.is_a?(Hash)
-    hsts = [hsts] unless hsts.respond_to?(:each)
-    deps = deps.nil? ? module_dependencies_from_metadata : deps
-
-    fh = ENV['BEAKER_FORGE_HOST']
-
-    hsts.each do |host|
-      deps.each do |dep|
-        if fh.nil?
-          install_puppet_module_via_pmt_on(host, dep)
-        else
-          with_forge_stubbed_on(host) do
+      fh = ENV.fetch('BEAKER_FORGE_HOST', nil)
+
+      hsts.each do |host|
+        deps.each do |dep|
+          if fh.nil?
             install_puppet_module_via_pmt_on(host, dep)
+          else
+            with_forge_stubbed_on(host) do
+              install_puppet_module_via_pmt_on(host, dep)
+            end
           end
         end
       end
     end
-  end
 
-  def install_module_from_forge(mod_name, ver_req)
-    install_module_from_forge_on(hosts_to_install_module_on, mod_name, ver_req)
-  end
+    def install_module_from_forge(mod_name, ver_req)
+      install_module_from_forge_on(hosts_to_install_module_on, mod_name, ver_req)
+    end
 
-  def install_module_from_forge_on(hsts, mod_name, ver_req)
-    sub_mod_name = mod_name.sub('/', '-')
-    dependency = {
-      module_name: sub_mod_name,
-      version: module_version_from_requirement(sub_mod_name, ver_req)
-    }
+    def install_module_from_forge_on(hsts, mod_name, ver_req)
+      sub_mod_name = mod_name.sub('/', '-')
+      dependency = {
+        module_name: sub_mod_name,
+        version: module_version_from_requirement(sub_mod_name, ver_req),
+      }
 
-    install_module_dependencies_on(hsts, [dependency])
-  end
+      install_module_dependencies_on(hsts, [dependency])
+    end
 
-  # This method returns an array of dependencies from the metadata.json file
-  # in the format of an array of hashes, containing :module_name and optionally
-  # :version elements. If no dependencies are specified, empty array is returned
-  def module_dependencies_from_metadata
-    metadata = module_metadata
-    return [] unless metadata.key?('dependencies')
+    # This method returns an array of dependencies from the metadata.json file
+    # in the format of an array of hashes, containing :module_name and optionally
+    # :version elements. If no dependencies are specified, empty array is returned
+    def module_dependencies_from_metadata
+      metadata = module_metadata
+      return [] unless metadata.key?('dependencies')
 
-    dependencies = []
-    metadata['dependencies'].each do |d|
-      tmp = { module_name: d['name'].sub('/', '-') }
+      dependencies = []
+      metadata['dependencies'].each do |d|
+        tmp = { module_name: d['name'].sub('/', '-') }
 
-      if d.key?('version_requirement')
-        tmp[:version] = module_version_from_requirement(tmp[:module_name],
-                                                        d['version_requirement'])
+        if d.key?('version_requirement')
+          tmp[:version] = module_version_from_requirement(tmp[:module_name],
+                                                          d['version_requirement'])
+        end
+        dependencies.push(tmp)
       end
-      dependencies.push(tmp)
+
+      dependencies
     end
 
-    dependencies
-  end
+    # This method takes a module name and the version requirement string from the
+    # metadata.json file, containing either lower bounds of version or both lower
+    # and upper bounds. The function then uses the forge rest endpoint to find
+    # the most recent release of the given module matching the version requirement
+    def module_version_from_requirement(mod_name, vr_str)
+      require 'net/http'
+      uri = URI("#{forge_api}v3/modules/#{mod_name}")
+      response = Net::HTTP.get_response(uri)
+      raise "Puppetforge API error '#{uri}': '#{response.body}'" if response.code.to_i >= 400
+
+      forge_data = JSON.parse(response.body)
+
+      vrs = version_requirements_from_string(vr_str)
 
-  # This method takes a module name and the version requirement string from the
-  # metadata.json file, containing either lower bounds of version or both lower
-  # and upper bounds. The function then uses the forge rest endpoint to find
-  # the most recent release of the given module matching the version requirement
-  def module_version_from_requirement(mod_name, vr_str)
-    require 'net/http'
-    uri = URI("#{forge_api}v3/modules/#{mod_name}")
-    response = Net::HTTP.get(uri)
-    forge_data = JSON.parse(response)
-
-    vrs = version_requirements_from_string(vr_str)
-
-    # Here we iterate the releases of the given module and pick the most recent
-    # that matches to version requirement
-    forge_data['releases'].each do |rel|
-      return rel['version'] if vrs.all? { |vr| vr.match?('', rel['version']) }
+      # Here we iterate the releases of the given module and pick the most recent
+      # that matches to version requirement
+      forge_data['releases'].each do |rel|
+        return rel['version'] if vrs.all? { |vr| vr.match?('', rel['version']) }
+      end
+
+      raise "No release version found matching '#{mod_name}' '#{vr_str}'"
     end
 
-    raise "No release version found matching '#{vr_str}'"
-  end
+    # This method takes a version requirement string as specified in the link
+    # below, with either simply a lower bound, or both lower and upper bounds and
+    # returns an array of Gem::Dependency objects
+    # https://docs.puppet.com/puppet/latest/modules_metadata.html
+    def version_requirements_from_string(vr_str)
+      ops = vr_str.scan(/[(<|>=)]{1,2}/i)
+      vers = vr_str.scan(/[(0-9|.)]+/i)
 
-  # This method takes a version requirement string as specified in the link
-  # below, with either simply a lower bound, or both lower and upper bounds and
-  # returns an array of Gem::Dependency objects
-  # https://docs.puppet.com/puppet/latest/modules_metadata.html
-  def version_requirements_from_string(vr_str)
-    ops = vr_str.scan(/[(<|>|=)]{1,2}/i)
-    vers = vr_str.scan(/[(0-9|\.)]+/i)
+      raise 'Invalid version requirements' if ops.count != 0 &&
+                                              ops.count != vers.count
 
-    raise 'Invalid version requirements' if ops.count != 0 &&
-                                            ops.count != vers.count
+      vrs = []
+      ops.each_with_index do |op, index|
+        vrs.push(Gem::Dependency.new('', "#{op} #{vers[index]}"))
+      end
 
-    vrs = []
-    ops.each_with_index do |op, index|
-      vrs.push(Gem::Dependency.new('', "#{op} #{vers[index]}"))
+      vrs
     end
 
-    vrs
-  end
+    # This method will return array of all masters. If no masters exist, it will
+    # return all agent nodes. If no nodes tagged master or agent exist, all nodes
+    # will be returned
+    def hosts_to_install_module_on
+      masters = hosts_with_role(hosts, :master)
+      return masters unless masters.empty?
 
-  # This method will return array of all masters. If no masters exist, it will
-  # return all agent nodes. If no nodes tagged master or agent exist, all nodes
-  # will be returned
-  def hosts_to_install_module_on
-    masters = hosts_with_role(hosts, :master)
-    return masters unless masters.empty?
+      agents = hosts_with_role(hosts, :agent)
+      return agents unless agents.empty?
 
-    agents = hosts_with_role(hosts, :agent)
-    return agents unless agents.empty?
+      hosts
+    end
 
-    hosts
-  end
+    # This method will read the 'name' attribute from metadata.json file and
+    # remove the first segment. E.g. puppetlabs-vcsrepo -> vcsrepo
+    def module_name_from_metadata
+      res = get_module_name module_metadata['name']
+      raise 'Error getting module name' unless res
 
-  # This method will read the 'name' attribute from metadata.json file and
-  # remove the first segment. E.g. puppetlabs-vcsrepo -> vcsrepo
-  def module_name_from_metadata
-    res = get_module_name module_metadata['name']
-    raise 'Error getting module name' unless res
-    res[1]
-  end
+      res[1]
+    end
 
-  # This method uses the module_source_directory path to read the metadata.json
-  # file into a json array
-  def module_metadata
-    metadata_path = "#{$module_source_dir}/metadata.json"
-    unless File.exist?(metadata_path)
-      raise "Error loading metadata.json file from #{$module_source_dir}"
+    # This method uses the module_source_directory path to read the metadata.json
+    # file into a json array
+    def module_metadata
+      metadata_path = "#{$module_source_dir}/metadata.json"
+      raise "Error loading metadata.json file from #{$module_source_dir}" unless File.exist?(metadata_path)
+
+      JSON.parse(File.read(metadata_path))
     end
-    JSON.parse(File.read(metadata_path))
-  end
 
-  # Use this property to store the module_source_dir, so we don't traverse
-  # the tree every time
-  def get_module_source_directory(call_stack)
-    matching_caller = call_stack.select { |i| i =~ /(spec_helper_acceptance|_spec)/i }
+    # Use this property to store the module_source_dir, so we don't traverse
+    # the tree every time
+    def get_module_source_directory(call_stack)
+      matching_caller = call_stack.grep(/(spec_helper_acceptance|_spec)/i)
 
-    raise 'Error finding module source directory' if matching_caller.empty?
+      raise 'Error finding module source directory' if matching_caller.empty?
 
-    matching_caller = matching_caller[0] if matching_caller.is_a?(Array)
-    search_in = matching_caller[/[^:]+/]
+      matching_caller = matching_caller[0] if matching_caller.is_a?(Array)
+      search_in = matching_caller[/[^:]+/]
 
-    module_source_dir = nil
-    # here we go up the file tree and search the directories for a
-    # valid metadata.json
-    while module_source_dir.nil? && search_in != File.dirname(search_in)
-      # remove last segment (file or folder, doesn't matter)
-      search_in = File.dirname(search_in)
+      module_source_dir = nil
+      # here we go up the file tree and search the directories for a
+      # valid metadata.json
+      while module_source_dir.nil? && search_in != File.dirname(search_in)
+        # remove last segment (file or folder, doesn't matter)
+        search_in = File.dirname(search_in)
 
-      # Append metadata.json, check it exists in the directory we're searching
-      metadata_path = File.join(search_in, 'metadata.json')
-      module_source_dir = search_in if File.exist?(metadata_path)
+        # Append metadata.json, check it exists in the directory we're searching
+        metadata_path = File.join(search_in, 'metadata.json')
+        module_source_dir = search_in if File.exist?(metadata_path)
+      end
+      module_source_dir
     end
-    module_source_dir
-  end
 
-  def forge_host
-    fh = ENV['BEAKER_FORGE_HOST']
-    unless fh.nil?
-      fh = 'https://' + fh if fh !~ /^(https:\/\/|http:\/\/)/i
-      fh += '/' unless fh != /\/$/
-      return fh
+    def forge_host
+      fh = ENV['BEAKER_FORGE_HOST'] # rubocop:disable Style/FetchEnvVar
+      unless fh.nil?
+        fh = "https://#{fh}" unless %r{^(https://|http://)}i.match?(fh)
+        fh += '/' unless fh != %r{/$}
+        return fh
+      end
+
+      'https://forge.puppet.com/'
     end
 
-    'https://forge.puppet.com/'
-  end
+    def forge_api
+      fa = ENV['BEAKER_FORGE_API'] # rubocop:disable Style/FetchEnvVar
+      unless fa.nil?
+        fa = "https://#{fa}" unless %r{^(https://|http://)}i.match?(fa)
+        fa += '/' unless fa != %r{/$}
+        return fa
+      end
 
-  def forge_api
-    fa = ENV['BEAKER_FORGE_API']
-    unless fa.nil?
-      fa = 'https://' + fa if fa !~ /^(https:\/\/|http:\/\/)/i
-      fa += '/' unless fa != /\/$/
-      return fa
+      'https://forgeapi.puppetlabs.com/'
     end
-
-    'https://forgeapi.puppetlabs.com/'
   end
 end
 
+# rubocop:disable Style/MixinUsage
 include Beaker::ModuleInstallHelper
+# rubocop:enable Style/MixinUsage
 # Use the caller (requirer) of this file to begin search for module source dir
 $module_source_dir = get_module_source_directory caller

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'simplecov'
   require 'simplecov-console'

data/spec/unit/beaker/module_install_helper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Beaker::ModuleInstallHelper do
@@ -6,7 +8,7 @@ describe Beaker::ModuleInstallHelper do
       let(:hosts) do
         [
           { 'roles' => %w[master database dashboard classifier] },
-          { 'roles' => ['agent'] }
+          { 'roles' => ['agent'] },
         ]
       end
 
@@ -147,19 +149,19 @@ describe Beaker::ModuleInstallHelper do
           'dependencies' => [
             {
               'name' => 'puppetlabs/stdlib',
-              'version_requirement' => '>= 4.13.1 <= 4.14.0'
+              'version_requirement' => '>= 4.13.1 <= 4.14.0',
             }, {
               'name' => 'puppetlabs/concat',
-              'version_requirement' => '>= 2.0.0 <= 2.2.0'
-            }
-          ]
+              'version_requirement' => '>= 2.0.0 <= 2.2.0',
+            },
+          ],
         }
       end
 
       let(:desired) do
         [
           { module_name: 'puppetlabs-stdlib', version: '4.14.0' },
-          { module_name: 'puppetlabs-concat', version: '2.2.0' }
+          { module_name: 'puppetlabs-concat', version: '2.2.0' },
         ]
       end
 
@@ -175,15 +177,15 @@ describe Beaker::ModuleInstallHelper do
           'name' => 'puppetlabs-vcsrepo',
           'dependencies' => [
             { 'name' => 'puppetlabs/stdlib' },
-            { 'name' => 'puppetlabs/concat' }
-          ]
+            { 'name' => 'puppetlabs/concat' },
+          ],
         }
       end
 
       let(:desired) do
         [
           { module_name: 'puppetlabs-stdlib' },
-          { module_name: 'puppetlabs-concat' }
+          { module_name: 'puppetlabs-concat' },
         ]
       end
 
@@ -197,7 +199,7 @@ describe Beaker::ModuleInstallHelper do
       let(:input_metadata) do
         {
           'name' => 'puppetlabs-vcsrepo',
-          'dependencies' => []
+          'dependencies' => [],
         }
       end
       let(:desired) { [] }
@@ -236,7 +238,7 @@ describe Beaker::ModuleInstallHelper do
       it 'return array with 2 gem version dependency objects' do
         res = version_requirements_from_string("#{lower_bound} #{upper_bound}")
         expect(res).to eql([Gem::Dependency.new('', lower_bound),
-                            Gem::Dependency.new('', upper_bound)])
+                            Gem::Dependency.new('', upper_bound),])
       end
     end
   end
@@ -297,9 +299,9 @@ describe Beaker::ModuleInstallHelper do
           'dependencies' => [
             {
               'name' => 'puppetlabs/stdlib',
-              'version_requirement' => '>= 4.13.1 <= 4.14.0'
-            }
-          ]
+              'version_requirement' => '>= 4.13.1 <= 4.14.0',
+            },
+          ],
         }
       end
 
@@ -319,8 +321,8 @@ describe Beaker::ModuleInstallHelper do
           'name' => 'puppetlabs-vcsrepo',
           'dependencies' => [
             { 'name' => 'puppetlabs/stdlib' },
-            { 'name' => 'puppetlabs/concat' }
-          ]
+            { 'name' => 'puppetlabs/concat' },
+          ],
         }
       end
       let(:a_host) { { name: 'a_host' } }
@@ -358,4 +360,29 @@ describe Beaker::ModuleInstallHelper do
       install_module_from_forge_on(a_host, input_module_name, input_module_version_requirement)
     end
   end
+
+  describe 'module_version_from_requirement' do
+    context 'when looking up resolvable version contraints for a valid module' do
+      it 'gets a response', live_fire: true do
+        ver = module_version_from_requirement('puppetlabs-vcsrepo', '>= 1 < 2')
+        expect(ver).to eq '1.5.0'
+      end
+    end
+
+    context 'when looking up *unresolvable* version contraints for a valid module' do
+      it 'gets a response', live_fire: true do
+        expect do
+          module_version_from_requirement('puppetlabs-vcsrepo', '> 1.4 < 1.5')
+        end.to raise_error(/^No release version found matching 'puppetlabs-vcsrepo' '> 1.4 < 1.5'/)
+      end
+    end
+
+    context 'when looking up metadata for a *invalid* module name' do
+      it 'gets a response', live_fire: true do
+        expect do
+          module_version_from_requirement('puppet-does-not-exist', '>= 1 < 2')
+        end.to raise_error(/^Puppetforge API error/)
+      end
+    end
+  end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: beaker-module_install_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: beaker
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +45,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,20 +55,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: beaker-puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 description: A helper gem for use in a Puppet Modules spec_helper_acceptance.rb file
   to help install the module under test and its dependencies on the system under test
 email:
@@ -65,6 +91,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -87,14 +114,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A helper gem for use in a Puppet Modules spec_helper_acceptance.rb file