testlab 0.6.1 → 0.6.2

data/README.md

@@ -10,6 +10,8 @@ What is TestLab?  TestLab lets you iterate virtual infrastructure quickly.  Usin
 
 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.
 
+# Using TestLab Programmatically
+
 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")
@@ -19,8 +21,172 @@ Accessing TestLab via code is meant to be fairly easy and straightforward.  To g
 
 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`.
 
+There are several easy accessors available to grab the first container and execure the command `uptime` on it via and SSH connection:
+
+    container = @testlab.containers.first
+    container.ssh.exec(%(uptime))
+
+We can also execute this command via `lxc-attach`:
+
+    container.lxc.attach(%(-- uptime))
+
+You can access all the nodes for example:
+
+    @testlab.nodes
+
 For more information see the TestLab Documentation, `testlab-repo`, command-line binary and it never hurts to look at the TestLab source itself.
 
+# Using TestLab Interactively
+
+The TestLab command-line program `tl` follows in the style of git (using the GLI RubyGem).
+
+    $ tl help
+    NAME
+        tl - A framework for building lightweight virtual infrastructure using LXC
+
+    SYNOPSIS
+        tl [global options] command [command options] [arguments...]
+
+    VERSION
+        0.6.1
+
+    GLOBAL OPTIONS
+        --version -
+        --help    - Show this message
+
+    COMMANDS
+        help      - Shows a list of commands or help for one command
+        create    - Create the test lab
+        destroy   - Destroy the test lab
+        up        - Online the test lab
+        down      - Offline the test lab
+        setup     - Setup the test lab infrastructure
+        teardown  - Teardown the test lab infrastructure
+        status    - Display information on the status of the test lab
+        node      - Manage nodes
+        network   - Manage networks
+        container - Manage containers
+
+You stand up your lab with the following command:
+
+    tl setup
+
+You can down the entire lab:
+
+    tl down
+
+You can also destroy it (only works for VM backed providers; this would be a NO-OP on the Local provider for example):
+
+    tl destroy
+
+# Interacting with Containers
+
+You can interact with containers via SSH:
+
+    tl container ssh -i <container ID>
+
+You can pass an optional alternate username and/or identity to use.  By default TestLab will attempt to SSH as the user defined in the `Labfile` for that container, otherwise the default user for the containers distro is used.
+
+    $ tl help container ssh
+    NAME
+        ssh - Open an SSH console to a container
+
+    SYNOPSIS
+        tl [global options] container ssh [command options]
+
+    COMMAND OPTIONS
+        -u, --user=username - Specify an SSH Username to use (default: none)
+        -k, --key=key       - Specify an SSH Identity Key to use (default: none)
+
+You can individually online, offline, create or destroy containers:
+
+    tl container down -i server-www-1
+    tl container up -i server-www-1
+    tl container setup -i server-www-1
+    tl container teardown -i server-www-1
+
+You can recycle a container, effectively destroying then creating it again, provisioning it back to a "pristine" condition.
+
+    tl container recycle -i server-www-1
+
+# Ephemeral Container Cloning
+
+As it stands attempting to iterate infrastructure while developing with Vagrant is a slow and painful process.  Enter LXC and it's ephemeral feature.  The idea here is you have a container that is provisioned to a "pristine" state acording to the `Labfile`.  You then clone this container and run actions against the container.  After running your actions against the container you want to maybe tweak your Chef cookbook and re-run it against the container.  As we all know running an ever changing cookbook in development against the same system over and over again causes drift and problems.  With the cloning you can instantly reinstate the container as it was when you first cloned it.
+
+Here we are cloning the container for the first time.  It takes a bit longer than normal because TestLab is actually shutting down the container so it can be retained as the "pristine" copy of it, and starting up a ephemeral container in its place.  Subsequent calls to clone are very fast.
+
+    $ tl container clone -i server-www-1
+    [TL] TestLab v0.6.1 Loaded
+    [TL] container server-www-1 clone                            # Completed in 13.0116 seconds!
+    $ tl container clone -i server-www-1
+    [TL] TestLab v0.6.1 Loaded
+    [TL] container server-www-1 clone                            # Completed in 0.9169 seconds!
+    $ tl container clone -i server-www-1
+    [TL] TestLab v0.6.1 Loaded
+    [TL] container server-www-1 clone                            # Completed in 1.0794 seconds!
+    $ tl container clone -i server-www-1
+    [TL] TestLab v0.6.1 Loaded
+    [TL] container server-www-1 clone                            # Completed in 1.0281 seconds!
+
+We can also see the containers status reflects that it is a clone currently:
+
+    $ tl container status -i server-www-1
+    [TL] TestLab v0.6.1 Loaded
+    +----------------------------------------------+
+    |       NODE_ID: vagrant                       |
+    |            ID: server-www-1                  |
+    |         CLONE: true                          |
+    |          FQDN: server-www-1.default.zone     |
+    |         STATE: running                       |
+    |        DISTRO: ubuntu                        |
+    |       RELEASE: precise                       |
+    |    INTERFACES: labnet:eth0:10.10.0.21/16     |
+    |  PROVISIONERS: Resolv/AptCacherNG/Apt/Shell  |
+    +----------------------------------------------+
+
+We can easily revert it back to a full container if we want to make changes to it:
+
+    $ tl container up -i server-www-1
+
+We can even recycle it while it is in a cloned state:
+
+    $ tl container recycle -i server-www-1
+
+# Network Routes
+
+TestLab will add network routes for any networks defined in the `Labfile` with the route flag set to true.  This will allow you to directly interact with containers.  Here is an example of the routes added with the multi-network `Labfile`.
+
+    $ tl network route show -i labnet
+    [TL] TestLab v0.6.1 Loaded
+    TestLab routes:
+    10.10.0.0       192.168.33.239  255.255.0.0     UG        0 0          0 vboxnet0
+    10.11.0.0       192.168.33.239  255.255.0.0     UG        0 0          0 vboxnet0
+
+These routes can be manually manipulated as well:
+
+    $ tl help network route
+    NAME
+        route - Manage routes
+
+    SYNOPSIS
+        tl [global options] network route [command options]  add
+        tl [global options] network route [command options]  del
+        tl [global options] network route [command options]  show
+
+    COMMANDS
+        add  - Add routes to lab networks
+        del  - Delete routes to lab networks
+        show - Show routes to lab networks
+
+# Getting Help
+
+TestLab uses the GLI RubyGem, which gives us a command line pattern similar to that of Git.  Therefore help is easy to get:
+
+    tl help
+    tl help node
+    tl help container
+    tl help network
+
 # REQUIREMENTS
 
 * Latest VirtualBox Package

data/lib/testlab/version.rb

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

data/lib/testlab.rb

@@ -169,15 +169,7 @@ class TestLab
   #
   # @return [Boolean] True if successful.
   def up
-    @labfile.nodes.each do |node|
-      node.up
-      node.networks.each do |network|
-        network.up
-      end
-      node.containers.each do |container|
-        container.up
-      end
-    end
+    method_proxy(:up)
 
     true
   end
@@ -189,15 +181,7 @@ class TestLab
   #
   # @return [Boolean] True if successful.
   def down
-    @labfile.nodes.each do |node|
-      node.containers.reverse.each do |container|
-        container.down
-      end
-      node.networks.reverse.each do |network|
-        network.down
-      end
-      node.down
-    end
+    reverse_method_proxy(:down)
 
     true
   end
@@ -209,15 +193,7 @@ class TestLab
   #
   # @return [Boolean] True if successful.
   def setup
-    @labfile.nodes.each do |node|
-      node.setup
-      node.networks.each do |network|
-        network.setup
-      end
-      node.containers.each do |container|
-        container.setup
-      end
-    end
+    method_proxy(:setup)
 
     true
   end
@@ -229,15 +205,7 @@ class TestLab
   #
   # @return [Boolean] True if successful.
   def teardown
-    @labfile.nodes.each do |node|
-      node.containers.reverse.each do |container|
-        container.teardown
-      end
-      node.networks.reverse.each do |network|
-        network.teardown
-      end
-      node.teardown
-    end
+    reverse_method_proxy(:teardown)
 
     true
   end
@@ -249,13 +217,49 @@ class TestLab
   #
   # @return [Boolean] True if successful.
   def node_method_proxy(method_name, *method_args)
-    nodes.map do |node|
+    nodes.each do |node|
       node.send(method_name.to_sym, *method_args)
     end
 
     true
   end
 
+  # Method Proxy
+  #
+  # Iterates all of the lab objects sending the supplied method name and
+  # arguments to each object.
+  #
+  # @return [Boolean] True if successful.
+  def method_proxy(method_name, *method_args)
+    nodes.each do |node|
+      node.send(method_name, *method_args)
+      node.networks.each do |network|
+        network.send(method_name, *method_args)
+      end
+      node.containers.each do |container|
+        container.send(method_name, *method_args)
+      end
+    end
+  end
+
+  # Reverse Method Proxy
+  #
+  # Iterates all of the lab objects sending the supplied method name and
+  # arguments to each object.
+  #
+  # @return [Boolean] True if successful.
+  def reverse_method_proxy(method_name, *method_args)
+    nodes.reverse.each do |node|
+      node.containers.reverse.each do |container|
+        container.send(method_name, *method_args)
+      end
+      node.networks.reverse.each do |network|
+        network.send(method_name, *method_args)
+      end
+      node.send(method_name, *method_args)
+    end
+  end
+
   # TestLab Configuration Directory
   #
   # Returns the path to the test lab configuration directory which is located

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testlab
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -293,7 +293,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -83863336310687853
+      hash: -1071907971600767403
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -302,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -83863336310687853
+      hash: -1071907971600767403
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25