class R10K::Source::Git

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

Attributes

cache[R]

@!attribute [r] cache

@api private
@return [R10K::Git::Cache] The git cache associated with this source

filter_command[R]

@!attribute [r] filter_command

@return [String] Command to run to filter branches

ignore_branch_prefixes[R]

@!attribute [r] ignore_branch_prefixes

@return [Array<String>] Array of strings used to remove repository branches
  that will be deployed as environments.

invalid_branches[R]

@!attribute [r] invalid_branches

@return [String] How Git branch names that cannot be cleanly mapped to
  Puppet environments will be handled.

remote[R]

@!attribute [r] remote

@return [String] The URL to the remote git repository

settings[R]

@!attribute [r] settings

@return [Hash<Symbol, Object>] Additional settings that configure how
  the source should behave.

Public Class Methods

new(name, basedir, options = {}) click to toggle source

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, String] :prefix If a String this becomes the prefix.

If true, will use the source name as the prefix.
Defaults to false for no environment prefix.

@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.

Calls superclass method R10K::Source::Base::new

# File lib/r10k/source/git.rb, line 58
def initialize(name, basedir, options = {})
  super

  @environments = []

  @remote = options[:remote]
  @invalid_branches = (options[:invalid_branches] || 'correct_and_warn')
  @ignore_branch_prefixes = options[:ignore_branch_prefixes]
  @filter_command = options[:filter_command]

  @cache  = R10K::Git.cache.generate(@remote)
end

Public Instance Methods

desired_contents() click to toggle source

List all environments that should exist in the basedir for this source @note This is required by {R10K::Util::Basedir} @return [Array<String>]

# File lib/r10k/source/git.rb, line 132
def desired_contents
  environments.map {|env| env.dirname }
end

environments() click to toggle source

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>]

# File lib/r10k/source/git.rb, line 86
def environments
  if not @cache.cached?
    []
  elsif @environments.empty?
    @environments = generate_environments()
  else
    @environments
  end
end

fetch_remote()

Alias for: preload!

filter_branches_by_command(branches, command) click to toggle source

# File lib/r10k/source/git.rb, line 148
def filter_branches_by_command(branches, command)
  branches.select do |branch|
    result = system({'GIT_DIR' => @cache.git_dir.to_s, 'R10K_BRANCH' => branch, 'R10K_NAME' => @name.to_s}, command)
    unless result
      logger.warn _("Branch `%{name}:%{branch}` filtered out by filter_command %{cmd}") % {name: @name, branch: branch, cmd: command}
    end
    result
  end
end

filter_branches_by_regexp(branches, ignore_prefixes) click to toggle source

# File lib/r10k/source/git.rb, line 136
def filter_branches_by_regexp(branches, ignore_prefixes)
  filter = Regexp.new("^#{Regexp.union(ignore_prefixes)}")
  branches = branches.reject do |branch|
    result = filter.match(branch)
    if result
      logger.warn _("Branch %{branch} filtered out by ignore_branch_prefixes %{ibp}") % {branch: branch, ibp: @ignore_branch_prefixes}
    end
    result
  end
  branches
end

generate_environments() click to toggle source

# File lib/r10k/source/git.rb, line 101
def generate_environments
  envs = []
  environment_names.each do |en|
    if en.valid?
      envs << R10K::Environment::Git.new(en.name,
                                         @basedir,
                                         en.dirname,
                                         {remote: remote,
                                          ref: en.original_name,
                                          puppetfile_name: puppetfile_name,
                                          overrides: @options[:overrides]})
    elsif en.correct?
     logger.warn _("Environment %{env_name} contained non-word characters, correcting name to %{corrected_env_name}") % {env_name: en.name.inspect, corrected_env_name: en.dirname}
      envs << R10K::Environment::Git.new(en.name,
                                         @basedir,
                                         en.dirname,
                                         {remote: remote,
                                          ref: en.original_name,
                                          puppetfile_name: puppetfile_name,
                                          overrides: @options[:overrides]})
    elsif en.validate?
     logger.error _("Environment %{env_name} contained non-word characters, ignoring it.") % {env_name: en.name.inspect}
    end
  end

  envs
end

preload!() click to toggle source

Update the git cache for this git source to get the latest list of environments.

@return [void]

# File lib/r10k/source/git.rb, line 74
def preload!
  logger.debug _("Fetching '%{remote}' to determine current branches.") % {remote: @remote}
  @cache.sync
rescue => e
  raise R10K::Error.wrap(e, _("Unable to determine current branches for Git source '%{name}' (%{basedir})") % {name: @name, basedir: @basedir})
end

Also aliased as: fetch_remote

reload!() click to toggle source

# File lib/r10k/source/git.rb, line 96
def reload!
  @cache.sync!
  @environments = generate_environments()
end

Private Instance Methods

environment_names() click to toggle source

# File lib/r10k/source/git.rb, line 160
def environment_names
  opts = {prefix: @prefix,
          invalid: @invalid_branches,
          source: @name,
          strip_component: @strip_component}
  branch_names = @cache.branches
  if @ignore_branch_prefixes && !@ignore_branch_prefixes.empty?
    branch_names = filter_branches_by_regexp(branch_names, @ignore_branch_prefixes)
  end

  if @filter_command && !@filter_command.empty?
    branch_names = filter_branches_by_command(branch_names, @filter_command)
  end

  branch_names.map do |branch_name|
    R10K::Environment::Name.new(branch_name, opts)
  end
end