lxc 0.2.13 → 0.3.0

data/lib/lxc.rb

@@ -14,34 +14,17 @@ class LXC
   autoload :Container, 'lxc/container'
   autoload :Runner,    'lxc/runner'
 
-  # Controls if sudo is prefixed on all executed commands.
+  # The runner we will use to execute all LXC commands.
   #
-  # @overload use_sudo=(value)
-  #   Sets if all executed commands should be prefixed with sudo.
-  #   @param [Boolean] value
+  # @overload runner=(value)
+  #   Sets the runner to use.
+  #   @param [LXC::Runner] value
   #
-  # @overload use_sudo
-  #   Gets if we are prefixing all executed commands with sudo.
+  # @overload runner
+  #   Gets the runner we are using, if any.
   #
-  # @return [Boolean] Returns true if we are prefixing commands with "sudo";
-  #   otherwise false.
-  attr_accessor :use_sudo
-
-  # Controls if executed commands run locally or remotely via a Net::SSH
-  # Session.
-  #
-  # @overload use_ssh=(value)
-  #   Sets if all executed commands should be run locally or remotely.
-  #   To force commands to run locally, assign a value of nil (default).
-  #   To force commands to run remotely, assign a valid, active, Net::SSH
-  #   Session.
-  #
-  # @overload use_ssh
-  #   Gets if we are executing commands locally or remotely.
-  #
-  # @return [Net::SSH::Connection::Session] Returns nil if disabled; otherwise
-  #   returns the assigned Net::SSH Session object.
-  attr_accessor :use_ssh
+  # @return [LXC::Runner] Returns the instance of the runner we are using.
+  attr_accessor :runner
 
   # RegEx pattern for extracting the LXC Version from the "lxc-version" command
   # output.
@@ -54,8 +37,7 @@ class LXC
   #   execute all commands remotely via an SSH connection.
   def initialize(options={})
     @ui       = (options[:ui] || ZTK::UI.new)
-    @use_sudo = (options[:use_sudo] || false)
-    @use_ssh  = (options[:use_ssh] || nil)
+    @runner   = (options[:runner] || LXC::Runner::Shell.new(:ui => @ui))
   end
 
   # LXC configuration class
@@ -157,47 +139,15 @@ class LXC
   # @param [Array] args Additional command-line arguments.
   # @return [Array<String>] Stripped output text of the executed command.
   def exec(*args)
-    command = args.shift
-
-    arguments = Array.new
-    arguments << %(sudo) if (@use_sudo == true)
-    arguments << command
-    arguments << args
-    arguments = arguments.flatten.compact.join(' ')
-
-    output = Array.new
-
-    if @use_ssh.nil?
-      begin
-        ::ZTK::PTY.spawn(arguments) do |reader, writer, pid|
-          while (buffer = reader.readpartial(1024))
-            output << buffer
-          end
-        end
-      rescue EOFError
-        # NOOP
-      end
-    else
-      if @use_ssh.is_a?(ZTK::SSH)
-        output << @use_ssh.exec(arguments, :silence => true, :ignore_exit_status => true).output
-      else
-        if @use_ssh.respond_to?(:exec!)
-          output << @use_ssh.exec!(arguments)
-        else
-          raise LXCError, "The object you assigned to use_ssh does not respond to #exec!"
-        end
-      end
-    end
-
-    output.join.strip
+    @runner.exec(*args)
   end
 
   # Provides a concise string representation of the class
   # @return [String]
   def inspect
     tags = Array.new
-    tags << "use_sudo=#{@use_sudo}" if @use_sudo
-    tags << (@use_ssh.nil? ? "use_ssh=false" : "use_ssh=true")
+    tags << "version=#{self.version.inspect}"
+    tags << "runner=#{@runner.inspect}" if @runner
     tags = tags.join(' ')
 
     "#<LXC #{tags}>"

data/lib/lxc/config.rb

@@ -36,7 +36,7 @@ class LXC
     #
     # @return [Hash] LXC configuration hash.
     def save
-      use_sudo = (@lxc.use_sudo ? 'sudo ' : nil)
+      use_sudo = (@lxc.runner.use_sudo ? 'sudo ' : nil)
 
       script = Array.new
       script << "cat <<EOF | #{use_sudo}tee #{@filename}"

data/lib/lxc/container.rb

@@ -1,5 +1,3 @@
-require 'timeout'
-
 class LXC
 
   # Container Error Class
@@ -9,6 +7,8 @@ class LXC
   #
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Container
+    require 'timeout'
+    require 'tempfile'
 
     # An array containing the valid container states extracted from the LXC
     # c-source code.
@@ -244,6 +244,39 @@ class LXC
       self.exec("lxc-attach", *args)
     end
 
+    # Bootstrap a container
+    #
+    # Renders the supplied text blob inside a container as a script and executes
+    # it via lxc-attach.  The container must already be running.
+    #
+    # @see lxc-attach
+    #
+    # @param [String] content The content to render in 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)
+      output = nil
+
+      ZTK::RescueRetry.try(:tries => 5, :on => ContainerError) do
+        tempfile = Tempfile.new("bootstrap")
+        bootstrap_tempfile = File.join("/", "tmp", File.basename(tempfile.path))
+
+        self.exec(<<-SCRIPT)
+  cat <<-EOF | tee #{bootstrap_tempfile}
+  #{content}
+  EOF
+        SCRIPT
+
+        output = self.lxc.attach(%(-- /bin/bash #{bootstrap_tempfile}))
+
+        if !(output =~ /#{bootstrap_tempfile}: No such file or directory/).nil?
+          raise ContainerError, "We could not find the bootstrap file!"
+        end
+      end
+
+      output
+    end
+
     # Launch a console for the container
     #
     # @see lxc-console

data/lib/lxc/runners/shell.rb

@@ -25,8 +25,8 @@ class LXC
       def initialize(options={})
         @hostname = Socket.gethostname.split('.').first.strip
 
-        @ui       = (options[:ui] || ZTK::UI.new)
-        @use_sudo = (options[:use_sudo] || false)
+        @ui       = (options[:ui]       || ZTK::UI.new)
+        @use_sudo = (options[:use_sudo] || true)
       end
 
       # Linux container command execution wrapper
@@ -62,7 +62,7 @@ class LXC
           # NOOP
         end
 
-        output.join
+        output.join.strip
       end
 
       # Provides a concise string representation of the class

data/lib/lxc/runners/ssh.rb

@@ -0,0 +1,94 @@
+class LXC
+  class Runner
+
+    class SSHError < RunnerError; end
+
+    class SSH
+      require 'socket'
+
+      # Controls if sudo is prefixed on all executed commands.
+      #
+      # @overload use_sudo=(value)
+      #   Sets if all executed commands should be prefixed with sudo.
+      #   @param [Boolean] value
+      #
+      # @overload use_sudo
+      #   Gets if we are prefixing all executed commands with sudo.
+      #
+      # @return [Boolean] Returns true if we are prefixing commands with "sudo";
+      #   otherwise false.
+      attr_accessor :use_sudo
+
+      # @param [Hash] options Options hash.
+      # @option options [Boolean] :use_sudo (false) Whether or not to prefix all
+      #   commands with 'sudo'.
+      def initialize(options={})
+        @ui       = (options[:ui]       || ZTK::UI.new)
+        @use_sudo = (options[:use_sudo] || true)
+        @ssh      = (options[:ssh])
+
+        @ssh.nil? and raise SSHError, "You must supply a ZTK::SSH or Net::SSH instance!"
+      end
+
+      # Linux container command execution wrapper
+      #
+      # Runs the supplied LXC command.  The first element in the "args" splat is the
+      # command to be execute, the rest of the elements are treated as command line
+      # arguments.
+      #
+      # If use_sudo is true then all commands will be prefix with "sudo".
+      # If use_ssh is non-nil then all commands will be execute via the assigned
+      # Net::SSH Session.
+      #
+      # @param [Array] args Additional command-line arguments.
+      # @return [Array<String>] Stripped output text of the executed command.
+      def exec(*args)
+        command = args.shift
+
+        arguments = Array.new
+        arguments << %(sudo) if (@use_sudo == true)
+        arguments << command
+        arguments << args
+        arguments = arguments.flatten.compact.join(' ')
+
+        output = Array.new
+
+        if @ssh.is_a?(ZTK::SSH)
+          output << @ssh.exec(arguments, :silence => true, :ignore_exit_status => true).output
+        else
+          if @ssh.respond_to?(:exec!)
+            output << @ssh.exec!(arguments)
+          else
+            raise SSHError, "The object you assigned to ssh does not respond to #exec!"
+          end
+        end
+
+        output.join.strip
+      end
+
+      # Provides a concise string representation of the class
+      # @return [String]
+      def inspect
+        if @hostname.nil?
+          if @ssh.is_a?(ZTK::SSH)
+            @hostname ||= @ssh.exec(%(hostname -s)).output.strip
+          else
+            if @ssh.respond_to?(:exec!)
+              @hostname ||= @ssh.exec!(%(hostname -s)).strip
+            else
+              raise SSHError, "The object you assigned to ssh does not respond to #exec!"
+            end
+          end
+        end
+
+        tags = Array.new
+        tags << "host=#{@hostname.inspect}"
+        tags << "use_sudo=#{@use_sudo.inspect}"
+        tags = tags.join(' ')
+
+        "#<#{self.class} #{tags}>"
+      end
+
+    end
+  end
+end

data/lib/lxc/version.rb

@@ -2,7 +2,7 @@ class LXC
 
   unless const_defined?(:VERSION)
     # LXC Gem Version
-    VERSION = "0.2.13"
+    VERSION = "0.3.0"
   end
 
 end

data/spec/lxc/config_spec.rb

@@ -24,7 +24,7 @@ describe LXC::Config do
   subject {
     config_file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'support', 'fixtures', 'test-container'))
 
-    @lxc = LXC.new(:use_sudo => true)
+    @lxc = LXC.new
     lxc_config = LXC::Config.new(@lxc, config_file)
     lxc_config.load
 

data/spec/lxc_spec.rb

@@ -29,18 +29,6 @@ describe 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
@@ -195,17 +183,20 @@ describe LXC do
           end
 
           context "against remote host" do
-            before(:each) do
-              @ssh_connection = ::ZTK::SSH.new(
+
+            subject {
+              connection = ::ZTK::SSH.new(
                 :host_name => "127.0.0.1",
                 :user => ENV['USER'],
                 :keys => File.join(ENV['HOME'], '.ssh', 'id_rsa'),
                 :keys_only => true
-              ).ssh
-            end
+              )
+              runner = ::LXC::Runner::SSH.new(:ssh => connection.ssh)
+
+              LXC.new(:runner => runner)
+            }
 
             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']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lxc
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ztk
@@ -163,6 +163,7 @@ files:
 - lib/lxc/container.rb
 - lib/lxc/runner.rb
 - lib/lxc/runners/shell.rb
+- lib/lxc/runners/ssh.rb
 - lib/lxc/version.rb
 - lxc.gemspec
 - spec/lxc/config_spec.rb
@@ -216,18 +217,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2981418491518284885
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2981418491518284885
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25