linux_container 0.1

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1. first version

data/Manifest

@@ -0,0 +1,6 @@
+CHANGELOG
+README.md
+Rakefile
+lib/linux_container.rb
+test/test_all.rb
+Manifest

data/README.md

@@ -0,0 +1,62 @@
+## LinuxContainer gem
+
+This gem is an easy ruby interface to ubuntu linux containers (LXC). It
+provides a convenient wrapper for starting Ubuntu Cloud image-based
+ephemeral containers.
+
+lxc-start-ephemeral uses AUFS overlay filesystem to clone an container using
+very little disk space, which then disappears when shut down.
+
+    $ gem install linux_container
+
+### Create a new container
+
+    > c = LinuxContainer.new(
+        name: 'mycontainer',
+        username: 'ubuntu',            # optional for SSH, defaults to ubuntu
+        ssh_key_path: '~/.ssh/id_rsa'  # optional
+      )
+
+    > c.create(
+        template: 'ubuntu-cloud',  # optional, defaults to ubuntu-cloud
+        hostid:   'i12345',        # optional, autogenerated
+        userdata: 'userdata.txt',  # optional cloud-init user-data script
+        auth-key: '~/.ssh/id_rsa', # optional, defaults to ssh_key_path
+        arch:     'i686',          # optional, defaults to host arch
+        release:  'quantal'        # optional, defaults to host release
+      )
+
+    > c.dir('/tmp')
+      => "/var/lib/lxc/mycontainer/rootfs/tmp"
+
+### Start container and mess around with it
+
+    > c.start
+    > c.state
+    > c.running?  
+    > c.ip
+    > c.wait_for { ip && sshable? }
+    > c.ssh 'uptime'
+    > c.stop
+
+### Start an ephemeral container cloning an existing container
+
+    > e = c.start_ephemeral
+
+
+### Get existing containers
+
+    > LinuxContainer.all
+     => [container, container, container, ... ]
+
+### Force shutdown
+
+    c.destroy '-f'
+
+### other commands
+
+    execute, kill, wait, cgroup, ps, info, freeze, unfreeze, netstat
+
+
+
+ 

data/Rakefile

@@ -0,0 +1,8 @@
+require 'echoe'
+
+Echoe.new("linux_container") do |p|
+  p.author = "Andrew Snow"
+  p.email = 'andrew@modulus.org'
+  p.summary = "Ruby gem for ephemeral LXC linux containers"
+  p.url = "https://github.com/andys/linux_container"
+end

data/lib/linux_container.rb

@@ -0,0 +1,113 @@
+
+require 'timeout'
+require 'shellwords'
+require 'tempfile'
+
+class LinuxContainer
+  attr_accessor :name, :username, :ssh_key_path
+  attr_writer :ip
+
+  def self.all
+    `sudo lxc-ls`.lines.map(&:strip).uniq.map {|cname| new(name: cname) }
+  end
+  
+  def initialize(params={})
+    params.each {|k,v| instance_variable_set "@#{k}", v }
+    @username ||= 'ubuntu'
+  end
+  
+  def state
+    info('-s').chomp.split(':').last.strip
+  end
+  
+  def ip
+    @ip ||= self.class.get_ip_for(name)
+  end
+
+  def create(config={})  # template, hostid, userdata, auth-key, arch, release
+    args = (ssh_key_path ? {'auth-key' => "#{ssh_key_path}.pub"} : {}).merge(config).map {|k, v| "--#{k}=#{v}" }
+    lxc_execute('create', '-t', config.delete(:template) || 'ubuntu-cloud', '--', *args)
+  end
+  
+  [:start, :stop, :destroy, :execute, :kill, :wait, :cgroup, :ps, :info, :freeze, :unfreeze, :netstat].each do |cmd|
+    define_method(cmd) {|*args| lxc_execute(cmd, *args) }
+  end
+
+  def start_ephemeral
+    args = ['lxc-start-ephemeral','-U','aufs','-u',username,'-o',name]
+    logfile = bg_execute(*args)
+    newname = nil
+    while newname.nil?
+      sleep 1
+      logfile.rewind
+      newname = $1 if logfile.read =~ /^(.*) is running/
+     end
+    self.class.new(name: newname, ssh_key_path: ssh_key_path, username: username)
+  end
+
+  def ssh(cmd)
+    raise "cannot ssh without ip" unless ip
+    args = ['-o','StrictHostKeyChecking=no','-o','UserKnownHostsFile=/dev/null']
+    args.push('-i', ssh_key_path) if ssh_key_path
+    args.push("#{username}@#{ip}", cmd)
+    execute('ssh', *args)
+  end 
+
+  def sshable?
+    ssh('true') rescue false
+  end
+  
+  def running?
+    state == 'RUNNING'
+  end
+
+  def dir(subdir=nil)
+    "/var/lib/lxc/#{name}/rootfs/#{subdir}"
+  end
+  
+  def wait_for(timeout=300, interval=1, &block)
+    Timeout.timeout(timeout) do
+      duration = 0
+      start = Time.now
+      until instance_eval(&block) || duration > timeout
+        sleep(interval.to_f)
+        duration = Time.now - start
+      end
+      if duration > timeout
+        false
+      else
+        duration
+      end
+    end
+  end
+  
+#############################################################################
+
+  def lxc_execute(cmd, *args)
+    execute("lxc-#{cmd}", '-n', name, *args)
+  end
+  
+  def execute(*cmd)
+    cmdstring = "sudo #{cmd.shift} #{Shellwords.join(cmd)} "
+    result = `#{cmdstring} 2>&1`
+    raise "command failed: #{cmdstring.inspect}\n#{result}" unless $? == 0
+    result
+  end
+  
+  def bg_execute(*cmd)
+    logfile = Tempfile.new(self.class.to_s)
+    cmdstring = "sudo #{cmd.shift} #{Shellwords.join(cmd)} >>#{logfile.path} 2>>#{logfile.path} &"
+    system(cmdstring)
+    raise "command failed: #{cmdstring.inspect}\n" unless $? == 0
+    logfile
+  end
+
+  def self.get_ip_for(name)
+    File.read('/var/lib/misc/dnsmasq.leases').each_line do |line|
+      (timestamp,macaddr,ip,hostname,misc) = line.split(' ')
+      return ip if hostname == name
+    end
+    nil
+  end
+  
+end

data/linux_container.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "linux_container"
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Snow"]
+  s.date = "2013-02-08"
+  s.description = "Ruby gem for ephemeral LXC linux containers"
+  s.email = "andrew@modulus.org"
+  s.extra_rdoc_files = ["CHANGELOG", "README.md", "lib/linux_container.rb"]
+  s.files = ["CHANGELOG", "README.md", "Rakefile", "lib/linux_container.rb", "test/test_all.rb", "Manifest", "linux_container.gemspec"]
+  s.homepage = "https://github.com/andys/linux_container"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Linux_container", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "linux_container"
+  s.rubygems_version = "1.8.25"
+  s.summary = "Ruby gem for ephemeral LXC linux containers"
+  s.test_files = ["test/test_all.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/test_all.rb

@@ -0,0 +1,48 @@
+require "#{File.dirname(__FILE__)}/../lib/linux_container"
+
+require 'minitest/autorun'
+
+class TestLinuxContainer < MiniTest::Unit::TestCase
+  def self.startup
+    $sshkey = "/tmp/linuxcontainergemtestssh#{$$}"
+    `ssh-keygen -q -t rsa -f #{$sshkey} -N ''` unless File.exists?($sshkey)
+    $c = LinuxContainer.new(name: 'linuxcontainergemtest', ssh_key_path: $sshkey)
+    $c.create
+  end
+
+  def test_state
+    assert_equal 'STOPPED', $c.state
+  end
+
+  def test_running
+    assert_equal false, $c.running?
+  end
+
+  def test_dir
+    assert_equal '/var/lib/lxc/linuxcontainergemtest/rootfs/flibble', $c.dir('flibble')
+  end
+
+  def test_list
+    assert_includes LinuxContainer.all.map(&:name), 'linuxcontainergemtest'
+  end
+
+  def test_ephemeral
+    assert($ec = $c.start_ephemeral)
+    assert_match /^linuxcontainergemtest.+/, $ec.name
+    assert($ec.wait_for { running? }, 'wait_for running?')
+    assert($ec.wait_for { ip }, 'wait_for ip')
+    assert($ec.wait_for { sshable? }, 'wait_for sshable?')
+    assert_equal "hi\n", $ec.execute('echo hi')
+    $ec.stop
+    assert($ec.wait_for { !running? }, 'wait_for !running?')
+  end
+end
+
+
+
+MiniTest::Unit.after_tests do
+    File.unlink($sshkey) rescue nil
+    ($ec.destroy '-f' if $ec) rescue nil
+    $c.destroy '-f'
+  end
+TestLinuxContainer.startup

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: linux_container
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Snow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem for ephemeral LXC linux containers
+email: andrew@modulus.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG
+- README.md
+- lib/linux_container.rb
+files:
+- CHANGELOG
+- README.md
+- Rakefile
+- lib/linux_container.rb
+- test/test_all.rb
+- Manifest
+- linux_container.gemspec
+homepage: https://github.com/andys/linux_container
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Linux_container
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: linux_container
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby gem for ephemeral LXC linux containers
+test_files:
+- test/test_all.rb