Class: Puppet::Node::Environment

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/node/environment.rb

Overview

Puppet::Node::Environment acts as a container for all configuration that is expected to vary between environments.

## The root environment

In addition to normal environments that are defined by the user,there is a special ‘root’ environment. It is defined as an instance variable on the Puppet::Node::Environment metaclass. The environment name is ‘root` and can be accessed by looking up the `:root_environment` using Puppet.lookup.

The primary purpose of the root environment is to contain parser functions that are not bound to a specific environment. The main case for this is for logging functions. Logging functions are attached to the ‘root’ environment when Parser::Functions.reset is called.

Direct Known Subclasses

None, Remote

Defined Under Namespace

Classes: None, Remote

Constant Summary collapse

NO_MANIFEST = 
:no_manifest

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, modulepath, manifest, config_version) ⇒ Environment

Note:

new is private for historical reasons, as previously it had been overridden to return memoized objects and was replaced with create, so this will not be invoked with the normal Ruby initialization semantics.

Instantiate a new environment

Parameters:

  • name (Symbol) —

    The environment name



83
84
85
86
87
88
 
# File 'lib/puppet/node/environment.rb', line 83

def initialize(name, modulepath, manifest, config_version)
  @name = name
  @modulepath = modulepath
  @manifest = manifest
  @config_version = config_version
end

Instance Attribute Details

#config_version ⇒ Object (readonly) 



167
168
169
 
# File 'lib/puppet/node/environment.rb', line 167

def config_version
  @config_version
end

#manifest ⇒ Object (readonly) 



161
162
163
 
# File 'lib/puppet/node/environment.rb', line 161

def manifest
  @manifest
end

#name ⇒ Object (readonly) 



142
143
144
 
# File 'lib/puppet/node/environment.rb', line 142

def name
  @name
end

Class Method Details

.create(name, modulepath, manifest = NO_MANIFEST, config_version = nil) ⇒ Puppet::Node::Environment

Create a new environment with the given name

Parameters:

  • name (Symbol) —

    the name of the environment

  • modulepath (Array<String>) —

    the list of paths from which to load modules

  • manifest (String) (defaults to: NO_MANIFEST) —

    the path to the manifest for the environment or the constant Puppet::Node::Environment::NO_MANIFEST if there is none.

  • config_version (String) (defaults to: nil) —

    path to a script whose output will be added to report logs (optional)

Returns:



46
47
48
49
50
51
52
53
54
 
# File 'lib/puppet/node/environment.rb', line 46

def self.create(name, modulepath, manifest = NO_MANIFEST, config_version = nil)
  obj = self.allocate
  obj.send(:initialize,
           name.intern,
           expand_dirs(extralibs() + modulepath),
           manifest == NO_MANIFEST ? manifest : File.expand_path(manifest),
           config_version)
  obj
end

.remote(name) ⇒ Object

Note:

This does not provide access to the information of the remote

A “reference” to a remote environment. The created environment instance isn’t expected to exist on the local system, but is instead a reference to environment information on a remote system. For instance when a catalog is being applied, this will be used on the agent.

environment’s modules, manifest, or anything else. It is simply a value object to pass around and use as an environment.

Parameters:

  • name (Symbol) —

    The name of the remote environment



71
72
73
 
# File 'lib/puppet/node/environment.rb', line 71

def self.remote(name)
  Remote.create(name, [], NO_MANIFEST)
end

.split_path(path_string) ⇒ Object 



441
442
443
 
# File 'lib/puppet/node/environment.rb', line 441

def self.split_path(path_string)
  path_string.split(File::PATH_SEPARATOR)
end

.valid_name?(name) ⇒ Boolean

Returns true if name is valid.

Parameters:

  • name (String) —

    Environment name to check for valid syntax.

Returns:

  • (Boolean) —

    true if name is valid



134
135
136
 
# File 'lib/puppet/node/environment.rb', line 134

def self.valid_name?(name)
  !!name.match(/\A\w+\Z/)
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



445
446
447
448
449
450
 
# File 'lib/puppet/node/environment.rb', line 445

def ==(other)
  return true if other.kind_of?(Puppet::Node::Environment) &&
    self.name == other.name &&
    self.full_modulepath == other.full_modulepath &&
    self.manifest == other.manifest
end

#[](param) ⇒ Object

Return an environment-specific Puppet setting.

Parameters:

  • param (String, Symbol) —

    The environment setting to look up

Returns:

  • (Object) —

    The resolved setting value



223
224
225
 
# File 'lib/puppet/node/environment.rb', line 223

def [](param)
  Puppet.settings.value(param, self.name)
end

#check_for_reparse ⇒ Object

Checks if a reparse is required (cache of files is stale).



406
407
408
409
410
411
 
# File 'lib/puppet/node/environment.rb', line 406

def check_for_reparse
  if (Puppet[:code] != @parsed_code || @known_resource_types.parse_failed?)
    @parsed_code = nil
    @known_resource_types = nil
  end
end

#configuration ⇒ Puppet::Settings::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.

Return the environment configuration

Returns:



202
203
204
 
# File 'lib/puppet/node/environment.rb', line 202

def configuration
  Puppet.lookup(:environments).get_conf(name)
end

#conflicting_manifest_settings? ⇒ Boolean

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.

Checks to make sure that this environment did not have a manifest set in its original environment.conf if Puppet is configured with disable_per_environment_manifest set true. If it did, the environment’s modules may not function as intended by the original authors, and we may seek to halt a puppet compilation for a node in this environment.

The only exception to this would be if the environment.conf manifest is an exact, uninterpolated match for the current default_manifest setting.

Returns:

  • (Boolean) —

    true if using directory environments, and Puppet is true, and this environment’s original environment.conf had a manifest setting that is not the Puppet.



183
184
185
186
187
 
# File 'lib/puppet/node/environment.rb', line 183

def conflicting_manifest_settings?
  return false if !Puppet[:disable_per_environment_manifest]
  original_manifest = configuration.raw_setting(:manifest)
  !original_manifest.nil? && !original_manifest.empty? && original_manifest != Puppet[:default_manifest]
end

#each_plugin_directory {|String| ... } ⇒ Object

Yields each modules’ plugin directory if the plugin directory (modulename/lib) is present on the filesystem.

Yields:

  • (String) —

    Yields the plugin directory from each module to the block.



242
243
244
245
246
247
 
# File 'lib/puppet/node/environment.rb', line 242

def each_plugin_directory(&block)
  modules.map(&:plugin_directory).each do |lib|
    lib = Puppet::Util::Autoload.cleanpath(lib)
    yield lib if File.directory?(lib)
  end
end

#full_modulepath ⇒ Array<String>

Returns All directories in the modulepath (even if they are not present on disk).

Returns:

  • (Array<String>) —

    All directories in the modulepath (even if they are not present on disk)



154
155
156
 
# File 'lib/puppet/node/environment.rb', line 154

def full_modulepath
  @modulepath
end

#hash ⇒ Object 



454
455
456
 
# File 'lib/puppet/node/environment.rb', line 454

def hash
  [self.class, name, full_modulepath, manifest].hash
end

#inspect ⇒ Object 



426
427
428
 
# File 'lib/puppet/node/environment.rb', line 426

def inspect
  %Q{<#{self.class}:#{self.object_id} @name="#{name}" @manifest="#{manifest}" @modulepath="#{full_modulepath.join(":")}" >}
end

#known_resource_types ⇒ Puppet::Resource::TypeCollection

Returns The current global TypeCollection.

Returns:



229
230
231
232
233
234
235
 
# File 'lib/puppet/node/environment.rb', line 229

def known_resource_types
  if @known_resource_types.nil?
    @known_resource_types = Puppet::Resource::TypeCollection.new(self)
    @known_resource_types.import_ast(perform_initial_import(), '')
  end
  @known_resource_types
end

#module(name) ⇒ Puppet::Module?

Locate a module instance by the module name alone.

Parameters:

  • name (String) —

    The module name

Returns:



255
256
257
 
# File 'lib/puppet/node/environment.rb', line 255

def module(name)
  modules.find {|mod| mod.name == name}
end

#module_by_forge_name(forge_name) ⇒ Puppet::Module?

Locate a module instance by the full forge name (EG authorname/module)

Parameters:

  • forge_name (String) —

    The module name

Returns:



265
266
267
268
269
270
271
 
# File 'lib/puppet/node/environment.rb', line 265

def module_by_forge_name(forge_name)
  author, modname = forge_name.split('/')
  found_mod = self.module(modname)
  found_mod and found_mod.forge_name == forge_name ?
    found_mod :
    nil
end

#module_requirements ⇒ Hash<String, Array<Hash<String, String>>>

All module requirements for all modules in the environment modulepath

Examples:

environment.module_requirements
# => {
#   'username/amodule' => [
#     {
#       'name'    => 'username/moduledep',
#       'version' => '1.2.3',
#       'version_requirement' => '>= 1.0.0',
#     },
#     {
#       'name'    => 'username/anotherdep',
#       'version' => '4.5.6',
#       'version_requirement' => '>= 3.0.0',
#     }
#   ]
# }
#

Returns:

  • (Hash<String, Array<Hash<String, String>>>) —

    See the method example for an explanation of the return value.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/puppet/node/environment.rb', line 380

def module_requirements
  deps = {}

  modules.each do |mod|
    next unless mod.forge_name
    deps[mod.forge_name] ||= []

    mod.dependencies and mod.dependencies.each do |mod_dep|
      dep_name = mod_dep['name'].tr('-', '/')
      (deps[dep_name] ||= []) << {
        'name'                => mod.forge_name,
        'version'             => mod.version,
        'version_requirement' => mod_dep['version_requirement']
      }
    end
  end

  deps.each do |mod, mod_deps|
    deps[mod] = mod_deps.sort_by { |d| d['name'] }
  end

  deps
end

#modulepath ⇒ Array<String>

Returns All directories present on disk in the modulepath.

Returns:

  • (Array<String>) —

    All directories present on disk in the modulepath



146
147
148
149
150
 
# File 'lib/puppet/node/environment.rb', line 146

def modulepath
  @modulepath.find_all do |p|
    Puppet::FileSystem.directory?(p)
  end
end

#modules ⇒ Array<Puppet::Module>

Note:

If multiple modules with the same name are present they will both be added, but methods like #module and #module_by_forge_name will return the first matching entry in this list.

Note:

This value is cached so that the filesystem doesn’t have to be re-enumerated every time this method is invoked, since that enumeration could be a costly operation and this method is called frequently. The cache expiry is determined by ‘Puppet`.

Return all modules for this environment in the order they appear in the modulepath.

Returns:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/puppet/node/environment.rb', line 284

def modules
  if @modules.nil?
    module_references = []
    seen_modules = {}
    modulepath.each do |path|
      Dir.entries(path).each do |name|
        next unless Puppet::Module.is_module_directory?(name, path)
        warn_about_mistaken_path(path, name)
        if not seen_modules[name]
          module_references << {:name => name, :path => File.join(path, name)}
          seen_modules[name] = true
        end
      end
    end

    @modules = module_references.collect do |reference|
      begin
        Puppet::Module.new(reference[:name], reference[:path], self)
      rescue Puppet::Module::Error => e
        Puppet.log_exception(e)
        nil
      end
    end.compact
  end
  @modules
end

#modules_by_path ⇒ Hash<String, Array<Puppet::Module>>

Note:

This method changes the current working directory while enumerating the modules. This seems rather dangerous.

Modules broken out by directory in the modulepath

Returns:

  • (Hash<String, Array<Puppet::Module>>) —

    A hash whose keys are file paths, and whose values is an array of Puppet Modules for that path



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/puppet/node/environment.rb', line 334

def modules_by_path
  modules_by_path = {}
  modulepath.each do |path|
    if Puppet::FileSystem.exist?(path)
      Dir.chdir(path) do
        module_names = Dir.entries(path).select do |name|
          Puppet::Module.is_module_directory?(name, path)
        end
        modules_by_path[path] = module_names.sort.map do |name|
          Puppet::Module.new(name, File.join(path, name), self)
        end
      end
    else
      modules_by_path[path] = []
    end
  end
  modules_by_path
end

#override_from_commandline(settings) ⇒ Puppet::Node::Environment

Creates a new Puppet::Node::Environment instance, overriding :manifest, :modulepath, or :config_version from the passed settings if they were originally set from the commandline, or returns self if there is nothing to override.

Parameters:

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/puppet/node/environment.rb', line 111

def override_from_commandline(settings)
  overrides = {}

  if settings.set_by_cli?(:modulepath)
    overrides[:modulepath] = self.class.split_path(settings.value(:modulepath))
  end

  if settings.set_by_cli?(:config_version)
    overrides[:config_version] = settings.value(:config_version)
  end

  if settings.set_by_cli?(:manifest)
    overrides[:manifest] = settings.value(:manifest)
  end

  overrides.empty? ?
    self :
    self.override_with(overrides)
end

#override_with(env_params) ⇒ Puppet::Node::Environment

Creates a new Puppet::Node::Environment instance, overriding any of the passed parameters.

Parameters:

  • env_params (Hash<{Symbol => String,Array<String>}>) —

    new environment parameters (:modulepath, :manifest, :config_version)

Returns:



96
97
98
99
100
101
 
# File 'lib/puppet/node/environment.rb', line 96

def override_with(env_params)
  return self.class.create(name,
                    env_params[:modulepath] || modulepath,
                    env_params[:manifest] || manifest,
                    env_params[:config_version] || config_version)
end

#static_catalogs? ⇒ Boolean

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:

  • (Boolean) 


190
191
192
193
194
195
196
 
# File 'lib/puppet/node/environment.rb', line 190

def static_catalogs?
  if @static_catalogs.nil?
    environment_conf = Puppet.lookup(:environments).get_conf(name)
    @static_catalogs = (environment_conf.nil? ? Puppet[:static_catalogs] : environment_conf.static_catalogs)
  end
  @static_catalogs
end

#to_s ⇒ String

Returns The stringified value of the ‘name` instance variable.

Returns:

  • (String) —

    The stringified value of the ‘name` instance variable



421
422
423
 
# File 'lib/puppet/node/environment.rb', line 421

def to_s
  name.to_s
end

#to_sym ⇒ Symbol

Note:

the ‘name` instance variable is a Symbol, but this casts the value to a String and then converts it back into a Symbol which will needlessly create an object that needs to be garbage collected

Returns The ‘name` value, cast to a string, then cast to a symbol.

Returns:

  • (Symbol) —

    The ‘name` value, cast to a string, then cast to a symbol.



437
438
439
 
# File 'lib/puppet/node/environment.rb', line 437

def to_sym
  to_s.to_sym
end

#to_yaml ⇒ String

Return the name of the environment as a string interpretation of the object

Returns:

  • (String) —

    The YAML interpretation of the object



415
416
417
 
# File 'lib/puppet/node/environment.rb', line 415

def to_yaml
  to_s.to_yaml
end

#validation_errors ⇒ Array<String>

Checks the environment and settings for any conflicts

Returns:

  • (Array<String>) —

    an array of validation errors



209
210
211
212
213
214
215
 
# File 'lib/puppet/node/environment.rb', line 209

def validation_errors
  errors = []
  if conflicting_manifest_settings?
    errors << "The 'disable_per_environment_manifest' setting is true, and the '#{name}' environment has an environment.conf manifest that conflicts with the 'default_manifest' setting."
  end
  errors
end

#warn_about_mistaken_path(path, name) ⇒ 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.

Generate a warning if the given directory in a module path entry is named ‘lib`.

Parameters:

  • path (String) —

    The module directory containing the given directory

  • name (String) —

    The directory name



317
318
319
320
321
322
323
 
# File 'lib/puppet/node/environment.rb', line 317

def warn_about_mistaken_path(path, name)
  if name == "lib"
    Puppet.debug("Warning: Found directory named 'lib' in module path ('#{path}/lib'); unless " +
        "you are expecting to load a module named 'lib', your module path may be set " +
        "incorrectly.")
  end
end