testlab 0.2.1 → 0.3.0

data/.gitignore

@@ -17,4 +17,3 @@ test/version_tmp
 tmp
 *log
 Vagrantfile
-testlab/

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'coveralls', :require => false
-
 gemspec

data/bin/tl

@@ -3,39 +3,15 @@ require 'gli'
 require 'testlab'
 
 include GLI::App
+include TestLab::Utility::Misc
 
-program_desc %(TestLab #{TestLab::VERSION} - A framework for building lightweight virtual infrastructure using LXC)
+version TestLab::VERSION
 
-version Testlab::VERSION
+program_desc %(A framework for building lightweight virtual infrastructure using LXC)
+program_long_desc %(Program Long Description)
 
-# desc 'Describe some switch here'
-# switch [:s,:switch]
-
-# desc 'Describe some flag here'
-# default_value 'the default'
-# arg_name 'The name of the argument'
-# flag [:f,:flagname]
-
-# desc 'Manage the test lab'
-# arg_name 'Describe arguments to lab here'
-# command :lab do |c|
-
-#   # c.desc 'Describe a switch to lab'
-#   # c.switch :s
-
-#   # c.desc 'Describe a flag to lab'
-#   # c.default_value 'default'
-#   # c.flag :f
-#   # c.action do |global_options,options,args|
-
-#   #   # Your command logic here
-
-#   #   # If you have any errors, just raise them
-#   #   # raise "that command made no sense"
-
-#   #   puts "lab command ran"
-#   # end
-# end
+sort_help :manually
+default_command :help
 
 desc 'Create the test lab'
 command :create do |create|
@@ -90,7 +66,8 @@ desc 'Manage nodes'
 arg_name 'Describe arguments to node here'
 command :node do |c|
 
-  c.desc 'Node ID'
+  c.desc 'Node ID or Name'
+  c.arg_name 'node'
   c.flag [:i, :id]
 
   c.desc 'Open an SSH console to a node'
@@ -117,7 +94,8 @@ desc 'Manage containers'
 arg_name 'Describe arguments to container here'
 command :container do |c|
 
-  c.desc 'Container ID'
+  c.desc 'Container ID or Name'
+  c.arg_name 'container'
   c.flag [:i, :id]
 
   c.desc 'Open an SSH console to a container'
@@ -170,7 +148,7 @@ pre do |global,command,options,args|
   @ui = ZTK::UI.new(:logger => @logger)
   @testlab = TestLab.new(:ui => @ui)
 
-  message = TestLab::Utility.format_message("TestLab v#{TestLab::VERSION} Loaded".black.bold)
+  message = format_message("TestLab v#{TestLab::VERSION} Loaded".black.bold)
   @testlab.ui.stdout.puts(message)
 
   true
@@ -183,16 +161,25 @@ post do |global,command,options,args|
 end
 
 on_error do |exception|
-  # Error logic here
-  # return false to skip default error handling
-  @ui.stderr.puts(["EXCEPTION:".red.bold, exception.inspect.red].join(' '))
+  @ui.stderr.puts
+  @ui.stderr.puts(format_message(["ERROR:".red, exception.message.red.bold].join(' ')))
 
-  @logger.fatal { exception.inspect }
-  exception.backtrace.each do |line|
-    @logger.logdev.write("#{line}\n")
-  end
+  case exception
+  when GLI::BadCommandLine, GLI::UnknownCommand, GLI::UnknownCommandArgument, GLI::UnknownGlobalArgument then
+    command_regex = /Command '([\w]+)' /
+    command = exception.message.scan(command_regex).flatten.first
+
+    commands[:help] and commands[:help].execute({}, {}, (command.nil? ? [] : [command.to_s]))
 
-  false
+    false
+  else
+    @logger.fatal { exception.inspect }
+    exception.backtrace.each do |line|
+      @logger.logdev.write("#{line}\n")
+    end
+
+    false
+  end
 end
 
 exit run(ARGV)

data/lib/testlab/container/actions.rb

@@ -4,6 +4,11 @@ class TestLab
     module Actions
 
       # Create the container
+      #
+      # Builds the configuration for the container and sends a request to the
+      # LXC sub-system to create the container.
+      #
+      # @return [Boolean] True if successful.
       def create
         @ui.logger.debug { "Container Create: #{self.id} " }
 
@@ -22,33 +27,63 @@ class TestLab
 
           self.lxc.create(*create_args)
         end
+
+        true
       end
 
       # Destroy the container
+      #
+      # Sends a request to the LXC sub-system to destroy the container.
+      #
+      # @return [Boolean] True if successful.
       def destroy
         @ui.logger.debug { "Container Destroy: #{self.id} " }
 
         please_wait(:ui => @ui, :message => format_object_action(self, 'Destroy', :red)) do
           self.lxc.destroy
         end
+
+        true
       end
 
       # Start the container
+      #
+      # Sends a request to the LXC sub-system to bring the container online.
+      #
+      # @return [Boolean] True if successful.
       def up
         @ui.logger.debug { "Container Up: #{self.id} " }
 
+        (self.lxc.state == :not_created) and raise ContainerError, "We can not online a non-existant container!"
+
         please_wait(:ui => @ui, :message => format_object_action(self, 'Up', :green)) do
           self.lxc.start
+          self.lxc.wait(:running)
+
+          (self.lxc.state != :running) and raise ContainerError, "The container failed to online!"
         end
+
+        true
       end
 
       # Stop the container
+      #
+      # Sends a request to the LXC sub-system to take the container offline.
+      #
+      # @return [Boolean] True if successful.
       def down
         @ui.logger.debug { "Container Down: #{self.id} " }
 
+        (self.lxc.state == :not_created) and raise ContainerError, "We can not offline a non-existant container!"
+
         please_wait(:ui => @ui, :message => format_object_action(self, 'Down', :red)) do
           self.lxc.stop
+          self.lxc.wait(:stopped)
+
+          (self.lxc.state != :stopped) and raise ContainerError, "The container failed to offline!"
         end
+
+        true
       end
 
     end

data/lib/testlab/container/class_methods.rb

@@ -3,11 +3,17 @@ class TestLab
 
     module ClassMethods
 
+      # Container domain list
+      #
+      # Returns an array of strings containing all the unique domains defined
+      # across all containers
+      #
+      # @return [Array<String>] A unique array of all defined domain names.
       def domains
         self.all.map do |container|
           container.domain ||= container.node.labfile.config[:domain]
           container.domain
-        end.compact
+        end.compact.uniq
       end
 
     end

data/lib/testlab/container/generators.rb

@@ -3,6 +3,12 @@ class TestLab
 
     module Generators
 
+      # Generate IP address
+      #
+      # Generates an RFC compliant private IP address.
+      #
+      # @return [String] A random, private IP address in the 192.168.0.1/24
+      #   range.
       def generate_ip
         octets = [ 192..192,
                    168..168,
@@ -15,6 +21,11 @@ class TestLab
         ip.join(".")
       end
 
+      # Generate MAC address
+      #
+      # Generates an RFC compliant private MAC address.
+      #
+      # @return [String] A random, private MAC address.
       def generate_mac
         digits = [ %w(0),
                    %w(0),

data/lib/testlab/container/interface.rb

@@ -3,24 +3,17 @@ class TestLab
 
     module Interface
 
-      # Returns the IP of the container
-      def ip
-        TestLab::Utility.ip(self.primary_interface.last[:ip])
-      end
-
-      # Returns the CIDR of the container
-      def cidr
-        TestLab::Utility.cidr(self.primary_interface.last[:ip]).to_i
-      end
-
-      # Returns a BIND PTR record
-      def ptr
-        TestLab::Utility.ptr(self.primary_interface.last[:ip])
-      end
-
+      # Container primary interface
+      #
+      # Returns the primary interface for the container.  If the container has
+      # multiple interfaces, this is based on which ever interface is marked
+      # with the primary flag.  If the container only has one interface, then
+      # it is returned.
+      #
+      # @return [TestLab::Interface] The primary interface for the container.
       def primary_interface
-        if self.interfaces.any?{ |i,c| c[:primary] == true }
-          self.interfaces.find{ |i,c| c[:primary] == true }
+        if self.interfaces.any?{ |i| i.primary == true }
+          self.interfaces.find{ |i| i.primary == true }
         else
           self.interfaces.first
         end

data/lib/testlab/container/lifecycle.rb

@@ -3,7 +3,13 @@ class TestLab
 
     module Lifecycle
 
-      # Container Setup
+      # Setup the container
+      #
+      # Attempts to setup the container.  We first create the container, then
+      # attempt to bring it online.  Afterwards the containers provisioner is
+      # called.
+      #
+      # @return [Boolean] True if successful.
       def setup
         @ui.logger.debug { "Container Setup: #{self.id} " }
 
@@ -19,7 +25,13 @@ class TestLab
         true
       end
 
-      # Container Teardown
+      # Teardown the container
+      #
+      # Attempts to teardown the container.  We first call the provisioner
+      # teardown method defined for the container, if any.  Next we attempt to
+      # offline the container.  Afterwards the container is destroy.
+      #
+      # @return [Boolean] True if successful.
       def teardown
         @ui.logger.debug { "Container Teardown: #{self.id} " }
 

data/lib/testlab/container/lxc.rb

@@ -3,7 +3,9 @@ class TestLab
 
     module LXC
 
-      # Our LXC Container class
+      # LXC::Container object
+      #
+      # Returns a *LXC::Container* class instance configured for this container.
       #
       # @return [LXC] An instance of LXC::Container configured for this
       #   container.
@@ -11,12 +13,19 @@ class TestLab
         @lxc ||= self.node.lxc.container(self.id)
       end
 
-      # SSH to the container
+      # ZTK:SSH object
+      #
+      # Returns a *ZTK:SSH* class instance configured for this container.
+      #
+      # @return [ZTK::SSH] An instance of ZTK::SSH configured for this
+      #   container.
       def ssh(options={})
         self.node.container_ssh(self, options)
       end
 
       # Does the container exist?
+      #
+      # @return [Boolean] True if the containers exists, false otherwise.
       def exists?
         @ui.logger.debug { "Container Exists?: #{self.id} " }
 
@@ -25,7 +34,7 @@ class TestLab
 
       # Returns arguments for lxc-create based on our distro
       #
-      # @return [Array] An array of arguments for lxc-create
+      # @return [Array<String>] An array of arguments for lxc-create
       def create_args
         case self.distro.downcase
         when "ubuntu" then
@@ -49,21 +58,26 @@ class TestLab
         end
       end
 
+      # LXC Network Configuration
+      #
       # Builds an array of hashes containing the lxc configuration options for
-      # our networks
+      # our network interfaces.
+      #
+      # @return [Array<Hash>] An array of hashes defining the containers
+      #   interfaces for use in configuring LXC.
       def build_lxc_network_conf(interfaces)
         networks = Array.new
 
-        interfaces.each do |network, network_config|
+        interfaces.each do |interface|
           networks << Hash[
             'lxc.network.type'         => :veth,
             'lxc.network.flags'        => :up,
-            'lxc.network.link'         => TestLab::Network.first(network).bridge,
-            'lxc.network.name'         => network_config[:name],
-            'lxc.network.hwaddr'       => network_config[:mac],
-            'lxc.network.ipv4'         => network_config[:ip]
+            'lxc.network.link'         => interface.network.bridge,
+            'lxc.network.name'         => interface.name,
+            'lxc.network.hwaddr'       => interface.mac,
+            'lxc.network.ipv4'         => "#{interface.ip}/#{interface.cidr} #{interface.netmask}"
           ]
-          if (network_config[:primary] == true) || (interfaces.count == 1)
+          if (interface.primary == true) || (interfaces.count == 1)
             networks.last.merge!('lxc.network.ipv4.gateway' => :auto)
           end
         end

data/lib/testlab/container/method_missing.rb

@@ -3,7 +3,9 @@ class TestLab
 
     module MethodMissing
 
-      # Method missing handler
+      # Provisioner method handler
+      #
+      # Proxies missing methods to the containers defined provisioner, if any.
       def method_missing(method_name, *method_args)
         @ui.logger.debug { "CONTAINER METHOD MISSING: #{method_name.inspect}(#{method_args.inspect})" }
 

data/lib/testlab/container/status.rb

@@ -3,14 +3,54 @@ class TestLab
 
     module Status
 
+      # Container IP
+      #
+      # Returns the IP of the container.
+      #
+      # @return [String] The containers IP address.
+      def ip
+        TestLab::Utility.ip(self.primary_interface.address)
+      end
+
+      # Container CIDR
+      #
+      # Returns the CIDR of the container
+      #
+      # @return [Integer] The containers CIDR address.
+      def cidr
+        TestLab::Utility.cidr(self.primary_interface.address).to_i
+      end
+
+      # Container BIND PTR Record
+      #
+      # Returns a BIND reverse-DNS PTR record.
+      #
+      # @return [String] The containers ARPA PTR record.
+      def ptr
+        TestLab::Utility.ptr(self.primary_interface.address)
+      end
+
+      # Container FQDN
+      #
+      # Returns the FQDN for the container.
+      #
+      # @return [String] The containers FQDN.
       def fqdn
         self.domain ||= self.node.labfile.config[:domain]
 
         [self.id, self.domain].join('.')
       end
 
+      # Container Status
+      #
+      # Returns a hash of status information for the container.
+      #
+      # @return [Hash] A hash of status information for the container.
       def status
-        interfaces = self.interfaces.collect{ |network, network_config| "#{network}:#{network_config[:name]}:#{network_config[:ip]}" }.join(', ')
+        interfaces = self.interfaces.collect do |interface|
+          "#{interface.network_id}:#{interface.name}:#{interface.ip}/#{interface.cidr}"
+        end.join(', ')
+
         {
           :id => self.id,
           :fqdn => self.fqdn,
@@ -23,7 +63,11 @@ class TestLab
         }
       end
 
-      # State of the container
+      # Container State
+      #
+      # What state the container is in.
+      #
+      # @return [Symbol] A symbol indicating the state of the container.
       def state
         self.lxc.state
       end

data/lib/testlab/container.rb

@@ -5,8 +5,59 @@ class TestLab
 
   # Container Class
   #
+  # This class represents the TestLab Container DSL object.
+  #
+  # @example A simple container definition with a single interface:
+  #   container "server-west-1" do
+  #     domain        "west.zone"
+  #
+  #     distro        "ubuntu"
+  #     release       "precise"
+  #
+  #     interface do
+  #       network_id :west
+  #       name       :eth0
+  #       address    '10.11.0.254/16'
+  #       mac        '00:00:5e:48:e9:6f'
+  #     end
+  #   end
+  #
+  # @example Multiple interfaces can be defined as well:
+  #   container "dual-nic" do
+  #     distro        "ubuntu"
+  #     release       "precise"
+  #
+  #     interface do
+  #       network_id :east
+  #       name       :eth0
+  #       address    '10.10.0.200/16'
+  #       mac        '00:00:5e:63:b5:9f'
+  #     end
+  #
+  #     interface do
+  #       network_id :west
+  #       primary    true
+  #       name       :eth1
+  #       address    '10.11.0.200/16'
+  #       mac        '00:00:5e:08:63:df'
+  #     end
+  #   end
+  #
+  # The operating system is determined by the *distro* and *release* attributes.
+  # The hostname (container ID) is passed as a parameter to the container call.
+  # A *domain* may additionally be specified (overriding the global domain, if
+  # set).  If the *domain* attributes is omited, then the global domain is use,
+  # again only if it is set.  The hostname (container ID) and the domain will be
+  # joined together to form the FQDN of the container.
+  #
+  # @see TestLab::Interface
+  #
   # @author Zachary Patten <zachary@jovelabs.net>
   class Container < ZTK::DSL::Base
+
+    # An array of symbols of the various keys in our status hash.
+    #
+    # @see TestLab::Container::Status
     STATUS_KEYS   = %w(node_id id fqdn state distro release interfaces provisioner).map(&:to_sym)
 
     # Sub-Modules
@@ -33,6 +84,7 @@ class TestLab
 
     # Associations and Attributes
     belongs_to  :node,        :class_name => 'TestLab::Node'
+    has_many    :interfaces,  :class_name => 'TestLab::Interface'
 
     attribute   :provisioner
     attribute   :config
@@ -43,8 +95,6 @@ class TestLab
     attribute   :passwd
     attribute   :keys
 
-    attribute   :interfaces
-
     attribute   :distro
     attribute   :release
     attribute   :arch

data/lib/testlab/interface.rb

@@ -0,0 +1,45 @@
+class TestLab
+
+  # Interface Error Class
+  class InterfaceError < TestLabError; end
+
+  # Interface Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class Interface < ZTK::DSL::Base
+
+    # Associations and Attributes
+    belongs_to  :container, :class_name => 'TestLab::Container'
+    belongs_to  :network, :class_name => 'TestLab::Network'
+
+    attribute   :address
+    attribute   :mac
+    attribute   :name
+
+    attribute   :primary
+
+    def initialize(*args)
+      super(*args)
+
+      @ui = TestLab.ui
+    end
+
+    def ip
+      TestLab::Utility.ip(self.address)
+    end
+
+    def cidr
+      TestLab::Utility.cidr(self.address)
+    end
+
+    def netmask
+      TestLab::Utility.netmask(self.address)
+    end
+
+    def ptr
+      TestLab::Utility.ptr(self.address)
+    end
+
+  end
+
+end

data/lib/testlab/monkeys.rb

@@ -0,0 +1,4 @@
+# Monkey Patch the String class so we can have some easy ANSI methods
+class String
+  include ZTK::ANSI
+end

data/lib/testlab/network/actions.rb

@@ -26,7 +26,7 @@ class TestLab
         @ui.logger.debug { "Network Up: #{self.id} " }
 
         please_wait(:ui => @ui, :message => format_object_action(self, 'Up', :green)) do
-          self.node.ssh.exec(%(sudo ifconfig #{self.bridge} #{self.ip} up), :silence => true, :ignore_exit_status => true)
+          self.node.ssh.exec(%(sudo ifconfig #{self.bridge} #{self.ip} netmask #{self.netmask} up), :silence => true, :ignore_exit_status => true)
         end
       end
 

data/lib/testlab/network/bind.rb

@@ -5,12 +5,12 @@ class TestLab
 
       # BIND PTR Record
       def ptr
-        TestLab::Utility.ptr(self.ip)
+        TestLab::Utility.ptr(self.address)
       end
 
       # Returns the ARPA network
       def arpa
-        TestLab::Utility.arpa(self.ip)
+        TestLab::Utility.arpa(self.address)
       end
 
     end

data/lib/testlab/network/class_methods.rb

@@ -4,7 +4,7 @@ class TestLab
     module ClassMethods
 
       def ips
-        self.all.map(&:ip).collect{ |ip| TestLab::Utility.ip(ip) }.compact
+        self.all.map(&:address).collect{ |address| TestLab::Utility.ip(address) }.compact
       end
 
     end

data/lib/testlab/network/status.rb

@@ -5,7 +5,7 @@ class TestLab
 
       # Network status
       def status
-        interface = "#{bridge}:#{ip}"
+        interface = "#{bridge}:#{self.address}"
         {
           :id => self.id,
           :node_id => self.node.id,
@@ -17,19 +17,27 @@ class TestLab
         }
       end
 
+      def ip
+        TestLab::Utility.ip(self.address)
+      end
+
+      def cidr
+        TestLab::Utility.cidr(self.address)
+      end
+
       # Returns the network mask
       def netmask
-        TestLab::Utility.netmask(self.ip)
+        TestLab::Utility.netmask(self.address)
       end
 
       # Returns the network address
       def network
-        TestLab::Utility.network(self.ip)
+        TestLab::Utility.network(self.address)
       end
 
       # Returns the broadcast address
       def broadcast
-        TestLab::Utility.broadcast(self.ip)
+        TestLab::Utility.broadcast(self.address)
       end
 
       # Network Bridge State

data/lib/testlab/network.rb

@@ -27,10 +27,11 @@ class TestLab
 
     # Associations and Attributes
     belongs_to  :node,        :class_name => 'TestLab::Node'
+    has_many    :interfaces,  :class_name => 'TestLab::Interface'
 
+    attribute   :address
     attribute   :bridge
 
-    attribute   :ip
     attribute   :config