akerl-r10k 3.14.2.1

data/spec/unit/source/git_spec.rb

@@ -0,0 +1,233 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source::Git do
+
+  subject do
+    described_class.new('mysource', '/some/nonexistent/dir',
+                        {:remote => 'https://git-server/repo.git'})
+  end
+
+  it "stores the name" do
+    expect(subject.name).to eq 'mysource'
+  end
+
+  it "stores the basedir" do
+    expect(subject.basedir).to eq '/some/nonexistent/dir'
+  end
+
+  describe "preloading" do
+    it "fetches the git cache" do
+      expect(subject.cache).to receive(:sync)
+      subject.preload!
+    end
+  end
+
+  describe "lazily generating environments" do
+    it "returns an empty list of environments when the cache has not been created" do
+      allow(subject.cache).to receive(:cached?).and_return false
+      expect(subject.environments).to be_empty
+    end
+
+    it "generates environments when the cache is present and environments have not been loaded" do
+      allow(subject.cache).to receive(:cached?).and_return true
+      allow(subject).to receive(:generate_environments).and_return %w[hi]
+      expect(subject.environments.size).to eq(1)
+    end
+
+    it "doesn't recreate environments if they have already been loaded" do
+      allow(subject.cache).to receive(:cached?).and_return true
+      allow(subject).to receive(:generate_environments).once.and_return %w[hi]
+      expect(subject.environments.size).to eq(1)
+      expect(subject.environments.size).to eq(1)
+    end
+  end
+
+  describe "eagerly generating environments" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return %w[master]
+    end
+
+    let(:master_env) { subject.generate_environments.first }
+
+    it "creates an environment for each branch" do
+      expect(subject.generate_environments.size).to eq(1)
+    end
+
+    it "copies the source remote to the environment" do
+      expect(master_env.remote).to eq subject.remote
+    end
+
+    it "uses the branch name as the directory by default" do
+      expect(master_env.dirname).to eq 'master'
+    end
+  end
+
+  describe "generate_environments respects ignore_branch_prefixes setting" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production', 'not_dev_test_me', 'dev_test', 'dev', 'test_2']
+      subject.instance_variable_set(:@ignore_branch_prefixes, ['dev', 'test'])
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not in ignore_branch_prefixes" do
+      expect(subject.generate_environments.size).to eq(3)
+    end
+
+    it "copies the source remote to the environment" do
+      expect(environments[0].remote).to eq subject.remote
+      expect(environments[1].remote).to eq subject.remote
+      expect(environments[2].remote).to eq subject.remote
+    end
+
+    it "uses the branch name as the directory by default" do
+      expect(environments[0].dirname).to eq 'master'
+      expect(environments[1].dirname).to eq 'production'
+      expect(environments[2].dirname).to eq 'not_dev_test_me'
+    end
+  end
+
+  describe "filtering branches with ignore prefixes" do
+    let(:branches) { ['master', 'development', 'production', 'not_dev_test_me', 'dev_test', 'dev', 'test_2'] }
+    let(:ignore_prefixes) { ['dev', 'test'] }
+
+    it "filters branches" do
+      expect(subject.filter_branches_by_regexp(branches, ignore_prefixes)).to eq(['master', 'production', 'not_dev_test_me'])
+    end
+  end
+
+  describe "filtering branches with command" do
+    let(:branches) { ['master', 'development', 'production'] }
+    if R10K::Util::Platform.windows?
+      let(:filter_command) { 'powershell.exe if ($env:R10K_BRANCH.equals(\"development\")) {exit 1} else {exit 0}' }
+    else
+      let(:filter_command) { 'sh -c "[ $R10K_BRANCH != development ]"' }
+    end
+
+    it "filters branches" do
+      expect(subject.filter_branches_by_command(branches, filter_command)).to eq(['master', 'production'])
+    end
+  end
+
+  describe "generate_environments respects filter_command setting" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
+      if R10K::Util::Platform.windows?
+        subject.instance_variable_set(:@filter_command, 'powershell.exe if ($env:R10K_BRANCH.equals(\"master\")) {exit 1} else {exit 0}')
+      else
+        subject.instance_variable_set(:@filter_command, '[ $R10K_BRANCH != master ]')
+      end
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not filtered by filter_command" do
+      expect(subject.generate_environments.size).to eq(2)
+    end
+  end
+
+  describe "generate_environments respects filter_command setting and name" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
+      if R10K::Util::Platform.windows?
+        subject.instance_variable_set(:@filter_command, 'powershell.exe if ($env:R10K_NAME.equals(\"mysource\")) {exit 0} else {exit 1}')
+      else
+        subject.instance_variable_set(:@filter_command, '[ $R10K_NAME = mysource ]')
+      end
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not filtered by filter_command" do
+      expect(subject.generate_environments.size).to eq(3)
+    end
+  end
+
+end
+
+describe R10K::Source::Git, "handling invalid branch names" do
+  %w[correct_and_warn correct].each do |setting|
+    describe "when invalid is #{setting}" do
+      subject do
+        described_class.new('/some/nonexistent/dir', 'mysource', {
+          :remote           => 'https://git-server/repo.git',
+          :invalid_branches => setting
+        })
+      end
+
+      before do
+        allow(subject.cache).to receive(:branches).and_return ['master', 'invalid-branch']
+      end
+
+      it "creates an environment for each branch" do
+        expect(subject.generate_environments.size).to eq(2)
+      end
+
+      it "removes invalid characters from branch names" do
+        invalid_env = subject.generate_environments.last
+        expect(invalid_env.dirname).to eq 'invalid_branch'
+      end
+    end
+  end
+
+  describe "when invalid is 'error'" do
+    subject do
+      described_class.new('/some/nonexistent/dir', 'mysource', {
+        :remote   => 'https://git-server/repo.git',
+        :invalid_branches => 'error',
+      })
+    end
+
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'invalid-branch']
+    end
+
+    it "only creates an environment for valid branches" do
+      expect(subject.generate_environments.size).to eq(1)
+    end
+  end
+end
+
+# Since prefixing is an immutable property of a source, it's easier to create
+# a new context and duplicate stubs in a single location rather than packing a
+# single test with all the stubs that entirely recreate the source.
+describe R10K::Source::Git, 'when prefixing is enabled' do
+  subject do
+    described_class.new(
+      'prefixed',
+      '/some/nonexistent/dir',
+      {
+        :prefix => true,
+        :remote => 'https://git-server/repo.git',
+      })
+  end
+
+  describe "generating prefixed environments" do
+    before do
+      allow(subject.cache).to receive(:cached?).and_return true
+      allow(subject.cache).to receive(:branches).and_return %w[master other]
+    end
+
+    let(:environments) { subject.environments }
+
+    it "creates an environment for each branch" do
+      expect(subject.environments.size).to eq(2)
+    end
+
+    it "prefixes the source name to environments when prefixing is enabled" do
+      expect(environments[0].dirname).to eq 'prefixed_master'
+      expect(environments[1].dirname).to eq 'prefixed_other'
+    end
+  end
+end
+
+describe R10K::Source::Git, 'registering as a source' do
+  it "registers with the :git key" do
+    expect(R10K::Source.retrieve(:git)).to eq described_class
+  end
+
+  it "registers with the nil key" do
+    expect(R10K::Source.retrieve(nil)).to eq described_class
+  end
+end

data/spec/unit/source/hash_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source::Hash do
+
+  describe '.valid_environments_hash?' do
+    it "rejects strings" do
+      expect(R10K::Source::Hash.valid_environments_hash?('200 OK'))
+        .to eq false
+    end
+  end
+
+  let(:environments_hash) do
+    {
+      'production' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'release-141',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.0'
+          }
+        }
+      },
+      'development' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'master',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.1'
+          }
+        }
+      }
+    }
+  end
+
+  describe "with a prefix" do
+    subject do
+      described_class.new('hashsource', '/some/nonexistent/dir',
+                          prefix: 'prefixed', environments: environments_hash)
+    end
+
+    it "prepends environment names with a prefix" do
+      environments = subject.environments
+      expect(environments[0].dirname).to eq 'prefixed_production'
+      expect(environments[1].dirname).to eq 'prefixed_development'
+    end
+  end
+end

data/spec/unit/source/svn_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source::SVN do
+
+  subject do
+    described_class.new('mysource', '/some/nonexistent/dir',
+                        {:remote => 'https://svn-server.site/repo'})
+  end
+
+  it "stores the name" do
+    expect(subject.name).to eq 'mysource'
+  end
+
+  it "stores the basedir" do
+    expect(subject.basedir).to eq '/some/nonexistent/dir'
+  end
+
+
+  describe "lazily generating environments" do
+    it "generates environments when they have not been loaded" do
+      expect(subject).to receive(:generate_environments).and_return %w[hi]
+      expect(subject.environments).to eq %w[hi]
+    end
+
+    it "doesn't recreate environments if they have already been loaded" do
+      expect(subject).to receive(:generate_environments).once.and_return %w[hi]
+      subject.environments
+      subject.environments
+    end
+  end
+
+  describe "eagerly generating environments" do
+    before do
+      allow(subject.svn_remote).to receive(:branches).and_return %w[apache dns robobutler]
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch and the trunk" do
+      expect(environments[0].name).to eq 'production'
+      expect(environments[1].name).to eq 'apache'
+      expect(environments[2].name).to eq 'dns'
+      expect(environments[3].name).to eq 'robobutler'
+    end
+
+    it "maps trunk to production" do
+      expect(environments[0].remote).to eq 'https://svn-server.site/repo/trunk'
+    end
+
+    it "sets the remote for branch environments to subdirectories of the branches/ directory" do
+      expect(environments[1].remote).to eq 'https://svn-server.site/repo/branches/apache'
+      expect(environments[2].remote).to eq 'https://svn-server.site/repo/branches/dns'
+      expect(environments[3].remote).to eq 'https://svn-server.site/repo/branches/robobutler'
+    end
+
+    it "uses the branch name as the directory by default" do
+      expect(environments[0].dirname).to eq 'production'
+      expect(environments[1].dirname).to eq 'apache'
+      expect(environments[2].dirname).to eq 'dns'
+      expect(environments[3].dirname).to eq 'robobutler'
+    end
+  end
+
+  describe "generate_environments respects ignore_branch_prefixes setting" do
+    before do
+      allow(subject.svn_remote).to receive(:branches).and_return ['master', 'development', 'not_dev_test_me', 'dev_test', 'dev', 'test_2']
+      subject.instance_variable_set(:@ignore_branch_prefixes, ['dev', 'test'])
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not in ignore_branch_prefixes" do
+      expect(subject.generate_environments.size).to eq(3)
+    end
+
+    it "uses the branch name as the directory by default" do
+      expect(environments[0].name).to eq 'production'
+      expect(environments[1].name).to eq 'master'
+      expect(environments[2].name).to eq 'not_dev_test_me'
+    end
+  end
+
+  describe "filtering branches with ignore prefixes" do
+    let(:branches) { ['master', 'development', 'production', 'not_dev_test_me', 'dev_test', 'dev', 'test_2'] }
+    let(:ignore_prefixes) { ['dev', 'test'] }
+
+    it "filters branches" do
+      expect(subject.filter_branches(branches, ignore_prefixes)).to eq(['master', 'production', 'not_dev_test_me'])
+    end
+  end
+end
+
+describe R10K::Source::SVN, 'when prefixing is enabled' do
+  subject do
+    described_class.new(
+      'mysource',
+      '/some/nonexistent/dir',
+      {
+        :remote => 'https://svn-server.site/repo',
+        :prefix => true
+      }
+    )
+  end
+
+  describe "generating prefixed environments" do
+    before do
+      allow(subject.svn_remote).to receive(:branches).and_return %w[apache dns robobutler]
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch and the trunk" do
+      expect(environments.size).to eq(4)
+    end
+
+    it "prefixes the source name to environments" do
+      expect(environments[0].dirname).to eq 'mysource_production'
+      expect(environments[1].dirname).to eq 'mysource_apache'
+      expect(environments[2].dirname).to eq 'mysource_dns'
+      expect(environments[3].dirname).to eq 'mysource_robobutler'
+    end
+  end
+end
+
+describe R10K::Source::SVN, 'when prefixing is disabled' do
+  subject do
+    described_class.new(
+    'mysource',
+    '/some/nonexistent/dir',
+    {
+      :remote => 'https://svn-server.site/repo',
+      :prefix => false
+    }
+    )
+  end
+
+  describe "generating environments" do
+    before do
+      allow(subject.svn_remote).to receive(:branches).and_return %w[apache dns robobutler]
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch and the trunk" do
+      expect(environments.size).to eq(4)
+    end
+
+    it "does not prefix environments" do
+      expect(environments[0].dirname).to eq 'production'
+      expect(environments[1].dirname).to eq 'apache'
+      expect(environments[2].dirname).to eq 'dns'
+      expect(environments[3].dirname).to eq 'robobutler'
+    end
+  end
+end
+
+
+describe R10K::Source::SVN, 'when prefixing is overridden' do
+  subject do
+    described_class.new(
+    'mysource',
+    '/some/nonexistent/dir',
+    {
+      :remote => 'https://svn-server.site/repo',
+      :prefix => "tenant1"
+    }
+    )
+  end
+
+  describe "generating prefixed environments" do
+    before do
+      allow(subject.svn_remote).to receive(:branches).and_return %w[apache dns robobutler]
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch and the trunk" do
+      expect(environments.size).to eq(4)
+    end
+
+    it "prefixes the prefix name to environments" do
+      expect(environments[0].dirname).to eq 'tenant1_production'
+      expect(environments[1].dirname).to eq 'tenant1_apache'
+      expect(environments[2].dirname).to eq 'tenant1_dns'
+      expect(environments[3].dirname).to eq 'tenant1_robobutler'
+    end
+  end
+end
+
+
+describe R10K::Source::SVN, 'registering as a source' do
+  it "registers with the :svn key" do
+    expect(R10K::Source.retrieve(:svn)).to eq described_class
+  end
+end

data/spec/unit/source/yaml_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source::Yaml do
+
+  let(:environments_hash) do
+    {
+      'production' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'release-141',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.0'
+          }
+        }
+      },
+      'development' => {
+        'remote'  => 'https://git.example.com/puppet/control-repo.git',
+        'ref'     => 'master',
+        'modules' => {
+          'puppetlabs-stdlib' => '6.1.0',
+          'puppetlabs-ntp' => '8.1.0',
+          'example-myapp1' => {
+            'git' => 'https://git.example.com/puppet/example-myapp1.git',
+            'ref' => 'v1.3.1'
+          }
+        }
+      }
+    }
+  end
+
+  describe "with valid yaml file" do
+    it "produces environments" do
+      allow(YAML).to receive(:load_file).with('/envs.yaml').and_return(environments_hash)
+      source = described_class.new('yamlsource', '/some/nonexistent/dir', config: '/envs.yaml')
+      expect(source.environments.map(&:name)).to contain_exactly('production', 'development')
+    end
+  end
+end

data/spec/unit/source_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'r10k/source'
+
+describe R10K::Source do
+  it "implementds methods for a keyed factory" do
+    expect(described_class).to respond_to :register
+    expect(described_class).to respond_to :retrieve
+    expect(described_class).to respond_to :generate
+  end
+end

data/spec/unit/svn/remote_spec.rb

@@ -0,0 +1,21 @@
+require 'r10k'
+require 'r10k/svn'
+
+describe R10K::SVN::Remote do
+  subject { described_class.new('https://svn-server.site/repo') }
+
+  it "generates the trunk URL by appending '/trunk' to the base URL" do
+    expect(subject.trunk).to eq 'https://svn-server.site/repo/trunk'
+  end
+
+  describe "retrieving branches" do
+    let(:branches) do
+      %[apache/\ndns/\nrobobutler/\nstaging/\n]
+    end
+
+    it "enumerates the /branches directory of the base URL" do
+      allow(subject).to receive(:svn).with(['ls', 'https://svn-server.site/repo/branches']).and_return(branches)
+      expect(subject.branches).to eq(%w[apache dns robobutler staging])
+    end
+  end
+end

data/spec/unit/svn/working_dir_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'r10k/svn/working_dir'
+
+describe R10K::SVN::WorkingDir, "initializing" do
+  let(:pathname) { Pathname.new("/some/imaginary/path") }
+  it "stores the provided path" do
+    subject = described_class.new(pathname)
+    expect(subject.path).to eq Pathname.new("/some/imaginary/path")
+  end
+
+  describe "when auth is provided" do
+    it "raises an error when only the username is provided" do
+      expect {
+        described_class.new(pathname, :username => "root")
+      }.to raise_error(ArgumentError, "Both username and password must be specified")
+    end
+
+    it "raises an error when only the password is provided" do
+      expect {
+        described_class.new(pathname, :password => "hunter2")
+      }.to raise_error(ArgumentError, "Both username and password must be specified")
+    end
+
+    it "does not raise an error when both username and password are provided" do
+      o = described_class.new(pathname, :username => "root", :password => "hunter2")
+      expect(o.username).to eq("root")
+      expect(o.password).to eq("hunter2")
+    end
+  end
+end
+
+describe R10K::SVN::WorkingDir, "when authentication credentials are given" do
+  let(:pathname) { Pathname.new("/some/imaginary/path") }
+  subject { described_class.new(pathname, :username => "root", :password => "hunter2") }
+
+  def check_args(args)
+    expect(args).to include("--username")
+    expect(args).to include("root")
+    expect(args).to include("--password")
+    expect(args).to include("hunter2")
+  end
+
+  it "invokes 'svn checkout' with the given credentials" do
+    expect(subject).to receive(:svn) do |args, _|
+      check_args(args)
+    end
+    subject.checkout('https://some.svn.url/trunk')
+  end
+
+  it "invokes 'svn update' with the given credentials" do
+    expect(subject).to receive(:svn) do |args, _|
+      check_args(args)
+    end
+    subject.update
+  end
+end

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