Class: R10K::Environment::WithModules

Inherits:
Base
  • Object
show all
Includes:
Logging, Util::Purgeable
Defined in:
lib/r10k/environment/with_modules.rb

Overview

This abstract base class implements an environment that can include module content

Since:

  • 3.4.0

Direct Known Subclasses

Bare, Git

Constant Summary

Constants included from Logging

Logging::LOG_LEVELS

Instance Attribute Summary collapse

Attributes inherited from Base

#basedir, #dirname, #name, #path, #puppetfile, #puppetfile_name

Instance Method Summary collapse

Methods included from Util::Purgeable

#current_contents, #logger, #pending_contents, #purge!, #stale_contents

Methods included from Logging

debug_formatter, default_formatter, default_outputter, #logger, #logger_name, parse_level

Methods inherited from Base

#generate_types!, #info, #signature, #status, #sync, #whitelist

Constructor Details

#initialize(name, basedir, dirname, options = {}) ⇒ WithModules

Initialize the given environment.

Parameters:

  • name (String) —

    The unique name describing this environment.

  • basedir (String) —

    The base directory where this environment will be created.

  • dirname (String) —

    The directory name for this environment.

  • options (Hash) (defaults to: {}) —

    An additional set of options for this environment.

  • options (String) (defaults to: {}) —

    :moduledir The path to install modules to

  • options (Hash) (defaults to: {}) —

    :modules Modules to add to the environment

Since:

  • 3.4.0



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/r10k/environment/with_modules.rb', line 26

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

Instance Attribute Details

#moduledir ⇒ Object (readonly)

Since:

  • 3.4.0



15
16
17
 
# File 'lib/r10k/environment/with_modules.rb', line 15

def moduledir
  @moduledir
end

Instance Method Details

#accept(visitor) ⇒ Object

Since:

  • 3.4.0



78
79
80
81
82
83
84
85
86
 
# File 'lib/r10k/environment/with_modules.rb', line 78

def accept(visitor)
  visitor.visit(:environment, self) do
    @modules.each do |mod|
      mod.accept(visitor)
    end

    puppetfile.accept(visitor)
  end
end

#add_module(name, args) ⇒ Object

Parameters:

  • name (String)
  • args (*Object)

Since:

  • 3.4.0



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/r10k/environment/with_modules.rb', line 96

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

#desired_contents ⇒ Array<String>

Note:

This implements a required method for the Purgeable mixin

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.

Returns:

  • (Array<String>)

Since:

  • 3.4.0



133
134
135
136
137
138
 
# File 'lib/r10k/environment/with_modules.rb', line 133

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

#load_modules(module_hash) ⇒ Object

Since:

  • 3.4.0



88
89
90
91
92
 
# File 'lib/r10k/environment/with_modules.rb', line 88

def load_modules(module_hash)
  module_hash.each do |name, args|
    add_module(name, args)
  end
end

#managed_directories ⇒ Array<String>

Note:

This implements a required method for the Purgeable mixin

Returns an array of the full paths that can be purged.

Returns:

  • (Array<String>)

Since:

  • 3.4.0



124
125
126
 
# File 'lib/r10k/environment/with_modules.rb', line 124

def managed_directories
  [@full_path]
end

#module_conflicts?(mod_b) ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 3.4.0



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/r10k/environment/with_modules.rb', line 55

def module_conflicts?(mod_b)
  conflict = @modules.any? { |mod_a| mod_a.name == mod_b.name }
  return false unless conflict

  msg_vars = {src: mod_b.origin, name: mod_b.name}
  msg_error = _('Environment and %{src} both define the "%{name}" module' % msg_vars)
  msg_continue = _("#{msg_error}. The %{src} definition will be ignored" % msg_vars)

  case conflict_opt = @options[:module_conflicts]
  when 'override_and_warn', nil
    logger.warn msg_continue
  when 'override'
    logger.debug msg_continue
  when 'error'
    raise R10K::Error, msg_error
  else
    raise R10K::Error, _('Unexpected value for `module_conflicts` setting in %{env} ' \
                         'environment: %{val}' % {env: self.name, val: conflict_opt})
  end

  true
end

#modules ⇒ Array<R10K::Module::Base>

Returns All modules associated with this environment. Modules may originate from either:

- The r10k environment object
- A Puppetfile in the environment's content.

Returns:

  • (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

Since:

  • 3.4.0



48
49
50
51
52
53
 
# File 'lib/r10k/environment/with_modules.rb', line 48

def modules
  return @modules if puppetfile.nil?

  puppetfile.load unless puppetfile.loaded?
  @modules + puppetfile.modules
end

#purge_exclusions ⇒ Object

Since:

  • 3.4.0



140
141
142
143
144
145
146
 
# File 'lib/r10k/environment/with_modules.rb', line 140

def purge_exclusions
  super + @managed_content.flat_map do |install_path, modnames|
    modnames.map do |name|
      File.join(install_path, name, '**', '*')
    end
  end
end