r10k 3.5.2

data/lib/r10k/source/exec.rb

@@ -0,0 +1,51 @@
+require 'r10k/util/subprocess'
+require 'json'
+require 'yaml'
+
+class R10K::Source::Exec < R10K::Source::Hash
+  R10K::Source.register(:exec, self)
+
+  def initialize(name, basedir, options = {})
+    unless @command = options[:command]
+      raise ConfigError, _('Environment source %{name} missing required parameter: command') % {name: name}
+    end
+
+    # We haven't set the environments option yet. We will do that by
+    # overloading the #environments method.
+    super(name, basedir, options)
+  end
+
+  def environments_hash
+    @environments_hash ||= set_environments_hash(run_environments_command)
+  end
+
+  private
+
+  def run_environments_command
+    subproc = R10K::Util::Subprocess.new([@command])
+    subproc.raise_on_fail = true
+    subproc.logger = self.logger
+    procresult = subproc.execute
+
+    begin
+      environments = JSON.parse(procresult.stdout)
+    rescue JSON::ParserError => json_err
+      begin
+        environments = YAML.safe_load(procresult.stdout)
+      rescue Psych::SyntaxError => yaml_err
+        raise R10K::Error, _("Error parsing command output for exec source %{name}:\n" \
+                             "Not valid JSON: %{j_msg}\n" \
+                             "Not valid YAML: %{y_msg}\n" \
+                             "Stdout:\n%{out}") % {name: name, j_msg: json_err.message, y_msg: yaml_err.message, out: procresult.stdout}
+      end
+    end
+
+    unless R10K::Source::Hash.valid_environments_hash?(environments)
+      raise R10K::Error, _("Environment source %{name} command %{cmd} did not return valid environment data.\n" \
+                           'Returned: %{data}') % {name: name, cmd: @command, data: environments}
+    end
+
+    # Return the resulting environments hash
+    environments
+  end
+end

data/lib/r10k/source/git.rb

@@ -0,0 +1,142 @@
+require 'r10k/git'
+require 'r10k/environment'
+require 'r10k/environment/name'
+
+# 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
+
+  # @!attribute [r] ignore_branch_prefixes
+  #   @return [Array<String>] Array of strings used to remove repository branches
+  #     that will be deployed as environments.
+  attr_reader :ignore_branch_prefixes
+
+  # 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.
+  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]
+
+    @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.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
+  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 @environments.empty?
+      @environments = generate_environments()
+    else
+      @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, :puppetfile_name => puppetfile_name })
+      elsif bn.correct?
+       logger.warn _("Environment %{env_name} contained non-word characters, correcting name to %{corrected_env_name}") % {env_name: bn.name.inspect, corrected_env_name: bn.dirname}
+        envs << R10K::Environment::Git.new(bn.name, @basedir, bn.dirname,
+                                       {:remote => remote, :ref => bn.name, :puppetfile_name => puppetfile_name})
+      elsif bn.validate?
+       logger.error _("Environment %{env_name} contained non-word characters, ignoring it.") % {env_name: bn.name.inspect}
+      end
+    end
+
+    envs
+  end
+
+  # List all environments that should exist in the basedir for this source
+  # @note This is required by {R10K::Util::Basedir}
+  # @return [Array<String>]
+  def desired_contents
+    environments.map {|env| env.dirname }
+  end
+
+  def filter_branches(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
+
+  private
+
+  def branch_names
+    opts = {:prefix => @prefix, :invalid => @invalid_branches, :source => @name}
+    branches = @cache.branches
+    if @ignore_branch_prefixes && !@ignore_branch_prefixes.empty?
+      branches = filter_branches(branches, @ignore_branch_prefixes)
+    end
+    branches.map do |branch|
+      R10K::Environment::Name.new(branch, opts)
+    end
+  end
+end

data/lib/r10k/source/hash.rb

@@ -0,0 +1,182 @@
+# This class implements an environment source based on recieving a hash of
+# environments
+#
+# @since 3.4.0
+#
+# DESCRIPTION
+#
+# This class implements environments defined by a hash having the following
+# schema:
+#
+#     ---
+#     type: object
+#     additionalProperties:
+#       type: object
+#       properties:
+#         type:
+#           type: string
+#         basedir:
+#           type: string
+#         modules:
+#           type: object
+#           additionalProperties:
+#             type: object
+#         moduledir:
+#           type: string
+#       additionalProperties:
+#         type: string
+#
+# The top-level keys in the hash are environment names. Keys in individual
+# environments should be the same as those which would be given to define a
+# single source in r10k.yaml. Additionally, the "modules" key (and moduledir)
+# can be used to designate module content for the environment, independent of
+# the base source parameters.
+#
+# Example:
+#
+#     ---
+#     production:
+#       type: git
+#       remote: 'https://github.com/reidmv/control-repo.git'
+#       ref: '1.0.0'
+#       modules:
+#         geoffwilliams-r_profile: '1.1.0'
+#         geoffwilliams-r_role: '2.0.0'
+#
+#     development:
+#       type: git
+#       remote: 'https://github.com/reidmv/control-repo.git'
+#       ref: 'master'
+#       modules:
+#         geoffwilliams-r_profile: '1.1.0'
+#         geoffwilliams-r_role: '2.0.0'
+#
+# USAGE
+#
+# The following is an example implementation class showing how to use the
+# R10K::Source::Hash abstract base class. Assume an r10k.yaml file such as:
+#
+#     ---
+#     sources:
+#       proof-of-concept:
+#         type: demo
+#         basedir: '/etc/puppetlabs/code/environments'
+#
+# Class implementation:
+#
+#     class R10K::Source::Demo < R10K::Source::Hash
+#       R10K::Source.register(:demo, self)
+#
+#       def initialize(name, basedir, options = {})
+#         # This is just a demo class, so we hard-code an example :environments
+#         # hash here. In a real class, we might do something here such as
+#         # perform an API call to retrieve an :environments hash.
+#         options[:environments] = {
+#           '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',
+#               },
+#             },
+#           },
+#         }
+#
+#         # All we need to do is supply options with the :environments hash.
+#         # The R10K::Source::Hash parent class takes care of the rest.
+#         super(name, basedir, options)
+#       end
+#     end
+#
+# Example output:
+#
+#     [root@master:~] % r10k deploy environment production -pv
+#     INFO     -> Using Puppetfile '/etc/puppetlabs/code/environments/production/Puppetfile'
+#     INFO     -> Using Puppetfile '/etc/puppetlabs/code/environments/development/Puppetfile'
+#     INFO     -> Deploying environment /etc/puppetlabs/code/environments/production
+#     INFO     -> Environment production is now at 74ea2e05bba796918e4ff1803018c526337ef5f3
+#     INFO     -> Deploying Environment content /etc/puppetlabs/code/environments/production/modules/stdlib
+#     INFO     -> Deploying Environment content /etc/puppetlabs/code/environments/production/modules/ntp
+#     INFO     -> Deploying Environment content /etc/puppetlabs/code/environments/production/modules/myapp1
+#     INFO     -> Deploying Puppetfile content /etc/puppetlabs/code/environments/production/modules/ruby_task_helper
+#     INFO     -> Deploying Puppetfile content /etc/puppetlabs/code/environments/production/modules/bolt_shim
+#     INFO     -> Deploying Puppetfile content /etc/puppetlabs/code/environments/production/modules/apply_helpers
+#
+class R10K::Source::Hash < R10K::Source::Base
+
+  include R10K::Logging
+
+  # @param hash [Hash] A hash to validate.
+  # @return [Boolean] False if the hash is obviously invalid. A true return
+  #   means _maybe_ it's valid.
+  def self.valid_environments_hash?(hash)
+    # TODO: more robust schema valiation
+    hash.is_a?(Hash)
+  end
+
+  # @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. The
+  #   semantics of this hash may depend on the source implementation.
+  #
+  # @option options [Boolean, String] :prefix If a String this becomes the prefix.
+  #   If true, will use the source name as the prefix. All sources should respect this option.
+  #   Defaults to false for no environment prefix.
+  # @option options [Hash] :environments The hash definition of environments
+  def initialize(name, basedir, options = {})
+    super(name, basedir, options)
+  end
+
+  # Set the environment hash for the source. The environment hash is what the
+  # source uses to generate enviroments.
+  # @param hash [Hash] The hash to sanitize and use as the source's environments.
+  #   Should be formatted for use with R10K::Environment#from_hash.
+  def set_environments_hash(hash)
+    @environments_hash = hash.reduce({}) do |memo,(name,opts)|
+      R10K::Util::SymbolizeKeys.symbolize_keys!(opts)
+      memo.merge({ 
+        name => opts.merge({
+          :basedir => @basedir,
+          :dirname => R10K::Environment::Name.new(name, {prefix: @prefix, source: @name}).dirname
+        })
+      })
+    end
+  end
+
+  # Return the sanitized environments hash for this source. The environments
+  # hash should contain objects formatted for use with R10K::Environment#from_hash.
+  # If the hash does not exist it will be built based on @options.
+  def environments_hash
+    @environments_hash ||= set_environments_hash(@options.fetch(:environments, {}))
+  end
+
+  def environments
+    @environments ||= environments_hash.map do |name, hash|
+      R10K::Environment.from_hash(name, hash)
+    end
+  end
+
+  # List all environments that should exist in the basedir for this source
+  # @note This is required by {R10K::Util::Basedir}
+  # @return [Array<String>]
+  def desired_contents
+    environments.map {|env| env.dirname }
+  end
+
+end

data/lib/r10k/source/svn.rb

@@ -0,0 +1,136 @@
+require 'r10k/svn'
+require 'r10k/environment'
+require 'r10k/environment/name'
+require 'r10k/util/setopts'
+
+# 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
+
+  # @!attribute [r] username
+  #   @return [String, nil] The SVN username to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :username
+
+  # @!attribute [r] password
+  #   @return [String, nil] The SVN password to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :password
+
+  # @!attribute [r] ignore_branch_prefixes
+  #   @return [Array<String>] Array of strings used to remove repository branches
+  #     that will be deployed as environments.
+  attr_reader :ignore_branch_prefixes
+
+  include R10K::Util::Setopts
+
+  # 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 [String] :username The SVN username
+  # @option options [String] :password The SVN password
+  # @option options [String] :puppetfile_name The puppetfile name
+  def initialize(name, basedir, options = {})
+    super
+
+    setopts(options, {:remote => :self, :username => :self, :password => :self, :puppetfile_name => :self })
+    @environments = []
+    @svn_remote = R10K::SVN::Remote.new(@remote, :username => @username, :password => @password)
+    @ignore_branch_prefixes = options[:ignore_branch_prefixes]
+  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
+    names_and_paths.map do |(branch, path)|
+      options = {
+        :remote   => path,
+        :username => @username,
+        :password => @password,
+        :puppetfile_name => puppetfile_name
+      }
+      R10K::Environment::SVN.new(branch.name, @basedir, branch.dirname, options)
+    end
+  end
+
+  # List all environments that should exist in the basedir for this source
+  # @note This is required by {R10K::Util::Basedir}
+  # @return [Array<String>]
+  def desired_contents
+    @environments.map {|env| env.dirname }
+  end
+
+  include R10K::Logging
+
+  def filter_branches(branches, ignore_prefixes)
+    filter = Regexp.new("^(#{ignore_prefixes.join('|')})")
+    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
+
+  private
+
+  def names_and_paths
+    branches = []
+    opts = {:prefix => @prefix, :correct => false, :validate => false, :source => @name}
+    branches << [R10K::Environment::Name.new('production', opts), "#{@remote}/trunk"]
+    additional_branch_names = @svn_remote.branches
+    if @ignore_branch_prefixes && !@ignore_branch_prefixes.empty?
+      additional_branch_names = filter_branches(additional_branch_names, @ignore_branch_prefixes)
+    end
+
+    additional_branch_names.each do |branch|
+      branches << [R10K::Environment::Name.new(branch, opts), "#{@remote}/branches/#{branch}"]
+    end
+    branches
+  end
+end