testlab 0.9.1 → 1.0.0

data/README.md

@@ -4,11 +4,17 @@
 [![Coverage Status](https://coveralls.io/repos/zpatten/testlab/badge.png?branch=master)](https://coveralls.io/r/zpatten/testlab)
 [![Code Climate](https://codeclimate.com/github/zpatten/testlab.png)](https://codeclimate.com/github/zpatten/testlab)
 
+# A Quick Note on Versioning
+
+I attempt to keep TestLab in line with Semantic Versioning when incrementing version numbers.  I am human so I may screw this up on, hopefully rare, occasion.  Semantic Versioning is delicious and everyone should be following this schema, especially when it comes to Ruby Gems which have a habit of pushing your projects into "dependency hell".
+
+* http://semver.org/
+
 # TestLab
 
 A toolkit for building virtual computer labs.
 
-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 tear down this virtual infrastructure as you have dictated in the `Labfile`.
+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 build and demolish this virtual infrastructure as you have dictated in the `Labfile`.
 
 TestLab can also import and export containers, making it easy to share them.  TestLab supports the latest LXC versions, allowing for ephemeral cloning operations, furthering your ability to iterate quickly.  TestLab can be used for many other applications, including infrastructure unit and integration testing, allowing for vastly more complex configurations and more effective resource sharing than traditional VM solutions.
 
@@ -26,11 +32,11 @@ The TestLab command-line program `tl` follows in the style of git:
         tl [global options] command [command options] [arguments...]
 
     VERSION
-        0.8.1
+        0.9.1
 
     GLOBAL OPTIONS
         -l, --labfile=path/to/file     - Path to Labfile: ${REPO}/Labfile (default: none)
-        -r, --repo=path/to/directory   - Path to Repository directory: ${PWD} (default: /home/zpatten/code/personal/testlab-repo)
+        -r, --repo=path/to/directory   - Path to Repository directory: ${PWD} (default: /home/zpatten/code/chef-repo)
         -c, --config=path/to/directory - Path to Configuration directory: ${REPO}/.testlab-$(hostname -s) (default: none)
         --version                      - Display the program version
         -v, --[no-]verbose             - Show verbose output
@@ -38,19 +44,19 @@ The TestLab command-line program `tl` follows in the style of git:
         --help                         - Show this message
 
     COMMANDS
-        help      - Shows a list of commands or help for one command
-        container - Manage lab containers
-        network   - Manage lab networks
-        node      - Manage lab nodes
-        create    - Create the lab components
-        destroy   - Destroy the lab components
-        up        - On-line the lab components
-        down      - Off-line the lab components
-        setup     - Provision the lab components
-        teardown  - De-provision the lab components
-        build     - Build the lab
-        demolish  - Demolish the lab
-        status    - Display the lab status
+        help        - Shows a list of commands or help for one command
+        container   - Manage lab containers
+        network     - Manage lab networks
+        node        - Manage lab nodes
+        create      - Create the lab components
+        destroy     - Destroy the lab components
+        up          - On-line the lab components
+        down        - Off-line the lab components
+        provision   - Provision the lab components
+        deprovision - De-provision the lab components
+        build       - Build the lab
+        demolish    - Demolish the lab
+        status      - Display the lab status
 
 You stand up your lab with the following command:
 
@@ -107,8 +113,8 @@ You can individually online, offline, create or destroy containers:
 
     tl container down -n server-www-1
     tl container up -n server-www-1
-    tl container setup -n server-www-1
-    tl container teardown -n server-www-1
+    tl container provision -n server-www-1
+    tl container deprovision -n server-www-1
 
 You can recycle a container, effectively destroying then creating it again, provisioning it back to a "pristine" condition.
 
@@ -159,9 +165,9 @@ We can even recycle it while it is in a cloned state:
 
     $ tl container recycle -n server-www-1
 
-We can run setup against a clone as well (note: running `build`, calls `up`, which would revert us back to a non-cloned container and we would not want this to happen):
+We can run provision against a clone as well (note: running `build`, calls `up`, which would revert us back to a non-cloned container and we would not want this to happen):
 
-    $ tl container setup -n server-www-1
+    $ tl container provision -n server-www-1
 
 ## Network Routes
 

data/bin/tl

@@ -109,9 +109,6 @@ post do |global,command,options,args|
 end
 
 on_error do |exception|
-  testlab_run_time = (Time.now.utc - @testlab_start_time)
-
-  @ui.stderr.puts
   @ui.stderr.puts(format_message(["ERROR:".red, exception.inspect.red.bold].join(' ')))
 
   case exception
@@ -124,6 +121,8 @@ on_error do |exception|
 
     false
   else
+    testlab_run_time = (Time.now.utc - @testlab_start_time)
+
     @logger.fatal { exception.inspect }
     exception.backtrace.each do |line|
       @logger.logdev.write("#{line}\n")

data/features/support/Labfile.local

@@ -5,7 +5,12 @@ node 'vagrant' do
 
   provider      TestLab::Provider::Local
 
-  provisioners  [TestLab::Provisioner::Raring]
+  provisioners  [
+    TestLab::Provisioner::Raring,
+    TestLab::Provisioner::AptCacherNG,
+    TestLab::Provisioner::Bind,
+    TestLab::Provisioner::Resolv
+  ]
 
   config      ({
     :bind => {
@@ -14,6 +19,10 @@ node 'vagrant' do
   })
 
   network 'labnet' do
+    provisioners  [
+      TestLab::Provisioner::Bind
+    ]
+
     address       '10.128.0.1/16'
     bridge        :br_test
   end
@@ -23,6 +32,7 @@ node 'vagrant' do
     release       "precise"
 
     provisioners   [
+      TestLab::Provisioner::Resolv,
       TestLab::Provisioner::AptCacherNG,
       TestLab::Provisioner::Apt
     ]

data/features/support/Labfile.vagrant

@@ -7,7 +7,9 @@ node 'vagrant' do
 
   provisioners  [
     TestLab::Provisioner::Raring,
-    TestLab::Provisioner::Bind
+    TestLab::Provisioner::AptCacherNG,
+    TestLab::Provisioner::Bind,
+    TestLab::Provisioner::Resolv
   ]
 
   config      ({
@@ -25,6 +27,10 @@ node 'vagrant' do
   })
 
   network 'labnet' do
+    provisioners  [
+      TestLab::Provisioner::Bind
+    ]
+
     address       '10.128.0.1/16'
     bridge        :br0
   end

data/lib/commands/container.rb

@@ -107,18 +107,18 @@ Recycles a container.  The container is taken through a series of state changes
 
 The container is cycled in this order:
 
-Teardown -> Down -> Destroy -> Create -> Up -> Setup
+Deprovision -> Down -> Destroy -> Create -> Up -> Provision
 EOF
   c.command :recycle do |recycle|
     recycle.action do |global_options, options, args|
       iterate_objects_by_name(options[:name], TestLab::Container) do |container|
-        container.teardown
+        container.deprovision
         container.down
         container.destroy
 
         container.create
         container.up
-        container.setup
+        container.provision
       end
     end
   end

data/lib/commands/network.rb

@@ -54,7 +54,7 @@ EOF
       add.action do |global_options,options,args|
         iterate_objects_by_name(options[:name], TestLab::Network) do |network|
           p = TestLab::Provisioner::Route.new({}, @ui)
-          p.on_network_setup(network)
+          p.on_network_provision(network)
           @testlab.ui.stdout.puts("Added routes successfully!".green.bold)
           @testlab.ui.stdout.puts %x(netstat -nr | grep '#{network.node.ip}').strip
         end
@@ -68,7 +68,7 @@ EOF
       del.action do |global_options,options,args|
         iterate_objects_by_name(options[:name], TestLab::Network) do |network|
           p = TestLab::Provisioner::Route.new({}, @ui)
-          p.on_network_teardown(network)
+          p.on_network_deprovision(network)
           @testlab.ui.stdout.puts("Deleted routes successfully!".red.bold)
           @testlab.ui.stdout.puts %x(netstat -nr | grep '#{network.node.ip}').strip
         end

data/lib/commands/testlab.rb

@@ -82,35 +82,35 @@ command :down do |down|
   end
 end
 
-# LAB SETUP
-############
+# LAB PROVISION
+################
 desc 'Provision the lab components'
 long_desc <<-EOF
-Attempts to setup the defined lab components.
+Attempts to provision the defined lab components.
 
-The components are set up in the following order:
+The components are provisioned in the following order:
 
 Nodes -> Networks -> Containers
 EOF
-command :setup do |setup|
-  setup.action do |global_options,options,args|
-    @testlab.setup
+command :provision do |provision|
+  provision.action do |global_options,options,args|
+    @testlab.provision
   end
 end
 
-# LAB TEARDOWN
-###############
+# LAB DEPROVISION
+##################
 desc 'De-provision the lab components'
 long_desc <<-EOF
-Attempts to teardown the defined lab components.
+Attempts to deprovision the defined lab components.
 
 The components are torndown in the following order:
 
 Containers -> Networks -> Nodes
 EOF
-command :teardown do |teardown|
-  teardown.action do |global_options,options,args|
-    @testlab.teardown
+command :deprovision do |deprovision|
+  deprovision.action do |global_options,options,args|
+    @testlab.deprovision
   end
 end
 
@@ -126,7 +126,7 @@ Nodes -> Networks -> Containers
 
 TestLab will then attempt to build the components, executing the following tasks for each:
 
-Create -> Up -> Setup
+Create -> Up -> Provision
 EOF
 command :build do |build|
   build.action do |global_options,options,args|
@@ -146,7 +146,7 @@ Containers -> Networks -> Nodes
 
 TestLab will then attempt to demolish the components, executing the following tasks for each:
 
-Teardown -> Down -> Destroy
+Deprovision -> Down -> Destroy
 EOF
 command :demolish do |demolish|
   demolish.action do |global_options,options,args|

data/lib/testlab/container/actions.rb

@@ -19,6 +19,8 @@ class TestLab
           configure
 
           self.lxc.create(*create_args)
+
+          do_provisioner_callbacks(self, :create, @ui)
         end
 
         true
@@ -38,6 +40,8 @@ class TestLab
         please_wait(:ui => @ui, :message => format_object_action(self, 'Destroy', :red)) do
           self.lxc.destroy(%(-f))
           self.lxc_clone.destroy(%(-f))
+
+          do_provisioner_callbacks(self, :destroy, @ui)
         end
 
         true
@@ -65,10 +69,12 @@ class TestLab
           (self.lxc.state != :running) and raise ContainerError, "The container failed to online!"
 
           self.users.each do |user|
-            user.setup
+            user.provision
           end
 
           self.ssh.exec(%(sudo hostname #{self.fqdn}))
+
+          do_provisioner_callbacks(self, :up, @ui)
         end
 
         true
@@ -89,6 +95,8 @@ class TestLab
           self.lxc.stop
 
           (self.lxc.state == :running) and raise ContainerError, "The container failed to offline!"
+
+          do_provisioner_callbacks(self, :down, @ui)
         end
 
         true

data/lib/testlab/container/io.rb

@@ -101,20 +101,33 @@ EOF
       # Duplicates this container under another container definition.
       #
       # @return [Boolean] True if successful.
-      def copy(to_name)
+      def copy(target_name)
         @ui.logger.debug { "Container Copy: #{self.id}" }
 
-        to_container = self.node.containers.select{ |c| c.id.to_sym == to_name.to_sym }.first
-        to_container.nil? and raise ContainerError, "We could not locate the target container!"
+        target_name.nil? and raise ContainerError, "You must supply a destination container!"
 
-        to_container.demolish
-        to_container.create
+        target_container = self.node.containers.select{ |c| c.id.to_sym == target_name.to_sym }.first
+        target_container.nil? and raise ContainerError, "We could not locate the target container!"
 
+        source_state = self.state
+        target_state = target_container.state
+
+        target_container.demolish
+        target_container.create
+
+        self.down
         please_wait(:ui => @ui, :message => format_object_action(self, 'Copy', :yellow)) do
-          self.node.ssh.exec(%(sudo rm -rf #{to_container.lxc.fs_root}))
-          self.node.ssh.exec(%(sudo rsync -a #{self.lxc.fs_root} #{to_container.lxc.container_root}))
+          self.node.ssh.exec(%(sudo rm -rf #{target_container.lxc.fs_root}))
+          self.node.ssh.exec(%(sudo rsync -a #{self.lxc.fs_root} #{target_container.lxc.container_root}))
+          self.node.ssh.exec(%(sudo rm -fv #{File.join(self.lxc.fs_root, '.*provision')}))
         end
 
+        # bring the source container back online if it was running before the copy operation
+        (source_state == :running) and self.up
+
+        # bring the target container back online if it was running before the copy operation
+        (target_state == :running) and target_container.up
+
         true
       end
 

data/lib/testlab/container/lifecycle.rb

@@ -3,53 +3,41 @@ class TestLab
 
     module Lifecycle
 
-      # Setup the container
+      # Provision the container
       #
-      # Attempts to setup the container.  We first create the container, then
-      # attempt to bring it online.  Afterwards the containers provisioner is
-      # called.
+      # Attempts to provision the container.  We first create the container,
+      # then attempt to bring it online.  Afterwards the containers provisioner
+      # is called.
       #
       # @return [Boolean] True if successful.
-      def setup
-        @ui.logger.debug { "Container Setup: #{self.id} " }
+      def provision
+        @ui.logger.debug { "Container Provision: #{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|
-            @ui.logger.info { ">>>>> CONTAINER PROVISIONER SETUP: #{provisioner} (#{self.id}) <<<<<" }
-            p = provisioner.new(self.config, @ui)
-            p.respond_to?(:on_container_setup) and p.on_container_setup(self)
-          end
+        (self.state != :running) and return false
 
+        please_wait(:ui => @ui, :message => format_object_action(self, :provision, :green)) do
+          do_provisioner_callbacks(self, :provision, @ui)
         end
 
         true
       end
 
-      # Teardown the container
+      # Deprovision the container
       #
-      # Attempts to teardown the container.  We first call the provisioner
-      # teardown method defined for the container, if any.  Next we attempt to
-      # offline the container.  Afterwards the container is destroy.
+      # Attempts to deprovision the container.  We first call the provisioner
+      # deprovision method defined for the container, if any.  Next we attempt
+      # to offline the container.  Afterwards the container is destroy.
       #
       # @return [Boolean] True if successful.
-      def teardown
-        @ui.logger.debug { "Container Teardown: #{self.id} " }
+      def deprovision
+        @ui.logger.debug { "Container Deprovision: #{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
-
-          self.container_provisioners.each do |provisioner|
-            @ui.logger.info { ">>>>> CONTAINER PROVISIONER TEARDOWN: #{provisioner} (#{self.id}) <<<<<" }
-            p = provisioner.new(self.config, @ui)
-            p.respond_to?(:on_container_teardown) and p.on_container_teardown(self)
-          end
+        (self.state != :running) and return false
 
+        please_wait(:ui => @ui, :message => format_object_action(self, :deprovision, :red)) do
+          do_provisioner_callbacks(self, :deprovision, @ui)
         end
 
         true
@@ -59,25 +47,20 @@ class TestLab
       def build
         self.create
         self.up
-        self.setup
+        self.provision
 
         true
       end
 
       # Demolish the container
       def demolish
-        self.teardown
+        self.deprovision
         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
-      end
-
     end
 
   end

data/lib/testlab/container/lxc.rb

@@ -17,9 +17,9 @@ class TestLab
       # @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)
+      def bootstrap(content, options={})
         if self.lxc_clone.exists?
-          self.ssh.bootstrap(content)
+          self.ssh.bootstrap(content, options)
         else
           self.lxc.bootstrap(content)
         end

data/lib/testlab/container/status.rb

@@ -14,11 +14,11 @@ class TestLab
 
       # Container CIDR
       #
-      # Returns the CIDR of the container
+      # Returns the CIDR of the container.
       #
       # @return [Integer] The containers CIDR address.
       def cidr
-        TestLab::Utility.cidr(self.primary_interface.address).to_i
+        TestLab::Utility.cidr(self.primary_interface.address)
       end
 
       # Container BIND PTR Record

data/lib/testlab/container.rb

@@ -14,7 +14,8 @@ class TestLab
   #     distro        "ubuntu"
   #     release       "precise"
   #
-  #     user "deployer" do
+  #     user do
+  #       username "deployer"
   #       password "deployer"
   #       uid 2600
   #       gid 2600
@@ -33,7 +34,8 @@ class TestLab
   #     distro        "ubuntu"
   #     release       "precise"
   #
-  #     user "deployer" do
+  #     user do
+  #       username "deployer"
   #       password "deployer"
   #       uid 2600
   #       gid 2600

data/lib/testlab/labfile.rb

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

data/lib/testlab/network/actions.rb

@@ -11,7 +11,27 @@ class TestLab
         (self.state != :not_created) and return false
 
         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)
+          self.node.ssh.bootstrap(<<-EOF, :ignore_exit_status => true)
+set -x
+grep '#{def_tag}' /etc/network/interfaces && exit 0
+cat <<EOI | tee -a /etc/network/interfaces
+#{def_tag}
+auto br0
+iface #{self.bridge} inet static
+      bridge_ports none
+      bridge_stp off
+      bridge_fd 0
+      address #{self.ip}
+      broadcast #{self.broadcast}
+      netmask #{self.netmask}
+#{end_tag}
+EOI
+brctl addbr #{self.bridge}
+brctl stp #{self.bridge} off
+brctl setfd #{self.bridge} 0
+          EOF
+
+          do_provisioner_callbacks(self, :create, @ui)
         end
 
         true
@@ -25,7 +45,13 @@ class TestLab
         (self.state == :not_created) and return false
 
         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)
+          self.node.ssh.bootstrap(<<-EOF, :ignore_exit_status => true)
+set -x
+sed -i '/#{def_tag}/,/#{end_tag}/d' /etc/network/interfaces
+brctl delbr #{self.bridge}
+          EOF
+
+          do_provisioner_callbacks(self, :destroy, @ui)
         end
 
         true
@@ -39,7 +65,12 @@ class TestLab
         (self.state == :running) and return false
 
         please_wait(:ui => @ui, :message => format_object_action(self, 'Up', :green)) do
-          self.node.ssh.exec(%(sudo ifconfig #{self.bridge} #{self.ip} netmask #{self.netmask} up), :silence => true, :ignore_exit_status => true)
+          self.node.ssh.bootstrap(<<-EOF, :ignore_exit_status => true)
+set -x
+ifconfig #{self.bridge} #{self.ip} netmask #{self.netmask} broadcast #{self.broadcast} up
+          EOF
+
+          do_provisioner_callbacks(self, :up, @ui)
         end
 
         true
@@ -53,7 +84,12 @@ class TestLab
         (self.state != :running) and return false
 
         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)
+          self.node.ssh.bootstrap(<<-EOF, :ignore_exit_status => true)
+set -x
+ifconfig #{self.bridge} down
+          EOF
+
+          do_provisioner_callbacks(self, :down, @ui)
         end
 
         true

data/lib/testlab/network/lifecycle.rb

@@ -3,41 +3,29 @@ class TestLab
 
     module Lifecycle
 
-      # Network Setup
-      def setup
-        @ui.logger.debug { "Network Setup: #{self.id} " }
+      # Network Provision
+      def provision
+        @ui.logger.debug { "Network Provision: #{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|
-            @ui.logger.info { ">>>>> NETWORK PROVISIONER SETUP: #{provisioner} (#{self.bridge}) <<<<<" }
-            p = provisioner.new(self.config, @ui)
-            p.respond_to?(:on_network_setup) and p.on_network_setup(self)
-          end
+        (self.state != :running) and return false
 
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Provision', :green)) do
+          do_provisioner_callbacks(self, :provision, @ui)
         end
 
         true
       end
 
-      # Network Teardown
-      def teardown
-        @ui.logger.debug { "Network Teardown: #{self.id} " }
+      # Network Deprovision
+      def deprovision
+        @ui.logger.debug { "Network Deprovision: #{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|
-            @ui.logger.info { ">>>>> NETWORK PROVISIONER TEARDOWN: #{provisioner} (#{self.bridge}) <<<<<" }
-            p = provisioner.new(self.config, @ui)
-            p.respond_to?(:on_network_teardown) and p.on_network_teardown(self)
-          end
+        (self.state != :running) and return false
 
+        please_wait(:ui => @ui, :message => format_object_action(self, 'Deprovision', :red)) do
+          do_provisioner_callbacks(self, :deprovision, @ui)
         end
 
         true
@@ -47,25 +35,20 @@ class TestLab
       def build
         self.create
         self.up
-        self.setup
+        self.provision
 
         true
       end
 
       # Demolish the network
       def demolish
-        self.teardown
+        self.deprovision
         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
-      end
-
     end
 
   end