testlab 0.7.6 → 0.8.0

data/lib/testlab/container/lifecycle.rb

@@ -13,6 +13,9 @@ class TestLab
       def setup
         @ui.logger.debug { "Container Setup: #{self.id} " }
 
+        (self.node.state != :running) and return false
+        (self.lxc.state == :not_created) and return false
+
         please_wait(:ui => @ui, :message => format_object_action(self, 'Setup', :green)) do
 
           self.container_provisioners.each do |provisioner|
@@ -36,6 +39,7 @@ class TestLab
       def teardown
         @ui.logger.debug { "Container Teardown: #{self.id} " }
 
+        (self.node.state != :running) and return false
         (self.lxc.state == :not_created) and return false
 
         please_wait(:ui => @ui, :message => format_object_action(self, 'Teardown', :red)) do
@@ -60,6 +64,15 @@ class TestLab
         true
       end
 
+      # Demolish the container
+      def demolish
+        self.teardown
+        self.down
+        self.destroy
+
+        true
+      end
+
       # Returns all defined provisioners for this container's networks and the container iteself.
       def container_provisioners
         [self.interfaces.map(&:network).map(&:provisioners), self.provisioners].flatten.compact.uniq

data/lib/testlab/container/ssh.rb

@@ -20,14 +20,14 @@ class TestLab
         identities = [self.users.map(&:identity), self.node.identity].flatten.compact.uniq
 
         output = <<-EOF
-#{ZTK::Template.do_not_edit_notice(:message => %(TestLab "#{self.fqdn}" SSH Configuration))}
+#{ZTK::Template.do_not_edit_notice(:message => %(TestLab "#{self.id}" SSH Configuration))}
 Host #{self.id}
   HostName #{self.ip}
   Port 22
   UserKnownHostsFile /dev/null
   StrictHostKeyChecking no
   PasswordAuthentication no
-  ForwardAgent no
+  ForwardAgent yes
   IdentitiesOnly yes
 EOF
 

data/lib/testlab/container.rb

@@ -70,7 +70,7 @@ class TestLab
     # An array of symbols of the various keys in our status hash.
     #
     # @see TestLab::Container::Status
-    STATUS_KEYS   = %w(node_id id clone fqdn state distro release interfaces provisioners).map(&:to_sym)
+    STATUS_KEYS   = %w(id node_id clone fqdn state distro release interfaces provisioners).map(&:to_sym)
 
     # Sub-Modules
     autoload :Actions,       'testlab/container/actions'
@@ -124,6 +124,8 @@ class TestLab
       @ui          = TestLab.ui
 
       super(*args)
+
+      @ui.logger.info { "Container '#{self.id}' Loaded" }
     end
 
     def config_dir

data/lib/testlab/interface.rb

@@ -22,6 +22,8 @@ class TestLab
       @ui = TestLab.ui
 
       super(*args)
+
+      @ui.logger.info { "Interface '#{self.id}' Loaded" }
     end
 
     def ip

data/lib/testlab/network/actions.rb

@@ -7,7 +7,7 @@ class TestLab
       def create
         @ui.logger.debug { "Network Create: #{self.id} " }
 
-        (self.node.state == :not_created) and return false
+        (self.node.state != :running) and return false
         (self.state != :not_created) and return false
 
         please_wait(:ui => @ui, :message => format_object_action(self, 'Create', :green)) do
@@ -21,7 +21,7 @@ class TestLab
       def destroy
         @ui.logger.debug { "Network Destroy: #{self.id} " }
 
-        (self.node.state == :not_created) and return false
+        (self.node.state != :running) and return false
         (self.state == :not_created) and return false
 
         please_wait(:ui => @ui, :message => format_object_action(self, 'Destroy', :red)) do

data/lib/testlab/network/lifecycle.rb

@@ -7,6 +7,9 @@ class TestLab
       def setup
         @ui.logger.debug { "Network Setup: #{self.id} " }
 
+        (self.node.state != :running) and return false
+        (self.state == :not_created) and return false
+
         please_wait(:ui => @ui, :message => format_object_action(self, 'Setup', :green)) do
 
           self.network_provisioners.each do |provisioner|
@@ -24,6 +27,9 @@ class TestLab
       def teardown
         @ui.logger.debug { "Network Teardown: #{self.id} " }
 
+        (self.node.state != :running) and return false
+        (self.state == :not_created) and return false
+
         please_wait(:ui => @ui, :message => format_object_action(self, 'Teardown', :red)) do
 
           self.network_provisioners.each do |provisioner|
@@ -46,6 +52,15 @@ class TestLab
         true
       end
 
+      # Demolish the network
+      def demolish
+        self.teardown
+        self.down
+        self.destroy
+
+        true
+      end
+
       # Returns all defined provisioners for this network's containers and the network iteself.
       def network_provisioners
         [self.provisioners, self.interfaces.map(&:container).map(&:provisioners)].flatten.compact.uniq

data/lib/testlab/network/status.rb

@@ -48,7 +48,7 @@ class TestLab
           :not_created
         else
           output = self.node.ssh.exec(%(sudo ifconfig #{self.bridge} 2>&1 | grep 'MTU'), :silence => true, :ignore_exit_status => true).output.strip
-          if ((output =~ /UP/) && (output =~ /RUNNING/))
+          if ((output =~ /UP/) || (output =~ /RUNNING/))
             :running
           else
             :stopped

data/lib/testlab/network.rb

@@ -7,7 +7,7 @@ class TestLab
   #
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Network < ZTK::DSL::Base
-    STATUS_KEYS   = %w(node_id id state interface network netmask broadcast provisioners).map(&:to_sym)
+    STATUS_KEYS   = %w(id node_id state interface network netmask broadcast provisioners).map(&:to_sym)
 
     # Sub-Modules
     autoload :Actions,      'testlab/network/actions'
@@ -40,6 +40,8 @@ class TestLab
       @ui     = TestLab.ui
 
       super(*args)
+
+      @ui.logger.info { "Network '#{self.id}' Loaded" }
     end
 
   end

data/lib/testlab/node/lifecycle.rb

@@ -54,6 +54,15 @@ class TestLab
         true
       end
 
+      # Demolish the node
+      def demolish
+        self.teardown
+        self.down
+        self.destroy
+
+        true
+      end
+
       # Returns all defined provisioners for this node and it's networks and containers.
       def all_provisioners
         [self.provisioners, self.networks.map(&:provisioners), self.containers.map(&:provisioners)].flatten.compact.uniq

data/lib/testlab/node.rb

@@ -48,6 +48,8 @@ class TestLab
       @provider = self.provider.new(self.config, @ui)
 
       raise NodeError, "You must specify a provider class!" if self.provider.nil?
+
+      @ui.logger.info { "Node '#{self.id}' Loaded" }
     end
 
     def config_dir

data/lib/testlab/user.rb

@@ -30,6 +30,8 @@ class TestLab
       @ui = TestLab.ui
 
       super(*args)
+
+      @ui.logger.info { "User '#{self.id}' Loaded" }
     end
 
   end

data/lib/testlab/utility/gli.rb

@@ -0,0 +1,83 @@
+class TestLab
+  module Utility
+
+    # GLI Module
+    #
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    module GLI
+      require 'ztk'
+
+      LAB_ACTION_ORDER = %W(create destroy up down setup teardown build demolish).map(&:to_sym)
+
+      LAB_ACTIONS = {
+        :create   => ["Construct %s",    "Attempts to create the <%= @component %>."],
+        :destroy  => ["Destruct %s",     "Attempts to destroy the <%= @component %>."],
+        :up       => ["On-line %s",      "Attempts to online the <%= @component %>."],
+        :down     => ["Off-line %s",     "Attempts to offline the <%= @component %>."],
+        :setup    => ["Provision %s",    "Attempts to provision the <%= @component %>."],
+        :teardown => ["De-provision %s", "Attempts to deprovision the <%= @component %>."],
+        :build    => ["Build %s", <<-EOF],
+          Attempts to build the <%= @component %>.  TestLab will attempt to create, online and provision the <%= @component %>.
+
+          The <%= @component %> are taken through the following states:
+
+          Create -> Up -> Setup
+          EOF
+        :demolish => ["Demolish %s", <<-EOF]
+          Attempts to demolish the <%= @component %>.  TestLab will attempt to deprovision, offline and destroy the <%= @component %>.
+
+          The <%= @component %> are taken through the following states:
+
+          Teardown -> Down -> Destroy
+          EOF
+      }
+
+      def build_lab_commands(component, klass, &block)
+        desc %(Manage lab #{component}s)
+        command component do |c|
+          c.desc %(Optional #{component} ID or comma separated list of #{component} IDs)
+          c.arg_name %(#{component}[,#{component},...])
+          c.flag [:n, :name]
+
+          LAB_ACTION_ORDER.each do |lab_action|
+            action_desc = LAB_ACTIONS[lab_action]
+            c.desc(action_desc.first % "#{component}s")
+            c.long_desc(ZTK::Template.string(action_desc.last, {:component => "#{component}s"}))
+
+            c.command lab_action do |la|
+              la.action do |global_options, options, args|
+                iterate_objects_by_name(options[:name], klass) do |object|
+                  object.send(lab_action)
+                end
+              end
+            end
+          end
+
+          !block.nil? and block.call(c)
+        end
+      end
+
+      def iterate_objects_by_name(name, klass, &block)
+        objects = Array.new
+        klass_name = klass.to_s.split('::').last.downcase
+
+        if name.nil?
+          objects = klass.all
+        else
+          names = name.split(',')
+          objects = klass.find(names)
+        end
+
+        (objects.nil? || (objects.count == 0)) and raise TestLab::TestLabError, "We could not find any of the #{klass_name}s you supplied!"
+
+        objects.each do |object|
+          !block.nil? and block.call(object)
+        end
+
+        objects
+      end
+
+    end
+
+  end
+end

data/lib/testlab/utility/logger.rb

@@ -16,76 +16,81 @@ class TestLab
       end
 
       def log_page_break(max_key_length, char='-')
+        (max_key_length > 80) and (max_key_length = 80)
         (char * max_key_length)
       end
 
-      def log_details(testlab)
+      def log_config(testlab)
         {
-          "hostname" => "%s (%s)" % [Socket.gethostname.inspect, TestLab.hostname.inspect],
-          "program" => $0.to_s.inspect,
           "config_dir" => testlab.config_dir.inspect,
           "repo_dir" => testlab.repo_dir.inspect,
           "labfile_path" => testlab.labfile_path.inspect,
           "logdev" => testlab.ui.logger.logdev.inspect,
           "version" => TestLab::VERSION.inspect,
-          "argv" => ARGV.inspect
         }
       end
 
-      def log_ruby
+      def log_details(testlab)
+        {
+          "hostname" => "%s (%s)" % [Socket.gethostname.inspect, TestLab.hostname.inspect],
+          "program" => $0.to_s.inspect,
+          "argv" => ARGV.join(' ').inspect,
+          "timezone" => Time.now.zone.inspect
+        }
+      end
+
+      def log_ruby(testlab)
         dependencies = {
           "ruby_version" => RUBY_VERSION.inspect,
           "ruby_patchlevel" => RUBY_PATCHLEVEL.inspect,
           "ruby_platform" => RUBY_PLATFORM.inspect
         }
 
-        defined?(RUBY_ENGINE) and dependencies.merge!("ruby_engine" => RUBY_ENGINE)
+        defined?(RUBY_ENGINE)       and dependencies.merge!("ruby_engine" => RUBY_ENGINE)
+        defined?(RUBY_DESCRIPTION)  and dependencies.merge!("ruby_description" => RUBY_DESCRIPTION)
+        defined?(RUBY_RELEASE_DATE) and dependencies.merge!("ruby_release_date" => RUBY_RELEASE_DATE)
 
         dependencies
       end
 
-      def log_dependencies
-        @command = ZTK::Command.new(:silence => true, :ignore_exit_status => true)
-
+      def log_gem_dependencies(testlab)
         {
           "gli_version" => ::GLI::VERSION.inspect,
           "lxc_version" => ::LXC::VERSION.inspect,
           "ztk_version" => ::ZTK::VERSION.inspect,
-          "activesupport_version" => ::ActiveSupport::VERSION::STRING.inspect,
+          "activesupport_version" => ::ActiveSupport::VERSION::STRING.inspect
+        }
+      end
+
+      def log_external_dependencies(testlab)
+        @command = ZTK::Command.new(:silence => true, :ignore_exit_status => true)
+
+        {
           "vagrant_version" => @command.exec(%(/usr/bin/env vagrant --version)).output.strip.inspect,
-          "virtualbox_version" => @command.exec(%(/usr/bin/env vboxmanage --version)).output.strip.inspect
+          "virtualbox_version" => @command.exec(%(/usr/bin/env vboxmanage --version)).output.strip.inspect,
+          "lxc_version" => @command.exec(%(/usr/bin/env lxc-version)).output.strip.inspect
         }
       end
 
       def log_header(testlab)
         log_lines = Array.new
 
-        details_hash       = log_details(testlab)
-        ruby_hash          = log_ruby
-        dependencies_hash  = log_dependencies
+        log_methods = [:log_details, :log_config, :log_ruby, :log_gem_dependencies, :log_external_dependencies]
+        log_hashes = log_methods.collect{ |log_method| self.send(log_method, testlab) }
 
-        max_key_length = [details_hash.keys, ruby_hash.keys, dependencies_hash.keys].flatten.compact.map(&:length).max + 2
-        max_value_length = [details_hash.values, ruby_hash.values, dependencies_hash.values].flatten.compact.map(&:length).max + 2
+        max_key_length = log_hashes.collect{ |log_hash| log_hash.keys }.flatten.compact.map(&:length).max + 2
+        max_value_length = log_hashes.collect{ |log_hash| log_hash.values }.flatten.compact.map(&:length).max + 2
 
         max_length = (max_key_length + max_value_length + 2)
 
         log_lines << log_page_break(max_length, '=')
-        details_hash.sort.each do |key, value|
-          log_lines << log_key_value(key, value, max_key_length)
+        log_hashes.each do |log_hash|
+          log_hash.sort.each do |key, value|
+            log_lines << log_key_value(key, value, max_key_length)
+          end
+          log_lines << log_page_break(max_length, '=')
         end
 
-        log_lines << log_page_break(max_length)
-        ruby_hash.sort.each do |key, value|
-          log_lines << log_key_value(key, value, max_key_length)
-        end
-
-        log_lines << log_page_break(max_length)
-        dependencies_hash.sort.each do |key, value|
-          log_lines << log_key_value(key, value, max_key_length)
-        end
-
-        log_lines << log_page_break(max_length, '=')
-
         log_lines.flatten.compact
       end
 

data/lib/testlab/utility.rb

@@ -11,10 +11,12 @@ class TestLab
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   module Utility
     autoload :CIDR,   'testlab/utility/cidr'
+    autoload :GLI,    'testlab/utility/gli'
     autoload :Logger, 'testlab/utility/logger'
     autoload :Misc,   'testlab/utility/misc'
 
     extend TestLab::Utility::CIDR
+    extend TestLab::Utility::GLI
     extend TestLab::Utility::Logger
     extend TestLab::Utility::Misc
 

data/lib/testlab/version.rb

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

data/lib/testlab.rb

@@ -17,53 +17,85 @@ require 'testlab/monkeys'
 # to accomplish this.
 #
 # @example Sample Labfile:
-#   shell_provision_script = <<-EOF
-#   set -x
-#   apt-get -y update
-#   apt-get -y install dnsutils
-#   EOF
+#   node 'vagrant' do
 #
-#   config Hash[
-#     :domain => "default.zone",
-#     :repo => File.join(ENV['HOME'], "code", "personal", "testlab-repo")
-#   ]
-#
-#   node :localhost do
-#     components %w(resolv bind)
-#     route true
+#     provider      TestLab::Provider::Vagrant
+#     provisioners  [
+#       TestLab::Provisioner::Raring,
+#       TestLab::Provisioner::Bind
+#     ]
 #
-#     provider    TestLab::Provider::Vagrant
-#     config      Hash[
+#     config      ({
 #       :vagrant => {
-#         :id       => "mytestlab-#{ENV['USER']}".downcase,
-#         :ip       => "192.168.13.37",
-#         :user     => "vagrant",
-#         :port     => 22,
-#         :cpus     => 8,
-#         :memory   => 16384,
-#         :box      => 'raring64'
+#         :id       => "chef-rubygem-#{TestLab.hostname}".downcase,
+#         :cpus     => ZTK::Parallel::MAX_FORKS.div(2),                    # use half of the available processors
+#         :memory   => ZTK::Parallel::MAX_MEMORY.div(3).div(1024 * 1024),  # use a third of available RAM
+#         :box      => 'raring64',
+#         :box_url  => 'https://dl.dropboxusercontent.com/u/22904185/boxes/raring64.box',
+#         :file     => File.dirname(__FILE__)
+#       },
+#       :bind => {
+#         :domain => "default.zone"
 #       }
-#     ]
+#     })
 #
-#     network :east do
-#       address '10.10.0.1/16'
-#       bridge  :br0
+#     network 'labnet' do
+#       provisioners  [TestLab::Provisioner::Route]
+#       address       '10.10.0.1/16'
+#       bridge        :br0
 #     end
 #
-#     container "server-east-1" do
-#       domain        "east.zone"
+#     container "chef-server" do
+#       distro        "ubuntu"
+#       release       "precise"
+#
+#       provisioners   [
+#         TestLab::Provisioner::Resolv,
+#         TestLab::Provisioner::AptCacherNG,
+#         TestLab::Provisioner::Apt,
+#         TestLab::Provisioner::Chef::RubyGemServer
+#       ]
+#
+#       user 'deployer' do
+#         password         'deployer'
+#         identity         File.join(ENV['HOME'], '.ssh', 'id_rsa')
+#         public_identity  File.join(ENV['HOME'], '.ssh', 'id_rsa.pub')
+#         uid              2600
+#         gid              2600
+#       end
+#
+#       interface do
+#         network_id  'labnet'
+#         name        :eth0
+#         address     '10.10.0.254/16'
+#         mac         '00:00:5e:63:b5:9f'
+#       end
+#     end
 #
+#     container "chef-client" do
 #       distro        "ubuntu"
 #       release       "precise"
 #
-#       provisioner   TestLab::Provisioner::Shell
-#       config        Hash[:setup => shell_provision_script]
+#       provisioners  [
+#         TestLab::Provisioner::Resolv,
+#         TestLab::Provisioner::AptCacherNG,
+#         TestLab::Provisioner::Apt,
+#         TestLab::Provisioner::Chef::RubyGemClient
+#       ]
+#
+#       user 'deployer' do
+#         password         'deployer'
+#         identity         File.join(ENV['HOME'], '.ssh', 'id_rsa')
+#         public_identity  File.join(ENV['HOME'], '.ssh', 'id_rsa.pub')
+#         uid              2600
+#         gid              2600
+#       end
 #
 #       interface do
-#         name       :eth0
-#         network_id :east
-#         address    '10.10.0.254/16'
-#         mac        '00:00:5e:b7:e5:15'
+#         network_id  'labnet'
+#         name        :eth0
+#         address     '10.10.0.20/16'
+#         mac         '00:00:5e:b7:e5:15'
 #       end
 #     end
 #
@@ -78,8 +110,8 @@ require 'testlab/monkeys'
 # @example We can control things via code easily as well:
 #   testlab.create   # creates the lab
 #   testlab.up       # ensures the lab is up and running
-#   testlab.setup    # setup the lab, creating all networks and containers
-#   testlab.teardown # teardown the lab, destroy all networks and containers
+#   testlab.build    # build the lab, creating all networks and containers
+#   testlab.demolish # demolish the lab, destroy all networks and containers
 #
 # @author Zachary Patten <zachary AT jovelabs DOT com>
 class TestLab
@@ -115,11 +147,16 @@ class TestLab
 
     labfile_path     = (options[:labfile_path] || File.join(@repo_dir, 'Labfile'))
     @labfile_path    = File.expand_path(ZTK::Locator.find(labfile_path))
+  end
 
+  # Boot TestLab
+  #
+  # Change to the defined repository directory and load the *Labfile*.
+  #
+  # @return [Boolean] True if successful.
+  def boot
     @labfile         = TestLab::Labfile.load(labfile_path)
     @labfile.testlab = self
-
-    Dir.chdir(@repo_dir)
   end
 
   # Test Lab Nodes
@@ -186,6 +223,30 @@ class TestLab
     !alive?
   end
 
+  # Test Lab Create
+  #
+  # Attempts to create our lab topology.  This calls the create method on all of
+  # our nodes.
+  #
+  # @return [Boolean] True if successful.
+  def create
+    method_proxy(:create)
+
+    true
+  end
+
+  # Test Lab Destroy
+  #
+  # Attempts to destroy our lab topology.  This calls the destroy method on all of
+  # our nodes.
+  #
+  # @return [Boolean] True if successful.
+  def destroy
+    reverse_method_proxy(:destroy)
+
+    true
+  end
+
   # Test Lab Up
   #
   # Attempts to up our lab topology.  This calls the up method on all of
@@ -246,6 +307,18 @@ class TestLab
     true
   end
 
+  # Test Lab Demolish
+  #
+  # Attempts to demolish our lab topology.  This calls various methods on
+  # all of our nodes, networks and containers.
+  #
+  # @return [Boolean] True if successful.
+  def demolish
+    reverse_method_proxy(:demolish)
+
+    true
+  end
+
   # Node Method Proxy
   #
   # Iterates all of the lab nodes, sending the supplied method name and arguments

data/spec/container_spec.rb

@@ -195,6 +195,7 @@ describe TestLab::Container do
     describe "#setup" do
       context "with no provisioner" do
         it "should setup the container" do
+          subject.node.stub(:state) { :running }
           subject.lxc.stub(:exists?) { true }
           subject.lxc.stub(:state) { :stopped }
           subject.provisioners = Array.new
@@ -207,6 +208,7 @@ describe TestLab::Container do
         it "should setup the container" do
           subject = TestLab::Container.first('server-shell')
 
+          subject.node.stub(:state) { :running }
           subject.lxc.stub(:exists?) { true }
           subject.lxc.stub(:state) { :stopped }
           subject.provisioners = Array.new
@@ -219,6 +221,7 @@ describe TestLab::Container do
     describe "#teardown" do
       context "with no provisioner" do
         it "should teardown the container" do
+          subject.node.stub(:state) { :running }
           subject.lxc.stub(:exists?) { true }
           subject.lxc.stub(:state) { :stopped }
           subject.provisioners = Array.new
@@ -231,6 +234,7 @@ describe TestLab::Container do
         it "should teardown the container" do
           subject = TestLab::Container.first('server-shell')
 
+          subject.node.stub(:state) { :running }
           subject.lxc.stub(:exists?) { true }
           subject.lxc.stub(:state) { :stopped }
           subject.provisioners = Array.new

data/spec/network_spec.rb

@@ -144,6 +144,8 @@ describe TestLab::Network do
 
     describe "#setup" do
       it "should create and online the network" do
+        subject.node.stub(:state) { :running }
+        subject.stub(:state) { :running }
         subject.stub(:create) { true }
         subject.stub(:up) { true }
 
@@ -153,6 +155,8 @@ describe TestLab::Network do
 
     describe "#teardown" do
       it "should create and online the network" do
+        subject.node.stub(:state) { :running }
+        subject.stub(:state) { :running }
         subject.stub(:down) { true }
         subject.stub(:destroy) { true }