veewee-atlassian 0.3.11

data/lib/veewee/command/group_base.rb

@@ -0,0 +1,108 @@
+require 'thor'
+require 'thor/actions'
+
+module Veewee
+  module Command
+    # A {GroupBase} is the superclass which should be used if you're
+    # creating a CLI command which has subcommands such as `veewee box`,
+    # which has subcommands such as `add`, `remove`, `list`. If you're
+    # creating a simple command which has no subcommands, such as `veewee up`,
+    # then use {Base} instead.
+    #
+    # Unlike {Base}, where all public methods are executed, in a {GroupBase},
+    # each public method defines a separate task which can be invoked. The best
+    # way to get examples of how to create a {GroupBase} command is to look
+    # at the built-in commands, such as {BoxCommand}.
+    #
+    # # Defining a New Command
+    #
+    # To define a new command with subcommands, create a new class which inherits
+    # from this class, then call {register} to register the command. That's it! When
+    # the command is invoked, the method matching the subcommand is invoked. An
+    # example is shown below:
+    #
+    #     class SayCommand < Veewee::Command::GroupBase
+    #       register "say", "Say hello or goodbye"
+    #
+    #       desc "hello", "say hello"
+    #       def hello
+    #         env.ui.info "Hello"
+    #       end
+    #
+    #       desc "goodbye", "say goodbye"
+    #       def goodbye
+    #         env.ui.info "Goodbye"
+    #       end
+    #     end
+    #
+    # In this case, the above class is invokable via `veewee say hello` or
+    # `veewee say goodbye`. To give it a try yourself, just copy and paste
+    # the above into a Veeweefile somewhere, and run `veewee` from within
+    # that directory. You should see the new command!
+    #
+    # Also notice that in the above, each task follows a `desc` call. This
+    # call is used to provide usage and description for each task, and is
+    # required.
+    #
+    # ## Defining Command-line Options
+    #
+    # ### Arguments
+    #
+    # To define arguments to your commands, such as `veewee say hello mitchell`,
+    # then you simply define them as arguments to the method implementing the
+    # task. An example is shown below (only the method, to keep things brief):
+    #
+    #     def hello(name)
+    #       env.ui.info "Hello, #{name}"
+    #     end
+    #
+    # Then, if `veewee say hello mitchell` was called, then the output would
+    # be "Hello, mitchell"
+    #
+    # ### Switches or Other Options
+    #
+    # TODO
+    class GroupBase < Thor
+      include Thor::Actions
+      include Helpers
+
+      attr_reader :env
+
+      # Register the command with the main Veewee CLI under the given
+      # usage. The usage will be used for accessing it from the CLI,
+      # so if you give it a usage of `lamp [subcommand]`, then the command
+      # to invoke this will be `veewee lamp` (with a subcommand).
+      #
+      # The description is used when a listing of the commands is given
+      # and is meant to be a brief (one sentence) description of what this
+      # command does.
+      #
+      # Some additional options may be passed in as the last parameter:
+      #
+      # * `:alias` - If given as an array or string, these will be aliases
+      #  for the same command. For example, `veewee version` is also
+      #  `veewee --version` and `veewee -v`
+      #
+      # @param [String] usage
+      # @param [String] description
+      # @param [Hash] opts
+      def self.register(usage, description, opts=nil)
+        @_name = Base.extract_name_from_usage(usage)
+        CLI.register(self, @_name, usage, description, opts)
+      end
+
+      def initialize(*args)
+        super
+        initialize_environment(*args)
+      end
+
+      protected
+
+      # Override the basename to include the subcommand name.
+      def self.basename
+        "#{super}"
+        #"#{super} #{@_name}"
+      end
+    end
+  end
+end

data/lib/veewee/command/helpers.rb

@@ -0,0 +1,13 @@
+module Veewee
+  module Command
+    module Helpers
+      # Initializes the environment by pulling the environment out of
+      # the configuration hash and sets up the UI if necessary.
+      def initialize_environment(args, options, config)
+        raise Errors::CLIMissingEnvironment if !config[:env]
+        @env = config[:env]
+      end
+
+     end
+  end
+end

data/lib/veewee/command/kvm.rb

@@ -0,0 +1,130 @@
+module Veewee
+  module Command
+    class Kvm< Veewee::Command::GroupBase
+
+      register "kvm", "Subcommand for KVM"
+      desc "build [BOX_NAME]", "Build box"
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "force the build"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :nogui,:type => :boolean , :default => false, :aliases => "-n", :desc => "no gui"
+      method_option :auto,:type => :boolean , :default => false, :aliases => "-a", :desc => "auto answers"
+      method_option :checksum , :type => :boolean , :default => false, :desc => "verify checksum"
+
+      method_option :postinstall_include, :type => :array, :default => [], :aliases => "-i", :desc => "ruby regexp of postinstall filenames to additionally include"
+      method_option :postinstall_exclude, :type => :array, :default => [], :aliases => "-e", :desc => "ruby regexp of postinstall filenames to exclude"
+      method_option :use_emulation, :type => :boolean , :default => false, :desc => "Use QEMU emulation"
+      method_option :pool_name, :type => :string, :default => nil, :desc => "Name of the libvirt storage pool to be used"
+      method_option :network_name, :type => :string, :default => "default", :desc => "Name of the libvirt network to be used"
+      def build(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["kvm"].get_box(box_name).build(options)
+      end
+
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "force the destroy" 
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :nogui,:type => :boolean , :default => false, :aliases => "-n", :desc => "no gui"
+      desc "destroy [BOXNAME]", "Destroys the virtualmachine that was built"
+      def destroy(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["kvm"].get_box(box_name).destroy(options)
+      end
+
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "force the shutdown" 
+      desc "halt [BOXNAME]", "Activates a shutdown the virtualmachine"
+      def halt(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["kvm"].get_box(box_name).halt(options)
+      end
+
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :nogui,:type => :boolean , :default => false, :aliases => "-n", :desc => "no gui"
+      desc "up [BOXNAME]", "Starts a Box"
+      def up(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["kvm"].get_box(box_name).up(options)
+      end
+
+      desc "ssh [BOXNAME] [COMMAND]", "SSH to box"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def ssh(box_name,command=nil)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["kvm"].get_box(box_name).issh(command)
+      end
+
+      desc "define [BOXNAME] [TEMPLATE]", "Define a new basebox starting from a template"
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "overwrite the definition"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def define(definition_name, template_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.definitions.define(definition_name,template_name,options)
+        env.ui.info "The basebox '#{definition_name}' has been successfully created from the template '#{template_name}'"
+        env.ui.info "You can now edit the definition files stored in definitions/#{definition_name} or build the box with:"
+        env.ui.info "veewee kvm build '#{definition_name}'"
+      end
+
+      desc "undefine [BOXNAME]", "Removes the definition of a basebox "
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def undefine(definition_name)
+        env.ui.info "Removing definition #{definition_name}"
+        begin
+          venv=Veewee::Environment.new(options)
+          venv.ui=env.ui
+          venv.definitions.undefine(definition_name,options)
+        rescue Error => ex
+          env.ui.error("#{ex}", :prefix=> false)
+          exit -1
+        end
+      end
+
+      desc "validate [NAME]", "Validates a box against kvm compliancy rules"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :tags,:type => :array , :default => %w{kvm puppet chef}, :aliases => "-t", :desc => "tags to validate"
+      def validate(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["kvm"].get_box(box_name).validate_kvm(options)
+      end
+
+      desc "ostypes", "List the available Operating System types"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def ostypes
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.ostypes.each do |name|
+           env.ui.info "- #{name}"
+        end
+      end
+
+      desc "templates", "List the currently available templates"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def templates
+        env.ui.info "The following templates are available:"
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.templates.each do |name,template|
+          env.ui.info "veewee kvm define '<box_name>' '#{name}'",:prefix => false
+        end
+      end
+
+      desc "list", "Lists all defined boxes"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def list
+        env.ui.info "The following local definitions are available:"
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.ui=env.ui
+        venv.definitions.each do |name,definition|
+          env.ui.info "- #{name}"
+        end
+      end
+    end
+
+  end
+end

data/lib/veewee/command/named_base.rb

@@ -0,0 +1,14 @@
+module Veewee
+  module Command
+    # Same as {Base} except adds the `name` argument for you. This superclass
+    # is useful if you're creating a command which should be able to target
+    # a specific VM in a multi-VM environment. For example, in a multi-VM
+    # environment, `vagrant up` "ups" all defined VMs, but you can specify a
+    # name such as `vagrant up web` to target only a specific VM. That name
+    # argument is from {NamedBase}. Of course, you can always add it manually
+    # yourself, as well.
+    class NamedBase < Base
+      argument :name, :type => :string, :optional => true
+    end
+  end
+end

data/lib/veewee/command/parallels.rb

@@ -0,0 +1,126 @@
+module Veewee
+  module Command
+    class Parallels< Veewee::Command::GroupBase
+
+      register "parallels", "Subcommand for Parallels"
+      desc "build [BOX_NAME]", "Build box"
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "force the build"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :auto,:type => :boolean , :default => false, :aliases => "-a", :desc => "auto answers"
+      method_option :checksum , :type => :boolean , :default => false, :desc => "verify checksum"
+      method_option :postinstall_include, :type => :array, :default => [], :aliases => "-i", :desc => "ruby regexp of postinstall filenames to additionally include"
+      method_option :postinstall_exclude, :type => :array, :default => [], :aliases => "-e", :desc => "ruby regexp of postinstall filenames to exclude"
+      def build(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["parallels"].get_box(box_name).build(options)
+      end
+
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "force the destroy" 
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      desc "destroy [BOXNAME]", "Destroys the virtualmachine that was built"
+      def destroy(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["parallels"].get_box(box_name).destroy(options)
+      end
+
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "force the shutdown" 
+      desc "halt [BOXNAME]", "Activates a shutdown the virtualmachine"
+      def halt(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["parallels"].get_box(box_name).halt(options)
+      end
+
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :nogui,:type => :boolean , :default => false, :aliases => "-n", :desc => "no gui"
+      desc "up [BOXNAME]", "Starts a Box"
+      def up(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["parallels"].get_box(box_name).up(options)
+      end
+
+      desc "ssh [BOXNAME] [COMMAND]", "SSH to box"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def ssh(box_name,command=nil)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["parallels"].get_box(box_name).issh(command)
+      end
+
+      desc "define [BOXNAME] [TEMPLATE]", "Define a new basebox starting from a template"
+      method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "overwrite the definition"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def define(definition_name, template_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.definitions.define(definition_name,template_name,options)
+        env.ui.info "The basebox '#{definition_name}' has been successfully created from the template '#{template_name}'"
+        env.ui.info "You can now edit the definition files stored in definitions/#{definition_name} or build the box with:"
+        env.ui.info "veewee parallels build '#{definition_name}'"
+      end
+
+      desc "undefine [BOXNAME]", "Removes the definition of a basebox "
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def undefine(definition_name)
+        env.ui.info "Removing definition #{definition_name}" , :prefix => false
+        begin
+          venv=Veewee::Environment.new(options)
+          venv.ui=env.ui
+          venv.definitions.undefine(definition_name,options)
+          env.ui.info "Definition #{definition_name} successfully removed",:prefix => false
+        rescue Error => ex
+          env.ui.error "#{ex}" , :prefix => false
+          exit -1
+        end
+      end
+
+      desc "validate [NAME]", "Validates a box against parallels compliancy rules"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      method_option :tags,:type => :array, :default => %w{parallels puppet chef}, :aliases => "-t", :desc => "tags to validate"
+      def validate(box_name)
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.providers["parallels"].get_box(box_name).validate_parallels(options)
+      end
+
+      desc "ostypes", "List the available Operating System types"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def ostypes
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.ostypes.each do |name|
+           env.ui.info "- #{name}"
+        end
+      end
+
+      desc "templates", "List the currently available templates"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def templates
+        env.ui.info "The following templates are available:",:prefix => false
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.templates.each do |name,template|
+          env.ui.info "veewee parallels define '<box_name>' '#{name}'",:prefix => false
+        end
+      end
+
+      desc "list", "Lists all defined boxes"
+      method_option :debug,:type => :boolean , :default => false, :aliases => "-d", :desc => "enable debugging"
+      def list
+        env.ui.info "The following local definitions are available:",:prefix => false
+        venv=Veewee::Environment.new(options)
+        venv.ui=env.ui
+        venv.definitions.each do |name,definition|
+          env.ui.info "- #{name}"
+        end
+      end
+
+
+    end
+
+  end
+end

data/lib/veewee/command/vagrant.rb

@@ -0,0 +1,4 @@
+require 'veewee'
+require 'veewee/command/vagrant/basebox'
+
+Vagrant.commands.register(:basebox)      { Veewee::Command::Vagrant::Basebox }

data/lib/veewee/command/vagrant/basebox.rb

@@ -0,0 +1,88 @@
+require 'veewee'
+require 'optparse'
+require 'veewee/command/vagrant/ostypes'
+require 'veewee/command/vagrant/templates'
+require 'veewee/command/vagrant/list'
+require 'veewee/command/vagrant/build'
+require 'veewee/command/vagrant/destroy'
+require 'veewee/command/vagrant/up'
+require 'veewee/command/vagrant/halt'
+require 'veewee/command/vagrant/ssh'
+require 'veewee/command/vagrant/winrm'
+require 'veewee/command/vagrant/define'
+require 'veewee/command/vagrant/undefine'
+require 'veewee/command/vagrant/validate'
+require 'veewee/command/vagrant/export'
+require 'veewee/command/vagrant/screenshot'
+
+
+module Veewee
+  module Command
+    module Vagrant
+      class Basebox < ::Vagrant::Command::Base
+        def initialize(argv,env)
+          super
+
+          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+          @subcommands = ::Vagrant::Registry.new
+          @subcommands.register(:ostypes)    { Veewee::Command::Vagrant::Ostypes }
+          @subcommands.register(:templates)    { Veewee::Command::Vagrant::Templates }
+          @subcommands.register(:list)    { Veewee::Command::Vagrant::List }
+          @subcommands.register(:build)    { Veewee::Command::Vagrant::Build }
+          @subcommands.register(:destroy)    { Veewee::Command::Vagrant::Destroy }
+          @subcommands.register(:up)    { Veewee::Command::Vagrant::Up }
+          @subcommands.register(:halt)    { Veewee::Command::Vagrant::Halt }
+          @subcommands.register(:ssh)    { Veewee::Command::Vagrant::Ssh }
+          @subcommands.register(:winrm)    { Veewee::Command::Vagrant::Winrm }
+          @subcommands.register(:define)    { Veewee::Command::Vagrant::Define }
+          @subcommands.register(:undefine)    { Veewee::Command::Vagrant::Undefine }
+          @subcommands.register(:export)    { Veewee::Command::Vagrant::Export }
+          @subcommands.register(:validate)    { Veewee::Command::Vagrant::Validate }
+          @subcommands.register(:screenshot)    { Veewee::Command::Vagrant::Screenshot }
+
+        end
+
+
+        def execute
+          if @main_args.include?("-h") || @main_args.include?("--help")
+            # Print the help for all the box commands.
+            return help
+          end
+
+          # If we reached this far then we must have a subcommand. If not,
+          # then we also just print the help and exit.
+          command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+          return help if !command_class || !@sub_command
+          @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+          # Initialize and execute the command class
+          command_class.new(@sub_args, @env).execute
+        end
+
+        # Prints the help out for this command
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant basebox <command> [<args>]"
+            opts.separator ""
+            opts.separator "Available subcommands:"
+
+            # Add the available subcommands as separators in order to print them
+            # out as well.
+            keys = []
+            @subcommands.each { |key, value| keys << key.to_s }
+
+            keys.sort.each do |key|
+              opts.separator "     #{key}"
+            end
+
+            opts.separator ""
+            opts.separator "For help on any individual command run `vagrant basebox COMMAND -h`"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+      end
+    end
+  end
+end