veewee 0.2.3 → 0.3.0.alpha1

data/lib/veewee/builder/vmfusion/helper/template.vmx.erb

@@ -0,0 +1,81 @@
+.encoding = "UTF-8"
+config.version = "8"
+virtualHW.version = "7"
+numvcpus = "<%= cpu_count %>"
+scsi0.present = "TRUE"
+scsi0.virtualDev = "<%= controller_type %>"
+memsize = "<%= memory_size %>"
+scsi0:0.present = "TRUE"
+scsi0:0.fileName = "<%= box_name %>.vmdk"
+ide1:0.present = "TRUE"
+ide1:0.fileName = "<%= iso_file %>"
+ide1:0.deviceType = "cdrom-image"
+usb.present = "TRUE"
+ehci.present = "TRUE"
+pciBridge0.present = "TRUE"
+pciBridge4.present = "TRUE"
+pciBridge4.virtualDev = "pcieRootPort"
+pciBridge4.functions = "8"
+pciBridge5.present = "TRUE"
+pciBridge5.virtualDev = "pcieRootPort"
+pciBridge5.functions = "8"
+pciBridge6.present = "TRUE"
+pciBridge6.virtualDev = "pcieRootPort"
+pciBridge6.functions = "8"
+pciBridge7.present = "TRUE"
+pciBridge7.virtualDev = "pcieRootPort"
+pciBridge7.functions = "8"
+vmci0.present = "TRUE"
+roamingVM.exitBehavior = "go"
+tools.syncTime = "TRUE"
+displayName = "<%= box_name %>"
+guestOS = "<%= fusion_os_type %>"
+nvram = "<%= box_name %>.nvram"
+virtualHW.productCompatibility = "hosted"
+proxyApps.publishToHost = "FALSE"
+tools.upgrade.policy = "upgradeAtPowerCycle"
+powerType.powerOff = "soft"
+powerType.powerOn = "soft"
+powerType.suspend = "soft"
+powerType.reset = "soft"
+floppy0.present = "FALSE"
+extendedConfigFile = "<%= box_name %>.vmxf"
+checkpoint.vmState = ""
+#uuid.location = "56 4d 7a 3a bb 23 52 50-d4 b3 d3 46 6e f3 aa 63"
+#uuid.bios = "56 4d 7a 3a bb 23 52 50-d4 b3 d3 46 6e f3 aa 63"
+cleanShutdown = "FALSE"
+replay.supported = "FALSE"
+debugStub.linuxOffsets = "0x0,0xffffffff,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0"
+replay.filename = ""
+scsi0:0.redo = ""
+pciBridge0.pciSlotNumber = "17"
+pciBridge4.pciSlotNumber = "21"
+pciBridge5.pciSlotNumber = "22"
+pciBridge6.pciSlotNumber = "23"
+pciBridge7.pciSlotNumber = "24"
+scsi0.pciSlotNumber = "16"
+usb.pciSlotNumber = "32"
+ehci.pciSlotNumber = "34"
+vmci0.pciSlotNumber = "35"
+vmotion.checkpointFBSize = "65536000"
+vmci0.id = "1861462627"
+gui.fullScreenAtPowerOn = "FALSE"
+gui.viewModeAtPowerOn = "windowed"
+hgfs.mapRootShare = "TRUE"
+hgfs.linkRootShare = "TRUE"
+isolation.tools.hgfs.disable = "FALSE"
+ethernet0.pciSlotNumber = "33"
+ethernet0.present = "TRUE"
+ethernet0.connectionType = "nat"
+ethernet0.virtualDev = "e1000"
+ethernet0.wakeOnPcktRcv = "FALSE"
+ethernet0.addressType = "generated"
+ethernet0.linkStatePropagation.enable = "FALSE"
+#ethernet0.generatedAddress = "<%= mac_address %>S"
+#ethernet0.generatedAddressOffset = "0"
+ethernet0.vnet = "vmnet2"
+ethernet0.bsdName = "en0"
+ethernet0.displayName = "Ethernet"
+sound.startConnected = "FALSE"
+RemoteDisplay.vnc.enabled = "TRUE"
+RemoteDisplay.vnc.port = "<%= vnc_port %>"

data/lib/veewee/builder/vmfusion/helper/validate_vmfusion.rb

@@ -0,0 +1,37 @@
+module Veewee
+  module Builder
+    module Vmfusion
+      module BuilderHelper
+
+      def validate_vmfusion(box_name,options)
+        require 'cucumber'
+
+        require 'cucumber/rspec/disable_option_parser'
+        require 'cucumber/cli/main'
+
+        ENV['veewee_user']=options[:user]
+        feature_path=File.join(File.dirname(__FILE__),"..","..","..","..","..","validation","vagrant.feature")
+
+        features=Array.new
+        features[0]=feature_path
+        features << "-t"
+        features << "@vmfusion"
+
+        begin
+          # The dup is to keep ARGV intact, so that tools like ruby-debug can respawn.
+          failure = Cucumber::Cli::Main.execute(features.dup)
+          Kernel.exit(failure ? 1 : 0)
+        rescue SystemExit => e
+          Kernel.exit(e.status)
+        rescue Exception => e
+          env.ui.error("#{e.message} (#{e.class})")
+          env.ui.error(e.backtrace.join("\n"))
+          Kernel.exit(1)
+        end
+
+      end
+    end #Module
+      
+    end #Module
+  end #Module
+end #Module

data/lib/veewee/builder/vmfusion/info/export_ovf.info

@@ -0,0 +1,103 @@
+# /Library/Application\ Support/VMware\ Fusion/ovftool/ovftool.bin  --help
+
+falcon-pdb:Downloads patrick$ /Library/Application\ Support/VMware\ Fusion/ovftool/ovftool.bin  --help
+Usage: ovftool [options] <source> [<target>]
+where
+<source>: Source URL locator to an OVF package, VMX file, or virtual machine in
+          vCenter or on ESX Server. 
+<target>: Destination URL locator which specifies either a file location, or a 
+          location in the vCenter inventory or on an ESX Server. 
+
+If <target> is not specified, information about the source is displayed to the 
+console. 
+
+Options:
+     --acceptAllEulas         : Accept all end-user licenses agreements without
+                                being prompted. 
+     --authdPortSource        : Use this to override default vmware authd port 
+                                (902) when using a host as source. 
+     --authdPortTarget        : Use this to override default vmware authd port 
+                                (902) when using a host as target. 
+     --chunkSize              : Specifies the chunk size to use for files in a 
+                                generated OVF package. The default is not to 
+                                chunk. The chunk size without unit is assumed 
+                                to be in megabytesAccepted units are b, kb, mb,
+                                gb; e.g., 2gb or 100kb. 
+     --compress               : Compress the disks in an OVF package. Value 
+                                must be between 1 and 9. 1 is the fastest, but 
+                                gives the worst compression, whereas 9 is the 
+                                slowest, but gives the best compression. 
+ -ds/--datastore              : Target datastore name for a VI locator.
+     --deploymentOption       : Selects what deployment option to use (if the 
+                                source OVF package supports multiple options.) 
+     --disableVerification    : Skip validation of signature and certificate.
+ -dm/--diskMode               : Select target disk format. Supported formats 
+                                are: monolithicSparse, monolithicFlat, 
+                                twoGbMaxExtentSparse, twoGbMaxExtentFlat, 
+                                streamOptimized, thin (VI target) and thick (VI
+                                target) 
+     --eula                   : EULA to be inserted in the first virtual system
+                                or virtual system collection in the OVF. If the
+                                EULA is in a file, use the option 
+                                --eula@=filename instead. 
+ -h /--help                   : Prints this message.
+     --hideEula               : In OVF probe mode, hides the EULA.
+     --ipAllocationPolicy     : IP allocation policy for a deployed OVF 
+                                package. Supported values are fixed, transient 
+                                and dhcp. 
+     --ipProtocol             : Select what IP protocol to use (IPv4, IPv6).
+     --lax                    : Relax OVF specification conformance and virtual
+                                hardware compliance checks. Use only if you 
+                                know what you are doing. 
+     --locale                 : Selects locale for target.
+     --machineOutput          : Output OVF Tool messages in a machine friendly 
+                                manner. 
+     --makeDeltaDisks         : Build delta disk hierarchy from the given 
+                                source locator. 
+ -n /--name                   : Specifies target name (defaults to source 
+                                name). 
+     --net                    : Set a network assignment in the deployed OVF 
+                                package. A network assignment is set using the 
+                                syntax --net:<OVF name>=<target name>. 
+ -nw/--network                : Target network for a VI deployment.
+     --noDisks                : Disable disk conversion.
+     --noImageFiles           : Do not include image files in destination.
+ -o /--overwrite              : Force overwrites of existing files.
+     --powerOffSource         : Ensures a VM/vApp is powered off before 
+                                importing from a VI source. 
+     --powerOffTarget         : Ensures a VM/vApp is powered off before 
+                                overwriting a VI target. 
+     --powerOn                : Powers on a VM/vApp deployed on a VI target.
+     --privateKey             : Sign OVF package with the given private key 
+                                (.pem file). The file must contain a private 
+                                key and a certificate. 
+     --privateKeyPassword     : Password for the private key. Should be used in
+                                conjunction with privateKey if the private key 
+                                requires password authentication. If required 
+                                and not specified, the tool will prompt for the
+                                password. 
+     --prop                   : Set a property in the deployed OVF package. A 
+                                property is set using the syntax 
+                                --prop:<key>=<value>. 
+     --proxy                  : Proxy used for HTTP[S] access.
+ -q /--quiet                  : No output to screen except errors.
+     --schemaValidate         : Validate OVF descriptor against OVF schema.
+     --skipManifestCheck      : Skip validation of OVF package manifest.
+     --skipManifestGeneration : Skip generation of OVF package manifest.
+ -st/--sourceType             : Explicitly express that source is OVF, OVA, 
+                                VMX, VI, vApprun 
+ -tt/--targetType             : Explicitly express that target is OVF, OVA, 
+                                VMX, VI, vApprun 
+     --verifyOnly             : Do not upload the source but only verify it 
+                                against the target host. Applies to VI 4 
+                                targets only. 
+ -v /--version                : Prints the version of this tool.
+ -vf/--vmFolder               : Target VM folder in VI inventory (relative to 
+                                datacenter). 
+
+For more help, type: --help <topic>, where topics are:
+ locators    : For detailed source and destination locator syntax
+ examples    : For examples of use
+ config      : For syntax of configuration files
+ integration : For a list of options primarily used when ovftool is exec'ed 
+               from another tool or shellscript. 

data/lib/veewee/cli.rb

@@ -0,0 +1,55 @@
+require 'thor'
+
+module Veewee
+  # Entrypoint for the Veewee CLI. This class should never be
+  # initialized directly (like a typical Thor class). Instead,
+  # use {Environment#cli} to invoke the CLI.
+  #
+  # # Defining Custom CLI Commands
+  #
+  # If you're looking to define custom CLI commands, then look at
+  # one of the two following classes:
+  #
+  # * {Command::Base} - Implementing a single command such as `mccloud up`, e.g.
+  #   one without subcommands. Also take a look at {Command::NamedBase}.
+  # * {Command::GroupBase} - Implementing a command with subcommands, such as
+  #   `mccloud box`, which has the `list`, `add`, etc. subcommands.
+  #
+  # The above linked classes contain the main documentation for each
+  # type of command.
+  class CLI < Thor
+    # Registers the given class with the CLI so it can be accessed.
+    # The class must be a subclass of either {Command::Base} or {Command::GroupBase}.
+    # Don't call this method directly, instead call the {Command::Base.register}
+    # or {Command::GroupBase.register} methods.
+    #
+    # @param [Class] klass Command class
+    # @param [String] name Command name, accessed at `mccloud NAME`
+    # @param [String] usage Command usage, such as "mccloud NAME [--option]"
+    # @param [String] description Description of the command shown during the
+    #   command listing.
+    # @param [Hash] opts Other options (not gone into detail here, look at
+    #   the source instead).
+    def self.register(klass, name, usage, description, opts=nil)
+      opts ||= {}
+
+      if klass <= Command::GroupBase
+        # A subclass of GroupBase is a subcommand, since it contains
+        # many smaller commands within it.
+        desc usage, description, opts
+        subcommand name, klass
+      elsif klass <= Command::Base
+        # A subclass of Base is a single command, since it
+        # is invoked as a whole (as Thor::Group)
+        desc usage, description, opts
+        define_method(name) { |*args| invoke klass, args }
+      end
+
+      if opts[:alias]
+        # Alises are defined for this command, so properly alias the
+        # newly defined method/subcommand:
+        map opts[:alias] => name
+      end
+    end
+  end
+end #Veewee

data/lib/veewee/command.rb

@@ -1,24 +1,14 @@
-require 'veewee/session'
-
-#Load Veewee::Session libraries
-lib_dir= File.expand_path(File.join(File.dirname(__FILE__),"..","..", "lib"))
-Dir.glob(File.join(lib_dir, '**','*.rb')).each {|f| require f  }
-
-#Setup some base variables to use
-template_dir=File.expand_path(File.join(lib_dir,"..", "templates"))
-
-veewee_dir="."
-definition_dir= File.expand_path(File.join(veewee_dir, "definitions"))
-tmp_dir=File.expand_path(File.join(veewee_dir, "tmp"))
-iso_dir=File.expand_path(File.join(veewee_dir, "iso"))
-box_dir=File.expand_path(File.join(veewee_dir, "boxes"))
-validation_dir=File.expand_path(File.join(lib_dir, "..","validation"))
-
-#Initialize
-Veewee::Session.setenv({:veewee_dir => veewee_dir, :definition_dir => definition_dir,
-   :template_dir => template_dir, :iso_dir => iso_dir, :box_dir => box_dir, :tmp_dir => tmp_dir, :validation_dir => validation_dir})
-
 module Veewee
   module Command
+    autoload :Base,      'veewee/command/base'
+    autoload :GroupBase, 'veewee/command/group_base'
+    autoload :Helpers,   'veewee/command/helpers'
+    autoload :NamedBase, 'veewee/command/named_base'
   end
 end
+
+# The built-in commands must always be loaded
+require 'veewee/command/version'
+require 'veewee/command/kvm'
+require 'veewee/command/virtualbox'
+require 'veewee/command/vmfusion'

data/lib/veewee/command/base.rb

@@ -0,0 +1,106 @@
+require 'thor/group'
+require 'thor/actions'
+
+module Veewee
+  module Command
+    # A {Base} is the superclass for all commands which are single
+    # commands, e.g. `veewee init`, `veewee up`. Not commands like
+    # `veewee box add`. For commands which have more subcommands, use
+    # a {GroupBase}.
+    #
+    # A {Base} is a subclass of `Thor::Group`, so view the documentation
+    # there on how to add arguments, descriptions etc. The important note
+    # about this is that when invoked, _all public methods_ will be called
+    # in the order they are defined. If you don't want a method called when
+    # the command is invoked, it must be made `protected` or `private`.
+    #
+    # The best way to get examples of how to create your own command is to
+    # view the various Veewee commands, which are relatively simple, and
+    # can be found in the Veewee source tree at `lib/veewee/command/`.
+    #
+    # # Defining a New Command
+    #
+    # To define a new single command, create a new class which inherits
+    # from this class, then call {register} to register the command. That's
+    # it! When the command is invoked, _all public methods_ will be called.
+    # Below is an example `SayHello` class:
+    #
+    #     class SayHello < Veewee::Command::Base
+    #       register "hello", "Says hello"
+    #
+    #       def hello
+    #         env.ui.info "Hello"
+    #       end
+    #     end
+    #
+    # In this case, the above class is invokable via `veewee hello`. To give
+    # this a try, just copy and paste the above into a Veeweefile somewhere.
+    # The command will be available for that project!
+    #
+    # Also note that the above example uses `env.ui` to output. It is recommended
+    # you use this instead of raw "env.ui.info" since it is configurable and provides
+    # additional functionality, such as colors and asking for user input. See
+    # the {UI} class for more information.
+    #
+    # ## Defining Command-line Options
+    #
+    # Most command line actions won't be as simple as `veewee hello`, and will
+    # probably require parameters or switches. Luckily, Thor makes adding these
+    # easy:
+    #
+    #     class SayHello < Veewee::Command::Base
+    #       register "hello", "Says hello"
+    #       argument :name, :type => :string
+    #
+    #       def hello
+    #         env.ui.info "Hello, #{name}"
+    #       end
+    #     end
+    #
+    # Then, the above can be invoked with `veewee hello Mitchell` which would
+    # output "Hello, Mitchell." If instead you're looking for switches, such as
+    # "--name Mitchell", then take a look at `class_option`, an example of which
+    # can be found in the {PackageCommand}.
+    class Base < Thor::Group
+      include Thor::Actions
+      include Helpers
+
+      attr_reader :env
+
+      # Register the command with the main Veewee CLI under the
+      # given name. The name will be used for accessing it from the CLI,
+      # so if you name it "lamp", then the command to invoke this
+      # will be `veewee lamp`.
+      #
+      # The description is used when the help is listed, and is meant to be
+      # a brief (one sentence) description of what the 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)
+        desc description
+        ::Veewee::CLI.register(self, extract_name_from_usage(usage), usage, desc, opts)
+      end
+
+      def initialize(*args)
+        super
+        initialize_environment(*args)
+      end
+
+      protected
+
+      # Extracts the name of the command from a usage string. Example:
+      # `init [box_name] [box_url]` becomes just `init`.
+      def self.extract_name_from_usage(usage)
+        /^([-_a-zA-Z0-9]+)(\s+(.+?))?$/.match(usage).to_a[1]
+      end
+    end
+  end
+end

data/lib/veewee/command/group_base.rb

@@ -0,0 +1,107 @@
+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} #{@_name}"
+      end
+    end
+  end
+end