lxc 0.0.1 → 0.0.2

data/lib/lxc/container.rb

@@ -0,0 +1,193 @@
+class LXC
+  class ContainerError < Error; end
+
+  class Container
+
+    # An array containing the valid container states extracted from the LXC
+    # c-source code.
+    STATES = %w(stopped starting running stopping aborting freezing frozen thawed)
+
+    # @!method stopped?
+    #   Returns true if the container is stopped, false otherwise.
+    #   @return [Boolean]
+    #
+    # @!method starting?
+    #   Returns true if the container is starting, false otherwise.
+    #   @return [Boolean]
+    #
+    # @!method running?
+    #   Returns true if the container is running, false otherwise.
+    #   @return [Boolean]
+    #
+    # @!method stopping?
+    #   Returns true if the container is stopping, false otherwise.
+    #   @return [Boolean]
+    #
+    # @!method aborting?
+    #   Returns true if the container is aborting, false otherwise.
+    #   @return [Boolean]
+    #
+    # @!method freezing?
+    #   Returns true if the container is freezing, false otherwise.
+    #   @return [Boolean]
+    #
+    # @!method frozen?
+    #   Returns true if the container is frozen, false otherwise.
+    #   @return [Boolean]
+    #
+    # @!method thawed?
+    #   Returns true if the container is thawed, false otherwise.
+    #   @return [Boolean]
+    STATES.each do |state|
+      define_method "#{state.downcase}?" do
+        (self.state == state.downcase.to_sym)
+      end
+    end
+
+    # RegEx pattern for extracting the container state from the "lxc-info"
+    # command output.
+    REGEX_STATE = /^state:\s+([\w]+)$/
+
+    # RegEx pattern for extracting the container PID from the "lxc-info"
+    # command output.
+    REGEX_PID = /^pid:\s+([\d]+)$/
+
+    # Returns the container name
+    #
+    # @return [String] Container name
+    attr_reader :name
+
+    def initialize(lxc, name)
+      raise ContainerError, "You must supply a LXC object!" if lxc.nil?
+      raise ContainerError, "You must supply a container name!" if (name.nil? || name.empty?)
+
+      @lxc  = lxc
+      @name = name
+    end
+
+    # Start the container
+    #
+    # Runs the "lxc-start" command with the "--daemon" flag.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Symbol] The state of the container.
+    def start(*args)
+      self.exec("start", "--daemon", *args)
+      self.state
+    end
+
+    # Stop the container
+    #
+    # Runs the "lxc-stop" command.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Symbol] The state of the container.
+    def stop(*args)
+      self.exec("stop", *args)
+      self.state
+    end
+
+    # Restart the container
+    def restart(options={})
+      self.stop
+      self.start
+    end
+    alias :reload :restart
+
+    # Freeze the container
+    #
+    # Runs the "lxc-freeze" command.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Symbol] The state of the container.
+    def freeze(*args)
+      self.exec("freeze", *args)
+      self.state
+    end
+
+    # Unfreeze (thaw) the container
+    #
+    # Runs the "lxc-unfreeze" command.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Symbol] The state of the container.
+    def unfreeze(*args)
+      self.exec("unfreeze", *args)
+      self.state
+    end
+
+    # Information on the container
+    #
+    # Runs the "lxc-info" command.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Array] Lines of output from the executed command.
+    def info(*args)
+      self.exec("info", *args).split("\n").uniq.flatten
+    end
+
+    # State of the container
+    #
+    # Runs the "lxc-info" command with the "--state" flag.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Symbol] Current state of the container.
+    def state(*args)
+      result = self.info("--state", *args).collect{ |str| str.scan(REGEX_STATE) }
+      result.flatten!.compact!
+
+      result.first.strip.downcase.to_sym
+    end
+
+    # PID of the container
+    #
+    # Runs the "lxc-info" command with the "--pid" flag.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Integer] Current PID of the container.
+    def pid(*args)
+      result = self.info("--pid", *args).collect{ |str| str.scan(REGEX_PID) }
+      result.flatten!.compact!
+
+      result.first.strip.to_i
+    end
+
+    # Does the container exist?
+    #
+    # @return [Boolean] Returns true if the container exists, false otherwise.
+    def exists?
+      @lxc.exists?(self.name)
+    end
+
+    # Linux container command execution wrapper
+    #
+    # Executes the supplied command by injecting the container name into the
+    # argument list and then passes to the arguments to the top-level LXC class
+    # exec method.
+    #
+    # @param [Array] args Additional command-line arguments.
+    # @return [Array<String>] Stripped output text of the executed command.
+    #
+    # @see LXC#exec
+    def exec(*args)
+      arguments = Array.new
+      arguments << args.shift
+      arguments << "--name=#{self.name}"
+      arguments << args
+      arguments.flatten!.compact!
+
+      @lxc.exec(*arguments)
+    end
+
+    # Provides a concise string representation of the class
+    # @return [String]
+    def inspect
+      tags = Array.new
+      tags << "name=#{self.name.inspect}"
+      tags = tags.join(' ')
+
+      "#<LXC::Container #{tags}>"
+    end
+
+  end
+end

data/lib/lxc/version.rb

@@ -1,3 +1,3 @@
-module Lxc
-  VERSION = "0.0.1" unless const_defined?(:VERSION)
+class LXC
+  VERSION = "0.0.2" unless const_defined?(:VERSION)
 end

data/lxc.gemspec

@@ -1,17 +1,30 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/lxc/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lxc/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Zachary Patten"]
-  gem.email         = ["zachary@jovelabs.com"]
-  gem.description   = %q{Gem for controlling local or remote Linux Containers (LXC)}
-  gem.summary       = %q{Gem for controlling local or remote Linux Containers (LXC)}
-  gem.homepage      = "https://github.com/zpatten/lxc"
+Gem::Specification.new do |spec|
+  spec.name          = "lxc"
+  spec.version       = LXC::VERSION
+  spec.authors       = ["Zachary Patten"]
+  spec.email         = ["zachary@jovelabs.com"]
+  spec.description   = %q(An interface for controlling local or remote Linux Containers (LXC))
+  spec.summary       = %q(An interface for controlling local or remote Linux Containers (LXC))
+  spec.homepage      = "https://github.com/zpatten/lxc"
+  spec.license       = "Apache 2.0"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "lxc"
-  gem.require_paths = ["lib"]
-  gem.version       = Lxc::VERSION
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("ztk")
+
+  spec.add_development_dependency("bundler", "~> 1.3")
+  spec.add_development_dependency("pry")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("redcarpet")
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency("simplecov")
+  spec.add_development_dependency("yard")
 end

data/spec/fixtures/0.7.5/lxc-checkconfig.out

@@ -0,0 +1,28 @@
+Kernel config /proc/config.gz not found, looking in other places...
+Found kernel config file /boot/config-3.2.0-23-generic
+--- Namespaces ---
+Namespaces: enabled
+Utsname namespace: enabled
+Ipc namespace: enabled
+Pid namespace: enabled
+User namespace: enabled
+Network namespace: enabled
+Multiple /dev/pts instances: enabled
+
+--- Control groups ---
+Cgroup: enabled
+Cgroup clone_children flag: enabled
+Cgroup device: enabled
+Cgroup sched: enabled
+Cgroup cpu account: enabled
+Cgroup memory controller: enabled
+Cgroup cpuset: enabled
+
+--- Misc ---
+Veth pair device: enabled
+Macvlan: enabled
+Vlan: enabled
+File capabilities: enabled
+
+Note : Before booting a new kernel, you can check its configuration
+usage : CONFIG=/path/to/config /usr/bin/lxc-checkconfig

data/spec/fixtures/0.7.5/lxc-ls-w-containers.out

@@ -0,0 +1,2 @@
+devop-test-1
+devop-test-1

data/spec/fixtures/0.7.5/lxc-ps.out

@@ -0,0 +1,4 @@
+CONTAINER    PID TTY          TIME CMD
+           11848 pts/7    00:00:00 lxc-ps
+           11849 pts/7    00:00:00 ps
+           32105 pts/7    00:00:01 bash

data/spec/fixtures/0.7.5/lxc-version.out

@@ -0,0 +1 @@
+lxc version: 0.7.5

data/spec/fixtures/0.8.0-rc2/lxc-checkconfig.out

@@ -0,0 +1,28 @@
+Kernel config /proc/config.gz not found, looking in other places...
+Found kernel config file /boot/config-2.6.32-358.2.1.el6.centos.plus.x86_64
+--- Namespaces ---
+Namespaces: enabled
+Utsname namespace: enabled
+Ipc namespace: enabled
+Pid namespace: enabled
+User namespace: enabled
+Network namespace: enabled
+Multiple /dev/pts instances: enabled
+
+--- Control groups ---
+Cgroup: enabled
+Cgroup namespace: enabled
+Cgroup device: enabled
+Cgroup sched: enabled
+Cgroup cpu account: enabled
+Cgroup memory controller: enabled
+Cgroup cpuset: enabled
+
+--- Misc ---
+Veth pair device: enabled
+Macvlan: enabled
+Vlan: enabled
+File capabilities: enabled
+
+Note : Before booting a new kernel, you can check its configuration
+usage : CONFIG=/path/to/config /usr/bin/lxc-checkconfig

data/spec/fixtures/0.8.0-rc2/lxc-ls-w-containers.out

@@ -0,0 +1,2 @@
+devop-test-1
+devop-test-1

data/spec/fixtures/0.8.0-rc2/lxc-ps.out

@@ -0,0 +1,4 @@
+CONTAINER    PID TTY          TIME CMD
+           11848 pts/7    00:00:00 lxc-ps
+           11849 pts/7    00:00:00 ps
+           32105 pts/7    00:00:01 bash

data/spec/fixtures/0.8.0-rc2/lxc-version.out

@@ -0,0 +1 @@
+lxc version: 0.8.0-rc2

data/spec/lxc_spec.rb

@@ -0,0 +1,193 @@
+require "spec_helper"
+
+describe LXC do
+
+  subject { LXC.new }
+
+  describe "class" do
+
+    it "should be an instance of LXC" do
+      subject.should be_an_instance_of LXC
+    end
+
+    describe "defaults" do
+
+      it "should have use_sudo set to false" do
+        subject.use_sudo.should == false
+      end
+
+      it "should have use_ssh set to nil" do
+        subject.use_ssh.should == nil
+      end
+
+    end
+
+  end
+
+  describe "methods" do
+
+    LXC_VERSIONS.each do |lxc_version|
+
+      context "LXC Target Version #{lxc_version}" do
+
+        describe "ls" do
+
+          context "with containers" do
+
+            it "should return an array of strings populated with container names" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-w-containers.out") }
+
+              subject.ls.should be_kind_of(Array)
+              subject.ls.should_not be_empty
+              subject.ls.size.should eq(1)
+            end
+
+          end
+
+          context "without containers" do
+
+            it "should return an empty array" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-wo-containers.out") }
+
+              subject.ls.should be_kind_of(Array)
+              subject.ls.should be_empty
+              subject.ls.size.should eq(0)
+            end
+
+          end
+
+        end
+
+        describe "exists?" do
+
+          context "with containers" do
+
+            it "should return false if the container does not exist" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-w-containers.out") }
+              subject.exists?("abc-123-test-container-name").should == false
+            end
+
+            it "should return true if the container does exist" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-w-containers.out") }
+              subject.exists?("devop-test-1").should == true
+            end
+
+          end
+
+          context "without containers" do
+
+            it "should return false if the container does not exist" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-wo-containers.out") }
+              subject.exists?("abc-123-test-container-name").should == false
+            end
+
+            it "should return false if the container does not exist" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-wo-containers.out") }
+              subject.exists?("devop-test-1").should == false
+            end
+
+          end
+
+        end
+
+        describe "ps" do
+          it "should return an array of strings representing the lxc process list" do
+            subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ps.out") }
+
+            subject.ps.should be_kind_of(Array)
+            subject.ps.should_not be_empty
+          end
+        end
+
+        describe "version" do
+          it "should return a string representation of the installed LXC version" do
+            subject.stub(:exec) { lxc_fixture(lxc_version, 'lxc-version.out') }
+
+            subject.version.should be_kind_of(String)
+            subject.version.should_not be_empty
+            subject.version.should == lxc_version
+          end
+        end
+
+        describe "checkconfig" do
+          it "should return an array of strings representing the LXC configuration" do
+            subject.stub(:exec) { lxc_fixture(lxc_version, 'lxc-checkconfig.out') }
+
+            subject.checkconfig.should be_kind_of(Array)
+            subject.checkconfig.should_not be_empty
+
+            subject.checkconfig.first.should be_kind_of(String)
+            subject.checkconfig.first.should_not be_empty
+          end
+        end
+
+        describe "container" do
+          it "should return a container object for the requested container" do
+            result = subject.container("devop-test-1")
+            result.should be_an_instance_of(::LXC::Container)
+          end
+        end
+
+        describe "containers" do
+
+          context "with containers" do
+            it "should return an array of container objects" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-w-containers.out") }
+
+              subject.containers.should be_kind_of(Array)
+              subject.containers.size.should eq(1)
+            end
+          end
+
+          context "without containers" do
+            it "should return an empty array" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-ls-wo-containers.out") }
+
+              subject.containers.should be_kind_of(Array)
+              subject.containers.size.should eq(0)
+            end
+          end
+
+        end
+
+        describe "inspect" do
+          it "should return an information string about our class instance" do
+            subject.inspect.should be_kind_of(String)
+            subject.inspect.length.should be > 0
+          end
+        end
+
+        describe "exec" do
+
+          context "against local host" do
+            it "should exec the supplied LXC command" do
+              subject.stub(:exec) { lxc_fixture(lxc_version, "lxc-version.out") }
+
+              subject.exec("version").should be_kind_of(String)
+            end
+          end
+
+          context "against remote host" do
+            before(:each) do
+              @ssh_connection = ::ZTK::SSH.new(
+                :host_name => "127.0.0.1",
+                :user => ENV['USER'],
+                :keys => "#{ENV['HOME']}/.ssh/id_rsa"
+              ).ssh
+            end
+
+            it "should exec the supplied LXC command" do
+              subject.use_ssh = @ssh_connection
+              subject.exec("version").should be_kind_of(String)
+            end
+          end if !ENV['CI'] && !ENV['TRAVIS']
+
+        end
+
+      end # LXC Version Context
+
+    end # LXC_VERSIONS
+
+  end
+
+end