r10k 3.6.0 → 3.9.2

data/doc/dynamic-environments/usage.mkd

@@ -18,16 +18,16 @@ Command line invocation
 
 Recursively update all environments:
 
-    r10k deploy environment --puppetfile
+    r10k deploy environment --modules
 
 The simplest way to use r10k is by simply updating all environments and modules
 and takes the brute force approach of "update everything, ever." When this
 command is run r10k will update all sources, create new environments and delete
 old environments, and recursively update all environment modules specified in
-environment Puppetfiles. While this is the simplest method for running r10k, is
-is also the slowest by a very large degree because it does the maximum possible
-work. This should not be something you run interactively, or use on a regular
-basis.
+environment Puppetfiles, yamldirs, etc. While this is the simplest method for
+running r10k, it is also the slowest by a very large degree because it does the
+maximum possible work. This should not be something you run interactively, or
+use on a regular basis.
 
 - - -
 
@@ -55,7 +55,7 @@ only the environment itself will be updated.
 
 Update a single environment and force an update of modules:
 
-    r10k deploy environment my_working_environment --puppetfile
+    r10k deploy environment my_working_environment --modules
 
 This will update the given environment and update all contained modules. This is
 useful if you want to make sure that a given environment is fully up to date.
@@ -64,13 +64,14 @@ useful if you want to make sure that a given environment is fully up to date.
 
 Update a single environment and specify a default branch override:
 
-    r10k deploy environment my_working_environment --puppetfile --default-branch-override default_branch_override
+    r10k deploy environment my_working_environment --modules --default-branch-override default_branch_override
 
-This will update the given environment and update all contained modules, overrideing 
-the :default_branch entry in the Puppetfile of each module. This is used primarily to allow
+This will update the given environment and update all contained modules, overriding
+the :default_branch entry in the Puppetfile of each module. If the specified override branch is not
+found, it will fall back to the normal default branch and attempt to use that. This is used primarily to allow
 automated r10k solutions using the control_branch pattern with a temporary branch deployment to 
-ensure the deployment is pushed to the correct module repository branch. Note that the :default_branch
-is only ever utilized if the desired ref cannot be located.
+ensure the deployment is pushed to the correct module repository branch. Note that the :default_branch and its
+override are only ever used if the specific desired ref cannot be located.
 
 ### Deploying modules
 

data/doc/puppetfile.mkd

@@ -109,11 +109,19 @@ latest version available.
 
     mod 'puppetlabs/apache', :latest
 
+An explicit type and/or version can be specified using the standard interface,
+`:type` and `:version`. The `:source` parameter is not supported for individual
+forge modules and will be ignored.
+
+    mod 'puppetlabs/apache',
+      type:    'forge',
+      version: '6.0.0'
+
 ### Git
 
 Git repositories that contain a Puppet module can be cloned and used as modules.
 When Git is used, the module version can be specified by using `:ref`, `:tag`,
-`:commit`, and `:branch`.
+`:commit`, `:branch`, or the standard interface parameter `:version`.
 
 When a module is installed using `:ref`, r10k uses some simple heuristics to
 determine the type of Git object that should be checked out. This can be used
@@ -153,6 +161,13 @@ mod 'apache',
 mod 'apache',
   :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
   :branch => 'docs_experiment'
+
+# Install puppetlabs/apache and use standard interface parameters pinned to the
+# '2098a17' commit.
+mod 'puppetlabs-apache',
+  type:    'git',
+  source:  'https://github.com/puppetlabs/puppetlabs-apache',
+  version: '2098a17'
 ```
 
 #### Control Repo Branch Tracking
@@ -195,8 +210,8 @@ the latest version available in the main SVN repository.
     mod 'apache',
       :svn => 'https://github.com/puppetlabs/puppetlabs-apache/trunk'
 
-If an SVN revision number is specified with `:rev` (or `:revision`), that
-SVN revision will be kept checked out.
+If an SVN revision number is specified with `:rev`, `:revision`, or `:version`,
+that SVN revision will be kept checked out.
 
     mod 'apache',
       :svn => 'https://github.com/puppetlabs/puppetlabs-apache/trunk',
@@ -206,6 +221,11 @@ SVN revision will be kept checked out.
       :svn      => 'https://github.com/puppetlabs/puppetlabs-apache/trunk',
       :revision => '154'
 
+    mod 'apache',
+      type:    'svn',
+      source:  'https://github.com/puppetlabs/puppetlabs-apache/trunk',
+      version: '154'
+
 If the SVN repository requires credentials, you can supply the `:username` and
 `:password` options.
 

data/docker/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gem 'pupperware',
     :git => 'https://github.com/puppetlabs/pupperware.git',
-    :branch => 'master',
+    :branch => 'main',
     :glob => 'gem/*.gemspec'
 
 group :test do

data/docker/Makefile

@@ -5,12 +5,12 @@ vcs_ref := $(shell git rev-parse HEAD)
 build_date := $(shell date -u +%FT%T)
 hadolint_available := $(shell hadolint --help > /dev/null 2>&1; echo $$?)
 hadolint_command := hadolint
-hadolint_container := hadolint/hadolint:latest
+hadolint_container := ghcr.io/hadolint/hadolint:latest
 alpine_version := 3.9
 export BUNDLE_PATH = $(PWD)/.bundle/gems
 export BUNDLE_BIN = $(PWD)/.bundle/bin
 export GEMFILE = $(PWD)/Gemfile
-export DOCKER_BUILDKIT = 1
+export DOCKER_BUILDKIT ?= 1
 
 ifeq ($(IS_RELEASE),true)
 	VERSION ?= $(shell echo $(git_describe) | sed 's/-.*//')
@@ -50,8 +50,9 @@ endif
 
 build: prep
 	docker pull alpine:$(alpine_version)
-	docker build \
+	docker buildx build \
 		${DOCKER_BUILD_FLAGS} \
+		--load \
 		--build-arg alpine_version=$(alpine_version) \
 		--build-arg vcs_ref=$(vcs_ref) \
 		--build-arg build_date=$(build_date) \

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/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/base.rb

@@ -10,6 +10,16 @@ module R10K
 
       attr_accessor :settings
 
+      # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
+      #   and managed by the SetOps mixin within the Action::Base class.
+      #   Corresponds to the CLI flags and options.
+      # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+      #   collection of the remaining arguments to the CLI invocation (after
+      #   removing flags and options).
+      # @param settings [Hash] A hash of configuration loaded from the relevant
+      #   config (r10k.yaml).
+      #
+      # @note All arguments will be required in the next major version
       def initialize(opts, argv, settings = {})
         @opts = opts
         @argv = argv

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

@@ -9,17 +9,48 @@ module R10K
 
         include R10K::Action::Deploy::DeployHelpers
 
+        # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
+        #   and managed by the SetOps mixin within the Action::Base class.
+        #   Corresponds to the CLI flags and options.
+        # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+        #   collection of the remaining arguments to the CLI invocation (after
+        #   removing flags and options).
+        # @param settings [Hash] A hash of configuration loaded from the relevant
+        #   config (r10k.yaml).
+        #
+        # @note All arguments will be required in the next major version
+        def initialize(opts, argv, settings = {})
+          super
+
+          @settings = @settings.merge({
+            overrides: {
+              environments: {
+                preload_environments: @fetch,
+                requested_environments: @argv.map { |arg| arg.gsub(/\W/, '_') }
+              },
+              modules: {},
+              output: {
+                format: @format,
+                trace: @trace,
+                detail: @detail
+              },
+              purging: {}
+            }
+          })
+        end
+
         def call
           expect_config!
           deployment = R10K::Deployment.new(@settings)
 
-          if @fetch
+          if @settings.dig(:overrides, :environments, :preload_environments)
             deployment.preload!
+            deployment.validate!
           end
 
-          output = { :sources => deployment.sources.map { |source| source_info(source, @argv) } }
+          output = { :sources => deployment.sources.map { |source| source_info(source, @settings.dig(:overrides, :environments, :requested_environments)) } }
 
-          case @format
+          case @settings.dig(:overrides, :output, :format)
           when 'json' then json_format(output)
           else yaml_format(output)
           end
@@ -27,7 +58,7 @@ module R10K
           # exit 0
           true
         rescue => e
-          logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+          logger.error R10K::Errors::Formatting.format_exception(e, @settings.dig(:overrides, :output, :trace))
           false
         end
 
@@ -43,7 +74,7 @@ module R10K
           puts output.to_yaml
         end
 
-        def source_info(source, argv=[])
+        def source_info(source, requested_environments = [])
           source_info = {
             :name => source.name,
             :basedir => source.basedir,
@@ -52,28 +83,30 @@ module R10K
           source_info[:prefix] = source.prefix if source.prefix
           source_info[:remote] = source.remote if source.respond_to?(:remote)
 
-          env_list = source.environments.select { |env| argv.empty? || argv.include?(env.name) }
+          select_all_envs = requested_environments.empty?
+          env_list = source.environments.select { |env| select_all_envs || requested_environments.include?(env.name) }
           source_info[:environments] = env_list.map { |env| environment_info(env) }
 
           source_info
         end
 
         def environment_info(env)
-          if !@puppetfile && !@detail
+          modules = @settings.dig(:overrides, :environments, :deploy_modules)
+          if !modules && !@settings.dig(:overrides, :output, :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
         end
 
         def module_info(mod)
-          if @detail
+          if @settings.dig(:overrides, :output, :detail)
             { :name => mod.title, :properties => mod.properties }
           else
             mod.title
@@ -81,7 +114,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