r10k 1.5.1 → 2.0.0

data/lib/shared/puppet_forge/version.rb

@@ -0,0 +1,3 @@
+module PuppetForge
+  VERSION = '2.0.0.alpha'
+end

data/r10k.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
     dynamic environments.
   DESCRIPTION
 
+  s.required_ruby_version = '>= 1.9.3'
+
   s.license  = 'Apache-2.0'
 
   s.add_dependency 'colored',   '1.2'
@@ -25,7 +27,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'log4r',     '1.1.10'
   s.add_dependency 'multi_json', '~> 1.10'
-  s.add_dependency 'json_pure',  '~> 1.8'
 
   s.add_dependency 'faraday',                       '~> 0.9.0'
   s.add_dependency 'faraday_middleware',            '~> 0.9.0'
@@ -34,7 +35,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'semantic_puppet', '~> 0.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.1'
-  s.add_development_dependency 'vcr',   '~> 2.9'
 
   s.add_development_dependency 'minitar'
 

data/r10k.yaml.example

@@ -1,5 +1,80 @@
-:cachedir: '/var/cache/r10k'
-:sources:
-  :plops:
-    remote: 'git@github.com:my-org/org-shared-modules'
-    basedir: '/etc/puppet/environments'
+---
+# This example configuration details the most commonly used configuration
+# options for the `r10k deploy` command.
+#
+
+# The 'cachedir' setting controls where cached content, such as mirrored Git
+# repositories, are stored on the local machine. This location should be
+# persistent, as environments and modules may rely on these files in order to
+# be updated.
+#
+# The default value is "~/.r10k"
+cachedir: '/var/cache/r10k'
+
+# 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:
+
+    # The 'remote' setting determines the location of the VCS repository used
+    # for creating environments.
+    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'
+    # setting in puppet.conf.
+    #
+    # See http://docs.puppetlabs.com/references/latest/configuration.html#environmentpath
+    # for more information about the Puppet 'environmentpath' setting.
+    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'
+
+    # 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'
+
+    # Sources can use the 'prefix' setting to avoid collisions between multiple
+    # sources being created in the same directory. Setting prefix to true
+    # prepends the source name and an underscore to each environment, so for
+    # the qa source the "production" branch will create the "qa_production"
+    # branch.
+    #
+    # The default value is 'false'.
+    prefix: true
+
+# Additional configuration can be supplied to configure how r10k uses Git
+# and what version of Git it uses.
+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'
+
+  # The 'private_key' setting sets the the SSH private key to use for remote
+  # Git repositories accessed over SSH.
+  #
+  # The 'private_key' setting is only used by the 'rugged' Git provider.
+  #private_key: '/root/.ssh/id_rsa'
+
+  # The 'username' setting sets the SSH username for remote Git repositories
+  # when a username is not provided in the URL. The username defaults to the
+  # current user.
+  #
+  # The 'username' setting is only used by the 'rugged' Git provider.
+  #username: 'git'
+
+# 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'

data/spec/spec_helper.rb

@@ -23,18 +23,6 @@ require 'matchers/exit_with'
 require 'matchers/match_realpath'
 require 'r10k-mocks'
 
-
-require 'vcr'
-VCR.configure do |vcr|
-  vcr.cassette_library_dir = File.expand_path('spec/fixtures/vcr/cassettes', PROJECT_ROOT)
-  # VCR 2.9.3 uses a Faraday constant that was deprecated in Faraday 0.9.0,
-  # and as such triggers a warning on the part of Faraday during the following
-  # hooking step. It's known and there's nothing that can be done until VCR
-  # 2.9.4 comes out.
-  vcr.hook_into :faraday
-  vcr.configure_rspec_metadata!
-end
-
 RSpec.configure do |config|
   config.before(:all) do
     Log4r::Logger.global.level = Log4r::OFF

data/spec/unit/action/runner_spec.rb

@@ -44,6 +44,11 @@ describe R10K::Action::Runner do
       runner.call
     end
 
+    it "configures settings" do
+      expect(runner).to receive(:setup_settings)
+      runner.call
+    end
+
     it "returns the result of the wrapped class #call method" do
       expect(runner.call).to eq %w[ARGS YES]
     end
@@ -61,4 +66,52 @@ describe R10K::Action::Runner do
       runner.call
     end
   end
+
+  describe "configuring settings" do
+    it "configures authorization" do
+      expect(runner).to receive(:setup_authorization)
+      runner.setup_settings
+    end
+  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)
+      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
+
+      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
+
+    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/deployment/config/loader_spec.rb

@@ -8,15 +8,16 @@ describe R10K::Deployment::Config::Loader do
       expect(subject.loadpath).to include('/etc/puppetlabs/r10k/r10k.yaml')
     end
 
-    it 'includes /etc/r10k.yaml in the loadpath' do
-      expect(subject.loadpath).to include('/etc/r10k.yaml')
-    end
-
     it 'does include the current working directory in the loadpath' do
       allow(Dir).to receive(:getwd).and_return '/some/random/path/westvletren'
       expect(subject.loadpath).to include('/some/random/path/westvletren/r10k.yaml')
     end
 
+    # This was the old default location that is no longer supported as of 2.0.0.
+    it 'does not include /etc/r10k.yaml in the loadpath' do
+      expect(subject.loadpath).not_to include('/etc/r10k.yaml')
+    end
+
     it 'does not include /some/random/path/atomium/r10k.yaml in the loadpath' do
       expect(subject.loadpath).not_to include('/some/random/path/atomium/r10k.yaml')
     end
@@ -27,22 +28,7 @@ describe R10K::Deployment::Config::Loader do
     it 'returns the correct default location' do
       allow(File).to receive(:file?).and_return false
       allow(File).to receive(:file?).with('/etc/puppetlabs/r10k/r10k.yaml').and_return true
-      allow(File).to receive(:file?).with('/etc/r10k.yaml').and_return true
       expect(subject.search).to eq '/etc/puppetlabs/r10k/r10k.yaml'
     end
-
-    it 'issues a warning if both default locations are present' do
-      allow(File).to receive(:file?).and_return false
-      allow(File).to receive(:file?).with('/etc/puppetlabs/r10k/r10k.yaml').and_return true
-      allow(File).to receive(:file?).with('/etc/r10k.yaml').and_return true
-
-      logger_dbl = double('Logging')
-      allow(subject).to receive(:logger).and_return logger_dbl
-
-      expect(logger_dbl).to receive(:warn).with('Both /etc/puppetlabs/r10k/r10k.yaml and /etc/r10k.yaml configuration files exist.')
-      expect(logger_dbl).to receive(:warn).with('/etc/puppetlabs/r10k/r10k.yaml will be used.')
-
-      subject.search
-    end
   end
 end

data/spec/unit/deployment/config_spec.rb

@@ -26,6 +26,14 @@ describe R10K::Deployment::Config do
       end
     end
 
+    describe "for the forge" do
+      it "sets the proxy when given" do
+        expect(YAML).to receive(:load_file).with('foo/bar').and_return('forge' => {'proxy' => 'https://proxy.url'})
+        expect(R10K::Forge::ModuleRelease.settings).to receive(:[]=).with(:proxy, 'https://proxy.url')
+        described_class.new('foo/bar')
+      end
+    end
+
     describe "for git" do
       it "sets the git provider when given" do
         expect(YAML).to receive(:load_file).with('foo/bar').and_return('git' => {'provider' => 'rugged'})

data/spec/unit/deployment_spec.rb

@@ -137,7 +137,7 @@ describe R10K::Deployment, "with environment collisions" do
   it "raises an error when validating" do
     expect {
       deployment.validate!
-    }.to raise_error(R10K::R10KError, /Environment collision at .* between s\d:third and s\d:third/)
+    }.to raise_error(R10K::Error, /Environment collision at .* between s\d:third and s\d:third/)
   end
 end
 

data/spec/unit/forge/module_release_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'r10k/forge/module_release'
+require 'r10k/util/exec_env'
+
+describe R10K::Forge::ModuleRelease do
+  subject { described_class.new('branan-eight_hundred', '8.0.0') }
+
+  let(:download_path) { instance_double('Pathname') }
+  let(:unpack_path) { instance_double('Pathname') }
+  let(:target_dir) { instance_double('Pathname') }
+  let(:file_lists) { {:valid=>['valid_ex'], :invalid=>[], :symlinks=>['symlink_ex']} }
+
+  before do
+    subject.download_path = download_path
+    subject.unpack_path = unpack_path
+  end
+
+  describe 'setting the proxy' do
+    %w[HTTPS_PROXY https_proxy HTTP_PROXY http_proxy].each do |env_var|
+      it "respects the #{env_var} environment variable" do
+        R10K::Util::ExecEnv.withenv(env_var => "http://proxy.value") do
+          subject = described_class.new('branan-eight_hundred', '8.0.0')
+          proxy_uri = subject.forge_release.conn.proxy.uri
+          expect(proxy_uri.to_s).to eq "http://proxy.value"
+        end
+      end
+    end
+
+    describe 'using application settings' do
+      before { described_class.settings[:proxy] = 'http://proxy.setting' }
+      after { described_class.settings.reset! }
+
+      it 'has a setting for the forge proxy' do
+        subject = described_class.new('branan-eight_hundred', '8.0.0')
+        proxy_uri = subject.forge_release.conn.proxy.uri
+        expect(proxy_uri.to_s).to eq "http://proxy.setting"
+      end
+
+      it 'prefers the proxy setting over an environment variable' do
+        R10K::Util::ExecEnv.withenv('HTTPS_PROXY' => "http://proxy.from.env") do
+          subject = described_class.new('branan-eight_hundred', '8.0.0')
+          proxy_uri = subject.forge_release.conn.proxy.uri
+          expect(proxy_uri.to_s).to eq "http://proxy.setting"
+        end
+      end
+    end
+
+  end
+
+  describe '#download' do
+    it "downloads the module from the forge into `download_path`" do
+      expect(subject.forge_release).to receive(:download).with(download_path)
+      subject.download
+    end
+  end
+
+  describe '#verify' do
+    it "verifies the module checksum based on the Forge file checksum" do
+      expect(subject.forge_release).to receive(:verify).with(download_path)
+      subject.verify
+    end
+  end
+
+  describe '#unpack' do
+    it "unpacks the module tarball in `download_path` into the provided target path" do
+      expect(PuppetForge::Unpacker).to receive(:unpack).with(download_path.to_s, target_dir.to_s, unpack_path.to_s).\
+          and_return({:valid=>["extractedmodule/metadata.json"], :invalid=>[], :symlinks=>[]})
+      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)
+      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]}")
+    end
+  end
+
+  describe "#cleanup" do
+    it "cleans up the download and unpack paths" do
+      expect(subject).to receive(:cleanup_unpack_path)
+      expect(subject).to receive(:cleanup_download_path)
+      subject.cleanup
+    end
+  end
+
+  describe "#cleanup_unpack_path" do
+    it "ignores the unpack_path if it doesn't exist" do
+      expect(unpack_path).to receive(:exist?).and_return false
+      expect(unpack_path).to_not receive(:rmtree)
+      subject.cleanup_unpack_path
+    end
+
+    it "removes the unpack_path if it exists" do
+      expect(unpack_path).to receive(:exist?).and_return true
+      expect(unpack_path).to receive(:rmtree)
+      subject.cleanup_unpack_path
+    end
+  end
+
+  describe "#cleanup_download_path" do
+    it "ignores the download_path if it doesn't exist" do
+      expect(download_path).to receive(:exist?).and_return false
+      expect(download_path).to_not receive(:delete)
+      subject.cleanup_download_path
+    end
+
+    it "removes the download_path if it exists" do
+      expect(download_path).to receive(:exist?).and_return true
+      expect(download_path).to receive(:delete)
+      subject.cleanup_download_path
+    end
+  end
+
+  describe '#install' do
+    it "performs all steps needed to install the module" do
+      expect(subject).to receive(:download)
+      expect(subject).to receive(:verify)
+      expect(subject).to receive(:unpack).with(target_dir)
+      expect(subject).to receive(:cleanup)
+      subject.install(target_dir)
+    end
+  end
+end

data/spec/unit/git_spec.rb

@@ -8,20 +8,20 @@ describe R10K::Git do
   describe 'selecting the default provider' do
     it 'returns shellgit when the git executable is present' do
       expect(R10K::Features).to receive(:available?).with(:shellgit).and_return true
-      expect(described_class.default).to eq R10K::Git::ShellGit
+      expect(described_class.default_name).to eq :shellgit
     end
 
     it 'returns rugged when the git executable is absent and the rugged library is present' do
       expect(R10K::Features).to receive(:available?).with(:shellgit).and_return false
       expect(R10K::Features).to receive(:available?).with(:rugged).and_return true
-      expect(described_class.default).to eq R10K::Git::Rugged
+      expect(described_class.default_name).to eq :rugged
     end
 
     it 'raises an error when the git executable and rugged library are absent' do
       expect(R10K::Features).to receive(:available?).with(:shellgit).and_return false
       expect(R10K::Features).to receive(:available?).with(:rugged).and_return false
       expect {
-        described_class.default
+        described_class.default_name
       }.to raise_error(R10K::Error, 'No Git providers are functional.')
     end
 
@@ -60,8 +60,8 @@ describe R10K::Git do
 
   describe "retrieving the current provider" do
     it "uses the default if a provider has not been set" do
-      expect(described_class).to receive(:default).and_return :def
-      expect(described_class.provider).to eq :def
+      expect(described_class).to receive(:default_name).and_return :rugged
+      expect(described_class.provider).to eq(R10K::Git::Rugged)
     end
 
     it "uses an explicitly set provider" do

data/spec/unit/module/forge_spec.rb

@@ -1,5 +1,4 @@
 require 'r10k/module/forge'
-require 'r10k/semver'
 require 'spec_helper'
 
 describe R10K::Module::Forge do
@@ -15,16 +14,12 @@ describe R10K::Module::Forge do
     end
 
     it "should implement 'branan-eight_hundred', '8.0.0'" do
-      expect(described_class).to be_implement('branan/eight_hundred', '8.0.0')
+      expect(described_class).to be_implement('branan-eight_hundred', '8.0.0')
     end
 
     it "should fail with an invalid title" do
       expect(described_class).to_not be_implement('branan!eight_hundred', '8.0.0')
     end
-
-    it "should fail with an invalid version" do
-      expect(described_class).to_not be_implement('branan-eight_hundred', 'not a semantic version')
-    end
   end
 
   describe "setting attributes" do
@@ -55,117 +50,25 @@ describe R10K::Module::Forge do
     end
 
     it "sets the expected version" do
-      expect(subject.properties).to include(:expected => R10K::SemVer.new('8.0.0'))
+      expect(subject.properties).to include(:expected => '8.0.0')
     end
 
     it "sets the actual version" do
-      expect(subject).to receive(:current_version).and_return(R10K::SemVer.new('0.8.0'))
-      expect(subject.properties).to include(:actual => R10K::SemVer.new('0.8.0'))
+      expect(subject).to receive(:current_version).and_return('0.8.0')
+      expect(subject.properties).to include(:actual => '0.8.0')
     end
   end
 
-  describe "when syncing" do
-    let(:metadata) do
-      double('metadata',
-             :exist? => true,
-             :author => 'branan',
-             :version => R10K::SemVer.new('8.0.0'))
+  describe '#expected_version' do
+    it "returns an explicitly given expected version" do
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      expect(subject.expected_version).to eq '8.0.0'
     end
 
-    subject { described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0') }
-
-    describe "and the module is in sync" do
-      before do
-        allow(subject).to receive(:status).and_return :insync
-      end
-
-      it "is in sync" do
-        expect(subject).to be_insync
-      end
-
-      it "doesn't act when syncing anything" do
-        expect(subject).to receive(:install).never
-        expect(subject).to receive(:upgrade).never
-        expect(subject).to receive(:reinstall).never
-        subject.sync
-      end
-    end
-
-    describe "and the module is mismatched" do
-      before do
-        allow(subject).to receive(:status).and_return :mismatched
-      end
-
-      it "is not in sync" do
-        expect(subject).to_not be_insync
-      end
-
-      it "reinstalls the module" do
-        expect(subject).to receive(:reinstall)
-        subject.sync
-      end
-
-      it "reinstalls by removing the existing directory and calling the module tool" do
-        expect(FileUtils).to receive(:rm_rf)
-        expect(subject).to receive(:pmt) do |args|
-          expect(args).to include 'install'
-          expect(args).to include '--version=8.0.0'
-          expect(args).to include 'branan/eight_hundred'
-        end
-
-        subject.sync
-      end
-    end
-
-    describe "and the module is outdated" do
-      before do
-        allow(subject).to receive(:status).and_return :outdated
-      end
-
-      it "is not in sync" do
-        expect(subject).to_not be_insync
-      end
-
-      it "upgrades the module" do
-        expect(subject).to receive(:upgrade)
-        subject.sync
-      end
-
-      it "upgrades by calling the module tool" do
-        expect(subject).to receive(:pmt) do |args|
-          expect(args).to include 'upgrade'
-          expect(args).to include '--version=8.0.0'
-          expect(args).to include 'branan/eight_hundred'
-        end
-
-        subject.sync
-      end
-    end
-
-    describe "and the module is not installed" do
-      before do
-        allow(subject).to receive(:status).and_return :absent
-      end
-
-      it "is not in sync" do
-        expect(subject).to_not be_insync
-      end
-
-      it "installs the module" do
-        expect(subject).to receive(:uninstall).never
-        expect(subject).to receive(:install)
-        subject.sync
-      end
-
-      it "installs by calling the module tool" do
-        expect(subject).to receive(:pmt) do |args|
-          expect(args).to include 'install'
-          expect(args).to include '--version=8.0.0'
-          expect(args).to include 'branan/eight_hundred'
-        end
-
-        subject.sync
-      end
+    it "uses the latest version from the forge when the version is :latest" do
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, :latest)
+      expect(subject.v3_module).to receive(:latest_version).and_return('8.8.8')
+      expect(subject.expected_version).to eq '8.8.8'
     end
   end
 
@@ -207,14 +110,61 @@ describe R10K::Module::Forge do
     end
   end
 
-  describe "and the expected version is :latest", :vcr => true, :unless => (RUBY_VERSION == '1.8.7') do
-    subject { described_class.new('branan/eight_hundred', fixture_modulepath, :latest) }
+  describe "#sync" do
+    subject { described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0') }
 
-    it "sets the expected version based on the latest forge version" do
-      allow(subject).to receive(:exist?).and_return true
-      allow(subject.metadata).to receive(:version).and_return '7.0.0'
-      expect(subject.status).to eq :outdated
-      expect(subject.expected_version).to eq R10K::SemVer.new('8.0.0')
+    it 'does nothing when the module is in sync' do
+      allow(subject).to receive(:status).and_return :insync
+
+      expect(subject).to receive(:install).never
+      expect(subject).to receive(:upgrade).never
+      expect(subject).to receive(:reinstall).never
+      subject.sync
+    end
+
+    it 'reinstalls the module when it is mismatched' do
+      allow(subject).to receive(:status).and_return :mismatched
+      expect(subject).to receive(:reinstall)
+      subject.sync
+    end
+
+    it 'upgrades the module when it is outdated' do
+      allow(subject).to receive(:status).and_return :outdated
+      expect(subject).to receive(:upgrade)
+      subject.sync
+    end
+
+    it 'installs the module when it is absent' do
+      allow(subject).to receive(:status).and_return :absent
+      expect(subject).to receive(:install)
+      subject.sync
+    end
+  end
+
+  describe '#install' do
+    it 'installs the module from the forge' do
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      release = instance_double('R10K::Forge::ModuleRelease')
+      expect(R10K::Forge::ModuleRelease).to receive(:new).with('branan/eight_hundred', '8.0.0').and_return(release)
+      expect(release).to receive(:install).with(subject.path)
+      subject.install
+    end
+  end
+
+  describe '#uninstall' do
+    it 'removes the module path' do
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      expect(FileUtils).to receive(:rm_rf).with(subject.path.to_s)
+      subject.uninstall
+    end
+  end
+
+  describe '#reinstall' do
+    it 'uninstalls and then installs the module' do
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      expect(subject).to receive(:uninstall)
+      expect(subject).to receive(:install)
+      subject.reinstall
     end
   end
 end