mirror of
https://github.com/elastic/logstash.git
synced 2025-04-24 22:57:16 -04:00
2e05338554
This PR changes the behavior of the command when you were specify a directory instead of a filename, if the directory exists it would have deleted the directory and the files in it. The new flow and validation is now safer, if you specify a directory Logstash will tell you to specify a complete filename. If the ZIP extension is missing, the command line will ask you to make sure you target a right filename. If the output file already exist it will *not* delete it but instead will return a warning message, you can force a delete by using the `--overwrite` option. Fixes: #6862 Fixes #6861
76 lines
2.8 KiB
Ruby
76 lines
2.8 KiB
Ruby
# encoding: utf-8
|
|
require "pluginmanager/command"
|
|
require "pluginmanager/errors"
|
|
|
|
class LogStash::PluginManager::PrepareOfflinePack < LogStash::PluginManager::Command
|
|
parameter "[PLUGIN] ...", "plugin name(s)", :attribute_name => :plugins_arg
|
|
option "--output", "OUTPUT", "output zip file", :default => ::File.join(LogStash::Environment::LOGSTASH_HOME, "logstash-offline-plugins-#{LOGSTASH_VERSION}.zip")
|
|
option "--overwrite", :flag, "overwrite a previously generated package file", :default => false
|
|
|
|
def execute
|
|
validate_arguments!
|
|
|
|
# We need to start bundler, dependencies so the plugins are available for the prepare
|
|
LogStash::Bundler.setup!({:without => [:build, :development]})
|
|
|
|
# manually require paquet since its an external dependency
|
|
require "pluginmanager/offline_plugin_packager"
|
|
require "paquet"
|
|
require "paquet/shell_ui"
|
|
|
|
# Override the shell output with the one from the plugin manager
|
|
# To silence some of debugs/info statements
|
|
Paquet.ui = Paquet::SilentUI unless debug?
|
|
|
|
if File.directory?(output)
|
|
signal_error("Package creation cancelled: The specified output is a directory, you must specify a filename with a zip extension, provided output: #{output}.")
|
|
else
|
|
if File.extname(output).downcase != ".zip"
|
|
signal_error("Package creation cancelled: You must specify the zip extension for the provided filename: #{output}.")
|
|
end
|
|
|
|
if ::File.exists?(output)
|
|
if overwrite?
|
|
File.delete(output)
|
|
else
|
|
signal_error("Package creation cancelled: output file destination #{output} already exists.")
|
|
end
|
|
end
|
|
end
|
|
|
|
LogStash::PluginManager::OfflinePluginPackager.package(plugins_arg, output)
|
|
|
|
message = <<-EOS
|
|
Offline package created at: #{output}
|
|
|
|
You can install it with this command `bin/logstash-plugin install file://#{::File.expand_path(output)}`
|
|
EOS
|
|
|
|
LogStash::PluginManager::ui.info(message)
|
|
rescue LogStash::PluginManager::UnpackablePluginError => e
|
|
report_exception("Offline package", e)
|
|
rescue LogStash::PluginManager::PluginNotFoundError => e
|
|
report_exception("Cannot create the offline archive", e)
|
|
end
|
|
|
|
def validate_arguments!
|
|
if plugins_arg.size == 0
|
|
message = <<-EOS
|
|
You need to specify at least one plugin or use a wildcard expression.
|
|
|
|
Examples:
|
|
bin/logstash-plugin prepare-offline-pack logstash-input-beats
|
|
bin/logstash-plugin prepare-offline-pack logstash-filter-jdbc logstash-input-beats
|
|
bin/logstash-plugin prepare-offline-pack logstash-filter-*
|
|
bin/logstash-plugin prepare-offline-pack logstash-filter-* logstash-input-beats
|
|
|
|
You can get a list of the installed plugin by running `bin/logstash-plugin list`
|
|
|
|
The prepare offline will pack the currently installed plugins and their dependencies
|
|
for offline installation.
|
|
EOS
|
|
signal_usage_error(message)
|
|
end
|
|
end
|
|
end
|
|
|