r10k 1.2.4 → 1.3.0rc1

data/lib/r10k/source/git.rb

@@ -0,0 +1,195 @@
+require 'r10k/git'
+require 'r10k/environment'
+require 'r10k/util/purgeable'
+require 'r10k/util/core_ext/hash_ext'
+
+# This class implements a source for Git environments.
+#
+# A Git source generates environments by locally caching the given Git
+# repository and enumerating the branches for the Git repository. Branches
+# are mapped to environments without modification.
+#
+# @since 1.3.0
+class R10K::Source::Git < R10K::Source::Base
+
+  include R10K::Logging
+
+  R10K::Source.register(:git, self)
+  # Register git as the default source
+  R10K::Source.register(nil, self)
+
+  # @!attribute [r] remote
+  #   @return [String] The URL to the remote git repository
+  attr_reader :remote
+
+  # @!attribute [r] cache
+  #   @api private
+  #   @return [R10K::Git::Cache] The git cache associated with this source
+  attr_reader :cache
+
+  # @!attribute [r] settings
+  #   @return [Hash<Symbol, Object>] Additional settings that configure how
+  #     the source should behave.
+  attr_reader :settings
+
+  # @!attribute [r] invalid_branches
+  #   @return [String] How Git branch names that cannot be cleanly mapped to
+  #     Puppet environments will be handled.
+  attr_reader :invalid_branches
+
+  # Initialize the given source.
+  #
+  # @param name [String] The identifier for this source.
+  # @param basedir [String] The base directory where the generated environments will be created.
+  # @param options [Hash] An additional set of options for this source.
+  #
+  # @option options [Boolean] :prefix Whether to prefix the source name to the
+  #   environment directory names. Defaults to false.
+  # @option options [String] :remote The URL to the base directory of the SVN repository
+  # @option options [Hash] :remote Additional settings that configure how the
+  #   source should behave.
+  def initialize(name, basedir, options = {})
+    super
+
+    @environments = []
+
+    @remote           = options[:remote]
+    @invalid_branches = (options[:invalid_branches] || 'correct_and_warn')
+
+    @cache  = R10K::Git::Cache.generate(@remote)
+  end
+
+  # Update the git cache for this git source to get the latest list of environments.
+  #
+  # @return [void]
+  def preload!
+    logger.info "Determining current branches for #{@remote.inspect}"
+    @cache.sync
+  end
+  alias fetch_remote preload!
+
+  # Load the git remote and create environments for each branch. If the cache
+  # has not been fetched, this will return an empty list.
+  #
+  # @return [Array<R10K::Environment::Git>]
+  def environments
+    if not @cache.cached?
+      []
+    elsif not @environments.empty?
+      @environments
+    else
+      @environments = generate_environments()
+    end
+  end
+
+  def generate_environments
+    envs = []
+    branch_names.each do |bn|
+      if bn.valid?
+        envs << R10K::Environment::Git.new(bn.name, @basedir, bn.dirname,
+                                       {:remote => remote, :ref => bn.name})
+      elsif bn.correct?
+       logger.warn "Environment #{bn.name.inspect} contained non-word characters, correcting name to #{bn.dirname}"
+        envs << R10K::Environment::Git.new(bn.name, @basedir, bn.dirname,
+                                       {:remote => remote, :ref => bn.name})
+      elsif bn.validate?
+       logger.error "Environment #{bn.name.inspect} contained non-word characters, ignoring it."
+      end
+    end
+
+    envs
+  end
+
+  include R10K::Util::Purgeable
+
+  def managed_directory
+    @basedir
+  end
+
+  def current_contents
+    dir = self.managed_directory
+    glob_part = @prefix ? @name.to_s() + '_*' : '*'
+    glob_exp = File.join(dir, glob_part)
+
+    Dir.glob(glob_exp).map do |fname|
+      File.basename fname
+    end
+  end
+
+  # List all environments that should exist in the basedir for this source
+  # @note This implements a required method for the Purgeable mixin
+  # @return [Array<String>]
+  def desired_contents
+    @environments.map {|env| env.dirname }
+  end
+
+  private
+
+  def branch_names
+    @cache.branches.map do |branch|
+      BranchName.new(branch, {
+        :prefix     => @prefix,
+        :sourcename => @name,
+        :invalid    => @invalid_branches,
+      })
+    end
+  end
+
+  # @api private
+  class BranchName
+
+    attr_reader :name
+
+    INVALID_CHARACTERS = %r[\W]
+
+    def initialize(name, opts)
+      @name = name
+      @opts = opts
+
+      @prefix = opts[:prefix]
+      @sourcename = opts[:sourcename]
+      @invalid = opts[:invalid]
+
+      case @invalid
+      when 'correct_and_warn'
+        @validate = true
+        @correct  = true
+      when 'correct'
+        @validate = false
+        @correct  = true
+      when 'error'
+        @validate = true
+        @correct  = false
+      when NilClass
+        @validate = opts[:validate]
+        @correct = opts[:correct]
+      end
+    end
+
+    def correct?; @correct end
+    def validate?; @validate end
+
+    def valid?
+      if @validate
+        ! @name.match(INVALID_CHARACTERS)
+      else
+        true
+      end
+    end
+
+    def dirname
+      dir = @name.dup
+
+      if @prefix
+        dir = "#{@sourcename}_#{dir}"
+      end
+
+      if @correct
+        dir.gsub!(INVALID_CHARACTERS, '_')
+      end
+
+      dir
+    end
+
+  end
+end

data/lib/r10k/source/svn.rb

@@ -0,0 +1,140 @@
+require 'r10k/svn'
+require 'r10k/environment'
+require 'r10k/util/purgeable'
+require 'r10k/util/core_ext/hash_ext'
+
+# This class implements a source for SVN environments.
+#
+# An SVN source generates environments by enumerating the branches and trunk
+# for a given SVN remote. SVN repositories must conform to the conventional
+# SVN repository structure with the directories trunk/, branches/, and
+# optionally tags/ in the root of the repository. The trunk/ directory is
+# specifically mapped to the production environment, branches are created
+# as environments with the name of the given branch.
+#
+# @see http://svnbook.red-bean.com/en/1.7/svn.branchmerge.maint.html
+# @since 1.3.0
+class R10K::Source::SVN < R10K::Source::Base
+
+  R10K::Source.register(:svn, self)
+
+  # @!attribute [r] remote
+  #   @return [String] The URL to the base directory of the SVN repository
+  attr_reader :remote
+
+  # @!attribute [r] svn_remote
+  #   @api private
+  #   @return [R10K::SVN::Remote]
+  attr_reader :svn_remote
+
+  # Initialize the given source.
+  #
+  # @param name [String] The identifier for this source.
+  # @param basedir [String] The base directory where the generated environments will be created.
+  # @param options [Hash] An additional set of options for this source.
+  #
+  # @option options [Boolean] :prefix Whether to prefix the source name to the
+  #   environment directory names. Defaults to false.
+  # @option options [String] :remote The URL to the base directory of the SVN repository
+  def initialize(name, basedir, options = {})
+    super
+
+    @remote = options[:remote]
+    @environments = []
+
+    @svn_remote = R10K::SVN::Remote.new(@remote)
+  end
+
+  # Enumerate the environments associated with this SVN source.
+  #
+  # @return [Array<R10K::Environment::SVN>] An array of environments created
+  #   from this source.
+  def environments
+    if @environments.empty?
+      @environments = generate_environments()
+    end
+
+    @environments
+  end
+
+  # Generate a list of currently available SVN environments
+  #
+  # @todo respect environment name corrections
+  #
+  # @api protected
+  # @return [Array<R10K::Environment::SVN>] An array of environments created
+  #   from this source.
+  def generate_environments
+
+    branch_names.map do |branch|
+      R10K::Environment::SVN.new(branch.name, @basedir, branch.dirname,
+                                 { :remote => branch.remote })
+    end
+  end
+
+  include R10K::Util::Purgeable
+
+  def managed_directory
+    @basedir
+  end
+
+  def current_contents
+    Dir.glob(File.join(@basedir, '*')).map do |fname|
+      File.basename fname
+    end
+  end
+
+  # List all environments that should exist in the basedir for this source
+  # @note This implements a required method for the Purgeable mixin
+  # @return [Array<String>]
+  def desired_contents
+    @environments.map {|env| env.dirname }
+  end
+
+  include R10K::Logging
+
+  private
+
+  def branch_names
+    branches = []
+
+    branch_opts = {
+      :prefix     => @prefix,
+      :sourcename => @name,
+    }
+
+    branches << BranchName.new('production', "#{@remote}/trunk", branch_opts)
+    @svn_remote.branches.each do |branch|
+      branches << BranchName.new(branch, "#{@remote}/branches/#{branch}", branch_opts)
+    end
+
+    branches
+  end
+
+  # @api private
+  # @todo respect environment name corrections
+  class BranchName
+
+    attr_reader :name
+    attr_reader :remote
+
+    def initialize(name, remote, opts)
+      @name   = name
+      @remote = remote
+      @opts   = opts
+
+      @prefix = opts[:prefix]
+      @sourcename = opts[:sourcename]
+    end
+
+    def dirname
+      dir = @name.dup
+
+      if @prefix
+        dir = "#{@sourcename}_#{dir}"
+      end
+
+      dir
+    end
+  end
+end

data/lib/r10k/source.rb

@@ -0,0 +1,39 @@
+require 'r10k'
+require 'r10k/keyed_factory'
+require 'r10k/util/core_ext/hash_ext'
+
+module R10K
+  module Source
+    def self.factory
+      @factory ||= R10K::KeyedFactory.new
+    end
+
+    def self.register(key, klass)
+      factory.register(key, klass)
+    end
+
+    def self.retrieve(key)
+      factory.retrieve(key)
+    end
+
+    def self.generate(type, basedir, name, options = {})
+      factory.generate(type, basedir, name, options)
+    end
+
+    def self.from_hash(name, hash)
+      hash.extend R10K::Util::CoreExt::HashExt::SymbolizeKeys
+      hash.symbolize_keys!
+
+      basedir = hash.delete(:basedir)
+
+      type = hash.delete(:type)
+      type = type.is_a?(String) ? type.to_sym : type
+
+      generate(type, name, basedir, hash)
+    end
+
+    require 'r10k/source/base'
+    require 'r10k/source/git'
+    require 'r10k/source/svn'
+  end
+end

data/lib/r10k/svn/remote.rb

@@ -0,0 +1,48 @@
+require 'r10k/util/subprocess'
+
+class R10K::SVN::Remote
+
+  def initialize(baseurl)
+    @baseurl = baseurl
+  end
+
+  # @todo validate that the path to trunk exists in the remote
+  def trunk
+    "#{@baseurl}/trunk"
+  end
+
+  # @todo gracefully handle cases where no branches exist
+  def branches
+    text = svn ['ls', "#{@baseurl}/branches"]
+    text.lines.map do |line|
+      line.chomp!
+      line.gsub!(%r[/$], '')
+      line
+    end
+  end
+
+  private
+
+  include R10K::Logging
+
+  # Wrap SVN commands
+  #
+  # @param argv [Array<String>]
+  # @param opts [Hash]
+  #
+  # @option opts [Pathname] :cwd The directory to run the command in
+  #
+  # @return [String] The stdout from the given command
+  def svn(argv, opts = {})
+    argv.unshift('svn')
+
+    subproc = R10K::Util::Subprocess.new(argv)
+    subproc.raise_on_fail = true
+    subproc.logger = self.logger
+
+    subproc.cwd = opts[:cwd]
+    result = subproc.execute
+
+    result.stdout
+  end
+end

data/lib/r10k/svn/working_dir.rb

@@ -1,4 +1,3 @@
-require 'r10k/logging'
 require 'r10k/util/subprocess'
 
 module R10K
@@ -48,7 +47,6 @@ module R10K
         svn ["info"], :cwd => @full_path
       end
 
-      include R10K::Execution
       include R10K::Logging
 
       # Wrap SVN commands

data/lib/r10k/svn.rb

@@ -0,0 +1,6 @@
+module R10K
+  module SVN
+    require 'r10k/svn/working_dir'
+    require 'r10k/svn/remote'
+  end
+end

data/lib/r10k/task/deployment.rb

@@ -67,8 +67,7 @@ module Deployment
     end
 
     def call
-      logger.info "Loading environments from all sources"
-      @deployment.fetch_sources
+      @deployment.preload!
 
       with_environments(@environment_names) do |env|
         task = R10K::Task::Environment::Deploy.new(env)

data/lib/r10k/task.rb

@@ -1,5 +1,3 @@
-require 'r10k/logging'
-
 module R10K
 module Task
   class Base

data/lib/r10k/task_runner.rb

@@ -1,5 +1,4 @@
 require 'r10k/task'
-require 'r10k/logging'
 
 module R10K
 class TaskRunner

data/lib/r10k/util/core_ext/hash_ext.rb

@@ -0,0 +1,19 @@
+module R10K
+  module Util
+    module CoreExt
+      module HashExt
+        module SymbolizeKeys
+          def symbolize_keys!
+            self.keys.each do |key|
+              next unless key.is_a? String
+              if self[key.to_sym]
+                raise TypeError, "An existing interned key for #{key} exists, cannot overwrite"
+              end
+              self[key.to_sym] = self.delete(key)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r10k/util/subprocess.rb

@@ -1,4 +1,3 @@
-require 'r10k/logging'
 require 'r10k/errors'
 require 'r10k/util/platform'
 

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '1.2.4'
+  VERSION = '1.3.0rc1'
 end

data/lib/r10k.rb

@@ -1,3 +1,4 @@
 module R10K; end
 
 require 'r10k/version'
+require 'r10k/logging'

data/spec/unit/deployment/environment_spec.rb

@@ -2,23 +2,24 @@ require 'spec_helper'
 require 'r10k/deployment/environment'
 
 describe R10K::Deployment::Environment do
-  let(:remote) { 'git://github.com/adrienthebo/r10k-fixture-repo' }
-  let(:ref)    { 'master' }
 
-  describe 'dirname' do
-    it 'uses the ref as the default dirname' do
-      subject = described_class.new(ref, remote, '/tmp')
-      subject.dirname.should == 'master'
-    end
+  it "creates R10K::Environment::Git instances" do
+    subject = described_class.new('gitref', 'git://git-server.local/git-remote.git', '/some/nonexistent/dir')
+    expect(subject).to be_a_kind_of R10K::Environment::Git
+  end
+
+  it "uses the ref as the dirname by default" do
+    subject = described_class.new('gitref', 'git://git-server.local/git-remote.git', '/some/nonexistent/dir')
+    expect(subject.dirname).to eq 'gitref'
+  end
 
-    it 'uses the ref and a provided source name in the default dirname' do
-      subject = described_class.new(ref, remote, '/tmp', nil, "the")
-      subject.dirname.should == 'the_master'
-    end
+  it "can specify an explicit dirname" do
+    subject = described_class.new('gitref', 'git://git-server.local/git-remote.git', '/some/nonexistent/dir', 'explicit-dirname')
+    expect(subject.dirname).to eq 'explicit-dirname'
+  end
 
-    it 'allows a specific dirname to be set' do
-      subject = described_class.new(ref, remote, '/tmp', 'sourcename_master')
-      subject.dirname.should == 'sourcename_master'
-    end
+  it "supports prefixing for backwards compatibility" do
+    subject = described_class.new('gitref', 'git://git-server.local/git-remote.git', '/some/nonexistent/dir', nil, 'source')
+    expect(subject.dirname).to eq 'source_gitref'
   end
 end

data/spec/unit/environment/git_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'r10k/environment'
+
+describe R10K::Environment::Git do
+
+  subject do
+    described_class.new(
+      'myenv',
+      '/some/nonexistent/environmentdir',
+      'gitref',
+      {
+        :remote => 'git://git-server.site/my-repo.git',
+        :ref    => 'd026ea677116424d2968edb9cee8cbc24d09322b',
+      }
+    )
+  end
+
+  let(:working_dir) { subject.working_dir }
+
+  describe "storing attributes" do
+    it "can return the environment name" do
+      expect(subject.name).to eq 'myenv'
+    end
+
+    it "can return the environment basedir" do
+      expect(subject.basedir).to eq '/some/nonexistent/environmentdir'
+    end
+
+    it "can return the environment dirname" do
+      expect(subject.dirname).to eq 'gitref'
+    end
+
+    it "can return the environment remote" do
+      expect(subject.remote).to eq 'git://git-server.site/my-repo.git'
+    end
+
+    it "can return the environment ref" do
+      expect(subject.ref).to eq 'd026ea677116424d2968edb9cee8cbc24d09322b'
+    end
+  end
+
+  describe "synchronizing the environment" do
+    it "updates all modules when creating a new environment" do
+      allow(working_dir).to receive(:cloned?).and_return(false)
+      expect(working_dir).to receive(:sync)
+      expect(subject).to receive(:sync_modules)
+      subject.sync
+    end
+
+    it "does not update all modules when updating an existing environment" do
+      allow(working_dir).to receive(:cloned?).and_return(true)
+      expect(working_dir).to receive(:sync)
+      expect(subject).to_not receive(:sync_modules)
+      subject.sync
+    end
+  end
+
+  describe "generating a puppetfile for the environment" do
+    let(:puppetfile) { subject.puppetfile }
+
+    it "creates a puppetfile at the full path to the environment" do
+      expect(puppetfile.basedir).to eq '/some/nonexistent/environmentdir/gitref'
+    end
+
+    it "sets the moduledir to 'modules' relative to the environment path" do
+      expect(puppetfile.moduledir).to eq '/some/nonexistent/environmentdir/gitref/modules'
+    end
+
+    it "sets the puppetfile path to 'Puppetfile' relative to the environment path" do
+      expect(puppetfile.puppetfile_path).to eq '/some/nonexistent/environmentdir/gitref/Puppetfile'
+    end
+  end
+
+  describe "enumerating modules" do
+    it "loads the Puppetfile and returns modules in that puppetfile" do
+      expect(subject.puppetfile).to receive(:load)
+      expect(subject.puppetfile).to receive(:modules).and_return [:modules]
+      expect(subject.modules).to eq([:modules])
+    end
+  end
+end