r10k 3.8.0 → 3.9.0

data/docker/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3.7'
+
+services:
+  r10k_check:
+    image: ${R10K_IMAGE:-puppet/r10k}
+    environment:
+      - PUPPERWARE_ANALYTICS_ENABLED=${PUPPERWARE_ANALYTICS_ENABLED:-false}
+    command: 'puppetfile check --verbose --trace --puppetfile test/Puppetfile'
+    volumes:
+      - ${SPEC_DIRECTORY}/fixtures:/home/puppet/test
+
+  r10k_install:
+    image: ${R10K_IMAGE:-puppet/r10k}
+    environment:
+      - PUPPERWARE_ANALYTICS_ENABLED=${PUPPERWARE_ANALYTICS_ENABLED:-false}
+    command: 'puppetfile install --verbose --trace --puppetfile test/Puppetfile'
+    volumes:
+      - ${SPEC_DIRECTORY}/fixtures:/home/puppet/test

data/docker/r10k/Dockerfile

@@ -49,7 +49,7 @@ COPY --from=build /workspace/r10k.gem /
 SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
 # ignore apk and gem pinning
 # hadolint ignore=DL3018,DL3028
-RUN chmod a+x /adduser.sh /docker-entrypoint.sh && \
+RUN chmod a+x /adduser.sh /docker-entrypoint.sh /docker-entrypoint.d/*.sh && \
 # Add a puppet user to run r10k as for consistency with puppetserver
     /adduser.sh && \
     chown -R puppet: /docker-entrypoint.d /docker-entrypoint.sh && \

data/docker/r10k/docker-entrypoint.sh

@@ -4,7 +4,6 @@ set -e
 
 for f in /docker-entrypoint.d/*.sh; do
   # Don't print out any messages here since this is a CLI container
-  chmod +x "$f"
   "$f"
 done
 

data/docker/r10k/release.Dockerfile

@@ -38,7 +38,7 @@ LABEL org.label-schema.version="$version" \
 SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
 # ignore apk and gem pinning
 # hadolint ignore=DL3018,DL3028
-RUN chmod a+x /adduser.sh /docker-entrypoint.sh && \
+RUN chmod a+x /adduser.sh /docker-entrypoint.sh /docker-entrypoint.d/*.sh && \
     /adduser.sh && \
     chown -R puppet: /docker-entrypoint.d /docker-entrypoint.sh && \
     apk add --no-cache ruby openssh-client git ruby-rugged curl ruby-dev make gcc musl-dev && \

data/docker/spec/dockerfile_spec.rb

@@ -1,43 +1,37 @@
 require 'rspec/core'
 require 'fileutils'
 require 'open3'
+include Pupperware::SpecHelpers
 
-SPEC_DIRECTORY = File.dirname(__FILE__)
+ENV['SPEC_DIRECTORY'] = File.dirname(__FILE__)
+# unifies volume naming
+ENV['COMPOSE_PROJECT_NAME'] ||= 'r10k'
 
-describe 'r10k container' do
-  include Pupperware::SpecHelpers
-  def run_r10k(command)
-    run_command("docker run --detach \
-                   --volume #{File.join(SPEC_DIRECTORY, 'fixtures')}:/home/puppet/test \
-                   #{@image} #{command} \
-                   --verbose \
-                   --trace \
-                   --puppetfile test/Puppetfile")
-  end
-
-  before(:all) do
-    @image = require_test_image
+RSpec.configure do |c|
+  c.before(:suite) do
+    ENV['R10K_IMAGE'] = require_test_image
+    pull_images(['r10k_check','r10k_install'])
+    teardown_cluster()
+    # no certs to preload, but if the suite adds puppetserver, be explicit
+    docker_compose_up(preload_certs: true)
   end
 
-  after(:all) do
-    FileUtils.rm_rf(File.join(SPEC_DIRECTORY, 'fixtures', 'modules'))
-  end
-
-  it 'should validate the Puppetfile' do
-    result = run_r10k('puppetfile check')
-    container = result[:stdout].chomp
-    wait_on_container_exit(container)
-    expect(get_container_exit_code(container)).to eq(0)
-    emit_log(container)
-    teardown_container(container)
+  c.after(:suite) do
+    teardown_cluster()
+    FileUtils.rm_rf(File.join(ENV['SPEC_DIRECTORY'], 'fixtures', 'modules'))
   end
+end
 
-  it 'should install the Puppetfile' do
-    result = run_r10k('puppetfile install')
-    container = result[:stdout].chomp
-    wait_on_container_exit(container)
-    expect(get_container_exit_code(container)).to eq(0)
-    emit_log(container)
-    teardown_container(container)
+describe 'r10k container' do
+  {
+    'r10k_check': 'validate',
+    'r10k_install': 'install',
+  }.each do |container, op|
+    it "should #{op} the Puppetfile" do
+      container = get_service_container(container)
+      wait_on_container_exit(container)
+      expect(get_container_exit_code(container)).to eq(0)
+      emit_log(container)
+    end
   end
 end

data/integration/tests/git_source/git_source_repeated_remote.rb

@@ -30,11 +30,11 @@ CONF
 puppetfile = <<-EOS
 mod 'prod_apache',
   :git => 'git://github.com/puppetlabs/puppetlabs-apache.git',
-  :branch => 'master'
+  :tag => 'v6.0.0'
 
 mod 'test_apache',
   :git => 'git://github.com/puppetlabs/puppetlabs-apache.git',
-  :branch => 'master'
+  :tag => 'v6.0.0'
 EOS
 
 teardown do

data/integration/tests/user_scenario/basic_workflow/multi_env_custom_forge_git_module.rb

@@ -27,7 +27,8 @@ stdlib_notify_message_regex = /The test message is:.*one.*=>.*1.*two.*=>.*bats.*
 puppet_file = <<-PUPPETFILE
 mod "puppetlabs/motd"
 mod 'puppetlabs/stdlib',
-  :git => 'git://github.com/puppetlabs/puppetlabs-stdlib.git'
+  :git => 'git://github.com/puppetlabs/puppetlabs-stdlib.git',
+  :tag => 'v7.0.1'
 PUPPETFILE
 
 puppet_file_path = File.join(git_environments_path, 'Puppetfile')

data/integration/tests/user_scenario/basic_workflow/multi_env_custom_forge_git_module_static.rb

@@ -31,7 +31,8 @@ puppet_file = <<-PUPPETFILE
 moduledir '#{@module_path}'
 mod "puppetlabs/motd"
 mod 'puppetlabs/stdlib',
-  :git => 'git://github.com/puppetlabs/puppetlabs-stdlib.git'
+  :git => 'git://github.com/puppetlabs/puppetlabs-stdlib.git',
+  :tag => 'v7.0.1'
 PUPPETFILE
 
 puppet_file_path = File.join(git_environments_path, 'Puppetfile')

data/integration/tests/user_scenario/basic_workflow/multi_source_custom_forge_git_module.rb

@@ -65,7 +65,7 @@ env_structs = {:production => GitEnv.new('/git_repos',
                                          '/git_repos_alt/environments_alt.git',
                                          '/root/environments_alt',
                                          '/root/environments_alt/Puppetfile',
-                                         'mod "puppetlabs/stdlib", :git => "git://github.com/puppetlabs/puppetlabs-stdlib.git"',
+                                         'mod "puppetlabs/stdlib", :git => "git://github.com/puppetlabs/puppetlabs-stdlib.git", :tag => "v7.0.1"',
                                          '/root/environments_alt/manifests/site.pp',
                                          create_site_pp(master_certname, stage_env_manifest)
                                         ),

data/integration/tests/user_scenario/basic_workflow/single_env_custom_forge_git_module.rb

@@ -28,7 +28,8 @@ notify_message_regex = /I am in the production environment/
 puppet_file = <<-PUPPETFILE
 mod "puppetlabs/motd"
 mod 'puppetlabs/inifile',
-  :git => 'git://github.com/puppetlabs/puppetlabs-inifile'
+  :git => 'git://github.com/puppetlabs/puppetlabs-inifile',
+  :tag => 'v5.0.1'
 PUPPETFILE
 
 puppet_file_path = File.join(git_environments_path, 'Puppetfile')

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

@@ -59,14 +59,14 @@ module R10K
         end
 
         def environment_info(env)
-          if !@puppetfile && !@detail
+          if !@modules && !@detail
             env.dirname
           else
             env_info = env.info.merge({
               :status => (env.status rescue nil),
             })
 
-            env_info[:modules] = env.modules.map { |mod| module_info(mod) } if @puppetfile
+            env_info[:modules] = env.modules.map { |mod| module_info(mod) } if @modules
 
             env_info
           end
@@ -81,7 +81,13 @@ module R10K
         end
 
         def allowed_initialize_opts
-          super.merge(puppetfile: :self, detail: :self, format: :self, fetch: :self)
+          super.merge({
+            puppetfile: :modules,
+            modules: :self,
+            detail: :self,
+            format: :self,
+            fetch: :self
+          })
         end
       end
     end

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

@@ -18,7 +18,8 @@ module R10K
         def initialize(opts, argv, settings = nil)
           settings ||= {}
           @purge_levels = settings.fetch(:deploy, {}).fetch(:purge_levels, [])
-          @user_purge_whitelist = settings.fetch(:deploy, {}).fetch(:purge_whitelist, [])
+          @user_purge_allowlist = read_purge_allowlist(settings.fetch(:deploy, {}).fetch(:purge_whitelist, []),
+                                                       settings.fetch(:deploy, {}).fetch(:purge_allowlist, []))
           @generate_types = settings.fetch(:deploy, {}).fetch(:generate_types, false)
 
           super
@@ -43,6 +44,23 @@ module R10K
 
         private
 
+        def read_purge_allowlist (whitelist, allowlist)
+          whitelist_has_content = !whitelist.empty?
+          allowlist_has_content = !allowlist.empty?
+          case
+          when whitelist_has_content == false && allowlist_has_content == false
+            []
+          when whitelist_has_content && allowlist_has_content
+            raise R10K::Error.new "Values found for both purge_whitelist and purge_allowlist. Setting " <<
+                                  "purge_whitelist is deprecated, please only use purge_allowlist."
+          when allowlist_has_content
+            allowlist
+          else
+            logger.warn "Setting purge_whitelist is deprecated; please use purge_allowlist instead."
+            whitelist
+          end
+        end
+
         def visit_deployment(deployment)
           # Ensure that everything can be preloaded. If we cannot preload all
           # sources then we can't fully enumerate all environments which
@@ -95,7 +113,7 @@ module R10K
           environment.sync
           logger.info _("Environment %{env_dir} is now at %{env_signature}") % {env_dir: environment.dirname, env_signature: environment.signature}
 
-          if status == :absent || @puppetfile
+          if status == :absent || @modules
             if status == :absent
               logger.debug(_("Environment %{env_dir} is new, updating all modules") % {env_dir: environment.dirname})
             end
@@ -110,7 +128,7 @@ module R10K
           if @purge_levels.include?(:environment)
             if @visit_ok
               logger.debug("Purging unmanaged content for environment '#{environment.dirname}'...")
-              environment.purge!(:recurse => true, :whitelist => environment.whitelist(@user_purge_whitelist))
+              environment.purge!(:recurse => true, :whitelist => environment.whitelist(@user_purge_allowlist))
             else
               logger.debug("Not purging unmanaged content for environment '#{environment.dirname}' due to prior deploy failures.")
             end
@@ -145,17 +163,20 @@ module R10K
         end
 
         def write_environment_info!(environment, started_at, success)
-          module_deploys = []
-          begin
-            environment.modules.each do |mod|
-              name = mod.name
-              version = mod.version
-              sha = mod.repo.head rescue nil
-              module_deploys.push({:name => name, :version => version, :sha => sha})
+          module_deploys =
+            begin
+              environment.modules.map do |mod|
+                props = mod.properties
+                {
+                  name: mod.name,
+                  version: props[:expected],
+                  sha: props[:type] == :git ? props[:actual] : nil
+                }
+              end
+            rescue
+              logger.debug("Unable to get environment module deploy data for .r10k-deploy.json at #{environment.path}")
+              []
             end
-          rescue
-            logger.debug("Unable to get environment module deploy data for .r10k-deploy.json at #{environment.path}")
-          end
 
           # make this file write as atomic as possible in pure ruby
           final   = "#{environment.path}/.r10k-deploy.json"
@@ -183,7 +204,8 @@ module R10K
         end
 
         def allowed_initialize_opts
-          super.merge(puppetfile: :self,
+          super.merge(puppetfile: :modules,
+                      modules: :self,
                       cachedir: :self,
                       'no-force': :self,
                       'generate-types': :self,

data/lib/r10k/cli/deploy.rb

@@ -55,7 +55,7 @@ branches.
 
 Environments can provide a Puppetfile at the root of the directory to deploy
 independent Puppet modules. To recursively deploy an environment, pass the
-`--puppetfile` flag to the command.
+`--modules` flag to the command.
 
 **NOTE**: If an environment has a Puppetfile when it is instantiated a
 recursive update will be forced. It is assumed that environments are dependent
@@ -63,7 +63,8 @@ on modules specified in the Puppetfile and an update will be automatically
 scheduled. On subsequent deployments, Puppetfile deployment will default to off.
           DESCRIPTION
 
-          flag :p, :puppetfile, 'Deploy modules from a puppetfile'
+          flag :p, :puppetfile, 'Deploy modules (deprecated, use -m)'
+          flag :m, :modules, 'Deploy modules'
           option nil, :'default-branch-override', 'Specify a branchname to override the default branch in the puppetfile',
                  argument: :required
 
@@ -100,7 +101,8 @@ try to deploy the given module names in all environments.
           usage 'display'
           summary 'Display environments and modules in the deployment'
 
-          flag :p, :puppetfile, 'Display Puppetfile modules'
+          flag :p, :puppetfile, 'Display modules (deprecated, use -m)'
+          flag :m, :modules, 'Display modules'
           flag nil, :detail, 'Display detailed information'
           flag nil, :fetch, 'Update available environment lists from all remote sources'
           option nil, :format, 'Display output in a specific format. Valid values: json, yaml. Default: yaml',

data/lib/r10k/environment/base.rb

@@ -43,7 +43,7 @@ class R10K::Environment::Base
     @basedir = basedir
     @dirname = dirname
     @options = options
-    @puppetfile_name = options[:puppetfile_name]
+    @puppetfile_name = options.delete(:puppetfile_name)
 
     @full_path = File.join(@basedir, @dirname)
     @path = Pathname.new(File.join(@basedir, @dirname))

data/lib/r10k/environment/git.rb

@@ -27,6 +27,8 @@ class R10K::Environment::Git < R10K::Environment::WithModules
   #   @return [R10K::Git::StatefulRepository] The git repo backing this environment
   attr_reader :repo
 
+  include R10K::Util::Setopts
+
   # Initialize the given Git environment.
   #
   # @param name [String] The unique name describing this environment.
@@ -38,8 +40,21 @@ class R10K::Environment::Git < R10K::Environment::WithModules
   # @param options [String] :ref The git reference to use for this environment
   def initialize(name, basedir, dirname, options = {})
     super
-    @remote = options[:remote]
-    @ref    = options[:ref]
+    setopts(options, {
+      # Standard option interface
+      :version => :ref,
+      :source  => :remote,
+      :type    => ::R10K::Util::Setopts::Ignore,
+
+      # Type-specific options
+      :ref     => :self,
+      :remote  => :self,
+
+    }, raise_on_unhandled: false)
+    # TODO: in r10k 4.0.0, a major version bump, stop allowing garbage options.
+    # We only allow them now, here, on this object, because prior to adopting
+    # setopts in the constructor, this object type didn't do any validation
+    # checking of options passed, and would permit garbage parameters.
 
     @repo = R10K::Git::StatefulRepository.new(@remote, @basedir, @dirname)
   end

data/lib/r10k/environment/name.rb

@@ -12,13 +12,13 @@ module R10K
       INVALID_CHARACTERS = %r[\W]
 
       def initialize(name, opts)
-        @name   = name
-        @opts   = opts
-
         @source  = opts[:source]
         @prefix  = opts[:prefix]
         @invalid = opts[:invalid]
 
+        @name = derive_name(name, opts[:strip_component])
+        @opts = opts
+
         case @invalid
         when 'correct_and_warn'
           @validate = true
@@ -71,8 +71,26 @@ module R10K
 
       private
 
-      def derive_prefix(source,prefix)
+      def derive_name(name, strip_component)
+        return name unless strip_component
+
+        unless strip_component.is_a?(String)
+          raise _('Improper configuration value given for strip_component setting in %{src} source. ' \
+                  'Value must be a string, a /regex/, false, or omitted. Got "%{val}" (%{type})' \
+                  % {src: @source, val: strip_component, type: strip_component.class})
+        end
 
+        if %r{^/.*/$}.match(strip_component)
+          regex = Regexp.new(strip_component[1..-2])
+          name.gsub(regex, '')
+        elsif name.start_with?(strip_component)
+          name[strip_component.size..-1]
+        else
+          name
+        end
+      end
+
+      def derive_prefix(source,prefix)
         if prefix == true
           "#{source}_"
         elsif prefix.is_a? String

data/lib/r10k/environment/svn.rb

@@ -44,8 +44,17 @@ class R10K::Environment::SVN < R10K::Environment::Base
   # @option options [String] :password The SVN password
   def initialize(name, basedir, dirname, options = {})
     super
+    setopts(options, {
+      # Standard option interface
+      :source  => :remote,
+      :version => :expected_revision,
+      :type    => ::R10K::Util::Setopts::Ignore,
 
-    setopts(options, {:remote => :self, :username => :self, :password => :self, :puppetfile_name => :self })
+      # Type-specific options
+      :remote => :self,
+      :username => :self,
+      :password => :self,
+    })
 
     @working_dir = R10K::SVN::WorkingDir.new(Pathname.new(@full_path), :username => @username, :password => @password)
   end
@@ -61,7 +70,7 @@ class R10K::Environment::SVN < R10K::Environment::Base
     if @working_dir.is_svn?
       @working_dir.update
     else
-      @working_dir.checkout(@remote)
+      @working_dir.checkout(@remote, @expected_revision)
     end
     @synced = true
   end