r10k 3.13.0 → 3.14.0

data/spec/unit/environment/name_spec.rb

@@ -6,21 +6,29 @@ describe R10K::Environment::Name do
     it "does not modify the given name when no strip_component is given" do
       bn = described_class.new('myenv', source: 'source', prefix: false)
       expect(bn.dirname).to eq 'myenv'
+      expect(bn.name).to eq 'myenv'
+      expect(bn.original_name).to eq 'myenv'
     end
 
     it "removes the first occurance of a regex match when a regex is given" do
       bn = described_class.new('myenv', source: 'source', prefix: false, strip_component: '/env/')
       expect(bn.dirname).to eq 'my'
+      expect(bn.name).to eq 'my'
+      expect(bn.original_name).to eq 'myenv'
     end
 
     it "does not modify the given name when there is no regex match" do
       bn = described_class.new('myenv', source: 'source', prefix: false, strip_component: '/bar/')
       expect(bn.dirname).to eq 'myenv'
+      expect(bn.name).to eq 'myenv'
+      expect(bn.original_name).to eq 'myenv'
     end
 
     it "removes the given name's prefix when it matches strip_component" do
       bn = described_class.new('env/prod', source: 'source', prefix: false, strip_component: 'env/')
       expect(bn.dirname).to eq 'prod'
+      expect(bn.name).to eq 'prod'
+      expect(bn.original_name).to eq 'env/prod'
     end
 
     it "raises an error when given an integer" do
@@ -34,21 +42,29 @@ describe R10K::Environment::Name do
     it "uses the branch name as the dirname when prefixing is off" do
       bn = described_class.new('mybranch', :source => 'source', :prefix => false)
       expect(bn.dirname).to eq 'mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
 
     it "prepends the source name when prefixing is on" do
       bn = described_class.new('mybranch', :source => 'source', :prefix => true)
       expect(bn.dirname).to eq 'source_mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
 
     it "prepends the prefix name when prefixing is overridden" do
       bn = described_class.new('mybranch', {:prefix => "bar", :sourcename => 'foo'})
       expect(bn.dirname).to eq 'bar_mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
 
     it "uses the branch name as the dirname when prefixing is nil" do
       bn = described_class.new('mybranch', {:prefix => nil, :sourcename => 'foo'})
       expect(bn.dirname).to eq 'mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
   end
 
@@ -149,6 +165,8 @@ describe R10K::Environment::Name do
         it "replaces invalid characters in #{branch} with underscores" do
           bn = described_class.new(branch.dup, {:correct => true})
           expect(bn.dirname).to eq branch.gsub(/\W/, '_')
+          expect(bn.name).to eq branch
+          expect(bn.original_name).to eq branch
         end
       end
 

data/spec/unit/environment/tarball_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'r10k/environment'
+
+describe R10K::Environment::Tarball do
+  let(:tgz_path) do
+    File.expand_path('spec/fixtures/tarball/tarball.tar.gz', PROJECT_ROOT)
+  end
+
+  let(:checksum) { '36afcfc2378b8235902d6e647fce7479da6898354d620388646c595a1155ed67' }
+  let(:base_params) { { source: tgz_path, version: checksum, modules: { } } }
+
+  subject { described_class.new('envname', '/some/imaginary/path', 'dirname', base_params) }
+
+  describe "initializing" do
+    it "accepts valid base class initialization arguments" do
+      expect(subject.name).to eq 'envname'
+    end
+  end
+
+  describe "storing attributes" do
+    it "can return the environment name" do
+      expect(subject.name).to eq 'envname'
+    end
+
+    it "can return the environment basedir" do
+      expect(subject.basedir).to eq '/some/imaginary/path'
+    end
+
+    it "can return the environment dirname" do
+      expect(subject.dirname).to eq 'dirname'
+    end
+
+    it "can return the environment path" do
+      expect(subject.path.to_s).to eq '/some/imaginary/path/dirname'
+    end
+
+    it "can return the environment source" do
+      expect(subject.tarball.source).to eq tgz_path
+    end
+
+    it "can return the environment version" do
+      expect(subject.tarball.checksum).to eq checksum
+    end
+  end
+end

data/spec/unit/git/cache_spec.rb

@@ -21,7 +21,8 @@ describe R10K::Git::Cache do
     end
   end
 
-  subject { subclass.new('git://some/git/remote') }
+  let(:remote) { 'git://some/git/remote' }
+  subject { subclass.new(remote) }
 
   describe "updating the cache" do
     it "only updates the cache once" do
@@ -62,18 +63,4 @@ describe R10K::Git::Cache do
       subject.cached?
     end
   end
-
-  describe "dirname sanitization" do
-    it 'sanitizes cache directory name' do
-      expect(subject.sanitized_dirname).to eq('git---some-git-remote')
-    end
-
-    context 'with username and password' do
-      subject { subclass.new('https://"user:pa$$w0rd:@some/git/remote') }
-
-      it 'sanitizes cache directory name' do
-        expect(subject.sanitized_dirname).to eq('https---some-git-remote')
-      end
-    end
-  end
 end

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

@@ -26,4 +26,23 @@ describe R10K::Git::Rugged::Cache, :unless => R10K::Util::Platform.jruby? do
       expect(described_class.settings[:cache_root]).to eq '/some/path'
     end
   end
+
+  describe "remote url updates" do
+    before do
+      allow(subject.repo).to receive(:exist?).and_return true
+      allow(subject.repo).to receive(:fetch)
+      allow(subject.repo).to receive(:remotes).and_return({ 'origin' => 'git://some/git/remote' })
+    end
+
+    it "does not update the URLs if they match" do
+      expect(subject.repo).to_not receive(:update_remote)
+      subject.sync!
+    end
+
+    it "updates the remote URL if they do not match" do
+      allow(subject.repo).to receive(:remotes).and_return({ 'origin' => 'foo'})
+      expect(subject.repo).to receive(:update_remote)
+      subject.sync!
+    end
+  end
 end

data/spec/unit/module/tarball_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'r10k/module'
+require 'fileutils'
+
+describe R10K::Module::Tarball do
+  include_context 'Tarball'
+
+  let(:base_params) { { type: 'tarball', source: fixture_tarball, version: fixture_checksum } }
+
+  subject do
+    described_class.new(
+      'fixture-tarball',
+      moduledir,
+      base_params,
+    )
+  end
+
+  describe "setting the owner and name" do
+    describe "with a title of 'fixture-tarball'" do
+      it "sets the owner to 'fixture'" do
+        expect(subject.owner).to eq 'fixture'
+      end
+
+      it "sets the name to 'tarball'" do
+        expect(subject.name).to eq 'tarball'
+      end
+
+      it "sets the path to the given moduledir + modname" do
+        expect(subject.path.to_s).to eq(File.join(moduledir, 'tarball'))
+      end
+    end
+  end
+
+  describe "properties" do
+    it "sets the module type to :tarball" do
+      expect(subject.properties).to include(type: :tarball)
+    end
+
+    it "sets the version" do
+      expect(subject.properties).to include(expected: fixture_checksum)
+    end
+  end
+
+  describe 'syncing the module' do
+    it 'defaults to keeping the spec dir' do
+      subject.sync
+      expect(Dir.exist?(File.join(moduledir, 'tarball', 'spec'))).to be(true)
+    end
+  end
+
+  describe "determining the status" do
+    it "delegates to R10K::Tarball" do
+      expect(subject).to receive(:tarball).twice.and_return instance_double('R10K::Tarball', cache_valid?: true, insync?: true)
+      expect(subject).to receive(:path).twice.and_return instance_double('Pathname', exist?: true)
+
+      expect(subject.status).to eq(:insync)
+    end
+  end
+
+  describe "option parsing" do
+    describe "version" do
+      context "when no version is given" do
+        subject { described_class.new('fixture-tarball', moduledir, base_params.reject { |k| k.eql?(:version) }) }
+        it "does not require a version" do
+          expect(subject).to be_kind_of(described_class)
+        end
+      end
+    end
+  end
+end

data/spec/unit/module_loader/puppetfile_spec.rb

@@ -167,6 +167,7 @@ describe R10K::ModuleLoader::Puppetfile do
     it 'should disable and not add modules that conflict with the environment' do
       env = instance_double('R10K::Environment::Base')
       mod = instance_double('R10K::Module::Base', name: 'conflict', origin: :puppetfile, 'origin=': nil)
+      allow(env).to receive(:name).and_return('conflict')
       loader = R10K::ModuleLoader::Puppetfile.new(basedir: basedir, environment: env)
       allow(env).to receive(:'module_conflicts?').with(mod).and_return(true)
       allow(mod).to receive(:spec_deletable=)
@@ -187,7 +188,9 @@ describe R10K::ModuleLoader::Puppetfile do
     context 'when belonging to an environment' do
       let(:env_contents) { ['env1', 'env2' ] }
       let(:env) { double(:environment, desired_contents: env_contents) }
-
+      before {
+        allow(env).to receive(:name).and_return('env1')
+      }
       subject { R10K::ModuleLoader::Puppetfile.new(basedir: '/test/basedir', environment: env) }
 
       it "includes environment's desired_contents" do

data/spec/unit/tarball_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'r10k/tarball'
+
+describe R10K::Tarball do
+  include_context 'Tarball'
+
+  subject { described_class.new('fixture-tarball', fixture_tarball, checksum: fixture_checksum) }
+
+  describe 'initialization' do
+    it 'initializes' do
+      expect(subject).to be_kind_of(described_class)
+    end
+  end
+
+  describe 'downloading and caching' do
+    it 'downloads the source to the cache' do
+      # No cache present initially
+      expect(File.exist?(subject.cache_path)).to be(false)
+      expect(subject.cache_valid?).to be(false)
+
+      subject.get
+
+      expect(subject.cache_valid?).to be(true)
+      expect(File.exist?(subject.cache_path)).to be(true)
+    end
+
+    let(:raw_content) {[
+      './',
+      './Puppetfile',
+      './metadata.json',
+      './spec/',
+      './environment.conf',
+      './spec/1',
+    ]}
+
+    let(:clean_content) {[
+      'Puppetfile',
+      'metadata.json',
+      'spec',
+      'environment.conf',
+      'spec/1',
+    ]}
+
+    it 'returns clean paths when listing cached tarball content' do
+      iterator = allow(subject).to receive(:each_tarball_entry)
+      raw_content.each { |entry| iterator.and_yield(entry) }
+
+      expect(subject.paths).to eq(clean_content)
+    end
+  end
+
+  describe 'http sources'
+
+  describe 'file sources'
+
+  describe 'syncing'
+end

data/spec/unit/util/cacheable_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'r10k/util/cacheable'
+
+RSpec.describe R10K::Util::Cacheable do
+
+  subject { Object.new.extend(R10K::Util::Cacheable) }
+
+  describe "dirname sanitization" do
+    let(:input) { 'git://some/git/remote' }
+
+    it 'sanitizes URL to directory name' do
+      expect(subject.sanitized_dirname(input)).to eq('git---some-git-remote')
+    end
+
+    context 'with username and password' do
+      let(:input) { 'https://"user:pa$$w0rd:@authenticated/git/remote' }
+
+      it 'sanitizes authenticated URL to directory name' do
+        expect(subject.sanitized_dirname(input)).to eq('https---authenticated-git-remote')
+      end
+    end
+  end
+end

data/spec/unit/util/downloader_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'r10k/util/downloader'
+
+describe R10K::Util::Downloader do
+
+  subject(:downloader) do
+    subj = Object.new
+    subj.extend(R10K::Util::Downloader)
+    subj.singleton_class.class_eval { public :download }
+    subj.singleton_class.class_eval { public :http_get }
+    subj.singleton_class.class_eval { public :file_digest }
+    subj
+  end
+
+  let(:tmpdir) { Dir.mktmpdir }
+  after(:each) { FileUtils.remove_entry_secure(tmpdir) }
+
+  describe 'http_get' do
+    let(:src_url) { 'https://example.com' }
+    let(:dst_file) { File.join(tmpdir, 'test.out') }
+    let(:tarball_uri) { URI('http://tarball.example.com/tarball.tar.gz') }
+    let(:redirect_uri) { URI('http://redirect.example.com/redirect') }
+    let(:proxy_uri) { URI('http://user:password@proxy.example.com') }
+
+    it 'downloads a simple file' do
+      mock_session = instance_double('Net::HTTP', active?: true)
+      tarball_response = instance_double('Net::HTTPSuccess')
+
+      expect(Net::HTTP).to receive(:new).with(tarball_uri.host, any_args).and_return(mock_session)
+      expect(Net::HTTPSuccess).to receive(:===).with(tarball_response).and_return(true)
+
+      expect(mock_session).to receive(:request_get).and_yield(tarball_response)
+      expect(mock_session).to receive(:start).once
+      expect(mock_session).to receive(:finish).once
+
+      expect { |b| downloader.http_get(tarball_uri, &b) }.to yield_with_args(tarball_response)
+    end
+
+    it 'follows redirects' do
+      mock_session_1 = instance_double('Net::HTTP', active?: false)
+      mock_session_2 = instance_double('Net::HTTP', active?: true)
+      redirect_response = instance_double('Net::HTTPRedirection')
+      tarball_response = instance_double('Net::HTTPSuccess')
+
+      expect(Net::HTTP).to receive(:new).with(redirect_uri.host, any_args).and_return(mock_session_1).once
+      expect(Net::HTTP).to receive(:new).with(tarball_uri.host, any_args).and_return(mock_session_2).once
+      expect(Net::HTTPRedirection).to receive(:===).with(redirect_response).and_return(true)
+      expect(Net::HTTPSuccess).to receive(:===).with(tarball_response).and_return(true)
+      allow(Net::HTTPRedirection).to receive(:===).and_call_original
+
+      expect(mock_session_1).to receive(:request_get).and_yield(redirect_response)
+      expect(mock_session_2).to receive(:request_get).and_yield(tarball_response)
+
+      # The redirect response should be queried for the redirect location
+      expect(redirect_response).to receive(:[]).with('location').and_return(tarball_uri.to_s)
+
+      # Both sessions should start and finish cleanly
+      expect(mock_session_1).to receive(:start).once
+      expect(mock_session_1).to receive(:finish).once
+      expect(mock_session_2).to receive(:start).once
+      expect(mock_session_2).to receive(:finish).once
+
+      expect { |b| downloader.http_get(redirect_uri, &b) }.to yield_with_args(tarball_response)
+    end
+
+    it 'can use a proxy' do
+      mock_session = instance_double('Net::HTTP', active?: true)
+
+      expect(Net::HTTP).to receive(:new)
+                       .with(tarball_uri.host,
+                             tarball_uri.port,
+                             proxy_uri.host,
+                             proxy_uri.port,
+                             proxy_uri.user,
+                             proxy_uri.password,
+                             any_args)
+                       .and_return(mock_session)
+
+      expect(mock_session).to receive(:request_get).and_return(:not_yielded)
+      expect(mock_session).to receive(:start).once
+      expect(mock_session).to receive(:finish).once
+
+      downloader.http_get(tarball_uri, proxy: proxy_uri)
+    end
+  end
+
+  describe 'checksums' do
+    let(:fixture_checksum) { '0bcea17aa0c5e868c18f0fa042feda770e47c1a4223229f82116ccb3ca33c6e3' }
+    let(:fixture_tarball) do
+      File.expand_path('spec/fixtures/integration/git/puppet-boolean-bare.tar', PROJECT_ROOT)
+    end
+
+    it 'checksums files' do
+      expect(downloader.file_digest(fixture_tarball)).to eql(fixture_checksum)
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -142,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -184,20 +198,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.11
-- !ruby/object:Gem::Dependency
-  name: minitar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
 description: |2
       R10K provides a general purpose toolset for deploying Puppet environments and modules.
       It implements the Puppetfile format and provides a native implementation of Puppet
@@ -372,6 +372,7 @@ files:
 - lib/r10k/environment/name.rb
 - lib/r10k/environment/plain.rb
 - lib/r10k/environment/svn.rb
+- lib/r10k/environment/tarball.rb
 - lib/r10k/environment/with_modules.rb
 - lib/r10k/errors.rb
 - lib/r10k/errors/formatting.rb
@@ -410,6 +411,7 @@ files:
 - lib/r10k/module/local.rb
 - lib/r10k/module/metadata_file.rb
 - lib/r10k/module/svn.rb
+- lib/r10k/module/tarball.rb
 - lib/r10k/module_loader/puppetfile.rb
 - lib/r10k/module_loader/puppetfile/dsl.rb
 - lib/r10k/puppetfile.rb
@@ -434,10 +436,13 @@ files:
 - lib/r10k/svn.rb
 - lib/r10k/svn/remote.rb
 - lib/r10k/svn/working_dir.rb
+- lib/r10k/tarball.rb
 - lib/r10k/util/attempt.rb
 - lib/r10k/util/basedir.rb
+- lib/r10k/util/cacheable.rb
 - lib/r10k/util/cleaner.rb
 - lib/r10k/util/commands.rb
+- lib/r10k/util/downloader.rb
 - lib/r10k/util/exec_env.rb
 - lib/r10k/util/license.rb
 - lib/r10k/util/platform.rb
@@ -462,6 +467,7 @@ files:
 - spec/fixtures/module/forge/bad_module/metadata.json
 - spec/fixtures/module/forge/eight_hundred/Modulefile
 - spec/fixtures/module/forge/eight_hundred/metadata.json
+- spec/fixtures/tarball/tarball.tar.gz
 - spec/fixtures/unit/action/r10k.yaml
 - spec/fixtures/unit/action/r10k_cachedir.yaml
 - spec/fixtures/unit/action/r10k_creds.yaml
@@ -495,6 +501,7 @@ files:
 - spec/fixtures/unit/util/purgeable/managed_two/unmanaged_2
 - spec/fixtures/unit/util/subprocess/runner/no-execute.sh
 - spec/integration/git/rugged/bare_repository_spec.rb
+- spec/integration/git/rugged/cache_spec.rb
 - spec/integration/git/rugged/thin_repository_spec.rb
 - spec/integration/git/rugged/working_repository_spec.rb
 - spec/integration/git/shellgit/bare_repository_spec.rb
@@ -509,6 +516,7 @@ files:
 - spec/r10k-mocks/mock_env.rb
 - spec/r10k-mocks/mock_source.rb
 - spec/shared-contexts/git-fixtures.rb
+- spec/shared-contexts/tarball.rb
 - spec/shared-examples/deploy-actions.rb
 - spec/shared-examples/git-repository.rb
 - spec/shared-examples/git/bare_repository.rb
@@ -538,6 +546,7 @@ files:
 - spec/unit/environment/name_spec.rb
 - spec/unit/environment/plain_spec.rb
 - spec/unit/environment/svn_spec.rb
+- spec/unit/environment/tarball_spec.rb
 - spec/unit/environment/with_modules_spec.rb
 - spec/unit/errors/formatting_spec.rb
 - spec/unit/feature_spec.rb
@@ -559,6 +568,7 @@ files:
 - spec/unit/module/git_spec.rb
 - spec/unit/module/metadata_file_spec.rb
 - spec/unit/module/svn_spec.rb
+- spec/unit/module/tarball_spec.rb
 - spec/unit/module_loader/puppetfile_spec.rb
 - spec/unit/module_spec.rb
 - spec/unit/puppetfile_spec.rb
@@ -580,8 +590,11 @@ files:
 - spec/unit/source_spec.rb
 - spec/unit/svn/remote_spec.rb
 - spec/unit/svn/working_dir_spec.rb
+- spec/unit/tarball_spec.rb
 - spec/unit/util/attempt_spec.rb
+- spec/unit/util/cacheable_spec.rb
 - spec/unit/util/commands_spec.rb
+- spec/unit/util/downloader_spec.rb
 - spec/unit/util/exec_env_spec.rb
 - spec/unit/util/purgeable_spec.rb
 - spec/unit/util/setopts_spec.rb