testlab 0.0.1 → 0.0.2

data/lib/testlab/network.rb

@@ -0,0 +1,127 @@
+class TestLab
+
+  # Network Error Class
+  class NetworkError < TestLabError; end
+
+  # Network Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class Network < ZTK::DSL::Base
+    STATUS_KEYS   = %w(node_id id state interface).map(&:to_sym)
+
+    belongs_to  :node,        :class_name => 'TestLab::Node'
+
+    attribute   :bridge
+
+    attribute   :cidr
+    attribute   :config
+
+    def initialize(*args)
+      super(*args)
+
+      @ui = TestLab.ui
+    end
+
+    # Network status
+    def status
+      interface = "#{bridge}:#{cidr}"
+      {
+        :id => self.id,
+        :node_id => self.node.id,
+        :state => self.state,
+        :interface => interface
+      }
+    end
+
+################################################################################
+
+    # Create the network
+    def create
+      @ui.logger.debug { "Network Create: #{self.id} " }
+
+      self.node.ssh.exec(%(sudo brctl addbr #{self.bridge}), :silence => true, :ignore_exit_status => true)
+      self.node.ssh.exec(%(sudo ifconfig #{self.bridge} #{self.cidr} down), :silence => true, :ignore_exit_status => true)
+    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)
+    end
+
+    # Start the network
+    def up
+      @ui.logger.debug { "Network Up: #{self.id} " }
+
+      self.node.ssh.exec(%(sudo ifconfig #{self.bridge} up), :silence => true, :ignore_exit_status => true)
+    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)
+    end
+
+################################################################################
+
+    # Reload the network
+    def reload
+      @ui.logger.debug { "Network Reload: #{self.id} " }
+
+      self.down
+      self.up
+    end
+
+################################################################################
+
+    # State of the network
+    def state
+      output = self.node.ssh.exec(%(sudo ifconfig #{self.bridge} | grep 'MTU'), :silence => true, :ignore_exit_status => true).output.strip
+      if ((output =~ /UP/) && (output =~ /RUNNING/))
+        :running
+      else
+        :stopped
+      end
+    end
+
+################################################################################
+
+    # Network Callback: after_create
+    def after_create
+      @ui.logger.debug { "Network Callback: After Create: #{self.id} " }
+    end
+
+    # Network Callback: after_up
+    def after_up
+      @ui.logger.debug { "Network Callback: After Up: #{self.id} " }
+
+      self.create
+      self.up
+    end
+
+    # Network Callback: before_down
+    def before_down
+      @ui.logger.debug { "Network Callback: Before Down: #{self.id} " }
+
+      self.down
+      self.destroy
+    end
+
+    # Network Callback: before_destroy
+    def before_destroy
+      @ui.logger.debug { "Network Callback: Before Destroy: #{self.id} " }
+    end
+
+################################################################################
+
+    # Method missing handler
+    def method_missing(method_name, *method_args)
+      @ui.logger.debug { "NETWORK METHOD MISSING: #{method_name.inspect}(#{method_args.inspect})" }
+      super(method_name, *method_args)
+    end
+
+  end
+
+end

data/lib/testlab/node.rb

@@ -0,0 +1,148 @@
+require 'lxc'
+
+class TestLab
+
+  # Node Error Class
+  class NodeError < TestLabError; end
+
+  # Node Class
+  #
+  # @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)
+
+    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'
+
+    attribute  :provider
+    attribute  :config
+
+    def initialize(*args)
+      super(*args)
+
+      @ui       = TestLab.ui
+      @provider = self.provider.new(self.config)
+    end
+
+    def status
+      {
+        :instance_id => @provider.instance_id,
+        :state => @provider.state,
+        :user => @provider.user,
+        :ip => @provider.ip,
+        :port => @provider.port,
+        :provider => @provider.class,
+        :con => self.containers.count,
+        :net => self.networks.count,
+        :rtr => self.routers.count
+      }
+    end
+
+    # SSH to the Node
+    def ssh(options={})
+      if (!defined?(@ssh) || @ssh.nil?)
+        @ssh ||= ZTK::SSH.new({:ui => @ui, :timeout => 1200, :silence => true}.merge(options))
+        @ssh.config do |c|
+          c.host_name = @provider.ip
+          c.user      = @provider.user
+          c.keys      = @provider.identity
+        end
+      end
+      @ssh
+    end
+
+    # SSH to a container running on the Node
+    def ssh_container(id, options={})
+    end
+
+    # Returns the LXC object for this Node
+    #
+    # This object is used to control containers on the node via it's provider
+    def lxc(options={})
+      if (!defined?(@lxc) || @lxc.nil?)
+        @lxc ||= LXC.new
+        @lxc.use_sudo = true
+        @lxc.use_ssh = self.ssh
+      end
+      @lxc
+    end
+
+    def arch
+      @arch ||= self.ssh.exec(%(uname -m)).output.strip
+    end
+
+################################################################################
+
+    # Callback: After Create
+    # Ensure our packages are installed.
+    def after_create
+      self.ssh.exec(%(sudo apt-get -qq -y --force-yes update))
+      self.ssh.exec(%(sudo apt-get -qq -y --force-yes install lxc bridge-utils debootstrap yum isc-dhcp-server bind9 ntpdate ntp))
+    end
+
+    # Callback: After Up
+    def after_up
+    end
+
+################################################################################
+
+    # Provides a generic interface for triggering our callback framework
+    def proxy_callbacks(action, objects, method_name, *method_args)
+      callback_method = "#{action}_#{method_name}".to_sym
+
+      objects.each do |object|
+        if object.respond_to?(callback_method)
+          object.send(callback_method, *method_args)
+        end
+      end
+    end
+
+    # Provides a generic interface for triggering our callback framework
+    def self_callbacks(action, method_name, *method_args)
+      callback_method = "#{action}_#{method_name}".to_sym
+
+      if self.respond_to?(callback_method)
+        self.send(callback_method, *method_args)
+      end
+    end
+
+    # Method missing handler
+    def method_missing(method_name, *method_args)
+      @ui.logger.debug { "NODE METHOD MISSING: #{method_name.inspect}(#{method_args.inspect})" }
+
+      if TestLab::Provider::PROXY_METHODS.include?(method_name)
+        result = nil
+        object_collections = [self.containers, self.routers, self.networks]
+
+        self_callbacks(:before, method_name, *method_args)
+
+        object_collections.each do |object_collection|
+          proxy_callbacks(:before, object_collection, method_name, *method_args)
+        end
+
+        @ui.logger.debug { "method_name == #{method_name.inspect}" }
+        if @provider.respond_to?(method_name)
+          @ui.logger.debug { "@provider.send(#{method_name.inspect}, #{method_args.inspect})" }
+          result = @provider.send(method_name, *method_args)
+        else
+          raise TestLab::ProviderError, "Your provider does not respond to the method '#{method_name}'!"
+        end
+
+        self_callbacks(:after, method_name, *method_args)
+
+        object_collections.reverse.each do |object_collection|
+          proxy_callbacks(:after, object_collection, method_name, *method_args)
+        end
+
+        result
+      else
+        super(method_name, *method_args)
+      end
+    end
+
+  end
+
+end

data/lib/testlab/provider.rb

@@ -0,0 +1,27 @@
+class TestLab
+
+  # Provider Error Class
+  class ProviderError < TestLabError; end
+
+  # Provider Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class Provider
+    PROXY_METHODS = %w(instance_id state user ip port create destroy up down reload status alive? dead? exists?).map(&:to_sym)
+
+    autoload :AWS, 'testlab/providers/aws'
+    autoload :Local, 'testlab/providers/local'
+    autoload :Vagrant, 'testlab/providers/vagrant'
+
+    class << self
+
+      # Returns the path to the gems provider templates
+      def template_dir
+        File.join(TestLab.gem_dir, "lib", "testlab", "providers", "templates")
+      end
+
+    end
+
+  end
+
+end

data/lib/testlab/providers/aws.rb

@@ -0,0 +1,20 @@
+class TestLab
+
+  class Provider
+
+    # AWS Provider Error Class
+    class AWSError < ProviderError; end
+
+    # AWS Provider Class
+    #
+    # @author Zachary Patten <zachary@jovelabs.net>
+    class AWS
+
+      def initialize(ui=ZTK::UI.new)
+        @ui = ui
+      end
+
+    end
+
+  end
+end

data/lib/testlab/providers/local.rb

@@ -0,0 +1,20 @@
+class TestLab
+
+  class Provider
+
+    # Local Provider Error Class
+    class LocalError < ProviderError; end
+
+    # Local Provider Class
+    #
+    # @author Zachary Patten <zachary@jovelabs.net>
+    class Local
+
+      def initialize(ui=ZTK::UI.new)
+        @ui = ui
+      end
+
+    end
+
+  end
+end

data/lib/testlab/providers/templates/vagrant/Vagrantfile.erb

@@ -0,0 +1,25 @@
+#!/bin/env ruby
+#
+# Auto-generated by TestLab v<%= TestLab::VERSION %> on <%= Time.now.utc %> -- DO NOT EDIT!
+#
+# Vagrant v2 Configuration
+###########################
+
+Vagrant.configure("2") do |config|
+  config.vm.define <%= @id.inspect %> do |testlab|
+    testlab.vm.hostname = <%= @hostname.inspect %>
+    testlab.vm.box = <%= @box.inspect %>
+    testlab.vm.box_url = <%= @box_url.inspect %>
+    testlab.vm.network(:private_network, :ip => <%= @ip.inspect %>)
+
+    testlab.vm.provider :virtualbox do |vb|
+      vb.name = <%= @hostname.inspect %>
+      vb.customize(["modifyvm", :id, "--cpus", <%= @cpus.inspect %>])
+      vb.customize(["modifyvm", :id, "--memory", <%= @memory.inspect %>])
+    end
+
+    testlab.ssh.username = <%= @user.inspect %>
+    testlab.ssh.port = <%= @port.inspect %>
+    testlab.ssh.forward_agent = true
+  end
+end

data/lib/testlab/providers/vagrant.rb

@@ -0,0 +1,204 @@
+class TestLab
+
+  class Provider
+
+    # Vagrant Provider Error Class
+    class VagrantError < ProviderError; end
+
+    # Vagrant Provider Class
+    #
+    # @author Zachary Patten <zachary@jovelabs.net>
+    class Vagrant
+
+      # States which indicate the VM is running
+      RUNNING_STATES  = %w(running).map(&:to_sym)
+
+      # States which indicate the VM is shut down
+      SHUTDOWN_STATES = %w(aborted paused saved poweroff).map(&:to_sym)
+
+      # The state we report if we can not determine the VM state
+      UNKNOWN_STATE   = :unknown
+
+      # A collection of all valid states the VM can be in
+      VALID_STATES    = (RUNNING_STATES + SHUTDOWN_STATES).flatten
+
+      # A collection of all invalid states the VM can be in
+      INVALID_STATES  = (%w(not_created).map(&:to_sym) + [UNKNOWN_STATE]).flatten
+
+      # A collection of all states the VM can be in
+      ALL_STATES      = (VALID_STATES + INVALID_STATES).flatten
+
+      MSG_NO_LAB      = %(We could not find a test lab!)
+
+################################################################################
+
+      def initialize(config={}, ui=nil)
+        @config   = config
+        @ui       = (ui || TestLab.ui)
+
+        # ensure our vagrant key is there
+        @config[:vagrant] ||= Hash.new
+
+        render_vagrantfile
+      end
+
+################################################################################
+
+      # Create the Vagrant instance
+      def create
+        self.up
+      end
+
+      # Destroy Vagrant-controlled VM
+      def destroy
+        !self.exists? and raise VagrantError, MSG_NO_LAB
+
+        self.down
+        self.vagrant_cli("destroy", "--force", self.instance_id)
+
+        self.state
+      end
+
+################################################################################
+
+      # Online Vagrant-controlled VM
+      def up
+        self.vagrant_cli("up", self.instance_id)
+        ZTK::TCPSocketCheck.new(:host => self.ip, :port => self.port, :wait => 120, :ui => @ui).wait
+
+        self.state
+      end
+
+      # Halt Vagrant-controlled VM
+      def down
+        !self.exists? and raise VagrantError, MSG_NO_LAB
+
+        self.vagrant_cli("halt", self.instance_id)
+
+        self.state
+      end
+
+################################################################################
+
+      # Reload Vagrant-controlled VM
+      def reload
+        self.down
+        self.up
+
+        self.state
+      end
+
+################################################################################
+
+      # Inquire the state of the Vagrant-controlled VM
+      def state
+        output = self.vagrant_cli("status | grep '#{self.instance_id}'").output
+        result = UNKNOWN_STATE
+        ALL_STATES.map{ |s| s.to_s.gsub('_', ' ') }.each do |state|
+          if output =~ /#{state}/
+            result = state.to_s.gsub(' ', '_')
+            break
+          end
+        end
+        result.to_sym
+      end
+
+################################################################################
+
+      # Does the Vagrant-controlled VM exist?
+      def exists?
+        (self.state != :not_created)
+      end
+
+      # Is the Vagrant-controlled VM alive?
+      def alive?
+        (self.exists? && (RUNNING_STATES.include?(self.state) rescue false))
+      end
+
+      # Is the Vagrant-controlled VM dead?
+      def dead?
+        !self.alive?
+      end
+
+      # START CORE CONFIG
+      ####################
+
+      def instance_id
+        (@config[:vagrant][:id] || "testlab-#{ENV['USER']}".downcase)
+      end
+
+      def user
+        (@config[:vagrant][:user] || "vagrant")
+      end
+
+      def identity
+        (@config[:vagrant][:identity] || File.join(ENV['HOME'], ".vagrant.d", "insecure_private_key"))
+      end
+
+      def ip
+        (@config[:vagrant][:ip] || "192.168.33.10")
+      end
+
+      def port
+        (@config[:vagrant][:port] || 22)
+      end
+
+      ##################
+      # END CORE CONFIG
+
+      def hostname
+        (@config[:vagrant][:hostname] || self.instance_id)
+      end
+
+      def box
+        (@config[:vagrant][:box] || "precise64")
+      end
+
+      def box_url
+        (@config[:vagrant][:box_url] || "http://files.vagrantup.com/precise64.box")
+      end
+
+      def cpus
+        (@config[:vagrant][:cpus] || 2)
+      end
+
+      def memory
+        (@config[:vagrant][:memory] || 2048)
+      end
+
+################################################################################
+
+      def vagrant_cli(*args)
+        @ui.logger.debug { "args == #{args.inspect}" }
+
+        command = TestLab.build_command("vagrant", *args)
+        @ui.logger.debug { "command == #{command.inspect}" }
+
+        ZTK::Command.new(:ui => @ui).exec(command, :silence => true)
+      end
+
+      def render_vagrantfile
+        context = {
+          :id => self.instance_id,
+          :ip => self.ip,
+          :hostname => self.hostname,
+          :user => self.user,
+          :port => self.port,
+          :cpus => self.cpus,
+          :memory => self.memory,
+          :box => self.box,
+          :box_url => self.box_url
+        }
+
+        vagrantfile_template = File.join(TestLab::Provider.template_dir, "vagrant", "Vagrantfile.erb")
+        vagrantfile          = File.join(@config[:repo], "Vagrantfile")
+        IO.write(vagrantfile, ZTK::Template.render(vagrantfile_template, context))
+      end
+
+################################################################################
+
+
+    end
+
+  end
+end

data/lib/testlab/provisioner.rb

@@ -0,0 +1,25 @@
+class TestLab
+
+  # Provisioner Error Class
+  class ProvisionerError < TestLabError; end
+
+  # Provisioner Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class Provisioner
+
+    autoload :Shell, 'testlab/provisioners/shell'
+    autoload :Chef, 'testlab/provisioners/chef'
+
+    class << self
+
+      # Returns the path to the gems provisioner templates
+      def template_dir
+        File.join(TestLab.gem_dir, "lib", "testlab", "provisioners", "templates")
+      end
+
+    end
+
+  end
+
+end

data/lib/testlab/provisioners/chef.rb

@@ -0,0 +1,21 @@
+class TestLab
+
+  class Provisioner
+
+    # Chef Provisioner Error Class
+    class ChefError < ProvisionerError; end
+
+    # Chef Provisioner Class
+    #
+    # @author Zachary Patten <zachary@jovelabs.net>
+    class Chef
+
+      def initialize(config={}, ui=nil)
+        @config   = config
+        @ui       = (ui || TestLab.ui)
+      end
+
+    end
+
+  end
+end

data/lib/testlab/provisioners/shell.rb

@@ -0,0 +1,21 @@
+class TestLab
+
+  class Provisioner
+
+    # Shell Provisioner Error Class
+    class ShellError < ProvisionerError; end
+
+    # Shell Provisioner Class
+    #
+    # @author Zachary Patten <zachary@jovelabs.net>
+    class Shell
+
+      def initialize(config={}, ui=nil)
+        @config   = config
+        @ui       = (ui || TestLab.ui)
+      end
+
+    end
+
+  end
+end