class R10K::Module::Base

This class defines a common interface for module implementations.

Attributes

author[R]

@!attribute [r] owner

@return [String, nil] The owner of the module if one is specified

basedir[R]

@param [r] dirname

@return [String] The name of the directory containing this module

dirname[R]

@param [r] dirname

@return [String] The name of the directory containing this module

environment[R]

@!attribute [r] environment

@return [R10K::Environment, nil] The parent environment of the module

full_name[R]

@!attribute [r] title

@return [String] The forward slash separated owner and name of the module

name[R]

@!attribute [r] name

@return [String] The name of the module

origin[RW]

@!attribute [rw] origin

@return [String] Where the module was sourced from. E.g., "Puppetfile"

owner[R]

@!attribute [r] owner

@return [String, nil] The owner of the module if one is specified

path[R]

@!attribute [r] path

@return [Pathname] The full path of the module

spec_deletable[RW]

@!attribute [rw] spec_deletable

@return [Boolean] set this to true if the spec dir can be safely removed, ie in the moduledir

title[R]

@!attribute [r] title

@return [String] The forward slash separated owner and name of the module

Public Class Methods

new(title, dirname, args, environment=nil) click to toggle source

@param title [String] @param dirname [String] @param args [Hash]

# File lib/r10k/module/base.rb, line 54
def initialize(title, dirname, args, environment=nil)
  @title   = PuppetForge::V3.normalize_name(title)
  @dirname = dirname
  @args    = args
  @owner, @name = parse_title(@title)
  @path = Pathname.new(File.join(@dirname, @name))
  @environment = environment
  @overrides = args.delete(:overrides) || {}
  @spec_deletable = true
  @exclude_spec = true
  @exclude_spec = @overrides.dig(:modules, :exclude_spec) unless @overrides.dig(:modules, :exclude_spec).nil?
  if args.has_key?(:exclude_spec)
    logger.debug2 _("Overriding :exclude_spec setting with per module setting for #{@title}")
    @exclude_spec = args.delete(:exclude_spec)
  end
  @origin = 'external' # Expect Puppetfile or R10k::Environment to set this to a specific value

  @requested_modules = @overrides.dig(:modules, :requested_modules) || []
  @should_sync = (@requested_modules.empty? || @requested_modules.include?(@name))
end

Public Instance Methods

accept(visitor) click to toggle source

Deprecated

# File lib/r10k/module/base.rb, line 151
def accept(visitor)
  visitor.visit(:module, self)
end

cachedir() click to toggle source

Return the module's cachedir. Subclasses that implement a cache will override this to return a real directory location.

@return [String, :none]

# File lib/r10k/module/base.rb, line 167
def cachedir
  :none
end

delete_spec_dir() click to toggle source

Actually remove the spec dir

# File lib/r10k/module/base.rb, line 93
def delete_spec_dir
  spec_path = @path + 'spec'
  if spec_path.symlink?
    spec_path = spec_path.realpath
  end
  if spec_path.directory?
    logger.debug2 _("Deleting spec data at #{spec_path}")
    # Use the secure flag for the #rm_rf method to avoid security issues
    # involving TOCTTOU(time of check to time of use); more details here:
    # https://ruby-doc.org/stdlib-2.7.0/libdoc/fileutils/rdoc/FileUtils.html#method-c-rm_rf
    # Additionally, #rm_rf also has problems in windows with with symlink targets
    # also being deleted; this should be revisted if Windows becomes higher priority.
    FileUtils.rm_rf(spec_path, secure: true)
  else
    logger.debug2 _("No spec dir detected at #{spec_path}, skipping deletion")
  end
end

full_path() click to toggle source

@deprecated @return [String] The full filesystem path to the module.

# File lib/r10k/module/base.rb, line 77
def full_path
  path.to_s
end

maybe_delete_spec_dir() click to toggle source

Delete the spec dir if @exclude_spec is true and @spec_deletable is also true

# File lib/r10k/module/base.rb, line 82
def maybe_delete_spec_dir
  if @exclude_spec
    if @spec_deletable
      delete_spec_dir
    else
      logger.info _("Spec dir for #{@title} will not be deleted because it is not in the moduledir")
    end
  end
end

properties() click to toggle source

Return the properties of the module

@return [Hash] @abstract

# File lib/r10k/module/base.rb, line 159
def properties
  raise NotImplementedError
end

should_sync?() click to toggle source

# File lib/r10k/module/base.rb, line 118
def should_sync?
  if @should_sync
    logger.info _("Deploying module to %{path}") % {path: path}
    true
  else
    logger.debug1(_("Only updating modules %{modules}, skipping module %{name}") % {modules: @requested_modules.inspect, name: name})
    false
  end
end

status() click to toggle source

Return the status of the currently installed module.

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.

@return [Symbol] @abstract

# File lib/r10k/module/base.rb, line 146
def status
  raise NotImplementedError
end

sync(opts={}) click to toggle source

Synchronize this module with the indicated state. @param [Hash] opts Deprecated @return [Boolean] true if the module was updated, false otherwise

# File lib/r10k/module/base.rb, line 114
def sync(opts={})
  raise NotImplementedError
end

version() click to toggle source

Return the desired version of this module @abstract

# File lib/r10k/module/base.rb, line 131
def version
  raise NotImplementedError
end

Private Instance Methods

parse_title(title) click to toggle source

# File lib/r10k/module/base.rb, line 173
def parse_title(title)
  if (match = title.match(/\A(\w+)\Z/))
    [nil, match[1]]
  elsif (match = title.match(/\A(\w+)[-\/](\w+)\Z/))
    [match[1], match[2]]
  else
    raise ArgumentError, _("Module name (%{title}) must match either 'modulename' or 'owner/modulename'") % {title: title}
  end
end