schroot 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 386cca6227e48646b9b8fdfddc2460f554e91ce3
-  data.tar.gz: ce78042ae3f8533cc7f4544471a7b7b23e742391
+  metadata.gz: 1cbd1e243c8faebe108938506ba91250bcda4a47
+  data.tar.gz: 95a0de9e53b9e1fbc5fe1fd8a5aa390044f02721
 SHA512:
-  metadata.gz: 52a6f1a2e3a437dbcb0561f48a00e20da570aec93ad3b0abe3b4063759807cfa15549e379038ebe1d368e51a27fa7863ff868e7b37c86df6d5d8ce5807cc6e79
-  data.tar.gz: ff1c07b323dc5f10ee658be82d4d96ba86795b7b96b76e040fbb1e784c97fedef88fe587ab5d36f66c41f3b73dee57735b26905bba770e9875935e82168a7e20
+  metadata.gz: 19ec77eef2486c3c77704cd1edc62df255dabcceb2169946a98524ab23a72d650dd1c181facf3caf82ca9762aa9b22e9e15d77c33fff8651c5e2df9b7dfa405f
+  data.tar.gz: e983818aa490af8ff537aa15949fc3fb127fbeb4fb2df328f0ac32e4db2970d8eec2ea1a163141456a854d69a17a52d0b81081c32e162c7e046a522687b9db96

data/README.md

@@ -0,0 +1,49 @@
+ruby-schroot
+============
+
+Ruby bindings for debian schroot
+
+What is it?
+--------
+It's a gem which allows to create `schroot` sessions and execute commands in the chroot environment from ruby code.
+Currently it just calls schroot binaries.
+Ability to manage chroots (eg create) is coming soon.
+
+Usage
+-------
+Library requires installed chroot binary. All chroots u want to use should be configured in `/etc/schroot/schroot.conf` or `/etc/schroot/conf.d/`.
+
+Little example:
+
+    [sid]
+    type=directory
+    description=Debian sid (unstable)
+    union-type=aufs
+    directory=/srv/chroot/sid
+    users=dan
+    groups=dan
+    root-groups=root
+    aliases=unstable,default
+
+Library installation is pretty simple:
+
+     $ rake
+     $ gem install ./*.gem
+     
+or just
+
+     $ rake install
+     
+Examples
+------
+     
+```ruby
+irb(main):005:0> require 'schroot'
+=> true
+irb(main):006:0> my_session = Schroot.new('sid')
+=> #<Schroot:0x8ba789c @chroot="sid", @session="sid-19131ba0-84ba-42e5-a2fb-d2d375d61750", @location="/var/lib/schroot/mount/sid-19131ba0-84ba-42e5-a2fb-d2d375d61750">
+irb(main):007:0> stdin, stdout, stderr = my_session.run("echo Hello, World!")
+=> [#<IO:fd 22>, #<IO:fd 24>, #<IO:fd 26>]
+irb(main):008:0> stdout.gets
+=> "Hello, World!\n"
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+task :build => :test do
+  system "gem build schroot.gemspec"
+end
+
+task :install => :build do
+  system "sudo gem install schroot-*.gem"
+end
+
+task :default => :build

data/lib/schroot.rb

@@ -5,6 +5,7 @@ SCHROOT_BASE="/var/lib/schroot"
 class SchrootError < StandardError
 end
 
+# Schroot session handler
 class Schroot
   def initialize(chroot_name = 'default')
     start(chroot_name)
@@ -33,15 +34,31 @@ class Schroot
     return command.join(" ")
   end
 
+  # Runs command inside of chroot session.
+  # Session must be started before.
+  #
+  # @example
+  #   session.run("ping localhost",{:user => 'rainbowdash',:preserve_environment => true})
+  #     => [#<IO:fd 16>, #<IO:fd 18>, #<IO:fd 20>]
+  # @param cmd [String] command to run
+  # @param kwargs [Hash] extra args
+  # @return [Array<(IO:fd, IO:fd, IO:fd)>] descriptors for stdin, stdout, stderr
   def run(cmd, kwargs = {})
     return safe_run(command(cmd,kwargs))
-    # TBD
   end
 
+  # Clones current session
+  #
+  # @return [Object] new session object
   def clone
     return Schroot.new(@chroot)
   end
 
+  # Starts the session of `chroot_name` chroot
+  #
+  # @param chroot_name [String] name of configured chroot
+  # @return [String] schroot session id
+  # A string representing schroot session id.
   def start(chroot_name = 'default')
     stop if @session
     command = ['schroot', '-b', '-c', chroot_name]
@@ -54,10 +71,14 @@ class Schroot
     return @session
   end
 
+  # Stops current chroot session.
+  #
+  # @param chroot_name [String] name of configured chroot
+  # @return [nil] session_id of killed session (should be nil)
   def stop
     stdin, stdout, stderr = safe_run("schroot -e -c %s" % @session)
-    @session = nil
     @location = nil
+    @session = nil
   end
 
   private :safe_run, :command

data/test/test_schroot.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'schroot'
+
+class SchrootTest < Test::Unit::TestCase
+  def test_start
+    test = Schroot.new('default')
+    print_debug(test,:test)
+
+    assert_not_nil test.session
+    assert_not_nil test.chroot
+    assert_not_nil test.location
+
+    test_clone = test.clone
+    print_debug(test_clone,:test_clone)
+
+    assert_not_nil test_clone.session
+    assert_not_nil test_clone.chroot
+    assert_not_nil test_clone.location
+
+    assert_not_equal test.session, test_clone.session
+    assert_not_equal test.session, test_clone.location
+    assert_equal test.chroot, test_clone.chroot
+
+    test.stop
+    print_debug(test,:stopped)
+
+    test = Schroot.new
+    assert_equal test.run("echo -n 123")[1].gets, "123"
+    assert_equal test.run("echo 123")[1].gets, "123\n"
+  end
+
+  def print_debug(schroot,name = 'chroot')
+    print "\n#{name}_session = %s\n" % schroot.session
+    print "#{name}_chroot = %s\n" % schroot.chroot
+    print "#{name}_location = %s\n" % schroot.location
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schroot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniil Guzanov
@@ -17,6 +17,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/schroot.rb
+- test/test_schroot.rb
+- README.md
+- Rakefile
 homepage: http://rubygems.org/gems/schroot
 licenses:
 - WTFPL
@@ -41,4 +44,5 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Schroot bindings
-test_files: []
+test_files:
+- test/test_schroot.rb