r10k 3.9.3 → 3.10.0

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.9.3'
+  VERSION = '3.10.0'
 end

data/locales/r10k.pot

@@ -6,11 +6,11 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.4.1-231-g5574915\n"
+"Project-Id-Version: r10k 3.9.3-10-gfedc81a\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2021-05-10 23:18+0000\n"
-"PO-Revision-Date: 2021-05-10 23:18+0000\n"
+"POT-Creation-Date: 2021-07-07 21:13+0000\n"
+"PO-Revision-Date: 2021-07-07 21:13+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -31,31 +31,31 @@ msgstr ""
 msgid "Reason: %{write_lock}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:109
+#: ../lib/r10k/action/deploy/environment.rb:112
 msgid "Environment(s) \\'%{environments}\\' cannot be found in any source and will not be deployed."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:139
+#: ../lib/r10k/action/deploy/environment.rb:145
 msgid "Environment %{env_dir} does not match environment name filter, skipping"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:147
+#: ../lib/r10k/action/deploy/environment.rb:153
 msgid "Deploying environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:150
+#: ../lib/r10k/action/deploy/environment.rb:156
 msgid "Environment %{env_dir} is now at %{env_signature}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:154
+#: ../lib/r10k/action/deploy/environment.rb:160
 msgid "Environment %{env_dir} is new, updating all modules"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:78
+#: ../lib/r10k/action/deploy/module.rb:81
 msgid "Only updating modules in environment(s) %{opt_env} skipping environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:80
+#: ../lib/r10k/action/deploy/module.rb:83
 msgid "Updating modules %{modules} in environment %{env_path}"
 msgstr ""
 
@@ -75,15 +75,15 @@ msgstr ""
 msgid "No config file explicitly given and no default config file could be found, default settings will be used."
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:13
+#: ../lib/r10k/content_synchronizer.rb:27
 msgid "Updating modules with %{pool_size} threads"
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:24
+#: ../lib/r10k/content_synchronizer.rb:37
 msgid "Error during concurrent deploy of a module: %{message}"
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:52
+#: ../lib/r10k/content_synchronizer.rb:75
 msgid "Module thread %{id} exiting: %{message}"
 msgstr ""
 
@@ -95,7 +95,7 @@ msgstr ""
 msgid "Unable to load sources; the supplied configuration does not define the 'sources' key"
 msgstr ""
 
-#: ../lib/r10k/environment/base.rb:65 ../lib/r10k/environment/base.rb:81 ../lib/r10k/environment/base.rb:90 ../lib/r10k/source/base.rb:69
+#: ../lib/r10k/environment/base.rb:68 ../lib/r10k/environment/base.rb:84 ../lib/r10k/environment/base.rb:93 ../lib/r10k/source/base.rb:83
 msgid "%{class} has not implemented method %{method}"
 msgstr ""
 
@@ -103,15 +103,15 @@ msgstr ""
 msgid "Improper configuration value given for strip_component setting in %{src} source. Value must be a string, a /regex/, false, or omitted. Got \"%{val}\" (%{type})"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:60
+#: ../lib/r10k/environment/with_modules.rb:57
 msgid "Environment and %{src} both define the \"%{name}\" module"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:61
+#: ../lib/r10k/environment/with_modules.rb:58
 msgid "#{msg_error}. The %{src} definition will be ignored"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:71
+#: ../lib/r10k/environment/with_modules.rb:68
 msgid "Unexpected value for `module_conflicts` setting in %{env} environment: %{val}"
 msgstr ""
 
@@ -331,11 +331,15 @@ msgstr ""
 msgid "Module name (%{title}) must match either 'modulename' or 'owner/modulename'"
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:88 ../lib/r10k/module/forge.rb:117
+#: ../lib/r10k/module/forge.rb:89
+msgid "The module %{title} does not appear to have any published releases, cannot determine latest version."
+msgstr ""
+
+#: ../lib/r10k/module/forge.rb:92 ../lib/r10k/module/forge.rb:121
 msgid "The module %{title} does not exist on %{url}."
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:192
+#: ../lib/r10k/module/forge.rb:196
 msgid "Forge module names must match 'owner/modulename', instead got #{title}"
 msgstr ""
 
@@ -371,7 +375,7 @@ msgstr ""
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:276
+#: ../lib/r10k/puppetfile.rb:285
 msgid "unrecognized declaration '%{method}'"
 msgstr ""
 
@@ -454,27 +458,27 @@ msgid ""
 "Returned: %{data}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:77
+#: ../lib/r10k/source/git.rb:75
 msgid "Fetching '%{remote}' to determine current branches."
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:80
+#: ../lib/r10k/source/git.rb:78
 msgid "Unable to determine current branches for Git source '%{name}' (%{basedir})"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:110
+#: ../lib/r10k/source/git.rb:113
 msgid "Environment %{env_name} contained non-word characters, correcting name to %{corrected_env_name}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:119
+#: ../lib/r10k/source/git.rb:122
 msgid "Environment %{env_name} contained non-word characters, ignoring it."
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:138 ../lib/r10k/source/svn.rb:113
+#: ../lib/r10k/source/git.rb:141 ../lib/r10k/source/svn.rb:115
 msgid "Branch %{branch} filtered out by ignore_branch_prefixes %{ibp}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:149
+#: ../lib/r10k/source/git.rb:152
 msgid "Branch `%{name}:%{branch}` filtered out by filter_command %{cmd}"
 msgstr ""
 
@@ -518,23 +522,23 @@ msgstr ""
 msgid "pe_license feature is not available, PE only Puppet modules will not be downloadable."
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:52
-msgid "Not purging %{item} due to internal exclusion match: %{exclusion_match}"
+#: ../lib/r10k/util/purgeable.rb:87
+msgid "Not purging %{path} due to internal exclusion match: %{exclusion_match}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:54
-msgid "Not purging %{item} due to whitelist match: %{whitelist_match}"
+#: ../lib/r10k/util/purgeable.rb:89
+msgid "Not purging %{path} due to whitelist match: %{allowlist_match}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:71
+#: ../lib/r10k/util/purgeable.rb:133
 msgid "No unmanaged contents in %{managed_dirs}, nothing to purge"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:76
+#: ../lib/r10k/util/purgeable.rb:138
 msgid "Removing unmanaged path %{path}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:81
+#: ../lib/r10k/util/purgeable.rb:143
 msgid "Unable to remove unmanaged path: %{path}"
 msgstr ""
 

data/spec/fixtures/unit/action/r10k_forge_auth.yaml

@@ -0,0 +1,4 @@
+---
+forge:
+  baseurl: 'http://private-forge.com'
+  authorization_token: 'faketoken'

data/spec/fixtures/unit/action/r10k_forge_auth_no_url.yaml

@@ -0,0 +1,3 @@
+---
+forge:
+  authorization_token: 'faketoken'

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

@@ -265,6 +265,15 @@ describe R10K::Action::Deploy::Environment do
       describe "deployment purge level" do
         let(:purge_levels) { [:deployment] }
 
+
+        it "updates the source's cache before it purges environments" do
+          deployment.sources.each do |source|
+            expect(source).to receive(:reload!).ordered
+          end
+          expect(deployment).to receive(:purge!).ordered
+          subject.call
+        end
+
         it "only logs about purging deployment" do
           expect(subject).to receive(:visit_environment).and_wrap_original do |original, env, &block|
             expect(env.logger).to_not receive(:debug).with(/purging unmanaged puppetfile content/i)

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

@@ -182,7 +182,7 @@ describe R10K::Action::Deploy::Module do
     subject { described_class.new({ config: '/some/nonexistent/path' }, ['mod1', 'mod2'], {}) }
 
     let(:cache) { instance_double("R10K::Git::Cache", 'sanitized_dirname' => 'foo', 'cached?' => true, 'sync' => true) }
-    let(:repo) { instance_double("R10K::Git::StatefulRepository", cache: cache, resolve: 'main') }
+    let(:repo) { instance_double("R10K::Git::StatefulRepository", cache: cache, resolve: 'main', tracked_paths: []) }
 
     it 'does not sync modules not given' do
       allow(R10K::Deployment).to receive(:new).and_wrap_original do |original, settings, &block|
@@ -202,14 +202,26 @@ describe R10K::Action::Deploy::Module do
       allow_any_instance_of(R10K::Source::Git).to receive(:branch_names).and_return([R10K::Environment::Name.new('first', {})])
 
       expect(subject).to receive(:visit_environment).and_wrap_original do |original, environment, &block|
-        pf = environment.puppetfile
-        expect(pf).to receive(:load) do
-          pf.add_module('mod1', { git: 'git://remote' })
-          pf.add_module('mod2', { git: 'git://remote' })
-          pf.add_module('mod3', { git: 'git://remote' })
+        # For this test we want to have realistic Modules and access to
+        # their internal Repos to validate the sync. Unfortunately, to
+        # do so we do some invasive mocking, effectively implementing
+        # our own R10K::Puppetfile#load. We directly update the Puppetfile's
+        # internal ModuleLoader and then call `load` on it so it will create
+        # the correct loaded_content.
+        puppetfile = environment.puppetfile
+        loader = puppetfile.loader
+        expect(puppetfile).to receive(:load) do
+          loader.add_module('mod1', { git: 'git://remote' })
+          loader.add_module('mod2', { git: 'git://remote' })
+          loader.add_module('mod3', { git: 'git://remote' })
+
+          allow(loader).to receive(:puppetfile_content).and_return('')
+          loaded_content = loader.load
+          puppetfile.instance_variable_set(:@loaded_content, loaded_content)
+          puppetfile.instance_variable_set(:@loaded, true)
         end
 
-        pf.modules.each do |mod|
+        puppetfile.modules.each do |mod|
           if ['mod1', 'mod2'].include?(mod.name)
             expect(mod.should_sync?).to be(true)
           else
@@ -231,7 +243,7 @@ describe R10K::Action::Deploy::Module do
     subject { described_class.new({ config: '/some/nonexistent/path', environment: 'first' }, ['mod1'], {}) }
 
     let(:cache) { instance_double("R10K::Git::Cache", 'sanitized_dirname' => 'foo', 'cached?' => true, 'sync' => true) }
-    let(:repo) { instance_double("R10K::Git::StatefulRepository", cache: cache, resolve: 'main') }
+    let(:repo) { instance_double("R10K::Git::StatefulRepository", cache: cache, resolve: 'main', tracked_paths: []) }
 
     it 'only syncs to the given environments' do
       allow(R10K::Deployment).to receive(:new).and_wrap_original do |original, settings, &block|
@@ -252,15 +264,27 @@ describe R10K::Action::Deploy::Module do
                                                                                      R10K::Environment::Name.new('second', {})])
 
       expect(subject).to receive(:visit_environment).and_wrap_original do |original, environment, &block|
-        pf = environment.puppetfile
+        puppetfile = environment.puppetfile
 
         if environment.name == 'first'
-          expect(pf).to receive(:load) do
-            pf.add_module('mod1', { git: 'git://remote' })
-            pf.add_module('mod2', { git: 'git://remote' })
+          # For this test we want to have realistic Modules and access to
+          # their internal Repos to validate the sync. Unfortunately, to
+          # do so we do some invasive mocking, effectively implementing
+          # our own R10K::Puppetfile#load. We directly update the Puppetfile's
+          # internal ModuleLoader and then call `load` on it so it will create
+          # the correct loaded_content.
+          loader = puppetfile.loader
+          expect(puppetfile).to receive(:load) do
+            loader.add_module('mod1', { git: 'git://remote' })
+            loader.add_module('mod2', { git: 'git://remote' })
+
+            allow(loader).to receive(:puppetfile_content).and_return('')
+            loaded_content = loader.load
+            puppetfile.instance_variable_set(:@loaded_content, loaded_content)
+            puppetfile.instance_variable_set(:@loaded, true)
           end
 
-          pf.modules.each do |mod|
+          puppetfile.modules.each do |mod|
             if mod.name == 'mod1'
               expect(mod.should_sync?).to be(true)
             else
@@ -269,7 +293,7 @@ describe R10K::Action::Deploy::Module do
             expect(mod).to receive(:sync).and_call_original
           end
         else
-          expect(pf).not_to receive(:load)
+          expect(puppetfile).not_to receive(:load)
         end
 
         original.call(environment, &block)

data/spec/unit/action/runner_spec.rb

@@ -218,42 +218,66 @@ describe R10K::Action::Runner do
   end
 
   describe "configuration authorization" do
-    context "when license is not present" do
-      before(:each) do
-        expect(R10K::Util::License).to receive(:load).and_return(nil)
+    context "settings auth" do
+      it "sets the configured token as the forge authorization header" do
+        options = { config: "spec/fixtures/unit/action/r10k_forge_auth.yaml" }
+        runner = described_class.new(options, %w[args yes], action_class)
+
+        expect(PuppetForge).to receive(:host=).with('http://private-forge.com')
+        expect(PuppetForge::Connection).to receive(:authorization=).with('faketoken')
+        expect(PuppetForge::Connection).to receive(:authorization).and_return('faketoken')
+        expect(R10K::Util::License).not_to receive(:load)
+        runner.setup_settings
+        runner.setup_authorization
       end
 
-      it "does not set authorization header on connection class" do
-        expect(PuppetForge::Connection).not_to receive(:authorization=)
-        runner.setup_authorization
+      it 'errors if no custom forge URL is set' do
+        options = { config: "spec/fixtures/unit/action/r10k_forge_auth_no_url.yaml" }
+        runner = described_class.new(options, %w[args yes], action_class)
+        expect(PuppetForge::Connection).not_to receive(:authorization=).with('faketoken')
+
+        expect { runner.setup_settings }.to raise_error(R10K::Error, /Cannot specify a Forge auth/)
       end
     end
 
-    context "when license is present but invalid" do
-      before(:each) do
-        expect(R10K::Util::License).to receive(:load).and_raise(R10K::Error.new('invalid license'))
-      end
+    context "license auth" do
+      context "when license is not present" do
+        before(:each) do
+          expect(R10K::Util::License).to receive(:load).and_return(nil)
+        end
 
-      it "issues warning to logger" do
-        expect(runner.logger).to receive(:warn).with(/invalid license/)
-        runner.setup_authorization
+        it "does not set authorization header on connection class" do
+          expect(PuppetForge::Connection).not_to receive(:authorization=)
+          runner.setup_authorization
+        end
       end
 
-      it "does not set authorization header on connection class" do
-        expect(PuppetForge::Connection).not_to receive(:authorization=)
-        runner.setup_authorization
-      end
-    end
+      context "when license is present but invalid" do
+        before(:each) do
+          expect(R10K::Util::License).to receive(:load).and_raise(R10K::Error.new('invalid license'))
+        end
 
-    context "when license is present and valid" do
-      before(:each) do
-        mock_license = double('pe-license', :authorization_token => 'test token')
-        expect(R10K::Util::License).to receive(:load).and_return(mock_license)
+        it "issues warning to logger" do
+          expect(runner.logger).to receive(:warn).with(/invalid license/)
+          runner.setup_authorization
+        end
+
+        it "does not set authorization header on connection class" do
+          expect(PuppetForge::Connection).not_to receive(:authorization=)
+          runner.setup_authorization
+        end
       end
 
-      it "sets authorization header on connection class" do
-        expect(PuppetForge::Connection).to receive(:authorization=).with('test token')
-        runner.setup_authorization
+      context "when license is present and valid" do
+        before(:each) do
+          mock_license = double('pe-license', :authorization_token => 'test token')
+          expect(R10K::Util::License).to receive(:load).and_return(mock_license)
+        end
+
+        it "sets authorization header on connection class" do
+          expect(PuppetForge::Connection).to receive(:authorization=).with('test token')
+          runner.setup_authorization
+        end
       end
     end
   end

data/spec/unit/git/cache_spec.rb

@@ -62,4 +62,18 @@ describe R10K::Git::Cache do
       subject.cached?
     end
   end
+
+  describe "dirname sanitization" do
+    it 'sanitizes cache directory name' do
+      expect(subject.sanitized_dirname).to eq('git---some-git-remote')
+    end
+
+    context 'with username and password' do
+      subject { subclass.new('https://"user:pa$$w0rd:@some/git/remote') }
+
+      it 'sanitizes cache directory name' do
+        expect(subject.sanitized_dirname).to eq('https---some-git-remote')
+      end
+    end
+  end
 end

data/spec/unit/module/forge_spec.rb

@@ -104,9 +104,16 @@ describe R10K::Module::Forge do
 
     it "uses the latest version from the forge when the version is :latest" do
       subject = described_class.new('branan/eight_hundred', fixture_modulepath, { version: :latest })
-      expect(subject.v3_module).to receive_message_chain(:current_release, :version).and_return('8.8.8')
+      release = double("Module Release", version: '8.8.8')
+      expect(subject.v3_module).to receive(:current_release).and_return(release).twice
       expect(subject.expected_version).to eq '8.8.8'
     end
+
+    it "throws when there are no available versions" do
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, { version: :latest })
+      expect(subject.v3_module).to receive(:current_release).and_return(nil)
+      expect { subject.expected_version }.to raise_error(PuppetForge::ReleaseNotFound)
+    end
   end
 
   describe "determining the status" do