logstash/lib/pluginmanager/util.rb
Josh Soref a06dc211ff Spelling fixes (#6806)
Spelling fixes across the board.
2017-03-29 19:33:26 -07:00

113 lines
5.1 KiB
Ruby

# encoding: utf-8
require "rubygems/package"
module LogStash::PluginManager
class ValidationError < StandardError; end
# check for valid logstash plugin gem name & version or .gem file, logs errors to $stdout
# uses Rubygems API and will remotely validated agains the current Gem.sources
# @param plugin [String] plugin name or .gem file path
# @param version [String] gem version requirement string
# @param [Hash] options the options used to setup external components
# @option options [Array<String>] :rubygems_source Gem sources to lookup for the verification
# @return [Boolean] true if valid logstash plugin gem name & version or a .gem file
def self.logstash_plugin?(plugin, version = nil, options={})
if plugin_file?(plugin)
begin
return logstash_plugin_gem_spec?(plugin_file_spec(plugin))
rescue => e
$stderr.puts("Error reading plugin file #{plugin}, caused by #{e.class}")
$stderr.puts(e.message) if ENV["DEBUG"]
return false
end
else
dep = Gem::Dependency.new(plugin, version || Gem::Requirement.default)
Gem.sources = Gem::SourceList.from(options[:rubygems_source]) if options[:rubygems_source]
specs, errors = Gem::SpecFetcher.fetcher.spec_for_dependency(dep)
# dump errors
errors.each { |error| $stderr.puts(error.wordy) }
# depending on version requirements, multiple specs can be returned in which case
# we will grab the one with the highest version number
if latest = specs.map(&:first).max_by(&:version)
unless valid = logstash_plugin_gem_spec?(latest)
$stderr.puts("#{plugin} is not a Logstash plugin")
end
return valid
else
$stderr.puts("Plugin #{plugin}" + (version ? " version #{version}" : "") + " does not exist") if errors.empty?
return false
end
end
end
# Fetch latest version information as in rubygems
# @param [String] The plugin name
# @param [Hash] Set of available options when fetching the information
# @option options [Boolean] :pre Include pre release versions in the search (default: false)
# @return [Hash] The plugin version information as returned by rubygems
def self.fetch_latest_version_info(plugin, options={})
exclude_prereleases = options.fetch(:pre, false)
versions = LogStash::Rubygems.versions(plugin)
raise ValidationError.new("Something went wrong with the validation. You can skip the validation with the --no-verify option") if !versions.is_a?(Array) || versions.empty?
versions = versions.select { |version| !version["prerelease"] } if !exclude_prereleases
versions.first
end
# @param spec [Gem::Specification] plugin gem specification
# @return [Boolean] true if this spec is for an installable logstash plugin
def self.logstash_plugin_gem_spec?(spec)
spec.metadata && spec.metadata["logstash_plugin"] == "true"
end
# @param path [String] path to .gem file
# @return [Gem::Specification] .get file gem specification
# @raise [Exception] Gem::Package::FormatError will be raised on invalid .gem file format, might be other exceptions too
def self.plugin_file_spec(path)
Gem::Package.new(path).spec
end
# @param plugin [String] the plugin name or the local path to a .gem file
# @return [Boolean] true if the plugin is a local .gem file
def self.plugin_file?(plugin)
(plugin =~ /\.gem$/ && File.file?(plugin))
end
# retrieve gem specs for all or specified name valid logstash plugins locally installed
# @param name [String] specific plugin name to find or nil for all plugins
# @return [Array<Gem::Specification>] all local logstash plugin gem specs
def self.find_plugins_gem_specs(name = nil)
specs = name ? Gem::Specification.find_all_by_name(name) : Gem::Specification.find_all
specs.select{|spec| logstash_plugin_gem_spec?(spec)}
end
# list of all locally installed plugins specs specified in the Gemfile.
# note that an installed plugin dependencies like codecs will not be listed, only those
# specifically listed in the Gemfile.
# @param gemfile [LogStash::Gemfile] the gemfile to validate against
# @return [Array<Gem::Specification>] list of plugin specs
def self.all_installed_plugins_gem_specs(gemfile)
# we start form the installed gemspecs so we can verify the metadata for valid logstash plugin
# then filter out those not included in the Gemfile
find_plugins_gem_specs.select{|spec| !!gemfile.find(spec.name)}
end
# @param plugin [String] plugin name
# @param gemfile [LogStash::Gemfile] the gemfile to validate against
# @return [Boolean] true if the plugin is an installed logstash plugin and specified in the Gemfile
def self.installed_plugin?(plugin, gemfile)
!!gemfile.find(plugin) && find_plugins_gem_specs(plugin).any?
end
# @param plugin_list [Array] array of [plugin name, version] tuples
# @return [Array] array of [plugin name, version, ...] tuples when duplicate names have been merged and non duplicate version requirements added
def self.merge_duplicates(plugin_list)
# quick & dirty naive dedup for now
# TODO: properly merge versions requirements
plugin_list.uniq(&:first)
end
end