r10k 2.4.1 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 641a17c6593ee322ad99118d6cb4417bcf60dcee
-  data.tar.gz: 152e586e81392f906185e3bbf26c7ea4ef3d2e53
+  metadata.gz: 487d95e761e476a0701e43c1a36a146b977a5ed5
+  data.tar.gz: a05e79eadd63370717d5c766b94868a732117889
 SHA512:
-  metadata.gz: b841c5c9f5257fe8c737982b367cc047478d643c93a02158603dfd556b534010d7f323ade0c85e7726af9c8ee48d07d065ab68c856a399ce740c6eb6c325d6db
-  data.tar.gz: 64ca0499ceb9b51b6ab9c3b5695f8bf9d935e0b0737fdac186372e98cf463c53ec823d053f99aed3fcb7e9a63c5f5ed9376055f5f6164d5213cfa6a1a8e1e50b
+  metadata.gz: a4ae1bfa5022c9660acecf7953114c1d76e148283cc5d1a1048930a1c56be7b8492b9a07c16ac66ee8a056d69b4b1cdce9272e4485070ba738f16d59acb29ef7
+  data.tar.gz: 4e522d29f6cd877388748c871144763b258cee2afffe0ac2221c2cbbfdf3f1cb0f7bf415466a0b2725e8519787ef3abdc4e50f81906ab46ded0cd65853444807

data/CHANGELOG.mkd

@@ -1,6 +1,38 @@
 CHANGELOG
 =========
 
+2.4.3
+-----
+
+2016/08/23
+
+### Bug Fixes
+
+(RK-266) Fixed an issue where the "puppetfile install" action was encountering an
+error when operating on a Puppetfile with "local" content declarations.
+
+2.4.2 (Yanked)
+--------------
+
+2016/08/22
+
+### Bug Fixes
+
+(RK-265) The "puppetfile install" action will no longer overwrite local
+modifications to managed Git content. Instead, a message will be logged at the
+"WARN" level indicating that the content was skipped. Note: The "deploy"
+actions will still overwrite local modications. For more background on this
+change, see below:
+
+In 2.4.0 a change was made to r10k's behavior when it encounters local
+modifications during "deploy" operations. Previously, r10k would log an error
+and skip updating the modified content. As of 2.4.0, local modifications will
+be overwritten and a warning will be logged. This change was considered a bug
+fix but was originally omitted from the changelog for that release. This change
+also inadvertently modified the behavior of the "puppetfile install" action. A
+command line flag to control this behavior more explicitly will likely be added
+in a future version.
+
 2.4.1
 -----
 
@@ -51,6 +83,11 @@ iternationalization (i18n) and localization work.
 This situation used to raise an error but will now generate a WARN level log message
 instead.
 
+(#483) Local modifications to managed content will now be overwritten during "deploy"
+actions. (Note: This change inadvertently also affected the "puppetfile install"
+action in 2.4.0 and 2.4.1. This was fixed in 2.4.2. A command line flag to control
+this behavior more explicitly will likely be added in a future version.)
+
 ### Bug Fixes
 
 (#616) Ensure that Forge module version strings are valid semantic versions. (Special

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

@@ -27,7 +27,7 @@ module R10K
 
         def visit_module(mod)
           logger.info _("Updating module %{mod_path}") % {mod_path: mod.path}
-          mod.sync
+          mod.sync(force: false) # Don't force sync for 'puppetfile install' RK-265
         end
 
         def allowed_initialize_opts

data/lib/r10k/git/stateful_repository.rb

@@ -31,7 +31,7 @@ class R10K::Git::StatefulRepository
     @cache.resolve(ref)
   end
 
-  def sync(ref)
+  def sync(ref, force=true)
     @cache.sync if sync_cache?(ref)
 
     sha = @cache.resolve(ref)
@@ -44,21 +44,25 @@ class R10K::Git::StatefulRepository
 
     case workdir_status
     when :absent
-      logger.debug { _("Cloning %{repo_path} and checking out %{ref}") % {repo_path: @repo.path, ref: ref } }
+      logger.debug(_("Cloning %{repo_path} and checking out %{ref}") % {repo_path: @repo.path, ref: ref })
       @repo.clone(@remote, {:ref => sha})
     when :mismatched
-      logger.debug { _("Replacing %{repo_path} and checking out %{ref}") % {repo_path: @repo.path, ref: ref } }
+      logger.debug(_("Replacing %{repo_path} and checking out %{ref}") % {repo_path: @repo.path, ref: ref })
       @repo.path.rmtree
       @repo.clone(@remote, {:ref => sha})
-    when :outdated, :dirty
-      if workdir_status == :dirty
-        logger.warn { _("%{repo_path} has local modifications which will be overwritten") % {repo_path: @repo.path} }
+    when :outdated
+      logger.debug(_("Updating %{repo_path} to %{ref}") % {repo_path: @repo.path, ref: ref })
+      @repo.checkout(sha, {:force => force})
+    when :dirty
+      if force
+        logger.warn(_("Overwriting local modifications to %{repo_path}") % {repo_path: @repo.path})
+        logger.debug(_("Updating %{repo_path} to %{ref}") % {repo_path: @repo.path, ref: ref })
+        @repo.checkout(sha, {:force => force})
+      else
+        logger.warn(_("Skipping %{repo_path} due to local modifications") % {repo_path: @repo.path})
       end
-
-      logger.debug { _("Updating %{repo_path} to %{ref}") % {repo_path: @repo.path, ref: ref } }
-      @repo.checkout(sha, {:force => true})
     else
-      logger.debug { _("%{repo_path} is already at Git ref %{ref}") % {repo_path: @repo.path, ref: ref } }
+      logger.debug(_("%{repo_path} is already at Git ref %{ref}") % {repo_path: @repo.path, ref: ref })
     end
   end
 
@@ -71,12 +75,12 @@ class R10K::Git::StatefulRepository
       :mismatched
     elsif !(@repo.origin == @remote)
       :mismatched
+    elsif @repo.dirty?
+      :dirty
     elsif !(@repo.head == @cache.resolve(ref))
       :outdated
     elsif @cache.ref_type(ref) == :branch && !@cache.synced?
       :outdated
-    elsif @repo.dirty?
-      :dirty
     else
       :insync
     end

data/lib/r10k/module/base.rb

@@ -53,7 +53,7 @@ class R10K::Module::Base
 
   # Synchronize this module with the indicated state.
   # @abstract
-  def sync
+  def sync(opts={})
     raise NotImplementedError
   end
 

data/lib/r10k/module/forge.rb

@@ -42,7 +42,7 @@ class R10K::Module::Forge < R10K::Module::Base
     @v3_module = PuppetForge::V3::Module.new(:slug => @title)
   end
 
-  def sync(options = {})
+  def sync(opts={})
     case status
     when :absent
       install

data/lib/r10k/module/git.rb

@@ -38,8 +38,9 @@ class R10K::Module::Git < R10K::Module::Base
     }
   end
 
-  def sync
-    @repo.sync(version)
+  def sync(opts={})
+    force = opts && opts.fetch(:force, true)
+    @repo.sync(version, force)
   end
 
   def status

data/lib/r10k/module/local.rb

@@ -30,7 +30,7 @@ class R10K::Module::Local < R10K::Module::Base
     :insync
   end
 
-  def sync
+  def sync(opts={})
     logger.debug1 _("Module %{title} is a local module, always indicating synced.") % {title: title}
   end
 end

data/lib/r10k/module/svn.rb

@@ -66,7 +66,7 @@ class R10K::Module::SVN < R10K::Module::Base
     end
   end
 
-  def sync
+  def sync(opts={})
     case status
     when :absent
       install

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '2.4.1'
+  VERSION = '2.4.3'
 end

data/spec/integration/git/stateful_repository_spec.rb

@@ -68,12 +68,19 @@ describe R10K::Git::StatefulRepository do
     end
 
     describe "when the workdir has local modifications" do
-      it "is dirty" do
+      it "is dirty when workdir is up to date" do
         thinrepo.clone(remote, {:ref => ref})
         File.open(File.join(thinrepo.path, 'README.markdown'), 'a') { |f| f.write('local modifications!') }
 
         expect(subject.status(ref)).to eq :dirty
       end
+
+      it "is dirty when workdir is not up to date" do
+        thinrepo.clone(remote, {:ref => '1.0.0'})
+        File.open(File.join(thinrepo.path, 'README.markdown'), 'a') { |f| f.write('local modifications!') }
+
+        expect(subject.status(ref)).to eq :dirty
+      end
     end
 
     describe "if the right ref is checked out" do
@@ -119,11 +126,33 @@ describe R10K::Git::StatefulRepository do
     end
 
     describe "when the workdir is dirty" do
-      it "overwrites local modificatios" do
+      before(:each) do
         thinrepo.clone(remote, {:ref => ref})
         File.open(File.join(thinrepo.path, 'README.markdown'), 'a') { |f| f.write('local modifications!') }
-        subject.sync(ref)
-        expect(subject.status(ref)).to eq :insync
+      end
+
+      context "when force == true" do
+        let(:force) { true }
+
+        it "warns and overwrites local modifications" do
+          expect(subject.logger).to receive(:warn).with(/overwriting local modifications/i)
+
+          subject.sync(ref, force)
+
+          expect(subject.status(ref)).to eq :insync
+        end
+      end
+
+      context "when force != true" do
+        let(:force) { false }
+
+        it "warns and does not overwrite local modifications" do
+          expect(subject.logger).to receive(:warn).with(/skipping.*due to local modifications/i)
+
+          subject.sync(ref, force)
+
+          expect(subject.status(ref)).to eq :dirty
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.3
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored