testlab 0.1.0 → 0.2.0

data/.gitignore

@@ -16,3 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 *log
+Vagrantfile
+testlab/

data/README.md

@@ -14,8 +14,16 @@ A framework for building lightweight virtual infrastructure using LXC
 * Latest Vagrant Package (non-gem version)
 * Ubuntu 13.04 Server 64-bit (Raring) Base Box - https://github.com/zpatten/raring64
 
+# EXAMPLE USE
+
+* See the `testlab-repo` - https://github.com/zpatten/testlab-repo
+
 # RESOURCES
 
+IRC:
+
+* #jovelabs on irc.freenode.net
+
 Documentation:
 
 * http://zpatten.github.io/testlab/

data/bin/tl

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'testlab'
+
+include GLI::App
+
+program_desc %(TestLab #{TestLab::VERSION} - A framework for building lightweight virtual infrastructure using LXC)
+
+version Testlab::VERSION
+
+# 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
+
+desc 'Create the test lab'
+command :create do |create|
+  create.action do |global_options,options,args|
+    @testlab.create
+  end
+end
+
+desc 'Destroy the test lab'
+command :destroy do |destroy|
+  destroy.action do |global_options,options,args|
+    @testlab.destroy
+  end
+end
+
+desc 'Online the test lab'
+command :up do |up|
+  up.action do |global_options,options,args|
+    @testlab.up
+  end
+end
+
+desc 'Offline the test lab'
+command :down do |down|
+  down.action do |global_options,options,args|
+    @testlab.down
+  end
+end
+
+desc 'Setup the test lab infrastructure'
+command :setup do |setup|
+  setup.action do |global_options,options,args|
+    @testlab.setup
+  end
+end
+
+desc 'Teardown the test lab infrastructure'
+command :teardown do |teardown|
+  teardown.action do |global_options,options,args|
+    @testlab.teardown
+  end
+end
+
+desc 'Display information on the status of the test lab'
+command :status do |status|
+  status.action do |global_options,options,args|
+    @testlab.status
+  end
+end
+
+desc 'Manage nodes'
+arg_name 'Describe arguments to node here'
+command :node do |c|
+
+  c.desc 'Node ID'
+  c.flag [:i, :id]
+
+  c.desc 'Open an SSH console to a node'
+  c.command :ssh do |ssh|
+    ssh.action do |global_options,options,args|
+      help_now!('id is required') if options[:id].nil?
+
+      node = @testlab.nodes.select{ |n| n.id.to_sym == options[:id].to_sym }.first
+      node.ssh.console
+    end
+  end
+
+end
+
+desc 'Manage networks'
+arg_name 'Describe arguments to network here'
+command :network do |c|
+  c.action do |global_options,options,args|
+    puts "network command ran"
+  end
+end
+
+desc 'Manage containers'
+arg_name 'Describe arguments to container here'
+command :container do |c|
+
+  c.desc 'Container ID'
+  c.flag [:i, :id]
+
+  c.desc 'Open an SSH console to a container'
+  c.command :ssh do |ssh|
+    ssh.action do |global_options,options,args|
+      help_now!('id is required') if options[:id].nil?
+
+      container = @testlab.containers.select{ |n| n.id.to_sym == options[:id].to_sym }.first
+      container.ssh.console
+    end
+  end
+
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+
+  log_file = File.join(Dir.pwd, "testlab.log")
+  @logger = ZTK::Logger.new(log_file)
+  @ui = ZTK::UI.new(:logger => @logger)
+  @testlab = TestLab.new(:ui => @ui)
+
+  message = TestLab::Utility.format_message("TestLab v#{TestLab::VERSION} Loaded".black.bold)
+  @testlab.ui.stdout.puts(message)
+
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  puts(["EXCEPTION:".red.bold, exception.inspect.red].join(' '))
+
+  false
+end
+
+exit run(ARGV)

data/lib/testlab/container/actions.rb

@@ -7,40 +7,48 @@ class TestLab
       def create
         @ui.logger.debug { "Container Create: #{self.id} " }
 
-        self.domain  ||= self.node.labfile.config[:domain]
-        self.distro  ||= "ubuntu"
-        self.release ||= "precise"
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Create', :green)) do
+          self.domain  ||= self.node.labfile.config[:domain]
+          self.distro  ||= "ubuntu"
+          self.release ||= "precise"
 
-        self.arch    ||= detect_arch
+          self.arch    ||= detect_arch
 
-        self.lxc.config.clear
-        self.lxc.config['lxc.utsname'] = self.id
-        self.lxc.config['lxc.arch'] = self.arch
-        self.lxc.config.networks = build_lxc_network_conf(self.interfaces)
-        self.lxc.config.save
+          self.lxc.config.clear
+          self.lxc.config['lxc.utsname'] = self.id
+          self.lxc.config['lxc.arch'] = self.arch
+          self.lxc.config.networks = build_lxc_network_conf(self.interfaces)
+          self.lxc.config.save
 
-        self.lxc.create(*create_args)
+          self.lxc.create(*create_args)
+        end
       end
 
       # Destroy the container
       def destroy
         @ui.logger.debug { "Container Destroy: #{self.id} " }
 
-        self.lxc.destroy
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Destroy', :red)) do
+          self.lxc.destroy
+        end
       end
 
       # Start the container
       def up
         @ui.logger.debug { "Container Up: #{self.id} " }
 
-        self.lxc.start
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Up', :green)) do
+          self.lxc.start
+        end
       end
 
       # Stop the container
       def down
         @ui.logger.debug { "Container Down: #{self.id} " }
 
-        self.lxc.stop
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Down', :red)) do
+          self.lxc.stop
+        end
       end
 
     end

data/lib/testlab/container/interface.rb

@@ -3,6 +3,7 @@ class TestLab
 
     module Interface
 
+      # Returns the IP of the container
       def ip
         TestLab::Utility.ip(self.primary_interface.last[:ip])
       end
@@ -12,21 +13,9 @@ class TestLab
         TestLab::Utility.cidr(self.primary_interface.last[:ip]).to_i
       end
 
+      # Returns a BIND PTR record
       def ptr
-        octets = self.ip.split('.')
-
-        result = case self.cidr
-        when 0..7 then
-          octets[-4,4]
-        when 8..15 then
-          octets[-3,3]
-        when 16..23 then
-          octets[-2,2]
-        when 24..31 then
-          octets[-1,1]
-        end
-
-        result.reverse.join('.')
+        TestLab::Utility.ptr(self.primary_interface.last[:ip])
       end
 
       def primary_interface

data/lib/testlab/container/lifecycle.rb

@@ -9,14 +9,30 @@ class TestLab
 
         self.create
         self.up
+
+        if (!@provisioner.nil? && @provisioner.respond_to?(:setup))
+          please_wait(:ui => @ui, :message => format_object_action(self, 'Setup', :green)) do
+            @provisioner.setup(self)
+          end
+        end
+
+        true
       end
 
       # Container Teardown
       def teardown
         @ui.logger.debug { "Container Teardown: #{self.id} " }
 
+        if (!@provisioner.nil? && @provisioner.respond_to?(:teardown))
+          please_wait(:ui => @ui, :message => format_object_action(self, 'Teardown', :red)) do
+            @provisioner.teardown(self)
+          end
+        end
+
         self.down
         self.destroy
+
+        true
       end
 
     end

data/lib/testlab/container.rb

@@ -29,6 +29,8 @@ class TestLab
 
     extend  TestLab::Container::ClassMethods
 
+    include TestLab::Utility::Misc
+
     # Associations and Attributes
     belongs_to  :node,        :class_name => 'TestLab::Node'
 
@@ -38,6 +40,7 @@ class TestLab
     attribute   :domain
 
     attribute   :user
+    attribute   :passwd
     attribute   :keys
 
     attribute   :interfaces
@@ -53,7 +56,7 @@ class TestLab
       super(*args)
 
       @ui          = TestLab.ui
-      @provisioner = self.provisioner.new(self.config) if !self.provisioner.nil?
+      @provisioner = self.provisioner.new(self.config, @ui) if !self.provisioner.nil?
     end
 
   end

data/lib/testlab/network/actions.rb

@@ -7,28 +7,36 @@ class TestLab
       def create
         @ui.logger.debug { "Network Create: #{self.id} " }
 
-        self.node.ssh.exec(%(sudo brctl addbr #{self.bridge}), :silence => true, :ignore_exit_status => true)
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Create', :green)) do
+          self.node.ssh.exec(%(sudo brctl addbr #{self.bridge}), :silence => true, :ignore_exit_status => true)
+        end
       end
 
       # Destroy the network
       def destroy
         @ui.logger.debug { "Network Destroy: #{self.id} " }
 
-        self.node.ssh.exec(%(sudo brctl delbr #{self.bridge}), :silence => true, :ignore_exit_status => true)
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Destroy', :red)) do
+          self.node.ssh.exec(%(sudo brctl delbr #{self.bridge}), :silence => true, :ignore_exit_status => true)
+        end
       end
 
       # Start the network
       def up
         @ui.logger.debug { "Network Up: #{self.id} " }
 
-        self.node.ssh.exec(%(sudo ifconfig #{self.bridge} #{self.ip} up), :silence => true, :ignore_exit_status => true)
+        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)
+        end
       end
 
       # Stop the network
       def down
         @ui.logger.debug { "Network Down: #{self.id} " }
 
-        self.node.ssh.exec(%(sudo ifconfig #{self.bridge} down), :silence => true, :ignore_exit_status => true)
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Down', :red)) do
+          self.node.ssh.exec(%(sudo ifconfig #{self.bridge} down), :silence => true, :ignore_exit_status => true)
+        end
       end
 
     end

data/lib/testlab/network.rb

@@ -23,6 +23,8 @@ class TestLab
 
     extend  TestLab::Network::ClassMethods
 
+    include TestLab::Utility::Misc
+
     # Associations and Attributes
     belongs_to  :node,        :class_name => 'TestLab::Node'
 
@@ -35,7 +37,7 @@ class TestLab
     def initialize(*args)
       super(*args)
 
-      @ui = TestLab.ui
+      @ui     = TestLab.ui
     end
 
   end

data/lib/testlab/node/bind.rb

@@ -79,9 +79,11 @@ class TestLab
 
       def bind_install
         self.ssh.exec(%(sudo apt-get -y install bind9))
+        self.ssh.exec(%(sudo rm -fv /etc/bind/{*.arpa,*.zone,*.conf*}))
       end
 
       def bind_reload
+        self.ssh.exec(%(sudo chown -Rv bind:bind /etc/bind))
         self.ssh.exec(%(sudo rndc reload))
       end
 

data/lib/testlab/node/lifecycle.rb

@@ -14,6 +14,8 @@ 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
@@ -30,14 +32,18 @@ class TestLab
       def setup
         @ui.logger.debug { "Node Setup: #{self.id} " }
 
-        node_setup
+        # @ui.stdout.puts(format_message(format_object(self, :green)))
 
-        if self.components.include?('resolv')
-          build_resolv_conf
-        end
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Setup', :green)) do
+          node_setup
 
-        if self.components.include?('bind')
-          bind_setup
+          if self.components.include?('resolv')
+            build_resolv_conf
+          end
+
+          if self.components.include?('bind')
+            bind_setup
+          end
         end
 
         call_collections([self.networks, self.routers, self.containers], :setup)
@@ -53,8 +59,13 @@ class TestLab
       def teardown
         @ui.logger.debug { "Node Teardown: #{self.id} " }
 
+        # @ui.stdout.puts(format_message(format_object(self, :red)))
+
         call_collections([self.containers, self.routers, self.networks], :teardown)
 
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Teardown', :red)) do
+        end
+
         true
       end
 

data/lib/testlab/node/ssh.rb

@@ -31,7 +31,11 @@ class TestLab
 
             c.host_name       = container.ip
             c.user            = (container.user || "ubuntu")
-            c.keys            = container.keys
+            if container.keys.nil?
+              c.password      = (container.passwd || "ubuntu")
+            else
+              c.keys          = container.keys
+            end
           end
         end
         @container_ssh[name]

data/lib/testlab/node.rb

@@ -10,6 +10,7 @@ class TestLab
     STATUS_KEYS   = %w(id instance_id state user ip port provider con net rtr).map(&:to_sym)
 
     # Sub-Modules
+    autoload :Actions,       'testlab/node/actions'
     autoload :Bind,          'testlab/node/bind'
     autoload :ClassMethods,  'testlab/node/class_methods'
     autoload :Lifecycle,     'testlab/node/lifecycle'
@@ -19,6 +20,7 @@ class TestLab
     autoload :SSH,           'testlab/node/ssh'
     autoload :Status,        'testlab/node/status'
 
+    include TestLab::Node::Actions
     include TestLab::Node::Bind
     include TestLab::Node::Lifecycle
     include TestLab::Node::LXC
@@ -29,6 +31,8 @@ class TestLab
 
     extend  TestLab::Node::ClassMethods
 
+    include TestLab::Utility::Misc
+
     # Associations and Attributes
     belongs_to :labfile,    :class_name => 'TestLab::Lab'
 
@@ -45,7 +49,7 @@ class TestLab
       super(*args)
 
       @ui       = TestLab.ui
-      @provider = self.provider.new(self.config)
+      @provider = self.provider.new(self.config, @ui)
     end
 
   end

data/lib/testlab/providers/vagrant.rb

@@ -33,7 +33,7 @@ class TestLab
 ################################################################################
 
       def initialize(config={}, ui=nil)
-        @config   = config
+        @config   = (config || Hash.new)
         @ui       = (ui || TestLab.ui)
 
         # ensure our vagrant key is there

data/lib/testlab/provisioners/chef.rb

@@ -11,10 +11,16 @@ class TestLab
     class Chef
 
       def initialize(config={}, ui=nil)
-        @config   = config
+        @config   = (config || Hash.new)
         @ui       = (ui || TestLab.ui)
       end
 
+      def setup(container)
+      end
+
+      def teardown(container)
+      end
+
     end
 
   end

data/lib/testlab/provisioners/shell.rb

@@ -9,10 +9,27 @@ class TestLab
     #
     # @author Zachary Patten <zachary@jovelabs.net>
     class Shell
+      require 'tempfile'
 
       def initialize(config={}, ui=nil)
-        @config   = config
-        @ui       = (ui || TestLab.ui)
+        @config = (config || Hash.new)
+        @ui     = (ui || TestLab.ui)
+
+        @config[:shell] ||= "/bin/bash"
+      end
+
+      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])
+          end
+          container.lxc.attach(@config[:shell], tempfile.path)
+        end
+      end
+
+      def teardown(container)
+        # NOOP
       end
 
     end

data/lib/testlab/utility.rb

@@ -8,8 +8,10 @@ class TestLab
   # @author Zachary Patten <zachary@jovelabs.net>
   module Utility
     autoload :CIDR, 'testlab/utility/cidr'
+    autoload :Misc, 'testlab/utility/misc'
 
     extend TestLab::Utility::CIDR
+    extend TestLab::Utility::Misc
 
   end
 

data/lib/testlab/version.rb

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

data/lib/testlab.rb

@@ -2,6 +2,11 @@ require 'ztk'
 
 require 'testlab/version'
 
+# Monkey Patch the String class so we can have some easy ANSI methods
+class String
+  include ZTK::ANSI
+end
+
 # Top-Level LXC Class
 #
 # @author Zachary Patten <zachary@jovelabs.net>
@@ -20,6 +25,8 @@ class TestLab
   autoload :Router,      'testlab/router'
   autoload :Utility,     'testlab/utility'
 
+  include TestLab::Utility::Misc
+
   @@ui ||= nil
 
   def initialize(options={})
@@ -61,18 +68,18 @@ class TestLab
 
   def status
     if alive?
-      @@ui.stdout.puts("NODES:")
-      ZTK::Report.new(:ui => @@ui).spreadsheet(TestLab::Node.all, TestLab::Node::STATUS_KEYS) do |node|
+      @@ui.stdout.puts("NODES:".green.bold)
+      ZTK::Report.new(:ui => @@ui).list(TestLab::Node.all, TestLab::Node::STATUS_KEYS) do |node|
         OpenStruct.new(node.status)
       end
       @@ui.stdout.puts
-      @@ui.stdout.puts("NETWORKS:")
-      ZTK::Report.new(:ui => @@ui).spreadsheet(TestLab::Network.all, TestLab::Network::STATUS_KEYS) do |network|
+      @@ui.stdout.puts("NETWORKS:".green.bold)
+      ZTK::Report.new(:ui => @@ui).list(TestLab::Network.all, TestLab::Network::STATUS_KEYS) do |network|
         OpenStruct.new(network.status)
       end
       @@ui.stdout.puts
-      @@ui.stdout.puts("CONTAINERS:")
-      ZTK::Report.new(:ui => @@ui).spreadsheet(TestLab::Container.all, TestLab::Container::STATUS_KEYS) do |container|
+      @@ui.stdout.puts("CONTAINERS:".green.bold)
+      ZTK::Report.new(:ui => @@ui).list(TestLab::Container.all, TestLab::Container::STATUS_KEYS) do |container|
         OpenStruct.new(container.status)
       end
 
@@ -98,7 +105,6 @@ class TestLab
 
   # Proxy various method calls to our subordinate classes
   def node_method_proxy(method_name, *method_args)
-    @@ui.logger.debug { "TestLab.#{method_name}" }
     TestLab::Node.all.map do |node|
       node.send(method_name.to_sym, *method_args)
     end
@@ -115,6 +121,10 @@ class TestLab
     end
   end
 
+  def ui
+    @@ui ||= ZTK::UI.new
+  end
+
   # Class Helpers
   class << self
 

data/testlab.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency("gli")
   spec.add_dependency("lxc")
   spec.add_dependency("ztk")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testlab
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: lxc
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +159,7 @@ description: A framework for building lightweight virtual infrastructure using L
 email:
 - zachary@jovelabs.com
 executables:
-- testlab-console
+- tl
 extensions: []
 extra_rdoc_files: []
 files:
@@ -157,7 +173,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/testlab-console
+- bin/tl
 - lib/testlab.rb
 - lib/testlab/container.rb
 - lib/testlab/container/actions.rb
@@ -223,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4469350422868766283
+      hash: 3639724075672475487
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -232,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4469350422868766283
+      hash: 3639724075672475487
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/bin/testlab-console

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-require 'pry'
-require 'testlab'
-
-tl = TestLab.new
-
-##
-#
-# Welcome to the Cucumber-Chef pry console!
-#
-##
-binding.pry