testlab 0.2.1 → 0.3.0

data/lib/testlab/node/actions.rb

@@ -0,0 +1,45 @@
+class TestLab
+  class Node
+
+    module Actions
+
+      # Create the node
+      def create
+        @ui.logger.debug { "Node Create: #{self.id} " }
+
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Create', :green)) do
+          @provider.create
+        end
+      end
+
+      # Destroy the node
+      def destroy
+        @ui.logger.debug { "Node Destroy: #{self.id} " }
+
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Destroy', :red)) do
+          @provider.destroy
+        end
+      end
+
+      # Start the node
+      def up
+        @ui.logger.debug { "Node Up: #{self.id} " }
+
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Up', :green)) do
+          @provider.up
+        end
+      end
+
+      # Stop the node
+      def down
+        @ui.logger.debug { "Node Down: #{self.id} " }
+
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Down', :red)) do
+          @provider.down
+        end
+      end
+
+    end
+
+  end
+end

data/lib/testlab/node/bind.rb

@@ -17,14 +17,16 @@ class TestLab
         reverse_records = Hash.new
 
         TestLab::Container.all.each do |container|
-          interface          = container.primary_interface
           container.domain ||= container.node.labfile.config[:domain]
 
-          forward_records[container.domain] ||= Array.new
-          forward_records[container.domain] << %(#{container.id} IN A #{container.ip})
+          container.interfaces.each do |interface|
+            forward_records[container.domain] ||= Array.new
+            forward_records[container.domain] << %(#{container.id} IN A #{interface.ip})
+
+            reverse_records[interface.network_id] ||= Array.new
+            reverse_records[interface.network_id] << %(#{interface.ptr} IN PTR #{container.fqdn}.)
+          end
 
-          reverse_records[interface.first] ||= Array.new
-          reverse_records[interface.first] << %(#{container.ptr} IN PTR #{container.id}.#{container.domain}.)
         end
         { :forward => forward_records, :reverse => reverse_records }
       end

data/lib/testlab/node/lifecycle.rb

@@ -14,8 +14,6 @@ class TestLab
       # Calls the specified method on all the objects supplied
       def call_methods(objects, method_name)
         objects.each do |object|
-          # @ui.stdout.puts(format_message(format_object(object, (method_name == :setup ? :green : :red))))
-
           if object.respond_to?(method_name)
             object.send(method_name)
           end
@@ -31,7 +29,7 @@ class TestLab
       def route_setup(action)
         self.networks.each do |network|
           command = ZTK::Command.new(:silence => true, :ignore_exit_status => true)
-          command.exec(%(sudo route #{action} -net #{TestLab::Utility.network(network.ip)} netmask #{TestLab::Utility.netmask(network.ip)} gw #{network.node.ip}))
+          command.exec(%(sudo route #{action} -net #{TestLab::Utility.network(network.address)} netmask #{TestLab::Utility.netmask(network.address)} gw #{network.node.ip}))
         end
       end
 
@@ -56,7 +54,7 @@ class TestLab
           end
         end
 
-        call_collections([self.networks, self.routers, self.containers], :setup)
+        call_collections([self.networks, self.containers], :setup)
 
         if self.components.include?('bind')
           bind_reload
@@ -69,7 +67,7 @@ class TestLab
       def teardown
         @ui.logger.debug { "Node Teardown: #{self.id} " }
 
-        call_collections([self.containers, self.routers, self.networks], :teardown)
+        call_collections([self.containers, self.networks], :teardown)
 
         please_wait(:ui => @ui, :message => format_object_action(self, 'Teardown', :red)) do
 

data/lib/testlab/node/status.rb

@@ -16,8 +16,7 @@ class TestLab
           :port => @provider.port,
           :provider => @provider.class,
           :con => self.containers.count,
-          :net => self.networks.count,
-          :rtr => self.routers.count
+          :net => self.networks.count
         }
       end
 

data/lib/testlab/node.rb

@@ -7,7 +7,7 @@ class TestLab
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class Node < ZTK::DSL::Base
-    STATUS_KEYS   = %w(id instance_id state user ip port provider con net rtr).map(&:to_sym)
+    STATUS_KEYS   = %w(id instance_id state user ip port provider con net).map(&:to_sym)
 
     # Sub-Modules
     autoload :Actions,       'testlab/node/actions'
@@ -36,7 +36,6 @@ class TestLab
     # Associations and Attributes
     belongs_to :labfile,    :class_name => 'TestLab::Lab'
 
-    has_many   :routers,    :class_name => 'TestLab::Router'
     has_many   :containers, :class_name => 'TestLab::Container'
     has_many   :networks,   :class_name => 'TestLab::Network'
 

data/lib/testlab/providers/vagrant.rb

@@ -171,7 +171,7 @@ class TestLab
       def vagrant_cli(*args)
         @ui.logger.debug { "args == #{args.inspect}" }
 
-        command = TestLab.build_command("vagrant", *args)
+        command = TestLab.build_command_line("vagrant", *args)
         @ui.logger.debug { "command == #{command.inspect}" }
 
         ZTK::Command.new(:ui => @ui).exec(command, :silence => true)

data/lib/testlab/provisioners/shell.rb

@@ -20,11 +20,15 @@ class TestLab
 
       def setup(container)
         if !@config[:setup].nil?
-          tempfile = Tempfile.new("bootstrap")
-          container.node.ssh.file(:target => File.join(container.lxc.fs_root, tempfile.path), :chmod => '0777', :chown => 'root:root') do |file|
-            file.puts(@config[:setup])
+          ZTK::RescueRetry.try(:tries => 2, :on => ShellError) do
+            tempfile = Tempfile.new("bootstrap")
+            container.node.ssh.file(:target => File.join(container.lxc.fs_root, tempfile.path), :chmod => '0777', :chown => 'root:root') do |file|
+              file.puts(@config[:setup])
+            end
+            if container.lxc.attach(@config[:shell], tempfile.path) =~ /No such file or directory/
+              raise ShellError, "We could not find the bootstrap file!"
+            end
           end
-          container.lxc.attach(@config[:shell], tempfile.path)
         end
       end
 

data/lib/testlab/utility/misc.rb

@@ -0,0 +1,49 @@
+class TestLab
+  module Utility
+
+    # Misc Error Class
+    class MiscError < UtilityError; end
+
+    # Misc Module
+    #
+    # @author Zachary Patten <zachary@jovelabs.net>
+    module Misc
+
+      def format_object(object, color)
+        klass = object.class.to_s.split('::').last
+
+        ["#{klass}:".upcase.send(color).bold, "#{object.id}".white.bold].join(' ')
+      end
+
+      def format_object_action(object, action, color)
+        klass = object.class.to_s.split('::').last
+
+        ["#{klass}".downcase.send(color).bold, "#{object.id}".white.bold, "#{action}".downcase.send(color).bold, ].join(' ')
+      end
+
+      def format_message(message)
+        "[".blue + "TL".blue.bold + "]".blue + " " + message
+      end
+
+      def please_wait(options={}, &block)
+        ui      = options[:ui]
+        message = options[:message]
+        mark    = (options[:mark] || "# Completed in %0.4f seconds!".black.bold)
+
+        !block_given? and raise MiscError, "You must supply a block!"
+        ui.nil? and raise MiscError, "You must supply a ZTK::UI object!"
+        message.nil? and raise MiscError, "You must supply a message!"
+
+        message = format_message(message)
+        length = message.uncolor.length
+        mark = ((' ' * (60 - length)) + mark)
+
+        ZTK::Benchmark.bench(:ui => ui, :message => message, :mark => mark) do
+          yield
+        end
+      end
+
+    end
+
+  end
+end

data/lib/testlab/version.rb

@@ -1,6 +1,6 @@
 class TestLab
   unless const_defined?(:VERSION)
     # TestLab Gem Version
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/testlab.rb

@@ -1,13 +1,9 @@
 require 'ztk'
 
 require 'testlab/version'
+require 'testlab/monkeys'
 
-# Monkey Patch the String class so we can have some easy ANSI methods
-class String
-  include ZTK::ANSI
-end
-
-# Top-Level LXC Class
+# Top-Level TestLab Class
 #
 # @author Zachary Patten <zachary@jovelabs.net>
 class TestLab
@@ -17,99 +13,160 @@ class TestLab
 
   # Main Classes
   autoload :Container,   'testlab/container'
+  autoload :Interface,   'testlab/interface'
   autoload :Labfile,     'testlab/labfile'
   autoload :Network,     'testlab/network'
   autoload :Node,        'testlab/node'
   autoload :Provider,    'testlab/provider'
   autoload :Provisioner, 'testlab/provisioner'
-  autoload :Router,      'testlab/router'
   autoload :Utility,     'testlab/utility'
 
   include TestLab::Utility::Misc
 
-  @@ui ||= nil
-
   def initialize(options={})
     labfile      = (options[:labfile] || 'Labfile')
     labfile_path = ZTK::Locator.find(labfile)
 
-    @@ui         = (options[:ui] || ZTK::UI.new)
+    self.ui      = (options[:ui] || ZTK::UI.new)
 
     @labfile     = TestLab::Labfile.load(labfile_path)
   end
 
+  # Test Lab Nodes
+  #
+  # Returns an array of our defined nodes.
+  #
+  # @return [Array<TestLab::Node>] An array of all defined nodes.
   def nodes
     TestLab::Node.all
   end
 
+  # Test Lab Containers
+  #
+  # Returns an array of our defined containers.
+  #
+  # @return [Array<TestLab::Container>] An array of all defined containers.
   def containers
     TestLab::Container.all
   end
 
-  def routers
-    TestLab::Router.all
-  end
-
+  # Test Lab Networks
+  #
+  # Returns an array of our defined networks.
+  #
+  # @return [Array<TestLab::Network>] An array of all defined networks.
   def networks
     TestLab::Network.all
   end
 
-  # def config
-  #   @labfile.config
-  # end
+  # Test Lab Configuration
+  #
+  # The hash defined in our *Labfile* DSL object which represents any high-level
+  # lab configuration options.
+  #
+  # @return [Hash] A hash representing the labs configuration options.
+  def config
+    @labfile.config
+  end
 
+  # Test Lab Alive?
+  #
+  # Are all of our nodes alive; that is up and running?
+  #
+  # @return [Boolean] True is all nodes are running; false otherwise.
   def alive?
     nodes.map(&:state).all?{ |state| state == :running }
   end
 
+  # Test Lab Dead?
+  #
+  # Are any of our nodes dead; that is not up and running?
+  #
+  # @return [Boolean] False is all nodes are running; true otherwise.
   def dead?
     !alive?
   end
 
+  # Test Lab Status
+  #
+  # Iterates our various DSL objects and calls their status methods pushing
+  # the results through ZTK::Report to generate nice tabled output for us
+  # indicating the state of the lab.
+  #
+  # This can only be run if the lab is alive.
+  #
+  # @return [Boolean] True if successful; false otherwise.
   def status
     if alive?
       %w(nodes networks containers).map(&:to_sym).each do |object_symbol|
-        @@ui.stdout.puts
-        @@ui.stdout.puts("#{object_symbol}:".upcase.green.bold)
+        self.ui.stdout.puts
+        self.ui.stdout.puts("#{object_symbol}:".upcase.green.bold)
 
         klass = object_symbol.to_s.singularize.capitalize
         status_keys = "TestLab::#{klass}::STATUS_KEYS".constantize
 
-        ZTK::Report.new(:ui => @@ui).list(self.send(object_symbol), status_keys) do |object|
+        ZTK::Report.new(:ui => self.ui).spreadsheet(self.send(object_symbol), status_keys) do |object|
           OpenStruct.new(object.status)
         end
       end
 
       true
     else
-      @@ui.stdout.puts("Looks like your test lab is dead; fix this and try again.")
+      self.ui.stdout.puts("Looks like your test lab is dead; fix this and try again.")
 
       false
     end
   end
 
+  # Test Lab Setup
+  #
+  # Attempts to setup our lab topology.  This calls the setup method on all of
+  # our nodes.
+  #
+  # @return [Boolean] True if successful.
   def setup
     self.dead? and raise TestLabError, "You must have a running node in order to setup your infrastructure!"
 
     node_method_proxy(:setup)
+
+    true
   end
 
+  # Test Lab Teardown
+  #
+  # Attempts to tearddown our lab topology.  This calls the teardown method on
+  # all of our nodes.
+  #
+  # @return [Boolean] True if successful.
   def teardown
     self.dead? and raise TestLabError, "You must have a running node in order to teardown your infrastructure!"
 
     node_method_proxy(:teardown)
+
+    true
   end
 
-  # Proxy various method calls to our subordinate classes
+  # Node Method Proxy
+  #
+  # Iterates all of the lab nodes, sending the supplied method name and arguments
+  # to each node.
+  #
+  # @return [Boolean] True if successful.
   def node_method_proxy(method_name, *method_args)
-    TestLab::Node.all.map do |node|
+    nodes.map do |node|
       node.send(method_name.to_sym, *method_args)
     end
+
+    true
   end
 
-  # Method missing handler
+  # Provider Method Handler
+  #
+  # Proxies missing provider method calls to all nodes.
+  #
+  # @see TestLab::Provider::PROXY_METHODS
   def method_missing(method_name, *method_args)
-    @@ui.logger.debug { "TESTLAB METHOD MISSING: #{method_name.inspect}(#{method_args.inspect})" }
+    self.ui.logger.debug { "TESTLAB METHOD MISSING: #{method_name.inspect}(#{method_args.inspect})" }
 
     if TestLab::Provider::PROXY_METHODS.include?(method_name) # || %w(setup teardown).map(&:to_sym).include?(method_name))
       node_method_proxy(method_name, *method_args)
@@ -118,27 +175,62 @@ class TestLab
     end
   end
 
-  def ui
-    @@ui ||= ZTK::UI.new
-  end
+  # Test Lab Class Methods
+  #
+  # These are special methods that we both include and extend on the parent
+  # class.
+  module ClassMethods
 
-  # Class Helpers
-  class << self
+    @@ui ||= nil
 
+    # Get Test Lab User Interface
+    #
+    # Returns the instance of ZTK:UI the lab is using for its user interface.
+    #
+    # @return [ZTK::UI] Our user interface instance of ZTK::UI.
     def ui
       @@ui ||= ZTK::UI.new
     end
 
+    # Set Test Lab User Interface
+    #
+    # Sets the instance of ZTK::UI the lab will use for its user interface.
+    #
+    # @param [ZTK:UI] value The instance of ZTK::UI to use for the labs user
+    #   interface.
+    #
+    # @return [ZTK::UI]
+    def ui=(value)
+      @@ui = value
+      value
+    end
+
+    # Test Lab Gem Directory
+    #
+    # Returns the directory path to where the gem is installed.
+    #
+    # @return [String] The directory path to the gem installation.
     def gem_dir
       directory = File.join(File.dirname(__FILE__), "..")
       File.expand_path(directory, File.dirname(__FILE__))
     end
 
-    def build_command(name, *args)
+    # Build Command Line
+    #
+    # Attempts to build a command line to a binary for us.  We use ZTK::Locator
+    # to attempt to determine if we are using bundler binstubs; otherwise we
+    # simply rely on */bin/env* to find the executable for us via the
+    # *PATH* environment variable.
+    #
+    # @return [String] Constructed command line with arguments.
+    def build_command_line(name, *args)
       executable = (ZTK::Locator.find('bin', name) rescue "/bin/env #{name}")
       [executable, args].flatten.compact.join(' ')
     end
 
   end
 
+  include TestLab::ClassMethods
+  extend  TestLab::ClassMethods
+
 end

data/spec/support/Labfile

@@ -8,7 +8,7 @@ node :localhost do
   config      Hash[
     :vagrant => {
       :id       => "mytestlab-#{ENV['USER']}".downcase,
-      :ip       => "192.168.33.10",
+      :ip       => "192.168.255.1",
       :user     => "vagrant",
       :port     => 22,
       :cpus     => 1,
@@ -18,20 +18,19 @@ node :localhost do
   ]
 
   network :testnet do
-    ip          "192.168.255.254/16"
-    bridge      :br0
+    address '192.168.255.254/16'
+    bridge  :br0
   end
 
   container "server-1" do
     distro        "ubuntu"
     release       "lucid"
 
-    interfaces Hash[
-      :testnet => {
-        :ip => "192.168.0.254/16",
-        :name => :eth0
-      }
-    ]
+    interface do
+      name       :eth0
+      network_id :testnet
+      address    '192.168.0.254/16'
+    end
   end
 
 end

data/testlab.gemspec

@@ -46,4 +46,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("redcarpet")
   spec.add_development_dependency("rspec")
   spec.add_development_dependency("yard")
+  spec.add_development_dependency("coveralls")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testlab
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -155,6 +155,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A framework for building lightweight virtual infrastructure using LXC
 email:
 - zachary@jovelabs.com
@@ -184,7 +200,9 @@ files:
 - lib/testlab/container/lxc.rb
 - lib/testlab/container/method_missing.rb
 - lib/testlab/container/status.rb
+- lib/testlab/interface.rb
 - lib/testlab/labfile.rb
+- lib/testlab/monkeys.rb
 - lib/testlab/network.rb
 - lib/testlab/network/actions.rb
 - lib/testlab/network/bind.rb
@@ -192,6 +210,7 @@ files:
 - lib/testlab/network/lifecycle.rb
 - lib/testlab/network/status.rb
 - lib/testlab/node.rb
+- lib/testlab/node/actions.rb
 - lib/testlab/node/bind.rb
 - lib/testlab/node/class_methods.rb
 - lib/testlab/node/lifecycle.rb
@@ -214,9 +233,9 @@ files:
 - lib/testlab/provisioners/chef.rb
 - lib/testlab/provisioners/shell.rb
 - lib/testlab/provisioners/templates/chef/bootstrap.erb
-- lib/testlab/router.rb
 - lib/testlab/utility.rb
 - lib/testlab/utility/cidr.rb
+- lib/testlab/utility/misc.rb
 - lib/testlab/version.rb
 - spec/provider_spec.rb
 - spec/provisioner_spec.rb
@@ -239,7 +258,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -56474438421071425
+      hash: 1288569389927238950
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -248,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -56474438421071425
+      hash: 1288569389927238950
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/lib/testlab/router.rb

@@ -1,66 +0,0 @@
-class TestLab
-
-  # Router Error Class
-  class RouterError < TestLabError; end
-
-  # Router Class
-  #
-  # @author Zachary Patten <zachary@jovelabs.net>
-  class Router < ZTK::DSL::Base
-    belongs_to  :node,        :class_name => 'TestNode::Node'
-
-    attribute   :interfaces
-
-    def initialize(*args)
-      super(*args)
-
-      @ui = TestLab.ui
-    end
-
-    # Create the router
-    def create
-      @ui.logger.debug { "Router Create: #{self.id} " }
-    end
-
-    # Destroy the router
-    def destroy
-      @ui.logger.debug { "Router Destroy: #{self.id} " }
-    end
-
-    # Start the router
-    def up
-      @ui.logger.debug { "Router Up: #{self.id} " }
-    end
-
-    # Stop the router
-    def down
-      @ui.logger.debug { "Router Down: #{self.id} " }
-    end
-
-    # State of the router
-    def state
-    end
-
-    # Router Callback: after_up
-    def setup
-      @ui.logger.debug { "Router Callback: After Up: #{self.id} " }
-      self.create
-      self.up
-    end
-
-    # Router Callback: before_down
-    def teardown
-      @ui.logger.debug { "Router Callback: Before Down: #{self.id} " }
-      self.down
-      self.destroy
-    end
-
-    # Method missing handler
-    def method_missing(method_name, *method_args)
-      @ui.logger.debug { "ROUTER METHOD MISSING: #{method_name.inspect}(#{method_args.inspect})" }
-      super(method_name, *method_args)
-    end
-
-  end
-
-end