Class: Puppet::Environments::Directories Private

Inherits:
Object
  • Object
show all
Includes:
EnvironmentLoader
Defined in:
lib/puppet/environments.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Reads environments from a directory on disk. Each environment is represented as a sub-directory. The environment’s manifest setting is the ‘manifest` directory of the environment directory. The environment’s modulepath setting is the global modulepath (from the ‘[server]` section for the server) prepended with the `modules` directory of the environment directory.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from EnvironmentLoader

#clear_all, #get!, #guard, #unguard

Constructor Details

#initialize(environment_dir, global_module_path) ⇒ Directories

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Directories.



174
175
176
177
178
179
 
# File 'lib/puppet/environments.rb', line 174

def initialize(environment_dir, global_module_path)
  @environment_dir =  Puppet::FileSystem.expand_path(environment_dir)
  @global_module_path = global_module_path ?
    global_module_path.map { |p| Puppet::FileSystem.expand_path(p) } :
    nil
end

Class Method Details

.from_path(path, global_module_path) ⇒ Array<Puppet::Environments::Directories>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Generate an array of directory loaders from a path string.

Parameters:

  • path (String) —

    path to environment directories

  • global_module_path (Array<String>) —

    the global modulepath setting

Returns:



186
187
188
189
190
191
 
# File 'lib/puppet/environments.rb', line 186

def self.from_path(path, global_module_path)
  environments = path.split(File::PATH_SEPARATOR)
  environments.map do |dir|
    Puppet::Environments::Directories.new(dir, global_module_path)
  end
end

.real_path(dir) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



193
194
195
196
197
198
 
# File 'lib/puppet/environments.rb', line 193

def self.real_path(dir)
  if Puppet::FileSystem.symlink?(dir) && Puppet[:versioned_environment_dirs]
    dir = Pathname.new Puppet::FileSystem.expand_path(Puppet::FileSystem.readlink(dir))
  end
  dir
end

Instance Method Details

#get(name) ⇒ Puppet::Node::Environment?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Find a named environment

Parameters:

  • name (String, Symbol) —

    The name of environment to find

Returns:



213
214
215
216
217
 
# File 'lib/puppet/environments.rb', line 213

def get(name)
  if validated_directory(File.join(@environment_dir, name.to_s))
    create_environment(name)
  end
end

#get_conf(name) ⇒ Puppet::Setting::EnvironmentConf?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Attempt to obtain the initial configuration for the environment. Not all loaders can provide this.

Parameters:

  • name (String, Symbol) —

    The name of the environment whose configuration we are looking up

Returns:

  • (Puppet::Setting::EnvironmentConf, nil) —

    the configuration for the requested environment, or nil if not found or no configuration is available



220
221
222
223
224
225
226
227
 
# File 'lib/puppet/environments.rb', line 220

def get_conf(name)
  envdir = validated_directory(File.join(@environment_dir, name.to_s))
  if envdir
    Puppet::Settings::EnvironmentConf.load_from(envdir, @global_module_path)
  else
    nil
  end
end

#list ⇒ Array<Puppet::Node::Environment>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns All of the environments known to the loader.

Returns:



206
207
208
209
210
 
# File 'lib/puppet/environments.rb', line 206

def list
  valid_environment_names.collect do |name|
    create_environment(name)
  end
end

#search_paths ⇒ Array<String>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A list of indicators of where the loader is getting its environments from.

Returns:

  • (Array<String>) —

    The URIs of the load locations



201
202
203
 
# File 'lib/puppet/environments.rb', line 201

def search_paths
  ["file://#{@environment_dir}"]
end