testlab 0.0.1 → 0.0.2

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*log

data/.rspec

@@ -0,0 +1 @@
+-c -b -fd

data/.ruby-gemset

@@ -0,0 +1 @@
+testlab

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+
+notifications:
+  irc: "irc.freenode.net#jovelabs"

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in testlab.gemspec
+gem 'coveralls', :require => false
+
 gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,29 +1,43 @@
+[![Gem Version](https://badge.fury.io/rb/testlab.png)](http://badge.fury.io/rb/testlab)
+[![Dependency Status](https://gemnasium.com/zpatten/testlab.png)](https://gemnasium.com/zpatten/testlab)
+[![Build Status](https://secure.travis-ci.org/zpatten/testlab.png)](http://travis-ci.org/zpatten/testlab)
+[![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)
+
 # TestLab
 
-TODO: Write a gem description
+A framework for building lightweight virtual laboratories using LXC
+
+# RESOURCES
+
+Source:
 
-## Installation
+* https://github.com/zpatten/testlab
 
-Add this line to your application's Gemfile:
+Issues:
 
-    gem 'testlab'
+* https://github.com/zpatten/testlab/issues
 
-And then execute:
+Documentation:
 
-    $ bundle
+* http://zpatten.github.com/testlab/
 
-Or install it yourself as:
+# LICENSE
 
-    $ gem install testlab
+TestLab - A framework for building lightweight virtual laboratories using LXC
 
-## Usage
+* Author: Zachary Patten <zachary@jovelabs.com> [![endorse](http://api.coderwall.com/zpatten/endorsecount.png)](http://coderwall.com/zpatten)
+* Copyright: Copyright (c) Zachary Patten
+* License: Apache License, Version 2.0
 
-TODO: Write usage instructions here
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-## Contributing
+    http://www.apache.org/licenses/LICENSE-2.0
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -1 +1,75 @@
-require "bundler/gem_tasks"
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   Copyright: Copyright (c) Zachary Patten
+#     License: Apache License, Version 2.0
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+################################################################################
+
+require 'bundler/gem_tasks'
+
+################################################################################
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => [:spec]
+task :test => [:spec]
+
+################################################################################
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :coveralls => [:spec, 'coveralls:push']
+
+################################################################################
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+GEM_NAME = File.basename(Dir.pwd)
+DOC_PATH = File.expand_path(File.join("..", "/", "#{GEM_NAME}.doc"))
+
+namespace :doc do
+  YARD::Rake::YardocTask.new(:pages) do |t|
+
+    # t.files = ['lib/**/*.rb']
+    t.options = ['--verbose', '-o', DOC_PATH]
+  end
+
+  namespace :pages do
+
+    desc 'Generate and publish YARD Documentation to GitHub pages'
+    task :publish => ['doc:pages'] do
+      describe = %x(git describe).chomp
+      stats = %x(bundle exec yard stats).chomp
+
+      commit_message = Array.new
+      commit_message << "Generated YARD Documentation for #{GEM_NAME.upcase} #{describe}\n\n"
+      commit_message << stats
+
+      Dir.chdir(DOC_PATH) do
+        puts(%x{git add -Av})
+        puts(%x{git commit -m"#{commit_message.join}"})
+        puts(%x{git push origin gh-pages})
+      end
+    end
+
+  end
+
+end
+desc 'Alias to doc:yard'
+task 'doc' => 'doc:yard'
+
+################################################################################

data/bin/testlab-console

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

data/lib/testlab/container.rb

@@ -0,0 +1,218 @@
+class TestLab
+
+  # Container Error Class
+  class ContainerError < TestLabError; end
+
+  # Container Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class Container < ZTK::DSL::Base
+    STATUS_KEYS   = %w(node_id id state distro release interfaces provisioner).map(&:to_sym)
+
+    belongs_to  :node,        :class_name => 'TestLab::Node'
+
+    attribute   :provisioner
+    attribute   :config
+
+    attribute   :interfaces
+
+    attribute   :distro
+    attribute   :release
+    attribute   :arch
+
+    attribute   :persist
+
+    def initialize(*args)
+      super(*args)
+
+      @ui          = TestLab.ui
+      @provisioner = self.provisioner.new(self.config) if !self.provisioner.nil?
+    end
+
+    def status
+      interfaces = self.interfaces.collect{ |key, value| "#{key}:#{value[:name]}:#{value[:ip]}" }.join(', ')
+
+      {
+        :id => self.id,
+        :state => self.state,
+        :distro => self.distro,
+        :release => self.release,
+        :interfaces => interfaces,
+        :provisioner => self.provisioner,
+        :node_id => self.node.id
+      }
+    end
+
+    # Our LXC Container class
+    def lxc
+      @lxc ||= self.node.lxc.container(self.id)
+    end
+
+    # Create the container
+    def create
+      @ui.logger.debug { "Container Create: #{self.id} " }
+
+      self.arch ||= detect_arch
+
+      self.lxc.config.clear
+
+      self.lxc.config['lxc.utsname'] = self.id
+
+      self.interfaces.each do |network, network_config|
+        n = Hash.new
+        n['lxc.network.type']         = :veth
+        n['lxc.network.flags']        = :up
+        n['lxc.network.link']         = TestLab::Network.first(network).bridge
+        n['lxc.network.name']         = (network_config[:name] || "eth0")
+        n['lxc.network.hwaddr']       = (network_config[:mac] || generate_mac)
+        n['lxc.network.ipv4']         = (network_config[:ip] || generate_ip)
+        self.lxc.config.networks << n
+      end
+
+      self.lxc.config.save
+
+      self.lxc.create(*create_args)
+    end
+
+    # Destroy the container
+    def destroy
+      @ui.logger.debug { "Container Destroy: #{self.id} " }
+
+      self.lxc.destroy
+    end
+
+    # Start the container
+    def up
+      @ui.logger.debug { "Container Up: #{self.id} " }
+
+      self.lxc.start
+    end
+
+    # Stop the container
+    def down
+      @ui.logger.debug { "Container Down: #{self.id} " }
+
+      self.lxc.stop
+    end
+
+    # Reload the container
+    def reload
+      @ui.logger.debug { "Container Reload: #{self.id} " }
+
+      self.down
+      self.up
+    end
+
+    # Does the container exist?
+    def exists?
+      @ui.logger.debug { "Container Exists?: #{self.id} " }
+
+      self.lxc.exists?
+    end
+
+    # State of the container
+    def state
+      self.lxc.state
+    end
+
+################################################################################
+
+    # Container Callback: after_create
+    def after_create
+      @ui.logger.debug { "Container Callback: After Create: #{self.id} " }
+    end
+
+    # Container Callback: after_up
+    def after_up
+      @ui.logger.debug { "Container Callback: After Up: #{self.id} " }
+
+      self.create
+      self.up
+    end
+
+    # Container Callback: before_down
+    def before_down
+      @ui.logger.debug { "Container Callback: Before Down: #{self.id} " }
+
+      self.down
+      self.destroy
+    end
+
+    # Container Callback: before_destroy
+    def before_destroy
+      @ui.logger.debug { "Container Callback: Before Destroy: #{self.id} " }
+    end
+
+################################################################################
+
+    # Method missing handler
+    def method_missing(method_name, *method_args)
+      @ui.logger.debug { "CONTAINER METHOD MISSING: #{method_name.inspect}(#{method_args.inspect})" }
+
+      if (defined?(@provisioner) && @provisioner.respond_to?(method_name))
+        @provisioner.send(method_name, [self, *method_args].flatten)
+      else
+        super(method_name, *method_args)
+      end
+    end
+
+################################################################################
+  private
+################################################################################
+
+    # Returns arguments for lxc-create based on our distro
+    def create_args
+      case self.distro.downcase
+      when "ubuntu" then
+        %W(-f /etc/lxc/#{self.id} -t #{self.distro} -- --release #{self.release} --arch #{arch})
+      when "fedora" then
+        %W(-f /etc/lxc/#{self.id} -t #{self.distro} -- --release #{self.release})
+      end
+    end
+
+    # Attempt to detect the architecture of the node our container is running on
+    def detect_arch
+      case self.distro.downcase
+      when "ubuntu" then
+        ((self.node.arch =~ /x86_64/) ? "amd64" : "i386")
+      when "fedora" then
+        ((self.node.arch =~ /x86_64/) ? "amd64" : "i686")
+      end
+    end
+
+    def generate_ip
+      octets = [ 192..192,
+                 168..168,
+                 0..254,
+                 1..254 ]
+      ip = Array.new
+      for x in 1..4 do
+        ip << octets[x-1].to_a[rand(octets[x-1].count)].to_s
+      end
+      ip.join(".")
+    end
+
+    def generate_mac
+      digits = [ %w(0),
+                 %w(0),
+                 %w(0),
+                 %w(0),
+                 %w(5),
+                 %w(e),
+                 %w(0 1 2 3 4 5 6 7 8 9 a b c d e f),
+                 %w(0 1 2 3 4 5 6 7 8 9 a b c d e f),
+                 %w(5 6 7 8 9 a b c d e f),
+                 %w(3 4 5 6 7 8 9 a b c d e f),
+                 %w(0 1 2 3 4 5 6 7 8 9 a b c d e f),
+                 %w(0 1 2 3 4 5 6 7 8 9 a b c d e f) ]
+      mac = ""
+      for x in 1..12 do
+        mac += digits[x-1][rand(digits[x-1].count)]
+        mac += ":" if (x.modulo(2) == 0) && (x != 12)
+      end
+      mac
+    end
+
+  end
+
+end

data/lib/testlab/labfile.rb

@@ -0,0 +1,15 @@
+class TestLab
+
+  # Labfile Error Class
+  class LabfileError < TestLabError; end
+
+  # Labfile Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class Labfile < ZTK::DSL::Base
+    has_many    :nodes,       :class_name => 'TestLab::Node'
+
+    attribute   :config
+  end
+
+end