00aba5ac03
Easy commands are well... easy! They don't offer the full power of
creating a completely custom command class, but they let you do the
basics (what almost everyone needs) with minimal fuss. Example:
class MyPlugin < Vagrant.plugin("1")
name "my-plugin"
easy_command "foo" do |action|
puts "HELLO!"
end
end
NOTE: The "action" stuff isn't done yet, but will be soon!
58 lines
1.5 KiB
Ruby
58 lines
1.5 KiB
Ruby
require "log4r"
|
|
|
|
module Vagrant
|
|
class EasyCommand
|
|
# This creates a new easy command. This typically is not called
|
|
# directly. Instead, the plugin interface's `easy_command` is
|
|
# used to create one of these.
|
|
def self.create(name, &block)
|
|
# Create a new command class for this command, and return it
|
|
command = Class.new(Base)
|
|
command.configure(name, &block)
|
|
command
|
|
end
|
|
|
|
# Base class for all easy commands. This contains the basic code
|
|
# that knows how to run the easy commands.
|
|
class Base < Vagrant::Command::Base
|
|
@@command = nil
|
|
@@runner = nil
|
|
|
|
# This is called by the {EasyCommand.create} method when creating
|
|
# an easy command to set the invocation command.
|
|
def self.configure(name, &block)
|
|
@@command = name
|
|
@@runner = block
|
|
end
|
|
|
|
def initialize(*args, &block)
|
|
super
|
|
|
|
@logger = Log4r::Logger.new("vagrant::easy_command::#{@@command}")
|
|
end
|
|
|
|
def execute
|
|
# Build up a basic little option parser
|
|
opts = OptionParser.new do |opts|
|
|
opts.banner = "Usage: vagrant #{@@command}"
|
|
end
|
|
|
|
# Parse the options
|
|
argv = parse_options(opts)
|
|
return if !argv
|
|
|
|
# Run the action for each VM.
|
|
@logger.info("Running easy command: #{@@command}")
|
|
with_target_vms(argv) do |vm|
|
|
@logger.debug("Running easy command for VM: #{vm.name}")
|
|
|
|
@@runner.call(nil)
|
|
end
|
|
|
|
# Exit status 0 every time for now
|
|
0
|
|
end
|
|
end
|
|
end
|
|
end
|