require 'r10k/logging' require 'r10k/util/purgeable' # This abstract base class implements an environment that can include module # content # # @since 3.4.0 class R10K::Environment::WithModules < R10K::Environment::Base include R10K::Logging # @!attribute [r] moduledir # @return [String] The directory to install environment-defined modules # into (default: #{basedir}/modules) attr_reader :moduledir # Initialize the given environment. # # @param name [String] The unique name describing this environment. # @param basedir [String] The base directory where this environment will be created. # @param dirname [String] The directory name for this environment. # @param options [Hash] An additional set of options for this environment. # # @param options [String] :moduledir The path to install modules to # @param options [Hash] :modules Modules to add to the environment def initialize(name, basedir, dirname, options = {}) super(name, basedir, dirname, options) @managed_content = {} @modules = [] @moduledir = case options[:moduledir] when nil File.join(@basedir, @dirname, 'modules') when File.absolute_path(options[:moduledir]) options.delete(:moduledir) else File.join(@basedir, @dirname, options.delete(:moduledir)) end modhash = options.delete(:modules) load_modules(modhash) unless modhash.nil? end # @return [Array<R10K::Module::Base>] All modules associated with this environment. # Modules may originate from either: # - The r10k environment object # - A Puppetfile in the environment's content def modules return @modules if @puppetfile.nil? @puppetfile.load unless @puppetfile.loaded? @modules + @puppetfile.modules end def accept(visitor) visitor.visit(:environment, self) do @modules.each do |mod| mod.accept(visitor) end puppetfile.accept(visitor) validate_no_module_conflicts end end def load_modules(module_hash) module_hash.each do |name, args| add_module(name, args) end end # @param [String] name # @param [*Object] args def add_module(name, args) if args.is_a?(Hash) # symbolize keys in the args hash args = args.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo } end if args.is_a?(Hash) && install_path = args.delete(:install_path) install_path = resolve_install_path(install_path) validate_install_path(install_path, name) else install_path = @moduledir end # Keep track of all the content this environment is managing to enable purging. @managed_content[install_path] = Array.new unless @managed_content.has_key?(install_path) mod = R10K::Module.new(name, install_path, args, self.name) mod.origin = 'Environment' @managed_content[install_path] << mod.name @modules << mod end def validate_no_module_conflicts @puppetfile.load unless @puppetfile.loaded? conflicts = (@modules + @puppetfile.modules) .group_by { |mod| mod.name } .select { |_, v| v.size > 1 } .map(&:first) unless conflicts.empty? msg = _('Puppetfile cannot contain module names defined by environment %{name}') % {name: self.name} msg += ' ' msg += _("Remove the conflicting definitions of the following modules: %{conflicts}" % { conflicts: conflicts.join(' ') }) raise R10K::Error.new(msg) end end include R10K::Util::Purgeable # Returns an array of the full paths that can be purged. # @note This implements a required method for the Purgeable mixin # @return [Array<String>] def managed_directories [@full_path] end # Returns an array of the full paths of filenames that should exist. Files # inside managed_directories that are not listed in desired_contents will # be purged. # @note This implements a required method for the Purgeable mixin # @return [Array<String>] def desired_contents list = @managed_content.keys list += @managed_content.flat_map do |install_path, modnames| modnames.collect { |name| File.join(install_path, name) } end end def purge_exclusions super + @managed_content.flat_map do |install_path, modnames| modnames.map do |name| File.join(install_path, name, '**', '*') end end end end