r10k 3.5.2

data/r10k.gemspec

@@ -0,0 +1,50 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'r10k/version'
+
+Gem::Specification.new do |s|
+  s.name        = "r10k"
+  s.version     = R10K::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors     = "Adrien Thebo"
+  s.email       = "adrien@somethingsinistral.net"
+  s.homepage    = "https://github.com/puppetlabs/r10k"
+  s.summary     = "Puppet environment and module deployment"
+  s.description = <<-DESCRIPTION
+    R10K provides a general purpose toolset for deploying Puppet environments and modules.
+    It implements the Puppetfile format and provides a native implementation of Puppet
+    dynamic environments.
+  DESCRIPTION
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.license  = 'Apache-2.0'
+
+  s.add_dependency 'colored2',   '3.1.2'
+  s.add_dependency 'cri', ['>= 2.15.10', '< 3.0.0']
+
+  s.add_dependency 'log4r',     '1.1.10'
+  s.add_dependency 'multi_json', '~> 1.10'
+
+  s.add_dependency 'puppet_forge', '~> 2.3.0'
+
+  s.add_dependency 'gettext-setup', '~>0.24'
+  # These two pins narrow what is allowed by gettext-setup,
+  # to preserver compatability with Ruby 2.4
+  s.add_dependency 'fast_gettext', '~> 1.1.0'
+  s.add_dependency 'gettext', ['>= 3.0.2', '< 3.3.0']
+
+  s.add_development_dependency 'rspec', '~> 3.1'
+
+  s.add_development_dependency 'rake'
+
+  s.add_development_dependency 'yard', '~> 0.9.11'
+  s.add_development_dependency 'minitar', '~> 0.9.0'
+
+  s.files        = %x[git ls-files].split($/)
+  s.require_path = 'lib'
+  s.bindir       = 'bin'
+  s.executables  = 'r10k'
+end

data/r10k.yaml.example

@@ -0,0 +1,112 @@
+---
+# 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 '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:
+    # 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'
+
+    # The Puppetfile filename in the repo, defaults to 'Puppetfile'. This
+    # setting can be used, to allow custom Puppetfile names to allow hybrid
+    # use of librarian-puppet (transitive dependency resolution) and r10k
+    # (code management on the server).
+    #puppetfile_name: 'Puppetfile.r10k'
+
+  # 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'
+
+  # 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. 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/fixtures/module/forge/bad_module/metadata.json

@@ -0,0 +1 @@
+I am bad JSON!

data/spec/fixtures/module/forge/eight_hundred/Modulefile

@@ -0,0 +1,8 @@
+name    'branan-eight_hundred'
+version '8.0.0'
+source  'https://github.com/branan/puppet-module-eight_hundred'
+author  'Branan Purvine-Riley'
+license 'Apache License 2.0'
+summary '800 modules! WOOOOOOO!'
+description '800 modules! WOOOOOOOOOOOOOOOOOO!'
+project_page 'https://github.com/branan/puppet-module-eight_hundred'

data/spec/fixtures/module/forge/eight_hundred/metadata.json

@@ -0,0 +1,19 @@
+{
+  "checksums": {
+    "Modulefile": "1e780d794bcd6629dc3006129fc02edf"
+  },
+  "license": "Apache License 2.0",
+  "types": [
+
+  ],
+  "version": "8.0.0",
+  "dependencies": [
+
+  ],
+  "summary": "800 modules! WOOOOOOO!",
+  "source": "https://github.com/branan/puppet-module-eight_hundred",
+  "description": "800 modules! WOOOOOOOOOOOOOOOOOO!",
+  "author": "Branan Purvine-Riley",
+  "name": "branan-eight_hundred",
+  "project_page": "https://github.com/branan/puppet-module-eight_hundred"
+}

data/spec/fixtures/unit/action/r10k.yaml

@@ -0,0 +1,5 @@
+---
+  cachedir: /config_cachedir
+  deploy:
+    generate_types: /config_generate_types
+    puppet_path: /config_puppet_path

data/spec/fixtures/unit/action/r10k_cachedir.yaml

@@ -0,0 +1,2 @@
+---
+  cachedir: /config_cachedir

data/spec/fixtures/unit/action/r10k_generate_types.yaml

@@ -0,0 +1,3 @@
+---
+  deploy:
+    generate_types: /config_generate_types

data/spec/fixtures/unit/action/r10k_puppet_path.yaml

@@ -0,0 +1,3 @@
+---
+  deploy:
+    puppet_path: /config_puppet_path

data/spec/fixtures/unit/puppetfile/argument-error/Puppetfile

@@ -0,0 +1 @@
+mod 'branan/eight_hundred', '1.0.0', :git => 'https://github.com/branan/eight_hundred', :ref => 'master'

data/spec/fixtures/unit/puppetfile/default-branch-override/Puppetfile

@@ -0,0 +1,5 @@
+mod 'cd4pe',
+  :git => 'test@randomurl.com:something/some_module.git',
+  :ref => 'expected_ref',
+  :default_branch => 'here_lies_the_default_branch'
+

data/spec/fixtures/unit/puppetfile/duplicate-module-error/Puppetfile

@@ -0,0 +1,10 @@
+forge "http://forge.puppetlabs.com"
+
+mod "puppetlabs/stdlib", '4.11.0'
+mod "puppetlabs/stdlib", '4.12.0'
+mod "puppetlabs/concat", '2.1.0'
+mod "otheruser/concat", '2.1.0'
+
+mod 'apache',
+  :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
+  :branch => 'docs_experiment'

data/spec/fixtures/unit/puppetfile/invalid-syntax/Puppetfile

@@ -0,0 +1 @@
+mod 'branan/eight_hundred' :git => 'https://github.com/branan/eight_hundred'

data/spec/fixtures/unit/puppetfile/load-error/Puppetfile

@@ -0,0 +1 @@
+require 'a-shrubbery!'

data/spec/fixtures/unit/puppetfile/name-error/Puppetfile

@@ -0,0 +1 @@
+mod 'branan/eight_hundred', undefined_lookup_function('eight_hundred')

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/fixtures/unit/util/subprocess/runner/no-execute.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "This was supposed to be non-executable..."

data/spec/integration/git/rugged/bare_repository_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'r10k/git/rugged/bare_repository'
+
+describe R10K::Git::Rugged::BareRepository, :if => R10K::Features.available?(:rugged) do
+  include_context 'Git integration'
+
+  let(:dirname) { 'bare-repo.git' }
+
+  subject { described_class.new(basedir, dirname) }
+
+  it_behaves_like 'a git repository'
+  it_behaves_like 'a git bare repository'
+end

data/spec/integration/git/rugged/thin_repository_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'r10k/git/rugged/thin_repository'
+
+describe R10K::Git::Rugged::ThinRepository, :if => R10K::Features.available?(:rugged) do
+  include_context 'Git integration'
+
+  let(:dirname) { 'working-repo' }
+
+  let(:cacherepo) { R10K::Git::Rugged::Cache.generate(remote) }
+
+  subject { described_class.new(basedir, dirname, cacherepo) }
+
+  it_behaves_like "a git thin repository"
+end

data/spec/integration/git/rugged/working_repository_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'r10k/git/rugged/working_repository'
+
+describe R10K::Git::Rugged::WorkingRepository, :if => R10K::Features.available?(:rugged) do
+  include_context 'Git integration'
+
+  let(:dirname) { 'working-repo' }
+
+  subject { described_class.new(basedir, dirname) }
+
+  it_behaves_like 'a git repository'
+  it_behaves_like 'a git working repository'
+
+  describe "checking out an unresolvable ref" do
+    it "raises an error indicating that the ref was unresolvable" do
+      expect(subject).to receive(:resolve).with("unresolvable")
+      expect {
+        subject.checkout("unresolvable")
+      }.to raise_error(R10K::Git::GitError, /Unable to check out unresolvable ref 'unresolvable'/)
+    end
+  end
+
+  context "checking out a specific SHA" do
+    let(:_rugged_repo) { double("Repository") }
+
+    before do
+      subject.clone(remote)
+      allow(subject).to receive(:with_repo).and_yield(_rugged_repo)
+      allow(subject).to receive(:resolve).and_return("157011a4eaa27f1202a9d94335ee4876b26d377e")
+    end
+
+    describe "with force" do
+      it "does not receive a checkout call" do
+        expect(_rugged_repo).to_not receive(:checkout)
+        expect(_rugged_repo).to receive(:reset)
+        subject.checkout("157011a4eaa27f1202a9d94335ee4876b26d377e", {:force => true})
+      end
+    end
+
+    describe "without force" do
+      it "does receive a checkout call" do
+        expect(_rugged_repo).to receive(:checkout)
+        expect(_rugged_repo).to_not receive(:reset)
+        subject.checkout("157011a4eaa27f1202a9d94335ee4876b26d377e", {:force => false})
+      end
+    end
+  end
+end

data/spec/integration/git/shellgit/bare_repository_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'r10k/git/shellgit/bare_repository'
+
+describe R10K::Git::ShellGit::BareRepository do
+  include_context 'Git integration'
+
+  let(:dirname) { 'bare-repo.git' }
+
+  subject { described_class.new(basedir, dirname) }
+
+  it_behaves_like 'a git repository'
+  it_behaves_like 'a git bare repository'
+end

data/spec/integration/git/shellgit/thin_repository_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'r10k/git/shellgit/thin_repository'
+
+describe R10K::Git::ShellGit::ThinRepository do
+  include_context 'Git integration'
+
+  let(:dirname) { 'working-repo' }
+
+  let(:cacherepo) { R10K::Git::ShellGit::Cache.generate(remote) }
+
+  subject { described_class.new(basedir, dirname, cacherepo) }
+
+  it_behaves_like "a git thin repository"
+end

data/spec/integration/git/shellgit/working_repository_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'r10k/git/shellgit/working_repository'
+
+describe R10K::Git::ShellGit::WorkingRepository do
+  include_context 'Git integration'
+
+  let(:dirname) { 'working-repo' }
+
+  subject { described_class.new(basedir, dirname) }
+
+  it_behaves_like 'a git repository'
+  it_behaves_like 'a git working repository'
+end

data/spec/integration/git/stateful_repository_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+require 'r10k/git'
+require 'r10k/git/stateful_repository'
+
+describe R10K::Git::StatefulRepository do
+  include_context 'Git integration'
+
+  let(:dirname) { 'working-repo' }
+
+  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(remote, basedir, dirname) }
+
+  describe 'status' do
+    describe "when the directory does not exist" do
+      it "is absent" do
+        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(ref)).to eq :mismatched
+      end
+    end
+
+    describe "when the directory has a .git file" do
+      it "is mismatched" do
+        thinrepo.path.mkdir
+        File.open("#{thinrepo.path}/.git", "w") {}
+        expect(subject.status(ref)).to eq :mismatched
+      end
+    end
+
+    describe "when the repository doesn't match the desired remote" 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(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(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 => ref})
+        cacherepo.reset!
+        expect(subject.status(ref)).to eq :outdated
+      end
+    end
+
+    describe "when the ref can't be resolved" do
+      let(:ref) { '1.1.x' }
+
+      it "is outdated" do
+        thinrepo.clone(remote, {:ref => '0.9.x'})
+        expect(subject.status(ref)).to eq :outdated
+      end
+    end
+
+    describe "when the workdir has local modifications" do
+      it "is dirty when workdir is up to date" 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
+
+      it "is dirty when workdir is not up to date" do
+        thinrepo.clone(remote, {:ref => '1.0.0'})
+        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 => ref})
+        expect(subject.status(ref)).to eq :insync
+      end
+    end
+  end
+
+  describe "syncing" do
+    describe "when the ref is unresolvable" do
+      let(:ref) { '1.1.x' }
+
+      it "raises an error" do
+        expect {
+          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(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(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(ref)
+        expect(subject.status(ref)).to eq :insync
+      end
+    end
+
+    describe "when the workdir is dirty" do
+      before(:each) do
+        thinrepo.clone(remote, {:ref => ref})
+        File.open(File.join(thinrepo.path, 'README.markdown'), 'a') { |f| f.write('local modifications!') }
+      end
+
+      context "when force == true" do
+        let(:force) { true }
+
+        it "warns and overwrites local modifications" do
+          expect(subject.logger).to receive(:warn).with(/overwriting local modifications/i)
+
+          subject.sync(ref, force)
+
+          expect(subject.status(ref)).to eq :insync
+        end
+      end
+
+      context "when force != true" do
+        let(:force) { false }
+
+        it "warns and does not overwrite local modifications" do
+          expect(subject.logger).to receive(:warn).with(/skipping.*due to local modifications/i)
+
+          subject.sync(ref, force)
+
+          expect(subject.status(ref)).to eq :dirty
+        end
+      end
+    end
+  end
+end