r10k 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e54158e0a651c799246229971ba62ad36bd40a670ca84e61479aa5280306c8a
-  data.tar.gz: 153cc105ce9276d79e2501dc99accb398bba8fec423fbf0726a1b183993a2748
+  metadata.gz: d8b9e50ee8c5d0887c46aaf294074c57626229cb19218fc08dd87f5ae1812888
+  data.tar.gz: 96c59ea0332a86792c6922f354fdf5bed5c9cb31a37b608e09692fbce00cb1bb
 SHA512:
-  metadata.gz: 264ea2591c062d460edab02b8edf7a59c9ebc08ebea27ee2b103e43bdf71c936b797094014d66b776573196d4a9e86dfc9f0fd345626f27d7e25c8170ebaa83a
-  data.tar.gz: 224e40f3f13466ab2ea3296bc3741b10d591ea65c97ba60b3dd81078f70149770c07c46ac1464a44fd59af0d20dbc8bbf1a5e3990e5d7921cc05403772d99640
+  metadata.gz: 45e41d47b78d5951e533f6b2dece2f2f127610b6ac6a9d3d95927699eb11369159add33e467198e0b7869442c1803b5e183e02a44c00ccc8eadf43aabf263b8e
+  data.tar.gz: 4790f4189c4e15502cfc633d52605e000a9607acc1b59ec2b011d14736eed3dbcb05333e3bb2817d6bad3e08603c8472267f3a19dca0d64c3f1df10c99eb4200

data/.github/pull_request_template.md

@@ -1,4 +1,4 @@
 Please add all notable changes to the "Unreleased" section of the CHANGELOG in the format:
 ```
-- (JIRA ticket) Summary of changes. [Issue or PR #](link to issue or PR)
+- Summary of changes. [Issue or PR #](link to issue or PR)
 ```

data/.github/workflows/rspec_tests.yml

@@ -0,0 +1,81 @@
+name: Rspec tests
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  rspec_tests:
+    name: ${{ matrix.cfg.os }}(ruby ${{ matrix.cfg.ruby }})
+    strategy:
+      matrix:
+        cfg:
+          - {os: ubuntu-18.04, ruby: 2.4}
+          - {os: ubuntu-18.04, ruby: 2.5}
+          - {os: ubuntu-18.04, ruby: 2.6}
+          - {os: ubuntu-18.04, ruby: 2.7}
+          - {os: ubuntu-18.04, ruby: jruby-9.2.9.0}
+          - {os: windows-2016, ruby: 2.5}
+          - {os: windows-2016, ruby: 2.6}
+          - {os: windows-2016, ruby: 2.7}
+
+    runs-on: ${{ matrix.cfg.os }}
+    steps:
+      - name: Checkout current PR
+        uses: actions/checkout@v2
+
+      - name: Install ruby version ${{ matrix.cfg.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.cfg.ruby }}
+
+      - name: Install bundler and gems
+        run: |
+          gem install bundler
+          bundle config set without packaging documentation
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests on Windows
+        if: runner.os == 'Windows'
+        run: |
+          # https://github.com/ruby/ruby/pull/2791/files#diff-ff5ff976e81bebd977f0834e60416abbR97-R100
+          # Actions uses UTF8, causes test failures, similar to normal OS setup
+          $PSDefaultParameterValues['*:Encoding'] = 'utf8'
+          [Console]::OutputEncoding = [System.Text.Encoding]::GetEncoding("IBM437")
+          [Console]::InputEncoding  = [System.Text.Encoding]::GetEncoding("IBM437")
+          $Env:LOG_SPEC_ORDER = 'true'
+
+          # debug information
+          chcp
+          Get-WinSystemLocale
+          Get-ChildItem Env: | % { Write-Output "$($_.Key): $($_.Value)"  }
+          # list current OpenSSL install
+          gem list openssl
+          ruby -ropenssl -e 'puts \"OpenSSL Version - #{OpenSSL::OPENSSL_VERSION}\"; puts \"OpenSSL Library Version - #{OpenSSL::OPENSSL_LIBRARY_VERSION}\"'
+          Get-Content Gemfile.lock
+          ruby -v
+          gem --version
+          bundle --version
+
+          # Run tests
+          bundle exec rspec --color --format documentation spec/unit
+
+      - name: Run tests on Linux
+        if: runner.os == 'Linux'
+        run: |
+          # debug information
+          cat Gemfile.lock
+          ruby -v
+          gem --version
+          bundle --version
+
+          if [[ ${{ matrix.cfg.ruby }} =~ "jruby" ]]; then
+            export _JAVA_OPTIONS='-Xmx1024m -Xms512m'
+
+            # workaround for PUP-10683
+            sudo apt remove rpm
+          fi
+
+          # Run tests
+          bundle exec rspec --color --format documentation spec/unit

data/CHANGELOG.mkd

@@ -4,6 +4,13 @@ CHANGELOG
 Unreleased
 ----------
 
+3.7.0
+-----
+
+- Use %LOCALAPPDATA% for Windows cachedir [#1049](https://github.com/puppetlabs/r10k/issues/1049)
+- Add support for defining custom puppet.conf when generating types [#993](https://github.com/puppetlabs/r10k/pull/993)
+- Update test cases to account for error message changes in Puppet 7
+
 3.6.0
 -----
 

data/README.mkd

@@ -17,8 +17,8 @@ implementation of Puppet [environments][workflow].
 Requirements
 ------------
 
-R10k supports the Ruby versions `>= 2.3.0`. It's tested on Ruby 2.3.0 up to
-Ruby 2.6.0 + Jruby.
+R10k supports the Ruby versions `>= 2.4.0`. It's tested on Ruby 2.4.0 up to
+Ruby 2.7.0 + Jruby.
 
 R10k requires additional components, depending on how you plan on managing
 environments and modules.

data/doc/dynamic-environments/configuration.mkd

@@ -327,6 +327,15 @@ deploy:
   puppet_path: '/usr/local/bin/puppet'
 ```
 
+#### puppet\_conf
+
+The path to the puppet.conf file used for generating types. Defaults to `/etc/puppetlabs/puppet/puppet.conf`.
+
+```yaml
+deploy:
+  puppet_conf: '/opt/puppet/conf/puppet.conf'
+```
+
 Source options
 --------------
 

data/integration/tests/user_scenario/complex_workflow/multi_env_add_change_remove.rb

@@ -24,7 +24,7 @@ stage_env_notify_message = 'This is a different message'
 stage_env_notify_message_regex = /#{stage_env_notify_message}/
 
 #Verification for "test" Environment
-test_env_error_message_regex = /Error:.*Could not find environment 'test'/
+test_env_error_message_regex = /Error:.*Could not.*environment '?test'?/
 
 #Verification for "temp" Environment
 test_env_notify_message_regex = /I am in the temp environment/

data/integration/tests/user_scenario/complex_workflow/multi_env_remove_re-add.rb

@@ -15,7 +15,7 @@ initial_env_names = ['production', 'stage']
 
 #Verification
 notify_message_regex = /I am in the production environment/
-stage_env_error_message_regex = /Error:.*Could not find environment 'stage'/
+stage_env_error_message_regex = /Error:.*Could not.*environment '?stage'?/
 
 #Manifest
 site_pp_path = File.join(git_environments_path, 'manifests', 'site.pp')

data/integration/tests/user_scenario/complex_workflow/multi_env_unamanaged.rb

@@ -22,7 +22,7 @@ site_pp = create_site_pp(master_certname, '  include helloworld')
 notify_message_prod_env_regex = /I am in the production environment/
 notify_message_test_env_regex = /I am in the test environment/
 removal_message_test_env_regex = /Removing unmanaged path.*test/
-error_message_regex = /Could not retrieve catalog from remote server/
+error_message_regex = /Could not retrieve (catalog from remote server|information from environment test)/
 
 #Teardown
 teardown do

data/lib/r10k/action/deploy/environment.rb

@@ -188,6 +188,7 @@ module R10K
                       'no-force': :self,
                       'generate-types': :self,
                       'puppet-path': :self,
+                      'puppet-conf': :self,
                       'default-branch-override': :self)
         end
       end

data/lib/r10k/action/deploy/module.rb

@@ -76,7 +76,8 @@ module R10K
                       cachedir: :self,
                       'no-force': :self,
                       'generate-types': :self,
-                      'puppet-path': :self)
+                      'puppet-path': :self,
+                      'puppet-conf': :self)
         end
       end
     end

data/lib/r10k/action/runner.rb

@@ -46,6 +46,7 @@ module R10K
         overrides[:cachedir] = @opts[:cachedir] if @opts.key?(:cachedir)
         overrides[:deploy] = {} if @opts.key?(:'puppet-path') || @opts.key?(:'generate-types')
         overrides[:deploy][:puppet_path] = @opts[:'puppet-path'] if @opts.key?(:'puppet-path')
+        overrides[:deploy][:puppet_conf] = @opts[:'puppet-conf'] unless @opts[:'puppet-conf'].nil?
         overrides[:deploy][:generate_types] = @opts[:'generate-types'] if @opts.key?(:'generate-types')
 
         with_overrides = config_settings.merge(overrides) do |key, oldval, newval|

data/lib/r10k/cli/deploy.rb

@@ -31,6 +31,7 @@ module R10K::CLI
             exit 1
           end
         end
+        option nil, :'puppet-conf', 'Path to puppet.conf', argument: :required
 
         run do |opts, args, cmd|
           puts cmd.help(:verbose => opts[:verbose])

data/lib/r10k/environment/base.rb

@@ -137,7 +137,7 @@ class R10K::Environment::Base
   end
 
   def generate_types!
-    argv = [R10K::Settings.puppet_path, 'generate', 'types', '--environment', dirname, '--environmentpath', basedir]
+    argv = [R10K::Settings.puppet_path, 'generate', 'types', '--environment', dirname, '--environmentpath', basedir, '--config', R10K::Settings.puppet_conf]
     subproc = R10K::Util::Subprocess.new(argv)
     subproc.raise_on_fail = true
     subproc.logger = logger

data/lib/r10k/git/cache.rb

@@ -16,7 +16,17 @@ class R10K::Git::Cache
 
   include R10K::Settings::Mixin
 
-  def_setting_attr :cache_root, File.expand_path(ENV['HOME'] ? '~/.r10k/git': '/root/.r10k/git')
+  #@api private
+  def self.determine_cache_root
+    if R10K::Util::Platform.windows?
+      File.join(ENV['LOCALAPPDATA'], 'r10k', 'git')
+    else
+      File.expand_path(ENV['HOME'] ? '~/.r10k/git': '/root/.r10k/git')
+    end
+  end
+  private_class_method :determine_cache_root
+
+  def_setting_attr :cache_root, determine_cache_root
 
   @instance_cache = R10K::InstanceCache.new(self)
 

data/lib/r10k/initializers.rb

@@ -44,6 +44,7 @@ module R10K
     class DeployInitializer < BaseInitializer
       def call
         with_setting(:puppet_path) { |value| R10K::Settings.puppet_path = value }
+        with_setting(:puppet_conf) { |value| R10K::Settings.puppet_conf = value }
       end
     end
 

data/lib/r10k/settings.rb

@@ -12,6 +12,8 @@ module R10K
     class << self
       # Path to puppet executable
       attr_accessor :puppet_path
+      # Path to puppet.conf
+      attr_accessor :puppet_conf
     end
 
     def self.git_settings
@@ -131,6 +133,15 @@ module R10K
             end
           end
         }),
+        Definition.new(:puppet_conf, {
+          :desc => "Path to puppet.conf. Defaults to /etc/puppetlabs/puppet/puppet.conf.",
+          :default => '/etc/puppetlabs/puppet/puppet.conf',
+          :validate => lambda do |value|
+            unless File.readable? value
+              raise ArgumentError, "The specified puppet.conf #{value} is not readable"
+            end
+          end
+        }),
       ])
     end
 

data/lib/r10k/version.rb

@@ -2,5 +2,5 @@ module R10K
   # When updating to a new major (X) or minor (Y) version, include `#major` or
   # `#minor` (respectively) in your commit message to trigger the appropriate
   # release. Otherwise, a new patch (Z) version will be released.
-  VERSION = '3.6.0'
+  VERSION = '3.7.0'
 end

data/spec/shared-examples/subprocess-runner.rb

@@ -32,23 +32,29 @@ shared_examples_for "a subprocess runner" do |fixture_root|
     end
   end
 
-  describe "running 'ls' with a different working directory" do
+  describe "running 'ls' or 'dir' with a different working directory" do
     subject do
-      described_class.new(%w[ls]).tap do |o|
-        o.cwd = fixture_root
+      if R10K::Util::Platform.windows?
+        described_class.new(%w[cmd /c dir]).tap do |o|
+          o.cwd = fixture_root
+        end
+      else
+        described_class.new(%w[ls]).tap do |o|
+          o.cwd = fixture_root
+        end
       end
     end
 
     it "returns the contents of the given working directory" do
       result = subject.run
-      expect(result.stdout).to eq 'no-execute.sh'
+      expect(result.stdout).to match('no-execute.sh')
     end
   end
 
   describe "running 'false'" do
     subject { described_class.new(%w[false]) }
 
-    it "sets the exit code to 1" do
+    it "sets the exit code to 1", unless: R10K::Util::Platform.windows? do
       result = subject.run
       expect(result.exit_code).to eq 1
     end

data/spec/unit/action/deploy/environment_spec.rb

@@ -331,6 +331,15 @@ describe R10K::Action::Deploy::Environment do
         expect(subject.instance_variable_get(:@puppet_path)).to eq('/nonexistent')
       end
     end
+
+    describe 'with puppet-conf' do
+
+      subject { described_class.new({ config: '/some/nonexistent/path', 'puppet-conf': '/nonexistent' }, []) }
+
+      it 'sets puppet_conf' do
+        expect(subject.instance_variable_get(:@puppet_conf)).to eq('/nonexistent')
+      end
+    end
   end
 
   describe "write_environment_info!" do

data/spec/unit/action/deploy/module_spec.rb

@@ -26,6 +26,10 @@ describe R10K::Action::Deploy::Module do
       described_class.new({ 'puppet-path': '/nonexistent' }, [])
     end
 
+    it 'can accept a puppet-conf option' do
+      described_class.new({ 'puppet-conf': '/nonexistent' }, [])
+    end
+
     it 'can accept a cachedir option' do
       described_class.new({ cachedir: '/nonexistent' }, [])
     end
@@ -128,6 +132,15 @@ describe R10K::Action::Deploy::Module do
     end
   end
 
+  describe 'with puppet-conf' do
+
+    subject { described_class.new({ config: '/some/nonexistent/path', 'puppet-conf': '/nonexistent' }, []) }
+
+    it 'sets puppet_conf' do
+      expect(subject.instance_variable_get(:@puppet_conf)).to eq('/nonexistent')
+    end
+  end
+
   describe 'with cachedir' do
 
     subject { described_class.new({ config: '/some/nonexistent/path', cachedir: '/nonexistent' }, []) }

data/spec/unit/git/cache_spec.rb

@@ -3,6 +3,16 @@ require 'r10k/git/cache'
 
 describe R10K::Git::Cache do
 
+  describe 'the default cache_root' do
+    it 'is in the right location in linux', unless: R10K::Util::Platform.windows?  do
+      expect(described_class.defaults[:cache_root]).to match(/\.r10k\/git/)
+    end
+
+    it 'is in the right location for windows', if: R10K::Util::Platform.windows? do
+      expect(described_class.defaults[:cache_root]).to match(/[^.]r10k\/git/)
+    end
+  end
+
   let(:subclass) do
     Class.new(described_class) do
       def self.bare_repository

data/spec/unit/git/rugged/credentials_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby? do
+describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby?  || R10K::Util::Platform.windows? do
   before(:all) do
     require 'r10k/git/rugged/credentials'
     require 'rugged/credentials'

data/spec/unit/git_spec.rb

@@ -11,7 +11,7 @@ describe R10K::Git do
       expect(described_class.default_name).to eq :shellgit
     end
 
-    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? do
+    context 'under c-based rubies with rugged available', :unless => R10K::Util::Platform.jruby? || R10K::Util::Platform.windows? do
       it 'returns rugged when the git executable is absent and the rugged library is present' do
         expect(R10K::Features).to receive(:available?).with(:shellgit).and_return false
         expect(R10K::Features).to receive(:available?).with(:rugged).and_return true
@@ -53,7 +53,7 @@ describe R10K::Git do
       }.to raise_error(R10K::Error, "Git provider 'shellgit' is not functional.")
     end
 
-    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? do
+    context 'under c-based rubies with rugged available', :unless => R10K::Util::Platform.jruby? || R10K::Util::Platform.windows? do
       it "sets the current provider if the provider exists and is functional" do
         expect(R10K::Features).to receive(:available?).with(:rugged).and_return true
         described_class.provider = :rugged
@@ -71,7 +71,7 @@ describe R10K::Git do
   end
 
   describe "retrieving the current provider" do
-    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? do
+    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? || R10K::Util::Platform.windows? do
       it "uses the default if a provider has not been set" do
         expect(described_class).to receive(:default_name).and_return :rugged
         expect(described_class.provider).to eq(R10K::Git::Rugged)

data/spec/unit/settings_spec.rb

@@ -129,6 +129,18 @@ describe R10K::Settings do
         expect { subject.evaluate('puppet_path' => '/nonexistent') }.to raise_error(R10K::Settings::Collection::ValidationError)
       end
     end
+
+    describe 'puppet_conf' do
+      it 'when file raises no error' do
+        allow(File).to receive(:readable?).with('/nonexistent').and_return(true)
+        expect { subject.evaluate('puppet_conf' => '/nonexistent') }.not_to raise_error
+      end
+
+      it 'when not file raises error' do
+        allow(File).to receive(:readable?).with('/nonexistent').and_return(false)
+        expect { subject.evaluate('puppet_conf' => '/nonexistent') }.to raise_error(R10K::Settings::Collection::ValidationError)
+      end
+    end
   end
 
   describe "global settings" do

data/spec/unit/source/git_spec.rb

@@ -99,7 +99,11 @@ describe R10K::Source::Git do
 
   describe "filtering branches with command" do
     let(:branches) { ['master', 'development', 'production'] }
-    let(:filter_command) { 'sh -c "[ $R10K_BRANCH != development ]"' }
+    if R10K::Util::Platform.windows?
+      let(:filter_command) { 'powershell.exe if ($env:R10K_BRANCH.equals(\"development\")) {exit 1} else {exit 0}' }
+    else
+      let(:filter_command) { 'sh -c "[ $R10K_BRANCH != development ]"' }
+    end
 
     it "filters branches" do
       expect(subject.filter_branches_by_command(branches, filter_command)).to eq(['master', 'production'])
@@ -109,7 +113,11 @@ describe R10K::Source::Git do
   describe "generate_environments respects filter_command setting" do
     before do
       allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
-      subject.instance_variable_set(:@filter_command, '[ $R10K_BRANCH != master ]')
+      if R10K::Util::Platform.windows?
+        subject.instance_variable_set(:@filter_command, 'powershell.exe if ($env:R10K_BRANCH.equals(\"master\")) {exit 1} else {exit 0}')
+      else
+        subject.instance_variable_set(:@filter_command, '[ $R10K_BRANCH != master ]')
+      end
     end
 
     let(:environments) { subject.generate_environments }
@@ -122,7 +130,11 @@ describe R10K::Source::Git do
   describe "generate_environments respects filter_command setting and name" do
     before do
       allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
-      subject.instance_variable_set(:@filter_command, '[ $R10K_NAME = mysource ]')
+      if R10K::Util::Platform.windows?
+        subject.instance_variable_set(:@filter_command, 'powershell.exe if ($env:R10K_NAME.equals(\"mysource\")) {exit 0} else {exit 1}')
+      else
+        subject.instance_variable_set(:@filter_command, '[ $R10K_NAME = mysource ]')
+      end
     end
 
     let(:environments) { subject.generate_environments }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -204,6 +204,7 @@ files:
 - ".github/pull_request_template.md"
 - ".github/workflows/docker.yml"
 - ".github/workflows/release.yml"
+- ".github/workflows/rspec_tests.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.mkd