r10k 2.5.2 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eee7199351f477d257169a009b046e2230937312
-  data.tar.gz: ea45b1df75cbdaa6cd72192f703db55b9061bb14
+  metadata.gz: c759d0c0834d72049d5a2757df623f61af4d8789
+  data.tar.gz: 4747b49041fefce181a3ef2cf54f5417261d403e
 SHA512:
-  metadata.gz: c2ca4c25383eec5578394f412313b6e44b5204637b4ac05cd3943bf6526f9e6fca11b6fc23e7961cd630a39133d97d92edd5488627c83af3f78aa443a3833f37
-  data.tar.gz: 99e145a3c22b4bbc7523523800a610e13fed13b46b8c09624c822aeaa774d7f22569752ad337b90d01ac5a5297c7f620d65217bc095da5411419018cc20ff633
+  metadata.gz: 6fc5a03488a7ec604f8f4042049aa739e64d34214818699e10fcbf649fc797cbfc054fdcd4c42c29a1664783660084000cdddbccc16eed59bc14fc6cb3ac9e4f
+  data.tar.gz: 0c4107408660301001ee41bbbbb951646aaabcdd5bb3232d4ce65bc7da536f24fff9e7deef328393cb81f9833fcff35a330b5d41305d318a13421b33f559e864

data/CHANGELOG.mkd

@@ -1,6 +1,22 @@
 CHANGELOG
 =========
 
+2.5.3
+-----
+
+2017/03/31
+
+### Bug Fixes
+
+(#645) Fix undefined method error when r10.yaml empty
+
+(#659)(RK-269) Puppetfile actions acknowledge :branch and :default_branch
+(Thanks to [Chris Cowley](https://github.com/chriscowley) for the report.)
+
+### Changes
+
+(PF-1317) Emit a warning when syncing a deprecated Forge module.
+
 2.5.2
 -----
 

data/doc/dynamic-environments/workflow-guide.mkd

@@ -6,7 +6,7 @@ be customized easily.
 
 This guide assumes that each of your modules is in a separate repository 
 and that the `Puppetfile` is in its own repo called the
-[Control Repo](http://www.jeffmalnick.com/blog/2014/05/16/r10k-control-repos/).
+[Control Repo](http://technoblogic.io/blog/2014/05/16/r10k-control-repos/).
 All module repos have a primary branch of *master* and the Control's primary
 branch is *production*. All changes are made through r10k and no user makes
 manual changes to the environments under **/etc/puppet**.

data/lib/r10k/action/puppetfile/install.rb

@@ -27,6 +27,11 @@ module R10K
 
         def visit_module(mod)
           logger.info _("Updating module %{mod_path}") % {mod_path: mod.path}
+
+          if mod.respond_to?(:desired_ref) && mod.desired_ref == :control_branch
+            logger.warn _("Cannot track control repo branch for content '%{name}' when not part of a 'deploy' action, will use default if available." % {name: mod.name})
+          end
+
           mod.sync(force: false) # Don't force sync for 'puppetfile install' RK-265
         end
 

data/lib/r10k/module/forge.rb

@@ -43,6 +43,10 @@ class R10K::Module::Forge < R10K::Module::Base
   end
 
   def sync(opts={})
+    if deprecated?
+      logger.warn "Puppet Forge module '#{@v3_module.slug}' has been deprecated, visit https://forge.puppet.com/#{@v3_module.slug.tr('-','/')} for more information."
+    end
+
     case status
     when :absent
       install
@@ -88,6 +92,14 @@ class R10K::Module::Forge < R10K::Module::Base
     status == :insync
   end
 
+  def deprecated?
+    begin
+      !@v3_module.deprecated_at.nil?
+    rescue Faraday::ResourceNotFound => e
+      raise PuppetForge::ReleaseNotFound, _("The module %{title} does not exist on %{url}.") % {title: @title, url: PuppetForge::V3::Release.conn.url_prefix}, e.backtrace
+    end
+  end
+
   # Determine the status of the forge module.
   #
   # @return [Symbol] :absent If the directory doesn't exist

data/lib/r10k/module/git.rb

@@ -18,6 +18,11 @@ class R10K::Module::Git < R10K::Module::Base
   #   @return [R10K::Git::StatefulRepository]
   attr_reader :repo
 
+  # @!attribute [r] desired_ref
+  #   @api private
+  #   @return [String]
+  attr_reader :desired_ref
+
   def initialize(title, dirname, args, environment=nil)
     super
 
@@ -50,16 +55,31 @@ class R10K::Module::Git < R10K::Module::Base
   private
 
   def validate_ref(desired, default)
-    if desired && @repo.resolve(desired)
+    if desired && desired != :control_branch && @repo.resolve(desired)
       return desired
     elsif default && @repo.resolve(default)
       return default
     else
+      msg = ["Unable to manage Puppetfile content '%{name}':"]
+      vars = {name: @name}
+
+      if desired == :control_branch
+        msg << "Could not resolve control repo branch"
+      elsif desired
+        msg << "Could not resolve desired ref '%{desired}'"
+        vars[:desired] = desired
+      else
+        msg << "Could not determine desired ref"
+      end
+
       if default
-        raise ArgumentError, _("Unable to manage Puppetfile content '%{name}': Could not resolve desired ref '%{desired}' or default ref '%{default}'") % {name: @name, desired: desired, default: default}
+        msg << "or resolve default ref '%{default}'"
+        vars[:default] = default
       else
-        raise ArgumentError, _("Unable to manage Puppetfile content '%{name}': Could not resolve desired ref '%{desired}' and no default given") % {name: @name, desired: desired}
+        msg << "and no default provided"
       end
+
+      raise ArgumentError, _(msg.join(' ')) % vars
     end
   end
 
@@ -77,12 +97,8 @@ class R10K::Module::Git < R10K::Module::Base
     @desired_ref = ref_opts.find { |key| break options[key] if options.has_key?(key) } || 'master'
     @default_ref = options[:default_branch]
 
-    if @desired_ref == :control_branch
-      if @environment && @environment.respond_to?(:ref)
-        @desired_ref = @environment.ref
-      else
-        raise ArgumentError, _("Cannot track control repo branch from Puppetfile in this context: environment is nil or did not provide a valid ref")
-      end
+    if @desired_ref == :control_branch && @environment && @environment.respond_to?(:ref)
+      @desired_ref = @environment.ref
     end
   end
 end

data/lib/r10k/settings/loader.rb

@@ -69,6 +69,9 @@ module R10K
           raise ConfigError, _("Couldn't load config file: %{error_msg}") % {error_msg: e.message}
         end
 
+        if !contents
+          raise ConfigError, _("File exists at #{path} but doesn't contain any YAML") % {path: path}
+        end
         R10K::Util::SymbolizeKeys.symbolize_keys!(contents, true)
         contents
       end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '2.5.2'
+  VERSION = '2.5.3'
 end

data/spec/unit/module/forge_spec.rb

@@ -2,6 +2,7 @@ require 'r10k/module/forge'
 require 'spec_helper'
 
 describe R10K::Module::Forge do
+  # TODO: make these *unit* tests not depend on a real module on the real Forge :(
 
   include_context 'fail on execution'
 
@@ -59,6 +60,21 @@ describe R10K::Module::Forge do
     end
   end
 
+  context "when a module is deprecated" do
+    subject { described_class.new('puppetlabs/corosync', fixture_modulepath, :latest) }
+
+    it "warns on sync" do
+      allow(subject).to receive(:install)
+
+      logger_dbl = double(Log4r::Logger)
+      allow_any_instance_of(described_class).to receive(:logger).and_return(logger_dbl)
+
+      expect(logger_dbl).to receive(:warn).with(/puppet forge module.*puppetlabs-corosync.*has been deprecated/i)
+
+      subject.sync
+    end
+  end
+
   describe '#expected_version' do
     it "returns an explicitly given expected version" do
       subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')

data/spec/unit/module/git_spec.rb

@@ -205,8 +205,35 @@ describe R10K::Module::Git do
         end
 
         context "when module does not belong to an environment" do
-          it "raises appropriate error" do
-            expect { test_module(branch: :control_branch) }.to raise_error(ArgumentError, /cannot track control.*environment is nil/i)
+          it "leaves desired_ref unchanged" do
+            mod = test_module(branch: :control_branch)
+            expect(mod.desired_ref).to eq(:control_branch)
+          end
+
+          context "when default ref is provided and resolvable" do
+            it "uses default ref" do
+              expect(mock_repo).to receive(:resolve).with('default').and_return('abc123')
+              mod = test_module({branch: :control_branch, default_branch: 'default'})
+
+              expect(mod.properties).to include(expected: 'default')
+            end
+          end
+
+          context "when default ref is provided and not resolvable" do
+            it "raises appropriate error" do
+              expect(mock_repo).to receive(:resolve).with('default').and_return(nil)
+              mod = test_module({branch: :control_branch, default_branch: 'default'})
+
+              expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*could not resolve control repo branch.*or resolve default/i)
+            end
+          end
+
+          context "when default ref is not provided" do
+            it "raises appropriate error" do
+              mod = test_module({branch: :control_branch})
+
+              expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*could not resolve control repo branch.*no default provided/i)
+            end
           end
         end
 
@@ -229,7 +256,7 @@ describe R10K::Module::Git do
               expect(mock_repo).to receive(:resolve).with('default').and_return(nil)
               mod = test_module({branch: :control_branch, default_branch: 'default'}, mock_env)
 
-              expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*could not resolve desired.*or default/i)
+              expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*could not resolve desired.*or resolve default/i)
             end
           end
 
@@ -237,7 +264,7 @@ describe R10K::Module::Git do
             it "raises appropriate error" do
               mod = test_module({branch: :control_branch}, mock_env)
 
-              expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*no default given/i)
+              expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*no default provided/i)
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.5.3
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -538,9 +538,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Puppet environment and module deployment
 test_files: []
-has_rdoc: