testlab 0.3.1 → 0.4.0

data/README.md

@@ -6,13 +6,29 @@
 
 # TestLab
 
-A framework for building lightweight virtual infrastructure using LXC
+What is TestLab?  TestLab lets you iterate virtual infrastructure quickly.  Using a `Labfile` you can define how you want your virtual infrastructure laid out.  You can define multiple network segments and containers (i.e. boxen).  TestLab will then setup and teardown this virtual infrastructure as you have dictated in the `Labfile`.
+
+TestLab can be run directly on the command-line or can be interfaced with directly via code.  Unlike the trend with some popular open-source software recently, I want you to build off this API interface and hopefully create tools I would of never dreamed up.
+
+Accessing TestLab via code is meant to be fairly easy and straightforward.  To get an instance of TestLab you only need about four lines of code:
+
+    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)
+
+Calling `TestLab.new` without a `:labfile` option will, by default, attempt to read `Labfile` from the current directory.  This behaviour can be changed by passing the `:labfile` key with a path to your desired "Labfile" as the value to your `TestLab.new`.
+
+For more information see the TestLab Documentation, `testlab-repo`, command-line binary and it never hurts to look at the TestLab source itself.
 
 # REQUIREMENTS
 
 * Latest VirtualBox Package
 * Latest Vagrant Package (non-gem version)
+* Ubuntu 13.04 Recommended; 12.10 Minimum
+
 * Ubuntu 13.04 Server 64-bit (Raring) Base Box - https://github.com/zpatten/raring64
+* Ubuntu 12.10 Server 64-bit (Quantal) Base Box - https://github.com/zpatten/quantal64
 
 # EXAMPLE USE
 

data/bin/tl

@@ -27,11 +27,13 @@ include TestLab::Utility::Misc
 version TestLab::VERSION
 
 program_desc %(A framework for building lightweight virtual infrastructure using LXC)
-program_long_desc %(Program Long Description)
+# program_long_desc %(Program Long Description)
 
 sort_help :manually
 default_command :help
 
+# LAB CREATE
+#############
 desc 'Create the test lab'
 command :create do |create|
   create.action do |global_options,options,args|
@@ -39,6 +41,8 @@ command :create do |create|
   end
 end
 
+# LAB DESTROY
+##############
 desc 'Destroy the test lab'
 command :destroy do |destroy|
   destroy.action do |global_options,options,args|
@@ -46,6 +50,8 @@ command :destroy do |destroy|
   end
 end
 
+# LAB ONLINE
+#############
 desc 'Online the test lab'
 command :up do |up|
   up.action do |global_options,options,args|
@@ -53,6 +59,8 @@ command :up do |up|
   end
 end
 
+# LAB OFFLINE
+##############
 desc 'Offline the test lab'
 command :down do |down|
   down.action do |global_options,options,args|
@@ -60,6 +68,8 @@ command :down do |down|
   end
 end
 
+# LAB SETUP
+############
 desc 'Setup the test lab infrastructure'
 command :setup do |setup|
   setup.action do |global_options,options,args|
@@ -67,6 +77,8 @@ command :setup do |setup|
   end
 end
 
+# LAB TEARDOWN
+###############
 desc 'Teardown the test lab infrastructure'
 command :teardown do |teardown|
   teardown.action do |global_options,options,args|
@@ -74,6 +86,8 @@ command :teardown do |teardown|
   end
 end
 
+# LAB STATUS
+#############
 desc 'Display information on the status of the test lab'
 command :status do |status|
   status.action do |global_options,options,args|
@@ -88,6 +102,8 @@ command :status do |status|
   end
 end
 
+# NODES
+########
 desc 'Manage nodes'
 arg_name 'Describe arguments to node here'
 command :node do |c|
@@ -96,6 +112,8 @@ command :node do |c|
   c.arg_name 'node'
   c.flag [:i, :id]
 
+  # NODE SSH
+  ###########
   c.desc 'Open an SSH console to a node'
   c.command :ssh do |ssh|
     ssh.action do |global_options,options,args|
@@ -108,15 +126,19 @@ command :node do |c|
     end
   end
 
+  # NODE STATUS
+  ##############
   c.desc 'Display the status of node(s)'
-  c.long_desc 'Displays the status of all nodes or a single node if supplied via the id parameter.'
+  c.long_desc 'Displays the status of all nodes or a single node if supplied via the ID parameter.'
   c.command :status do |status|
     status.action do |global_options, options, args|
       if options[:id].nil?
+        # No ID supplied; show everything
         ZTK::Report.new(:ui => @testlab.ui).spreadsheet(@testlab.nodes, TestLab::Node::STATUS_KEYS) do |node|
           OpenStruct.new(node.status)
         end
       else
+        # ID supplied; show just that item
         node = @testlab.nodes.select{ |c| c.id.to_sym == options[:id].to_sym }.first
         node.nil? and raise TestLab::TestLabError, "We could not find the node you supplied!"
 
@@ -129,6 +151,8 @@ command :node do |c|
 
 end
 
+# NETWORKS
+###########
 desc 'Manage networks'
 arg_name 'Describe arguments to network here'
 command :network do |c|
@@ -137,15 +161,24 @@ command :network do |c|
   c.arg_name 'network'
   c.flag [:i, :id]
 
+  # NETWORK STATUS
+  #################
   c.desc 'Display the status of network(s)'
-  c.long_desc 'Displays the status of all networks or a single network if supplied via the id parameter.'
+  c.long_desc 'Displays the status of all networks or a single network if supplied via the ID parameter.'
   c.command :status do |status|
     status.action do |global_options, options, args|
       if options[:id].nil?
-        ZTK::Report.new(:ui => @testlab.ui).spreadsheet(@testlab.networks, TestLab::Network::STATUS_KEYS) do |network|
-          OpenStruct.new(network.status)
+        # No ID supplied; show everything
+        networks = @testlab.networks.delete_if{|n| n.node.dead? }
+        if networks.count == 0
+          @testlab.ui.stderr.puts("You either have no networks defined or dead nodes!".yellow)
+        else
+          ZTK::Report.new(:ui => @testlab.ui).spreadsheet(networks, TestLab::Network::STATUS_KEYS) do |network|
+            OpenStruct.new(network.status)
+          end
         end
       else
+        # ID supplied; show just that item
         network = @testlab.networks.select{ |c| c.id.to_sym == options[:id].to_sym }.first
         network.nil? and raise TestLab::TestLabError, "We could not find the network you supplied!"
 
@@ -158,6 +191,8 @@ command :network do |c|
 
 end
 
+# CONTAINERS
+#############
 desc 'Manage containers'
 arg_name 'Describe arguments to container here'
 command :container do |c|
@@ -166,6 +201,8 @@ command :container do |c|
   c.arg_name 'container'
   c.flag [:i, :id]
 
+  # CONTAINER SSH
+  ################
   c.desc 'Open an SSH console to a container'
   c.command :ssh do |ssh|
     ssh.action do |global_options, options, args|
@@ -178,15 +215,26 @@ command :container do |c|
     end
   end
 
+  # CONTAINER STATUS
+  ###################
   c.desc 'Display the status of container(s)'
-  c.long_desc 'Displays the status of all containers or a single container if supplied via the id parameter.'
+  c.long_desc <<-EOF
+Displays the status of all containers or a single container if supplied via the ID parameter.
+EOF
   c.command :status do |status|
     status.action do |global_options, options, args|
       if options[:id].nil?
-        ZTK::Report.new(:ui => @testlab.ui).spreadsheet(@testlab.containers, TestLab::Container::STATUS_KEYS) do |container|
-          OpenStruct.new(container.status)
+        # No ID supplied; show everything
+        containers = @testlab.containers.delete_if{ |c| c.node.dead? }
+        if containers.count == 0
+          @testlab.ui.stderr.puts("You either have no containers defined or dead nodes!".yellow)
+        else
+          ZTK::Report.new(:ui => @testlab.ui).spreadsheet(containers, TestLab::Container::STATUS_KEYS.reject{|k| k == :fqdn}) do |container|
+            OpenStruct.new(container.status.reject{|k,v| k == :fqdn})
+          end
         end
       else
+        # ID supplied; show just that item
         container = @testlab.containers.select{ |c| c.id.to_sym == options[:id].to_sym }.first
         container.nil? and raise TestLab::TestLabError, "We could not find the container you supplied!"
 
@@ -197,11 +245,77 @@ command :container do |c|
     end
   end
 
+  # CONTAINER RECYCLE
+  ####################
+  c.desc 'Recycles a container'
+  c.long_desc <<-EOF
+Recycles a container.  The container is taken through a series of state changes to ensure it is pristine.
+
+The containers is cycled in this order:
+
+Down -> Destroy -> Create -> Up
+EOF
+  c.command :recycle do |recycle|
+    recycle.action do |global_options, options, args|
+      if options[:id].nil?
+        help_now!('id is required') if options[:id].nil?
+      else
+        container = @testlab.containers.select{ |c| c.id.to_sym == options[:id].to_sym }.first
+        container.nil? and raise TestLab::TestLabError, "We could not find the container you supplied!"
+
+        container.teardown
+        container.setup
+      end
+    end
+  end
+
+  # CONTAINER SETUP
+  ####################
+  c.desc 'Setup a container'
+  c.long_desc <<-EOF
+Setup a container.  The container is created, started and provisioned.
+EOF
+  c.command :setup do |setup|
+    setup.action do |global_options, options, args|
+      if options[:id].nil?
+        help_now!('id is required') if options[:id].nil?
+      else
+        container = @testlab.containers.select{ |c| c.id.to_sym == options[:id].to_sym }.first
+        container.nil? and raise TestLab::TestLabError, "We could not find the container you supplied!"
+
+        container.setup
+      end
+    end
+  end
+
+  # CONTAINER TEARDOWN
+  ####################
+  c.desc 'Teardown a container'
+  c.long_desc <<-EOF
+Teardown a container.  The container is offlined and destroyed.
+EOF
+  c.command :teardown do |teardown|
+    teardown.action do |global_options, options, args|
+      if options[:id].nil?
+        help_now!('id is required') if options[:id].nil?
+      else
+        container = @testlab.containers.select{ |c| c.id.to_sym == options[:id].to_sym }.first
+        container.nil? and raise TestLab::TestLabError, "We could not find the container you supplied!"
+
+        container.teardown
+      end
+    end
+  end
+
 end
 
+# ROUTES
+#########
 desc 'Manage routes'
 command :route do |c|
 
+  # ROUTE ADD
+  ############
   c.desc 'Add routes to lab networks'
   c.command :add do |add|
     add.action do |global_options,options,args|
@@ -213,6 +327,8 @@ command :route do |c|
     end
   end
 
+  # ROUTE DEL
+  ############
   c.desc 'Delete routes to lab networks'
   c.command :del do |del|
     del.action do |global_options,options,args|

data/lib/testlab/container/lxc.rb

@@ -3,6 +3,31 @@ class TestLab
 
     module LXC
 
+      # Container Bootstrap
+      #
+      # Renders the supplied content into a file on the container and proceeds
+      # to execute it on the container as root.
+      #
+      # @param [String] content The content to render on the container and
+      #   execute.  This is generally a bash script of some sort for example.
+      # @return [String] The output of *lxc-attach*.
+      def bootstrap(content)
+        output = nil
+
+        ZTK::RescueRetry.try(:tries => 3, :on => ContainerError) do
+          tempfile = Tempfile.new("bootstrap")
+          self.node.ssh.file(:target => File.join(self.lxc.fs_root, tempfile.path), :chmod => '0777', :chown => 'root:root') do |file|
+            file.puts(content)
+          end
+          output = self.lxc.attach(%(/bin/bash), tempfile.path)
+          if output =~ /No such file or directory/
+            raise ContainerError, "We could not find the bootstrap file!"
+          end
+        end
+
+        output
+      end
+
       # LXC::Container object
       #
       # Returns a *LXC::Container* class instance configured for this container.

data/lib/testlab/container.rb

@@ -87,16 +87,16 @@ class TestLab
     has_many    :interfaces,  :class_name => 'TestLab::Interface'
 
     attribute   :provisioner
-    attribute   :config
+    attribute   :config,      :default => Hash.new
 
     attribute   :domain
 
-    attribute   :user
-    attribute   :passwd
+    attribute   :user,        :default => 'ubuntu'
+    attribute   :passwd,      :default => 'ubuntu'
     attribute   :keys
 
-    attribute   :distro
-    attribute   :release
+    attribute   :distro,      :default => 'ubuntu'
+    attribute   :release,     :default => 'precise'
     attribute   :arch
 
     attribute   :persist

data/lib/testlab/interface.rb

@@ -10,13 +10,13 @@ class TestLab
 
     # Associations and Attributes
     belongs_to  :container, :class_name => 'TestLab::Container'
-    belongs_to  :network, :class_name => 'TestLab::Network'
+    belongs_to  :network,   :class_name => 'TestLab::Network'
 
     attribute   :address
     attribute   :mac
     attribute   :name
 
-    attribute   :primary
+    attribute   :primary,   :default => false
 
     def initialize(*args)
       super(*args)

data/lib/testlab/labfile.rb

@@ -7,9 +7,9 @@ class TestLab
   #
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Labfile < ZTK::DSL::Base
-    has_many    :nodes,       :class_name => 'TestLab::Node'
+    has_many   :nodes,  :class_name => 'TestLab::Node'
 
-    attribute   :config
+    attribute  :config, :default => Hash.new
   end
 
 end

data/lib/testlab/node/ssh.rb

@@ -30,9 +30,9 @@ class TestLab
             c.proxy_keys      = @provider.identity
 
             c.host_name       = container.ip
-            c.user            = (container.user || "ubuntu")
+            c.user            = container.user
             if container.keys.nil?
-              c.password      = (container.passwd || "ubuntu")
+              c.password      = container.passwd
             else
               c.keys          = container.keys
             end

data/lib/testlab/node/templates/node-setup.erb

@@ -2,7 +2,7 @@ set -x
 
 # Update APT and ensure our required packages are installed
 apt-get -y update
-apt-get -y install lxc bridge-utils debootstrap yum iptables ntpdate ntp
+apt-get -y install lxc bridge-utils debootstrap yum iptables ntpdate ntp sshpass
 
 # Ensure the default lxc networking services are off
 service lxc-net stop

data/lib/testlab/node.rb

@@ -41,8 +41,8 @@ class TestLab
 
     attribute  :provider
     attribute  :config
-    attribute  :components
-    attribute  :route
+    attribute  :components, :default => Array.new
+    attribute  :route,      :default => false
 
 
     def initialize(*args)

data/lib/testlab/provisioner.rb

@@ -7,8 +7,9 @@ class TestLab
   #
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Provisioner
-    autoload :Shell, 'testlab/provisioners/shell'
-    autoload :Chef, 'testlab/provisioners/chef'
+    autoload :Shell,     'testlab/provisioners/shell'
+    autoload :OmniBus,   'testlab/provisioners/omnibus'
+    autoload :OmniTruck, 'testlab/provisioners/omnitruck'
 
     class << self
 

data/lib/testlab/provisioners/omnibus.rb

@@ -0,0 +1,48 @@
+class TestLab
+
+  class Provisioner
+
+    # OmniBus Provisioner Error Class
+    class OmniBusError < ProvisionerError; end
+
+    # OmniBus Provisioner Class
+    #
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    class OmniBus
+
+      def initialize(config={}, ui=nil)
+        @config = (config || Hash.new)
+        @ui     = (ui || TestLab.ui)
+
+        @config[:version]     ||= %(latest)
+        @config[:omnibus_url] ||= %(https://www.opscode.com/chef/install.sh)
+      end
+
+      # OmniBus Provisioner Container Setup
+      #
+      # Renders the defined script to a temporary file on the target container
+      # and proceeds to execute said script as root via *lxc-attach*.
+      #
+      # @param [TestLab::Container] container The container which we want to
+      #   provision.
+      # @return [Boolean] True if successful.
+      def setup(container)
+        omnibus_template = File.join(TestLab::Provisioner.template_dir, 'chef', 'omnibus.erb')
+        container.bootstrap(ZTK::Template.render(omnibus_template, @config))
+      end
+
+      # OmniBus Provisioner Container Teardown
+      #
+      # This is a NO-OP currently.
+      #
+      # @return [Boolean] True if successful.
+      def teardown(container)
+        # NOOP
+
+        true
+      end
+
+    end
+
+  end
+end

data/lib/testlab/provisioners/omnitruck.rb

@@ -0,0 +1,115 @@
+class TestLab
+
+  class Provisioner
+
+    # OmniTruck Provisioner Error Class
+    class OmniTruckError < ProvisionerError; end
+
+    # OmniTruck Provisioner Class
+    #
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    class OmniTruck
+      require 'json'
+
+      def initialize(config={}, ui=nil)
+        @config = (config || Hash.new)
+        @ui     = (ui || TestLab.ui)
+
+        @config[:version]     ||= "latest"
+        @config[:prereleases] ||= false
+        @config[:nightlies]   ||= false
+      end
+
+      # OmniTruck Provisioner Container Setup
+      #
+      # Renders the defined script to a temporary file on the target container
+      # and proceeds to execute said script as root via *lxc-attach*.
+      #
+      # @param [TestLab::Container] container The container which we want to
+      #   provision.
+      # @return [Boolean] True if successful.
+      def setup(container)
+        omnibus_template = File.join(TestLab::Provisioner.template_dir, 'chef', 'omnitruck.erb')
+        config = {}.merge!({
+          :server_name => container.fqdn,
+          :chef_pre_11 => chef_pre_11?,
+          :chef_solo_attributes => build_chef_solo_attributes(container),
+          :chef_validator => (chef_pre_11? ? '/etc/chef/validation.pem' : '/etc/chef-server/chef-validator.pem'),
+          :chef_webui => (chef_pre_11? ? '/etc/chef/webui.pem' : '/etc/chef-server/chef-webui.pem'),
+          :chef_admin => (chef_pre_11? ? '/etc/chef/admin.pem' : '/etc/chef-server/admin.pem'),
+          :default_password => "p@ssw01d",
+          :user => ENV['USER'],
+          :hostname_short => container.id,
+          :hostname_full => container.fqdn
+        }).merge!(@config)
+        container.bootstrap(ZTK::Template.render(omnibus_template, config))
+      end
+
+      # OmniTruck Provisioner Container Teardown
+      #
+      # This is a NO-OP currently.
+      #
+      # @return [Boolean] True if successful.
+      def teardown(container)
+        # NOOP
+
+        true
+      end
+
+    private
+
+      def build_chef_solo_10_attributes(container)
+        {
+          "chef-server" => {
+            "webui_enabled" => true
+          },
+          "run_list" => %w(recipe[chef-server::rubygems-install] recipe[chef-server::apache-proxy])
+        }
+      end
+
+      def build_chef_solo_11_attributes(container)
+        {
+          "chef-server" => {
+            "api_fqdn" => container.fqdn,
+            "nginx" => {
+              "enable_non_ssl" => true,
+              "server_name" => container.fqdn,
+              "url" => "https://#{container.fqdn}"
+            },
+            "lb" => {
+              "fqdn" => container.fqdn
+            },
+            "bookshelf" => {
+              "vip" => container.fqdn
+            },
+            "chef_server_webui" => {
+              "enable" => true
+            },
+            "version" => @config[:version],
+            "prereleases" => @config[:prereleases],
+            "nightlies" => @config[:nightlies]
+          },
+          "run_list" => %w(recipe[chef-server::default])
+        }
+      end
+
+      def build_chef_solo_attributes(container)
+        if chef_pre_11?
+          build_chef_solo_10_attributes(container)
+        else
+          build_chef_solo_11_attributes(container)
+        end
+      end
+
+      def chef_pre_11?
+        if (@config[:version].to_s.downcase != "latest") && (@config[:version].to_f < 11.0)
+          true
+        else
+          false
+        end
+      end
+
+    end
+
+  end
+end

data/lib/testlab/provisioners/shell.rb

@@ -14,26 +14,33 @@ class TestLab
       def initialize(config={}, ui=nil)
         @config = (config || Hash.new)
         @ui     = (ui || TestLab.ui)
-
-        @config[:shell] ||= "/bin/bash"
       end
 
+      # Shell Provisioner Container Setup
+      #
+      # Renders the defined script to a temporary file on the target container
+      # and proceeds to execute said script as root via *lxc-attach*.
+      #
+      # @param [TestLab::Container] container The container which we want to
+      #   provision.
+      # @return [Boolean] True if successful.
       def setup(container)
         if !@config[:setup].nil?
-          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.bootstrap(@config[:setup])
         end
+
+        true
       end
 
+      # Shell Provisioner Container Teardown
+      #
+      # This is a NO-OP currently.
+      #
+      # @return [Boolean] True if successful.
       def teardown(container)
         # NOOP
+
+        true
       end
 
     end

data/lib/testlab/provisioners/templates/chef/omnibus.erb

@@ -0,0 +1,6 @@
+set -x
+cd /tmp
+apt-get -y install wget || yum -y install wget
+rm -fv /tmp/install.sh
+wget -v --no-check-certificate <%= @omnibus_url %> -O /tmp/install.sh
+/bin/bash /tmp/install.sh -v <%= @version -%>