Move system test gems out of the main Gemfile

bundle install surprisingly resolves dependencies for all gems in a Gemfile,
even gems in excluded groups. As a result, the "release prep" workflow failed
trying to resolve gems that are only needed when running task acceptance tests.

In Gemfile:
  bolt was resolved to 4.0.0, which depends on
    orchestrator_client was resolved to 0.7.2, which depends on
      faraday was resolved to 1.9.0, which depends on
        faraday-patron was resolved to 2.0.2, which depends on
          patron

There are multiple dependency chains causing this:

    bolt (5.0.1)         → r10k (>= 3.10, < 5)
    r10k (3.16.2)        → puppet_forge (>= 2.3.0, < 4.0.0)
    puppet_forge (3.2.0) → faraday (~> 1.3)

Also

    beaker-abs (1.1.0)   → vmfloaty (>= 1.0, < 2)
    vmfloaty (1.8.1)     → faraday (~> 1.5, >= 1.5.1)

This commit moves the beaker related gems to task_spec/Gemfile, similar to what
is done for acceptance/Gemfile.

It sets Gemfile to be unmanaged so we don't regress on 7246266 the next
time we `pdk update`

It updates the task_acceptance_tests GH workflow to run `bundle install` in
the `task_spec` directory.

One important change is you no longer need to set GEM_BOLT as an environment
variable **before** running "bundle install".

Author: joshcooper

.github/workflows/task_acceptance_tests.yaml

@@ -62,8 +62,9 @@ jobs:
         with:
           ruby-version: ${{ env.ruby_version }}
           bundler-cache: true
+          working-directory: task_spec
 
       - name: Run task acceptance tests
         run: |
-          cd task_spec
           bundle exec rake task_acceptance
+        working-directory: task_spec

.gitignore

@@ -11,12 +11,14 @@
 /bin/
 /doc/
 /Gemfile.local
-/Gemfile.lock
+Gemfile.lock
 /junit/
 /log/
+/task_spec/log/
 /pkg/
 /spec/fixtures/manifests/
 /spec/fixtures/modules/*
+/task_spec/spec/fixtures/
 /tmp/
 /vendor/
 /.vendor/

.sync.yml

@@ -12,32 +12,7 @@
     Style/FileNull:
       Enabled: false
 Gemfile:
-  optional:
-    ":development":
-      - gem: beaker
-        version: '~> 6.0'
-        from_env: BEAKER_VERSION
-      - gem: beaker-abs
-        from_env: BEAKER_ABS_VERSION
-        version: '~> 1.0'
-      - gem: beaker-hostgenerator
-        from_env: BEAKER_HOSTGENERATOR_VERSION
-        version: '~> 2.0'
-      - gem: beaker-rspec
-        from_env: BEAKER_RSPEC_VERSION
-      - gem: beaker-puppet
-        from_env: BEAKER_PUPPET_VERSION
-        version: '~> 4.0'
-      - gem: beaker-module_install_helper
-      - gem: beaker-puppet_install_helper
-      - gem: nokogiri
-      - gem: 'beaker-task_helper'
-        version: '~> 1.9'
-        condition: 'ENV["GEM_BOLT"]'
-    ":system_tests":
-      - gem: voxpupuli-acceptance
-        version: '~> 3'
-
+  unmanaged: true
 .github/workflows/release.yml:
   unmanaged: false
 .github/workflows/release_prep.yml:
@@ -50,6 +25,3 @@ spec/spec_helper.rb:
 Rakefile:
   extra_disabled_lint_checks:
     - puppet_url_without_modules
-  requires:
-    - require: voxpupuli/acceptance/rake
-      conditional: Gem.loaded_specs.key? 'voxpupuli-acceptance'

Gemfile

@@ -36,53 +36,39 @@ def print_gem_statement_for(gems)
 end
 
 group :development do
-  gem "json", '= 2.6.1',                                                                     require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.6.3',                                                                     require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "racc", '~> 1.4.0',                                                                    require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "deep_merge", '~> 1.2.2',                                                              require: false
-  gem "voxpupuli-puppet-lint-plugins", '~> 5.0',                                             require: false
-  gem "facterdb", '~> 2.1',                                                                  require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "facterdb", '~> 3.0',                                                                  require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "metadata-json-lint", '~> 4.0',                                                        require: false
-  gem "json-schema", '< 5.1.1',                                                              require: false
-  gem "rspec-puppet-facts", '~> 4.0',                                                        require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "rspec-puppet-facts", '~> 5.0',                                                        require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "dependency_checker", '~> 1.0.0',                                                      require: false
-  gem "parallel_tests", '= 3.12.1',                                                          require: false
-  gem "pry", '~> 0.10',                                                                      require: false
-  gem "simplecov-console", '~> 0.9',                                                         require: false
-  gem "puppet-debugger", '~> 1.6',                                                           require: false
-  gem "rubocop", '~> 1.73.0',                                                                require: false
-  gem "rubocop-performance", '~> 1.24.0',                                                    require: false
-  gem "rubocop-rspec", '~> 3.5.0',                                                           require: false
-  gem "rubocop-rspec_rails", '~> 2.31.0',                                                    require: false
-  gem "rubocop-factory_bot", '~> 2.27.0',                                                    require: false
-  gem "rubocop-capybara", '~> 2.22.0',                                                       require: false
-  gem "rubocop-ast", '< 1.43.0',                                                             require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "rb-readline", '= 0.5.5',                                                              require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "bigdecimal", '< 3.2.2',                                                               require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 6.0')
-  gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 1.0')
-  gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION'] || '~> 2.0')
-  gem "beaker-rspec"
-  gem "beaker-puppet", *location_for(ENV['BEAKER_PUPPET_VERSION'] || '~> 4.0')
-  gem "beaker-module_install_helper",                                                        require: false
-  gem "beaker-puppet_install_helper",                                                        require: false
-  gem "nokogiri",                                                                            require: false
-  gem "beaker-task_helper", '~> 1.9',                                                        require: false if ENV["GEM_BOLT"]
+  gem "json", '= 2.6.1',                         require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.6.3',                         require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "racc", '~> 1.4.0',                        require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "deep_merge", '~> 1.2.2',                  require: false
+  gem "voxpupuli-puppet-lint-plugins", '~> 5.0', require: false
+  gem "facterdb", '~> 2.1',                      require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "facterdb", '~> 3.0',                      require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "metadata-json-lint", '~> 4.0',            require: false
+  gem "json-schema", '< 5.1.1',                  require: false
+  gem "rspec-puppet-facts", '~> 4.0',            require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "rspec-puppet-facts", '~> 5.0',            require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "dependency_checker", '~> 1.0.0',          require: false
+  gem "parallel_tests", '= 3.12.1',              require: false
+  gem "pry", '~> 0.10',                          require: false
+  gem "simplecov-console", '~> 0.9',             require: false
+  gem "puppet-debugger", '~> 1.6',               require: false
+  gem "rubocop", '~> 1.73.0',                    require: false
+  gem "rubocop-performance", '~> 1.24.0',        require: false
+  gem "rubocop-rspec", '~> 3.5.0',               require: false
+  gem "rubocop-rspec_rails", '~> 2.31.0',        require: false
+  gem "rubocop-factory_bot", '~> 2.27.0',        require: false
+  gem "rubocop-capybara", '~> 2.22.0',           require: false
+  gem "rubocop-ast", '< 1.43.0',                 require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "rb-readline", '= 0.5.5',                  require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "bigdecimal", '< 3.2.2',                   require: false, platforms: [:mswin, :mingw, :x64_mingw]
 end
 group :development, :release_prep do
   gem "puppet-strings", '~> 4.0',         require: false
   gem "puppetlabs_spec_helper", '~> 8.0', require: false
   gem "puppet-blacksmith", '~> 7.0',      require: false
 end
-# We are overriding the default PDK template's Litmus logic in order to use the
-# latest Bolt in tests. See PA-7824.
 group :system_tests do
-  gem "puppet_litmus", '~> 2.0',      require: false, platforms: [:ruby, :x64_mingw]
-  gem "CFPropertyList", '< 3.0.7',    require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "serverspec", '~> 2.41',        require: false
-  gem "voxpupuli-acceptance", '~> 3', require: false
+  # add gems to acceptance/Gemfile or task_spec/Gemfile
 end
 
 gems = {}

Rakefile

@@ -5,7 +5,6 @@ require 'puppet_litmus/rake_tasks' if Gem.loaded_specs.key? 'puppet_litmus'
 require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet-syntax/tasks/puppet-syntax'
 require 'puppet-strings/tasks' if Gem.loaded_specs.key? 'puppet-strings'
-require 'voxpupuli/acceptance/rake' if Gem.loaded_specs.key? 'voxpupuli-acceptance'
 
 PuppetLint.configuration.send('disable_relative')
 PuppetLint.configuration.send('disable_80chars')

task_spec/Gemfile

@@ -0,0 +1,28 @@
+source ENV['GEM_SOURCE'] || "https://rubygems.org"
+
+# Find a location or specific version before installing a gem
+#
+# @param place_or_version can be one of:
+#   - A specific version,
+#   - A git branch, as `https://<your-repo>.git#<branch-name>`
+#   - A file URI, as `file:///absolute/file/path`
+def location_for(place, fake_version = nil)
+  if place.is_a?(String) && place =~ /^((?:git[:@]|https:)[^#]*)#(.*)/
+    [fake_version, { git: $1, branch: $2, require: false }].compact
+  elsif place.is_a?(String) && place =~ /^file:\/\/(.*)/
+    ['>= 0', { path: File.expand_path($1), require: false }]
+  else
+    [place, { require: false }]
+  end
+end
+
+gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 6')
+gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 1')
+gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION'] || '~> 2')
+gem "beaker-puppet", *location_for(ENV['BEAKER_PUPPET_VERSION'] || '~> 4')
+gem "beaker-module_install_helper", require: false
+gem "beaker-puppet_install_helper", require: false
+gem "beaker-task_helper", '~>1.9' if ENV['GEM_BOLT']
+gem "puppetlabs_spec_helper", '~> 8.0', require: false
+gem "voxpupuli-acceptance", '~> 3', require: false
+gem "puppet_litmus", '~> 2.0',      require: false, platforms: [:ruby, :x64_mingw]