r10k 2.3.1 → 2.4.0

data/lib/r10k/util/setopts.rb

@@ -44,7 +44,7 @@ module R10K
               instance_variable_set("@#{rhs}".to_sym, value)
             end
           else
-            raise ArgumentError, "#{self.class.name} cannot handle option '#{key}'"
+            raise ArgumentError, _("%{class_name} cannot handle option '%{key}'") % {class_name: self.class.name, key: key}
           end
         end
       end

data/lib/r10k/util/subprocess.rb

@@ -66,15 +66,15 @@ module R10K
         subprocess = self.class.runner.new(@argv)
         subprocess.cwd = @cwd if @cwd
 
-        logmsg = "Starting process: #{@argv.inspect}"
+        logmsg = _("Starting process: %{args}") % {args: @argv.inspect}
         logmsg << "(cwd: #{@cwd})" if @cwd
         logger.debug2(logmsg)
 
         result = subprocess.run
-        logger.debug2("Finished process:\n#{result.format}")
+        logger.debug2(_("Finished process:\n%{result}") % {result: result.format})
 
         if @raise_on_fail && result.failed?
-          raise SubprocessError.new("Command exited with non-zero exit code", :result => result)
+          raise SubprocessError.new(_("Command exited with non-zero exit code"), :result => result)
         end
 
         result

data/lib/r10k/util/symbolize_keys.rb

@@ -14,7 +14,7 @@ module R10K
         hash.keys.each do |key|
           if key.is_a?(String)
             if hash.key?(key.to_sym)
-              raise TypeError, "An existing interned key for #{key} exists, cannot overwrite"
+              raise TypeError, _("An existing interned key for %{key} exists, cannot overwrite") % {key: key}
             end
             hash[key.to_sym] = hash.delete(key)
             key = key.to_sym

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '2.3.1'
+  VERSION = '2.4.0'
 end

data/locales/config.yaml

@@ -0,0 +1,21 @@
+---
+# This is the project-specific configuration file for setting up
+# fast_gettext for your project.
+gettext:
+  # This is used for the name of the .pot and .po files; they will be
+  # called <project_name>.pot?
+  project_name: 'r10k'
+  # This is used in comments in the .pot and .po files to indicate what
+  # project the files belong to and should bea little more desctiptive than
+  # <project_name>
+  package_name: r10k
+  # The locale that the default messages in the .pot file are in
+  default_locale: en
+  # The email used for sending bug reports.
+  bugs_address: docs@puppetlabs.com
+  # The holder of the copyright.
+  copyright_holder: Puppet, Inc.
+  # Patterns for +Dir.glob+ used to find all files that might contain
+  # translatable content, relative to the project root directory
+  source_files:
+    - 'lib/**/*.rb'

data/r10k.gemspec

@@ -32,8 +32,11 @@ Gem::Specification.new do |s|
   s.add_dependency 'semantic_puppet', '~> 0.1.0'
   s.add_dependency 'minitar'
 
+  s.add_dependency 'gettext-setup', '~> 0.5'
+
   s.add_development_dependency 'rspec', '~> 3.1'
 
+  s.add_development_dependency 'rake'
 
   s.add_development_dependency 'yard', '~> 0.8.7.3'
 

data/spec/fixtures/unit/puppetfile/valid-forge-with-version/Puppetfile

@@ -0,0 +1 @@
+mod 'puppetlabs/apt', '2.1.1'

data/spec/fixtures/unit/puppetfile/valid-forge-without-version/Puppetfile

@@ -0,0 +1 @@
+mod 'puppetlabs/apt'

data/spec/integration/git/stateful_repository_spec.rb

@@ -9,20 +9,21 @@ describe R10K::Git::StatefulRepository do
 
   let(:cacherepo) { R10K::Git.cache.generate(remote) }
   let(:thinrepo) { R10K::Git.thin_repository.new(basedir, dirname, cacherepo) }
+  let(:ref) { '0.9.x' }
 
-  subject { described_class.new('0.9.x', remote, basedir, dirname) }
+  subject { described_class.new(remote, basedir, dirname) }
 
   describe 'status' do
     describe "when the directory does not exist" do
       it "is absent" do
-        expect(subject.status).to eq :absent
+        expect(subject.status(ref)).to eq :absent
       end
     end
 
     describe "when the directory is not a git repository" do
       it "is mismatched" do
         thinrepo.path.mkdir
-        expect(subject.status).to eq :mismatched
+        expect(subject.status(ref)).to eq :mismatched
       end
     end
 
@@ -30,7 +31,7 @@ describe R10K::Git::StatefulRepository do
       it "is mismatched" do
         thinrepo.path.mkdir
         File.open("#{thinrepo.path}/.git", "w") {}
-        expect(subject.status).to eq :mismatched
+        expect(subject.status(ref)).to eq :mismatched
       end
     end
 
@@ -38,74 +39,91 @@ describe R10K::Git::StatefulRepository do
       it "is mismatched" do
         thinrepo.clone(remote, {:ref => '1.0.0'})
         allow(subject.repo).to receive(:origin).and_return('http://some.site/repo.git')
-        expect(subject.status).to eq :mismatched
+        expect(subject.status(ref)).to eq :mismatched
       end
     end
 
     describe "when the wrong ref is checked out" do
       it "is outdated" do
         thinrepo.clone(remote, {:ref => '1.0.0'})
-        expect(subject.status).to eq :outdated
+        expect(subject.status(ref)).to eq :outdated
       end
     end
 
     describe "when the ref is a branch and the cache is not synced" do
       it "is outdated" do
-        thinrepo.clone(remote, {:ref => '0.9.x'})
+        thinrepo.clone(remote, {:ref => ref})
         cacherepo.reset!
-        expect(subject.status).to eq :outdated
+        expect(subject.status(ref)).to eq :outdated
       end
     end
 
     describe "when the ref can't be resolved" do
-      subject { described_class.new('1.1.x', remote, basedir, dirname) }
+      let(:ref) { '1.1.x' }
 
       it "is outdated" do
         thinrepo.clone(remote, {:ref => '0.9.x'})
-        expect(subject.status).to eq :outdated
+        expect(subject.status(ref)).to eq :outdated
+      end
+    end
+
+    describe "when the workdir has local modifications" do
+      it "is dirty" 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
     end
 
     describe "if the right ref is checked out" do
       it "is insync" do
-        thinrepo.clone(remote, {:ref => '0.9.x'})
-        expect(subject.status).to eq :insync
+        thinrepo.clone(remote, {:ref => ref})
+        expect(subject.status(ref)).to eq :insync
       end
     end
   end
 
   describe "syncing" do
-
     describe "when the ref is unresolvable" do
-      subject { described_class.new('1.1.x', remote, basedir, dirname) }
+      let(:ref) { '1.1.x' }
 
       it "raises an error" do
         expect {
-          subject.sync
+          subject.sync(ref)
         }.to raise_error(R10K::Git::UnresolvableRefError)
       end
     end
 
     describe "when the repo is absent" do
       it "creates the repo" do
-        subject.sync
-        expect(subject.status).to eq :insync
+        subject.sync(ref)
+        expect(subject.status(ref)).to eq :insync
       end
     end
 
     describe "when the repo is mismatched" do
       it "removes and recreates the repo" do
         thinrepo.path.mkdir
-        subject.sync
-        expect(subject.status).to eq :insync
+        subject.sync(ref)
+        expect(subject.status(ref)).to eq :insync
       end
     end
 
     describe "when the repo is out of date" do
       it "updates the repository" do
         thinrepo.clone(remote, {:ref => '1.0.0'})
-        subject.sync
-        expect(subject.status).to eq :insync
+        subject.sync(ref)
+        expect(subject.status(ref)).to eq :insync
+      end
+    end
+
+    describe "when the workdir is dirty" do
+      it "overwrites local modificatios" 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
     end
   end

data/spec/r10k-mocks/mock_config.rb

@@ -24,6 +24,10 @@ module R10K
       def settings
         @hash
       end
+
+      def merge(other)
+        hash.merge(other)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -23,6 +23,9 @@ require 'matchers/exit_with'
 require 'matchers/match_realpath'
 require 'r10k-mocks'
 
+# Add a negated version of the change matcher.
+RSpec::Matchers.define_negated_matcher :not_change, :change
+
 RSpec.configure do |config|
   config.before(:all) do
     Log4r::Logger.global.level = Log4r::OFF

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

@@ -23,28 +23,28 @@ describe R10K::Action::Deploy::Environment do
   end
 
   describe "when called" do
-    describe "with an environment that doesn't exist" do
-      let(:config) do
-        R10K::Deployment::MockConfig.new(
-          :sources => {
-            :control => {
-              :type => :mock,
-              :basedir => '/some/nonexistent/path/control',
-              :environments => %w[first second third],
-            }
+    let(:mock_config) do
+      R10K::Deployment::MockConfig.new(
+        :sources => {
+          :control => {
+            :type => :mock,
+            :basedir => '/some/nonexistent/path/control',
+            :environments => %w[first second third],
           }
-        )
-      end
+        }
+      )
+    end
 
+    describe "with an environment that doesn't exist" do
       let(:deployment) do
-        R10K::Deployment.new(config)
+        R10K::Deployment.new(mock_config)
       end
 
       before do
         expect(R10K::Deployment).to receive(:new).and_return(deployment)
       end
 
-      subject { described_class.new({config: "/some/nonexistent/path", purge: false}, %w[not_an_environment]) }
+      subject { described_class.new({config: "/some/nonexistent/path"}, %w[not_an_environment]) }
 
       it "logs that the environments can't be deployed and returns false" do
         expect(subject.logger).to receive(:error).with("Environment(s) 'not_an_environment' cannot be found in any source and will not be deployed.")
@@ -52,5 +52,63 @@ describe R10K::Action::Deploy::Environment do
         expect(subject.call).to eq false
       end
     end
+
+    describe "purge_levels" do
+      let(:settings) { { deploy: { purge_levels: purge_levels } } }
+
+      let(:deployment) do
+        R10K::Deployment.new(mock_config.merge(settings))
+      end
+
+      before do
+        expect(R10K::Deployment).to receive(:new).and_return(deployment)
+      end
+
+      subject { described_class.new({ config: "/some/nonexistent/path", puppetfile: true }, %w[first], settings) }
+
+      describe "deployment purge level" do
+        let(:purge_levels) { [:deployment] }
+
+        it "only logs about purging deployment" do
+          expect(subject.logger).to receive(:debug).with(/purging unmanaged environments for deployment/i)
+          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged content for environment/i)
+          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged puppetfile content/i)
+
+          subject.call
+        end
+      end
+
+      describe "environment purge level" do
+        let(:purge_levels) { [:environment] }
+
+        it "only logs about purging environment" do
+          expect(subject.logger).to receive(:debug).with(/purging unmanaged content for environment/i)
+          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged environments for deployment/i)
+          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged puppetfile content/i)
+
+          subject.call
+        end
+
+        it "logs that environment was not purged if deploy failed" do
+          expect(subject).to receive(:visit_puppetfile) { subject.instance_variable_set(:@visit_ok, false) }
+
+          expect(subject.logger).to receive(:debug).with(/not purging unmanaged content for environment/i)
+
+          subject.call
+        end
+      end
+
+      describe "puppetfile purge level" do
+        let(:purge_levels) { [:puppetfile] }
+
+        it "only logs about purging puppetfile" do
+          expect(subject.logger).to receive(:debug).with(/purging unmanaged puppetfile content/i)
+          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged environments for deployment/i)
+          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged content for environment/i)
+
+          subject.call
+        end
+      end
+    end
   end
 end

data/spec/unit/environment/base_spec.rb

@@ -35,4 +35,75 @@ describe R10K::Environment::Base do
       subject.accept(visitor)
     end
   end
+
+  describe "#whitelist" do
+    let(:whitelist) do
+      ['**/*.xpp', 'custom', '*.tmp']
+    end
+
+    it "combines given patterns with full_path to env" do
+      expect(subject.whitelist(whitelist)).to all(start_with(subject.path.to_s))
+    end
+  end
+
+  describe "#purge_exclusions" do
+    let(:mock_env) { instance_double("R10K::Environment::Base") }
+    let(:mock_puppetfile) { instance_double("R10K::Puppetfile", :environment= => true, :environment => mock_env) }
+
+    before(:each) do
+      allow(mock_puppetfile).to receive(:managed_directories).and_return([])
+      allow(mock_puppetfile).to receive(:desired_contents).and_return([])
+      allow(R10K::Puppetfile).to receive(:new).and_return(mock_puppetfile)
+    end
+
+    it "excludes .r10k-deploy.json" do
+      expect(subject.purge_exclusions).to include(/r10k-deploy\.json/)
+    end
+
+    it "excludes puppetfile managed directories" do
+      managed_dirs = [
+        '/some/imaginary/path/env_name/modules',
+        '/some/imaginary/path/env_name/data',
+      ]
+
+      expect(mock_puppetfile).to receive(:managed_directories).and_return(managed_dirs)
+
+      exclusions = subject.purge_exclusions
+
+      managed_dirs.each do |dir|
+        expect(exclusions).to include(dir)
+      end
+    end
+
+    describe "puppetfile desired contents" do
+      let(:desired_contents) do
+        basedir = subject.path.to_s
+
+        [ 'modules/apache', 'data/local/site' ].collect do |c|
+          File.join(basedir, c)
+        end
+      end
+
+      before(:each) do
+        allow(File).to receive(:directory?).with(/^\/some\/imaginary\/path/).and_return(true)
+
+        expect(mock_puppetfile).to receive(:desired_contents).and_return(desired_contents)
+      end
+
+      it "excludes desired directory contents with glob" do
+        exclusions = subject.purge_exclusions
+
+        expect(exclusions).to include(/#{Regexp.escape(File.join('apache', '**', '*'))}$/)
+        expect(exclusions).to include(/#{Regexp.escape(File.join('site', '**', '*'))}$/)
+      end
+
+      it "excludes ancestors of desired directories" do
+        exclusions = subject.purge_exclusions
+
+        expect(exclusions).to include(/modules$/)
+        expect(exclusions).to include(/data\/local$/)
+        expect(exclusions).to include(/data$/)
+      end
+    end
+  end
 end

data/spec/unit/forge/module_release_spec.rb

@@ -40,17 +40,14 @@ describe R10K::Forge::ModuleRelease do
       subject.unpack(target_dir)
     end
 
-    it "raises an error if symlinks are present during the unpacking process after unpacking" do
-      logger_dbl = double(Log4r::Logger)
+    it "logs a warning if symlinks are present during the unpacking process" do
+      logger_dbl = double(Log4r::Logger, debug1: true, debug2: true)
       allow(subject).to receive(:logger).and_return(logger_dbl)
-      expect(PuppetForge::Unpacker).to receive(:unpack).with(download_path.to_s, target_dir.to_s, unpack_path.to_s).\
-          and_return(file_lists)
-      expect(logger_dbl).to receive(:debug1)
-      expect(logger_dbl).to receive(:debug2)
-      expect {
-        subject.unpack(target_dir)
-      }.to raise_error(R10K::Error, "Symlinks are unsupported and were not unpacked from the module tarball. " +
-                                    "#{subject.forge_release.slug} contained these ignored symlinks: #{file_lists[:symlinks]}")
+      allow(PuppetForge::Unpacker).to receive(:unpack).and_return(file_lists)
+
+      expect(logger_dbl).to receive(:warn).with(/symlinks are unsupported.*#{Regexp.escape(subject.forge_release.slug)}/i)
+
+      subject.unpack(target_dir)
     end
   end