Class: Inspec::Plugin::V2::Installer

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Singleton
Defined in:
lib/inspec/plugin/v2/installer.rb

Overview

Handles all actions modifying the user’s plugin set:

  • Modifying the plugins.json file

  • Installing, updating, and removing gem-based plugins

Loading plugins is handled by Loader. Listing plugins is handled by Loader. Searching for plugins is handled by ???

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Installer

Returns a new instance of Installer.



31
32
33
34
 
# File 'lib/inspec/plugin/v2/installer.rb', line 31

def initialize
  @loader = Inspec::Plugin::V2::Loader.new
  @registry = Inspec::Plugin::V2::Registry.instance
end

Instance Attribute Details

#loader ⇒ Object (readonly)

Returns the value of attribute loader.



25
26
27
 
# File 'lib/inspec/plugin/v2/installer.rb', line 25

def loader
  @loader
end

#registry ⇒ Object (readonly)

Returns the value of attribute registry.



25
26
27
 
# File 'lib/inspec/plugin/v2/installer.rb', line 25

def registry
  @registry
end

Instance Method Details

#__reset ⇒ Object

Testing API. Performs a hard reset on the installer and registry, and reloads the loader. Not for public use. TODO: bad timing coupling in tests



145
146
147
 
# File 'lib/inspec/plugin/v2/installer.rb', line 145

def __reset
  registry.__reset
end

#__reset_loader ⇒ Object 



149
150
151
 
# File 'lib/inspec/plugin/v2/installer.rb', line 149

def __reset_loader
  @loader = Loader.new
end

#install(plugin_name, opts = {}) ⇒ Object

Installs a plugin. Defaults to assuming the plugin provided is a gem, and will try to install from whatever gemsources ‘rubygems` thinks it should use. If it’s a gem, installs it and its dependencies to the ‘gem_path`. The gem is not activated. If it’s a path, leaves it in place. Finally, updates the plugins.json file with the new information. No attempt is made to load the plugin.

Parameters:

  • plugin_name (String)
  • opts (Hash) (defaults to: {}) —

    The installation options

Options Hash (opts):

  • :gem_file (String) —

    Path to a local gem file to install from

  • :path (String) —

    Path to a file to be used as the entry point for a path-based plugin

  • :version (String) —

    Version constraint for remote gem installs



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/inspec/plugin/v2/installer.rb', line 56

def install(plugin_name, opts = {})
  # TODO: - check plugins.json for validity before trying anything that needs to modify it.
  validate_installation_opts(plugin_name, opts)

  if opts[:path]
    install_from_path(plugin_name, opts)
  elsif opts[:gem_file]
    install_from_gem_file(plugin_name, opts)
  else
    install_from_remote_gems(plugin_name, opts)
  end

  update_plugin_config_file(plugin_name, opts.merge({ action: :install }))
end

#plugin_installed?(name) ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/inspec/plugin/v2/installer.rb', line 36

def plugin_installed?(name)
  list_installed_plugin_gems.detect { |spec| spec.name == name }
end

#plugin_version_installed?(name, version) ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/inspec/plugin/v2/installer.rb', line 40

def plugin_version_installed?(name, version)
  list_installed_plugin_gems.detect { |spec| spec.name == name && spec.version == Gem::Version.new(version) }
end

#search(plugin_query, opts = {}) ⇒ Hash of Arrays

Search rubygems.org for a plugin gem.

Parameters:

  • plugin_seach_term (String)
  • opts (Hash) (defaults to: {}) —

    Search options

Options Hash (opts):

  • :exact (TrueClass, FalseClass) —

    If true, use plugin_search_term exactly. If false (default), append a wildcard.

  • :scope (Symbol) —

    Which versions to search for. :released (default) - all released versions. :prerelease - Also include versioned marked prerelease. :latest - only return one version, the latest one.

Returns:

  • (Hash of Arrays) —

    • Keys are String names of gems, arrays contain String versions.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/inspec/plugin/v2/installer.rb', line 120

def search(plugin_query, opts = {})
  validate_search_opts(plugin_query, opts)

  fetcher = Gem::SpecFetcher.fetcher
  matched_tuples = []
  if opts[:exact]
    matched_tuples = fetcher.detect(opts[:scope]) { |tuple| tuple.name == plugin_query }
  else
    regex = Regexp.new('^' + plugin_query + '.*')
    matched_tuples = fetcher.detect(opts[:scope]) do |tuple|
      tuple.name != 'inspec-core' && tuple.name =~ regex
    end
  end

  gem_info = {}
  matched_tuples.each do |tuple|
    gem_info[tuple.first.name] ||= []
    gem_info[tuple.first.name] << tuple.first.version.to_s
  end
  gem_info
end

#uninstall(plugin_name, opts = {}) ⇒ Object

Uninstalls (removes) a plugin. Refers to plugin.json to determine if it was a gem-based or path-based install. If it’s a gem, uninstalls it, and all other unused plugins. If it’s a path, removes the reference from the plugins.json, but does not tamper with the plugin source tree. Either way, the plugins.json file is updated with the new information.

Parameters:

  • plugin_name (String)
  • opts (Hash) (defaults to: {}) —

    The uninstallation options. Currently unused.



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/inspec/plugin/v2/installer.rb', line 100

def uninstall(plugin_name, opts = {})
  # TODO: - check plugins.json for validity before trying anything that needs to modify it.
  validate_uninstall_opts(plugin_name, opts)

  if registry.path_based_plugin?(plugin_name)
    uninstall_via_path(plugin_name, opts)
  else
    uninstall_via_gem(plugin_name, opts)
  end

  update_plugin_config_file(plugin_name, opts.merge({ action: :uninstall }))
end

#update(plugin_name, opts = {}) ⇒ Object

Updates a plugin. Most options same as install, but will not handle path installs. If no :version is provided, updates to the latest. If a version is provided, the plugin becomes pinned at that specified version.

Parameters:

  • plugin_name (String)
  • opts (Hash) (defaults to: {}) —

    The installation options

Options Hash (opts):

  • :gem_file (String) —

    Reserved for future use. No effect.

  • :version (String) —

    Version constraint for remote gem updates



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/inspec/plugin/v2/installer.rb', line 79

def update(plugin_name, opts = {})
  # TODO: - check plugins.json for validity before trying anything that needs to modify it.
  validate_update_opts(plugin_name, opts)
  opts[:update_mode] = true

  # TODO: Handle installing from a local file
  # TODO: Perform dependency checks to make sure the new solution is valid
  install_from_remote_gems(plugin_name, opts)

  update_plugin_config_file(plugin_name, opts.merge({ action: :update }))
end