r10k 3.3.2 → 3.5.1

data/lib/r10k/source/yaml.rb

@@ -0,0 +1,20 @@
+class R10K::Source::Yaml < R10K::Source::Hash
+  R10K::Source.register(:yaml, self)
+
+  def initialize(name, basedir, options = {})
+    config = options[:config] || '/etc/puppetlabs/r10k/environments.yaml'
+
+    begin
+      contents = ::YAML.load_file(config)
+    rescue => e
+      raise ConfigError, _("Couldn't open environments file %{file}: %{err}") % {file: config, err: e.message}
+    end
+
+    # Set the environments key for the parent class to consume
+    options[:environments] = contents
+
+    # All we need to do is supply options with the :environments hash.
+    # The R10K::Source::Hash parent class takes care of the rest.
+    super(name, basedir, options)
+  end
+end

data/lib/r10k/source/yamldir.rb

@@ -0,0 +1,32 @@
+class R10K::Source::Yamldir < R10K::Source::Hash
+  R10K::Source.register(:yamldir, self)
+
+  def initialize(name, basedir, options = {})
+    config = options[:config] || '/etc/puppetlabs/r10k/environments.d'
+
+    unless File.directory?(config)
+      raise R10K::Deployment::Config::ConfigError, _("Error opening %{dir}: config must be a directory") % {dir: config}
+    end
+
+    unless File.readable?(config)
+      raise R10K::Deployment::Config::ConfigError, _("Error opening %{dir}: permission denied") % {dir: config}
+    end
+
+    environment_data = Dir.glob(File.join(config, '*.yaml')).reduce({}) do |memo,path|
+      name = File.basename(path, '.yaml')
+      begin
+        contents = ::YAML.load_file(path)
+      rescue => e
+        raise R10K::Deployment::Config::ConfigError, _("Error loading %{path}: %{err}") % {path: path, err: e.message}
+      end
+      memo.merge({name => contents })
+    end
+
+    # Set the environments key for the parent class to consume
+    options[:environments] = environment_data
+
+    # All we need to do is supply options with the :environments hash.
+    # The R10K::Source::Hash parent class takes care of the rest.
+    super(name, basedir, options)
+  end
+end

data/lib/r10k/util/attempt.rb

@@ -1,7 +1,7 @@
 require 'r10k/logging'
 require 'r10k/errors/formatting'
 require 'r10k/util/setopts'
-require 'colored'
+require 'colored2'
 
 module R10K
   module Util

data/lib/r10k/version.rb

@@ -1,3 +1,6 @@
 module R10K
-  VERSION = '3.3.2'
+  # 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.5.1'
 end

data/locales/r10k.pot

@@ -1,16 +1,16 @@
 # SOME DESCRIPTIVE TITLE.
-# Copyright (C) 2019 Puppet, Inc.
+# Copyright (C) 2020 Puppet, Inc.
 # This file is distributed under the same license as the r10k package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.3.0-7-g6a2159a\n"
+"Project-Id-Version: r10k 3.4.1-20-g8fe925b\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2019-06-14 22:40+0000\n"
-"PO-Revision-Date: 2019-06-14 22:40+0000\n"
+"POT-Creation-Date: 2020-04-28 18:41+0000\n"
+"PO-Revision-Date: 2020-04-28 18:41+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -52,7 +52,7 @@ msgid "Environment %{env_dir} is new, updating all modules"
 msgstr ""
 
 #: ../lib/r10k/action/deploy/environment.rb:143
-msgid "Deploying Puppetfile content %{mod_path}"
+msgid "Deploying %{origin} content %{path}"
 msgstr ""
 
 #: ../lib/r10k/action/deploy/module.rb:49
@@ -107,6 +107,14 @@ msgstr ""
 msgid "%{class} has not implemented method %{method}"
 msgstr ""
 
+#: ../lib/r10k/environment/with_modules.rb:104
+msgid "Puppetfile cannot contain module names defined by environment %{name}"
+msgstr ""
+
+#: ../lib/r10k/environment/with_modules.rb:106
+msgid "Remove the conflicting definitions of the following modules: %{conflicts}"
+msgstr ""
+
 #: ../lib/r10k/feature.rb:27
 msgid "Testing to see if feature %{name} is available."
 msgstr ""
@@ -131,19 +139,19 @@ msgstr ""
 msgid "Proc %{block} for feature %{name} returned %{output}"
 msgstr ""
 
-#: ../lib/r10k/forge/module_release.rb:164
+#: ../lib/r10k/forge/module_release.rb:196
 msgid "Unpacking %{tarball_cache_path} to %{target_dir} (with tmpdir %{tmp_path})"
 msgstr ""
 
-#: ../lib/r10k/forge/module_release.rb:166
+#: ../lib/r10k/forge/module_release.rb:198
 msgid "Valid files unpacked: %{valid_files}"
 msgstr ""
 
-#: ../lib/r10k/forge/module_release.rb:168
+#: ../lib/r10k/forge/module_release.rb:200
 msgid "These files existed in the module's tar file, but are invalid filetypes and were not unpacked: %{invalid_files}"
 msgstr ""
 
-#: ../lib/r10k/forge/module_release.rb:171
+#: ../lib/r10k/forge/module_release.rb:203
 msgid "Symlinks are unsupported and were not unpacked from the module tarball. %{release_slug} contained these ignored symlinks: %{symlinks}"
 msgstr ""
 
@@ -295,19 +303,19 @@ msgstr ""
 msgid "Module %{name} with args %{args} doesn't have an implementation. (Are you using the right arguments?)"
 msgstr ""
 
-#: ../lib/r10k/module/base.rb:105
+#: ../lib/r10k/module/base.rb:110
 msgid "Module name (%{title}) must match either 'modulename' or 'owner/modulename'"
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:70 ../lib/r10k/module/forge.rb:95
+#: ../lib/r10k/module/forge.rb:70 ../lib/r10k/module/forge.rb:99
 msgid "The module %{title} does not exist on %{url}."
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:170
+#: ../lib/r10k/module/forge.rb:174
 msgid "Forge module names must match 'owner/modulename'"
 msgstr ""
 
-#: ../lib/r10k/module/git.rb:92
+#: ../lib/r10k/module/git.rb:97
 msgid "Unhandled options %{unhandled} specified for %{class}"
 msgstr ""
 
@@ -323,35 +331,35 @@ msgstr ""
 msgid "Using Puppetfile '%{puppetfile}'"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:70
+#: ../lib/r10k/puppetfile.rb:71
 msgid "Puppetfile %{path} missing or unreadable"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:80
+#: ../lib/r10k/puppetfile.rb:84
 msgid "Failed to evaluate %{path}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:90
+#: ../lib/r10k/puppetfile.rb:98
 msgid "Puppetfiles cannot contain duplicate module names."
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:92
+#: ../lib/r10k/puppetfile.rb:100
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:179
+#: ../lib/r10k/puppetfile.rb:192
 msgid "Updating modules with %{pool_size} threads"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:190
+#: ../lib/r10k/puppetfile.rb:203
 msgid "Error during concurrent deploy of a module: %{message}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:212
+#: ../lib/r10k/puppetfile.rb:225
 msgid "Module thread %{id} exiting: %{message}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:269
+#: ../lib/r10k/puppetfile.rb:282
 msgid "unrecognized declaration '%{method}'"
 msgstr ""
 
@@ -415,6 +423,25 @@ msgstr ""
 msgid "Setting %{name} requires a URL but '%{value}' could not be parsed as a URL"
 msgstr ""
 
+#: ../lib/r10k/source/exec.rb:10
+msgid "Environment source %{name} missing required parameter: command"
+msgstr ""
+
+#: ../lib/r10k/source/exec.rb:36
+msgid ""
+"Error parsing command output for exec source %{name}:\n"
+"Not valid JSON: %{j_msg}\n"
+"Not valid YAML: %{y_msg}\n"
+"Stdout:\n"
+"%{out}"
+msgstr ""
+
+#: ../lib/r10k/source/exec.rb:44
+msgid ""
+"Environment source %{name} command %{cmd} did not return valid environment data.\n"
+"Returned: %{data}"
+msgstr ""
+
 #: ../lib/r10k/source/git.rb:72
 msgid "Fetching '%{remote}' to determine current branches."
 msgstr ""
@@ -435,6 +462,22 @@ msgstr ""
 msgid "Branch %{branch} filtered out by ignore_branch_prefixes %{ibp}"
 msgstr ""
 
+#: ../lib/r10k/source/yaml.rb:10
+msgid "Couldn't open environments file %{file}: %{err}"
+msgstr ""
+
+#: ../lib/r10k/source/yamldir.rb:8
+msgid "Error opening %{dir}: config must be a directory"
+msgstr ""
+
+#: ../lib/r10k/source/yamldir.rb:12
+msgid "Error opening %{dir}: permission denied"
+msgstr ""
+
+#: ../lib/r10k/source/yamldir.rb:20
+msgid "Error loading %{path}: %{err}"
+msgstr ""
+
 #: ../lib/r10k/svn/working_dir.rb:43
 msgid "Both username and password must be specified"
 msgstr ""

data/r10k.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
 
   s.license  = 'Apache-2.0'
 
-  s.add_dependency 'colored',   '1.2'
-  s.add_dependency 'cri',       '2.15.6'
+  s.add_dependency 'colored2',   '3.1.2'
+  s.add_dependency 'cri', ['>= 2.15.10', '< 3.0.0']
 
   s.add_dependency 'log4r',     '1.1.10'
   s.add_dependency 'multi_json', '~> 1.10'
@@ -31,13 +31,17 @@ Gem::Specification.new do |s|
   s.add_dependency 'puppet_forge', '~> 2.3.0'
 
   s.add_dependency 'gettext-setup', '~>0.24'
+  # These two pins narrow what is allowed by gettext-setup,
+  # to preserver compatability with Ruby 2.4
+  s.add_dependency 'fast_gettext', '~> 1.1.0'
+  s.add_dependency 'gettext', ['>= 3.0.2', '< 3.3.0']
 
   s.add_development_dependency 'rspec', '~> 3.1'
 
   s.add_development_dependency 'rake'
 
   s.add_development_dependency 'yard', '~> 0.9.11'
-  s.add_development_dependency 'minitar', '~> 0.6.1'
+  s.add_development_dependency 'minitar', '~> 0.9.0'
 
   s.files        = %x[git ls-files].split($/)
   s.require_path = 'lib'

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

@@ -369,6 +369,7 @@ describe R10K::Action::Deploy::Environment do
       allow(mock_forge_module_1).to receive(:repo).and_raise(NoMethodError)
 
       fake_env = Fake_Environment.new(@tmp_path, {:name => "my_cool_environment", :signature => "pablo picasso"})
+      allow(fake_env).to receive(:modules).and_return(mock_puppetfile.modules)
       subject.send(:write_environment_info!, fake_env, "2019-01-01 23:23:22 +0000", true)
 
       file_contents = File.read("#{@tmp_path}/.r10k-deploy.json")

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

@@ -25,6 +25,10 @@ describe R10K::Action::Deploy::Module do
     it 'can accept a puppet-path option' do
       described_class.new({ 'puppet-path': '/nonexistent' }, [])
     end
+
+    it 'can accept a cachedir option' do
+      described_class.new({ cachedir: '/nonexistent' }, [])
+    end
   end
 
   describe "with no-force" do
@@ -123,4 +127,13 @@ describe R10K::Action::Deploy::Module do
       expect(subject.instance_variable_get(:@puppet_path)).to eq('/nonexistent')
     end
   end
+
+  describe 'with cachedir' do
+
+    subject { described_class.new({ config: '/some/nonexistent/path', cachedir: '/nonexistent' }, []) }
+
+    it 'sets puppet_path' do
+      expect(subject.instance_variable_get(:@cachedir)).to eq('/nonexistent')
+    end
+  end
 end

data/spec/unit/action/puppetfile/install_spec.rb

@@ -19,7 +19,9 @@ describe R10K::Action::Puppetfile::Install do
 
   describe "installing modules" do
     let(:modules) do
-      Array.new(4, R10K::Module::Base.new('author/modname', "/some/nonexistent/path/modname", nil))
+      (1..4).map do |idx|
+        R10K::Module::Base.new("author/modname#{idx}", "/some/nonexistent/path/modname#{idx}", nil)
+      end
     end
 
     before do

data/spec/unit/action/runner_spec.rb

@@ -94,7 +94,7 @@ describe R10K::Action::Runner do
                         else
                           { "#{conf_path}": override }
                         end
-            expect(global_settings).to receive(:evaluate).with(overrides).and_call_original
+            expect(global_settings).to receive(:evaluate).with(hash_including(overrides)).and_call_original
             runner.call
           end
         end
@@ -109,7 +109,7 @@ describe R10K::Action::Runner do
                         else
                           { "#{conf_path}": override }
                         end
-            expect(global_settings).to receive(:evaluate).with(overrides).and_call_original
+            expect(global_settings).to receive(:evaluate).with(hash_including(overrides)).and_call_original
             runner.call
           end
         end

data/spec/unit/source/exec_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'r10k/source'
+require 'json'
+require 'yaml'
+
+describe R10K::Source::Exec do
+
+  let(:environments_hash) do
+    {
+      'production' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'release-141',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.0'
+          }
+        }
+      },
+      'development' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'master',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.1'
+          }
+        }
+      }
+    }
+  end
+
+  describe 'initialize' do
+    context 'with a valid command' do
+      context 'that produces valid output' do
+        it 'accepts json' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: environments_hash.to_json))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect(source.environments.map(&:name)).to contain_exactly('production', 'development')
+        end
+
+        it 'accepts yaml' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: environments_hash.to_yaml))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect(source.environments.map(&:name)).to contain_exactly('production', 'development')
+        end
+
+      end
+
+      context 'that produces invalid output' do
+        it 'raises an error for non-json, non-yaml data' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: "one:\ntwo\n"))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect { source.environments }.to raise_error(/Error parsing command output/)
+        end
+
+        it 'raises an error for yaml data that is not a hash' do
+          allow_any_instance_of(R10K::Util::Subprocess)
+            .to receive(:execute)
+            .and_return(double('result', stdout: "[one, two]"))
+
+          source = described_class.new('execsource', '/some/nonexistent/dir', command: '/path/to/command')
+          expect { source.environments }.to raise_error(R10K::Error, /Environment source execsource.*did not return valid environment data.*one.*two.*/m)
+        end
+      end
+    end
+  end
+end

data/spec/unit/source/hash_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source::Hash do
+
+  describe '.valid_environments_hash?' do
+    it "rejects strings" do
+      expect(R10K::Source::Hash.valid_environments_hash?('200 OK'))
+        .to eq false
+    end
+  end
+
+  let(:environments_hash) do
+    {
+      'production' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'release-141',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.0'
+          }
+        }
+      },
+      'development' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'master',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.1'
+          }
+        }
+      }
+    }
+  end
+
+  describe "with a prefix" do
+    subject do
+      described_class.new('hashsource', '/some/nonexistent/dir',
+                          prefix: 'prefixed', environments: environments_hash)
+    end
+
+    it "prepends environment names with a prefix" do
+      environments = subject.environments
+      expect(environments[0].dirname).to eq 'prefixed_production'
+      expect(environments[1].dirname).to eq 'prefixed_development'
+    end
+  end
+end