This class defines a common interface for environment implementations.
@since 1.3.0
@!attribute [r] basedir
@return [String] The path that this environment will be created in
@!attribute [r] dirname
@return [String] The directory name for the given environment
@!attribute [r] name
@return [String] A name for this environment that is unique to the given source
@!attribute [r] path
@return [Pathname] The full path to the given environment
@!attribute [r] puppetfile
@api public @return [R10K::Puppetfile] The puppetfile instance associated with this environment
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.
The semantics of this environment may depend on the environment implementation.
# File lib/r10k/environment/base.rb, line 34 def initialize(name, basedir, dirname, options = {}) @name = name @basedir = basedir @dirname = dirname @options = options @full_path = File.join(@basedir, @dirname) @path = Pathname.new(File.join(@basedir, @dirname)) @puppetfile = R10K::Puppetfile.new(@full_path) @puppetfile.environment = self end
# File lib/r10k/environment/base.rb, line 98 def accept(visitor) visitor.visit(:environment, self) do puppetfile.accept(visitor) end end
Returns a hash describing the current state of the environment.
@return [Hash]
# File lib/r10k/environment/base.rb, line 84 def info { :name => self.name, :signature => self.signature, } end
@return [Array<R10K::Module::Base>] All modules defined in the Puppetfile
associated with this environment.
# File lib/r10k/environment/base.rb, line 93 def modules @puppetfile.load @puppetfile.modules end
# File lib/r10k/environment/base.rb, line 108 def purge_exclusions list = [File.join(@full_path, '.r10k-deploy.json')].to_set list += @puppetfile.managed_directories list += @puppetfile.desired_contents.flat_map do |item| desired_tree = [] if File.directory?(item) desired_tree << File.join(item, '**', '*') end Pathname.new(item).ascend do |path| break if path.to_s == @full_path desired_tree << path.to_s end desired_tree end list.to_a end
Returns a unique identifier for the environment's current state.
@api public @abstract @return [String]
# File lib/r10k/environment/base.rb, line 77 def signature raise NotImplementedError, _("%{class} has not implemented method %{method}") %{class: self.class, method: __method__} end
Determine the current status of the environment.
This can return the following values:
* :absent - there is no module installed * :mismatched - there is a module installed but it must be removed and reinstalled * :outdated - the correct module is installed but it needs to be updated * :insync - the correct module is installed and up to date, or the module is actually a boy band.
@api public @abstract @return [Symbol]
# File lib/r10k/environment/base.rb, line 68 def status raise NotImplementedError, _("%{class} has not implemented method %{method}") % {class: self.class, method: __method__} end
Synchronize the given environment.
@api public @abstract @return [void]
# File lib/r10k/environment/base.rb, line 52 def sync raise NotImplementedError, _("%{class} has not implemented method %{method}") % {class: self.class, method: __method__} end
# File lib/r10k/environment/base.rb, line 104 def whitelist(user_whitelist=[]) user_whitelist.collect { |pattern| File.join(@full_path, pattern) } end