r10k 2.2.2 → 2.3.0

data/lib/r10k/util/symbolize_keys.rb

@@ -21,8 +21,12 @@ module R10K
           end
 
           value = hash[key]
-          if recurse && value.is_a?(Hash)
-            symbolize_keys!(value, true)
+          if recurse
+            if value.is_a?(Hash)
+              symbolize_keys!(value, true)
+            elsif value.is_a?(Array)
+              value.map { |item| symbolize_keys!(item, true) if item.is_a?(Hash) }
+            end
           end
         end
       end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '2.2.2'
+  VERSION = '2.3.0'
 end

data/r10k.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'log4r',     '1.1.10'
   s.add_dependency 'multi_json', '~> 1.10'
 
-  s.add_dependency 'puppet_forge', '~> 2.1.5'
+  s.add_dependency 'puppet_forge', '~> 2.2'
   s.add_dependency 'semantic_puppet', '~> 0.1.0'
   s.add_dependency 'minitar'
 

data/r10k.yaml.example

@@ -9,18 +9,25 @@
 # be updated.
 #
 # The default value is "~/.r10k"
-cachedir: '/var/cache/r10k'
+#cachedir: '/var/cache/r10k'
+
+# The 'proxy' setting configures an HTTP proxy to use for all HTTP/HTTPS
+# operations performed by r10k. This includes requests to the Puppet Forge
+# as well as any Git operations performed against an HTTP/HTTPS remote.
+# You can also configure specific proxies for only Git or Forge operations
+# using settings below. Authenticated proxies can be configured by providing
+# credentials in the URL, e.g. 'https://username:password@proxy.example.com:8888'
+#proxy: 'https://proxy.example.com:8888'
 
 # The 'sources' setting determines what repositories r10k will use when creating
 # Puppet environments.
 sources:
   # Each source should have a unique name, and preferrably should only use
   # alphanumeric characters and underscores.
-  operations:
-
+  #operations:
     # The 'remote' setting determines the location of the VCS repository used
     # for creating environments.
-    remote: 'git@github.com:my-org/org-operations-modules'
+    #remote: 'git@github.com:my-org/org-operations-modules'
 
     # The 'basedir' setting specifies where environments will be created for
     # this source. This setting should match the Puppet 'environmentpath'
@@ -28,19 +35,19 @@ sources:
     #
     # See http://docs.puppetlabs.com/references/latest/configuration.html#environmentpath
     # for more information about the Puppet 'environmentpath' setting.
-    basedir: '/etc/puppetlabs/puppet/environments'
+    #basedir: '/etc/puppetlabs/puppet/environments'
 
   # One or more sources can be specified; each source is simple another entry
   # in the sources map.
-  qa:
-    remote: 'git@github.com:my-org/org-qa-modules'
+  #qa:
+    #remote: 'git@github.com:my-org/org-qa-modules'
 
     # Multiple sources can have the same 'basedir' setting, in case there is a
     # reason to push different sets of environments to the same Puppet master.
     # If two different sources have the same basedir care should be exercised
     # to make sure that two sources don't try create multiple environments with
     # the same name. See the 'prefix' setting for more information.
-    basedir: '/etc/puppetlabs/puppet/environments'
+    #basedir: '/etc/puppetlabs/puppet/environments'
 
     # Sources can use the 'prefix' setting to avoid collisions between multiple
     # sources being created in the same directory. Setting prefix to true
@@ -49,7 +56,7 @@ sources:
     # branch.
     #
     # The default value is 'false'.
-    prefix: true
+    #prefix: true
 
 # Additional configuration can be supplied to configure how r10k uses Git
 # and what version of Git it uses.
@@ -58,7 +65,7 @@ git:
   # As of 1.5.0 r10k can interact with Git repositories in two ways - by
   # shelling out to the 'git' executable, and by using libgit2 through the
   # 'rugged' library.
-  provider: 'shellgit' # Either 'shellgit' or 'rugged', defaults to 'shellgit'
+  #provider: 'shellgit' # Either 'shellgit' or 'rugged', defaults to 'shellgit'
 
   # The 'private_key' setting sets the the SSH private key to use for remote
   # Git repositories accessed over SSH.
@@ -73,8 +80,27 @@ git:
   # The 'username' setting is only used by the 'rugged' Git provider.
   #username: 'git'
 
+  # The 'proxy' setting configures an HTTP proxy to use for all Git sources
+  # that have an HTTP/HTTPS remote URL. This can be overridden on a
+  # per-repository basis using the 'repositories' setting below.
+  #proxy: 'https://proxy.example.com:8888'
+
+  # The 'repositories' setting allows other git related settings to be
+  # configured for each remote repository individually. The value of
+  # this setting should be a list of repositories with a 'remote' key
+  # to identify the specific repository to be configured.
+  #repositories:
+  # - remote: "ssh://tessier-ashpool.freeside/protected-repo.git"
+  #   private_key: "/etc/puppetlabs/r10k/ssh/id_rsa-protected-repo-deploy-key"
+  #   proxy: 'https://proxy.example.com:8888'
+
 # Configuration options for downloading modules from the Puppet Forge
 forge:
   # The 'proxy' setting specifies an optional HTTP proxy to use when making
-  # requests to the Puppet Forge.
-  proxy: 'http://my.site.proxy:3128'
+  # requests to the Puppet Forge. This will override the top level 'proxy'
+  # option or any proxy related environment variables when configured.
+  #proxy: 'https://proxy.example.com:8888'
+
+  # The 'baseurl' setting indicates where Forge modules should be installed
+  # from. This defaults to 'https://forgeapi.puppetlabs.com'
+  #baseurl: 'https://forgemirror.example.com'

data/spec/shared-examples/git/bare_repository.rb

@@ -17,6 +17,37 @@ RSpec.shared_examples "a git bare repository" do
       config = File.read(File.join(basedir, dirname, 'config'))
       expect(config).to match(remote)
     end
+
+    context "without a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return(nil)
+      end
+
+      it 'does not change proxy ENV' do
+        expect(ENV).to_not receive(:[]=)
+        expect(ENV).to_not receive(:update)
+
+        subject.clone(remote)
+      end
+    end
+
+    context "with a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return('http://proxy.example.com:3128')
+      end
+
+      it "manages proxy-related ENV vars" do
+        # Sets proxy settings.
+        ['HTTPS_PROXY', 'https_proxy', 'HTTP_PROXY', 'http_proxy'].each do |var|
+          expect(ENV).to receive(:[]=).with(var, 'http://proxy.example.com:3128')
+        end
+
+        # Resets proxy settings when done.
+        expect(ENV).to receive(:update).with(hash_including('HTTPS_PROXY' => nil))
+
+        subject.clone(remote)
+      end
+    end
   end
 
   describe "updating the repo" do
@@ -34,6 +65,37 @@ RSpec.shared_examples "a git bare repository" do
       subject.fetch
       expect(subject.tags).to include('0.9.0')
     end
+
+    context "without a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return(nil)
+      end
+
+      it 'does not change proxy ENV' do
+        expect(ENV).to_not receive(:[]=)
+        expect(ENV).to_not receive(:update)
+
+        subject.fetch
+      end
+    end
+
+    context "with a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return('http://proxy.example.com:3128')
+      end
+
+      it "manages proxy-related ENV vars" do
+        # Sets proxy settings.
+        ['HTTPS_PROXY', 'https_proxy', 'HTTP_PROXY', 'http_proxy'].each do |var|
+          expect(ENV).to receive(:[]=).with(var, 'http://proxy.example.com:3128')
+        end
+
+        # Resets proxy settings when done.
+        expect(ENV).to receive(:update).with(hash_including('HTTPS_PROXY' => nil))
+
+        subject.fetch
+      end
+    end
   end
 
   describe "listing branches" do

data/spec/shared-examples/git/working_repository.rb

@@ -57,21 +57,36 @@ RSpec.shared_examples "a git working repository" do
         expect(alternates[0]).to match_realpath File.join(remote, 'objects')
       end
     end
-  end
 
-  describe "updating the repo" do
-    let(:tag_090) { subject.git_dir + 'refs' + 'tags' + '0.9.0' }
-    let(:packed_refs) { subject.git_dir + 'packed-refs' }
+    context "without a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return(nil)
+      end
 
-    before do
-      subject.clone(remote)
-      tag_090.delete if tag_090.exist?
-      packed_refs.delete if packed_refs.exist?
+      it 'does not change proxy ENV' do
+        expect(ENV).to_not receive(:[]=)
+        expect(ENV).to_not receive(:update)
+
+        subject.clone(remote)
+      end
     end
 
-    it "fetches objects from the remote" do
-      subject.fetch
-      expect(subject.tags).to include('0.9.0')
+    context "with a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return('http://proxy.example.com:3128')
+      end
+
+      it "manages proxy-related ENV vars" do
+        # Sets proxy settings.
+        ['HTTPS_PROXY', 'https_proxy', 'HTTP_PROXY', 'http_proxy'].each do |var|
+          expect(ENV).to receive(:[]=).with(var, 'http://proxy.example.com:3128')
+        end
+
+        # Resets proxy settings when done.
+        expect(ENV).to receive(:update).with(hash_including('HTTPS_PROXY' => nil))
+
+        subject.clone(remote)
+      end
     end
   end
 
@@ -90,6 +105,37 @@ RSpec.shared_examples "a git working repository" do
       subject.fetch
       expect(subject.tags).to include('0.9.0')
     end
+
+    context "without a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return(nil)
+      end
+
+      it 'does not change proxy ENV' do
+        expect(ENV).to_not receive(:[]=)
+        expect(ENV).to_not receive(:update)
+
+        subject.fetch
+      end
+    end
+
+    context "with a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return('http://proxy.example.com:3128')
+      end
+
+      it "manages proxy-related ENV vars" do
+        # Sets proxy settings.
+        ['HTTPS_PROXY', 'https_proxy', 'HTTP_PROXY', 'http_proxy'].each do |var|
+          expect(ENV).to receive(:[]=).with(var, 'http://proxy.example.com:3128')
+        end
+
+        # Resets proxy settings when done.
+        expect(ENV).to receive(:update).with(hash_including('HTTPS_PROXY' => nil))
+
+        subject.fetch
+      end
+    end
   end
 
   describe "listing branches" do

data/spec/shared-examples/settings/ancestry.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+require 'r10k/settings/collection'
+require 'r10k/settings/list'
+
+shared_examples_for "a setting with ancestors" do
+  describe '#parent=' do
+    it "allows assignment to a collection" do
+      parent = R10K::Settings::Collection.new(:parent, [])
+
+      subject.parent = parent
+
+      expect(subject.parent).to eq parent
+    end
+
+    it "allows assignment to a list" do
+      parent = R10K::Settings::List.new(:parent, [])
+
+      subject.parent = parent
+
+      expect(subject.parent).to eq parent
+    end
+
+    it "rejects assignment when argument is not a settings collection or list" do
+      parent = Hash.new
+
+      expect { subject.parent = parent }.to raise_error do |error|
+        expect(error.message).to match /may only belong to a settings collection or list/i
+      end
+    end
+
+    it "rejects re-assignment" do
+      parent = R10K::Settings::Collection.new(:parent, [])
+      step_parent = R10K::Settings::Collection.new(:step_parent, [])
+
+      subject.parent = parent
+
+      expect { subject.parent = step_parent }.to raise_error do |error|
+        expect(error.message).to match /cannot be reassigned.*new parent/i
+      end
+    end
+  end
+end
+

data/spec/unit/forge/module_release_spec.rb

@@ -27,7 +27,7 @@ describe R10K::Forge::ModuleRelease do
 
   describe '#verify' do
     it "verifies the module checksum based on the Forge file checksum" do
-      allow(subject.forge_release).to receive(:data).and_return('file_md5' => 'something')
+      allow(subject.forge_release).to receive(:file_md5).and_return('something')
       expect(subject.forge_release).to receive(:verify).with(download_path)
       subject.verify
     end

data/spec/unit/git/rugged/credentials_spec.rb

@@ -99,5 +99,11 @@ describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby?
     it "creates default credentials when no other types are allowed" do
       expect(subject.call("https://tessier-ashpool.freeside/repo.git", nil, [])).to be_a_kind_of(Rugged::Credentials::Default)
     end
+
+    it "refuses to generate credentials more than 50 times" do
+      (1..50).each { subject.call("https://tessier-ashpool.freeside/repo.git", nil, [:plaintext]) }
+
+      expect { subject.call("https://tessier-ashpool.freeside/repo.git", nil, [:plaintext]) }.to raise_error(R10K::Git::GitError, /authentication failed/i)
+    end
   end
 end

data/spec/unit/settings/collection_spec.rb

@@ -11,6 +11,8 @@ describe R10K::Settings::Collection do
     described_class.new(:collection, [symbol_defn, default_defn])
   end
 
+  it_behaves_like "a setting with ancestors"
+
   describe "#evaluate" do
     it "assigns values, validates them, and resolves a final value" do
       expect(subject).to receive(:assign).with({:default_defn => :squid})
@@ -20,7 +22,6 @@ describe R10K::Settings::Collection do
     end
   end
 
-
   describe '#assign' do
     it "assigns values to the appropriate setting" do
       subject.assign({:symbol_defn => :hello})

data/spec/unit/settings/definition_spec.rb

@@ -1,10 +1,15 @@
 require 'spec_helper'
 require 'r10k/settings/definition'
+require 'r10k/settings/collection'
+require 'r10k/settings/list'
 
 describe R10K::Settings::Definition do
+  subject { described_class.new(:setting) }
+
+  it_behaves_like "a setting with ancestors"
+
   describe "#evaluate" do
     it "assigns a value, validates it, and resolves a final value" do
-      subject = described_class.new(:setting)
       expect(subject).to receive(:assign).with("myvalue")
       expect(subject).to receive(:validate)
       expect(subject).to receive(:resolve)
@@ -14,7 +19,6 @@ describe R10K::Settings::Definition do
 
   describe "#assign" do
     it 'stores the provided value' do
-      subject = described_class.new(:setting)
       subject.assign("I'm the value")
       expect(subject.value).to eq "I'm the value"
     end
@@ -33,7 +37,6 @@ describe R10K::Settings::Definition do
     end
 
     it "does nothing if a validate hook has not been assigned" do
-      subject = described_class.new(:setting)
       subject.assign("I'm the value")
       subject.validate
     end
@@ -55,7 +58,6 @@ describe R10K::Settings::Definition do
 
   describe "#resolve" do
     it "returns the value when the value has been given" do
-      subject = described_class.new(:setting)
       subject.assign("Mun")
       expect(subject.resolve).to eq "Mun"
     end
@@ -71,7 +73,6 @@ describe R10K::Settings::Definition do
     end
 
     it "returns nil when there is no value nor default" do
-      subject = described_class.new(:setting)
       expect(subject.resolve).to be_nil
     end
   end

data/spec/unit/settings/inheritance_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'r10k/settings/collection'
+require 'r10k/settings/definition'
+
+RSpec.describe 'R10K::Settings inheritance' do
+  subject do
+    R10K::Settings::Collection.new(:parent_settings, [
+      R10K::Settings::Definition.new(:banana, {
+        :default => 'cavendish',
+      }),
+
+      R10K::Settings::Collection.new(:child_settings, [
+        R10K::Settings::Definition.new(:banana, {
+          :default => :inherit,
+        }),
+      ]),
+    ])
+  end
+
+  describe "child settings" do
+    let(:setting) { subject[:child_settings][:banana] }
+
+    context "when child value is not set" do
+      it "should resolve to default value from parent" do
+        expect(setting.value).to be_nil
+        expect(setting.resolve).to eq 'cavendish'
+      end
+    end
+
+    context "when child value is set" do
+      before(:each) { setting.assign('gros michel') }
+
+      it "should resolve to child value" do
+        expect(setting.resolve).to eq 'gros michel'
+      end
+    end
+  end
+end