zfs 0.1.0 → 0.1.1

data/README.md

@@ -92,3 +92,13 @@ Uses a Vagrant VM with a custom Ubuntu + ZFS-on-Linux to do all the practical te
 	* http://tomdoc.org/
 * http://www.bolthole.com/solaris/zrep/src/
 * Replace Open4 with Open3#popen3
+
+## Thoughts
+
+ZFS('foo/bar'), using Rush just to execute commands - that seems somewhat excessive, seeing as Open3 oughta do it.
+ - either way, the idea was to avoid spawning shells all the time, but the solution isn't really to keep a shell open.
+ the solution is rather that we do some more caching, IMHO.
+
+Rush - box.zfs('tank/foo').snapshot('snapname')
+       box.zfs('tank/foo').snapshots
+

data/lib/zfs.rb

@@ -2,7 +2,7 @@
 
 require 'pathname'
 require 'date'
-require 'open4'
+require 'open3'
 
 # Get ZFS object.
 def ZFS(path)
@@ -51,27 +51,26 @@ class ZFS
 	def children(opts={})
 		raise NotFound if !exist?
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + %w(list -H -r -oname -tfilesystem)
 		cmd << '-d1' unless opts[:recursive]
 		cmd << name
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
-
-		stdout.shift # self
-		stdout.collect do |filesystem|
-			ZFS(filesystem.chomp)
+		stdout, stderr, status = Open3.capture3(*cmd)
+		if status.success? and stderr == ""
+			stdout.lines.drop(1).collect do |filesystem|
+				ZFS(filesystem.chomp)
+			end
+		else
+			raise Exception, "something went wrong"
 		end
 	end
 
 	# Does the filesystem exist?
 	def exist?
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + %w(list -H -oname) + [name]
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr, ignore_exit_failure: true)
-
-		if stdout == ["#{name}\n"]
+		out, status = Open3.capture2e(*cmd)
+		if status.success? and out == "#{name}\n"
 			true
 		else
 			false
@@ -82,18 +81,18 @@ class ZFS
 	def create(opts={})
 		return nil if exist?
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['create']
 		cmd << '-p' if opts[:parents]
 		cmd += ['-V', opts[:volume]] if opts[:volume]
 		cmd << name
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
-
-		if stdout.empty? and stderr.empty?
+		out, status = Open3.capture2e(*cmd)
+		if status.success? and out.empty?
 			return self
+		elsif out.match(/dataset already exists\n$/)
+			nil
 		else
-			raise Exception, "something went wrong"
+			raise Exception, "something went wrong: #{out}, #{status}"
 		end
 	end
 
@@ -101,14 +100,13 @@ class ZFS
 	def destroy!(opts={})
 		raise NotFound if !exist?
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['destroy']
 		cmd << '-r' if opts[:children]
 		cmd << name
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		out, status = Open3.capture2e(*cmd)
 
-		if stdout.empty? and stderr.empty?
+		if status.success? and out.empty?
 			return true
 		else
 			raise Exception, "something went wrong"
@@ -126,25 +124,23 @@ class ZFS
 	end
 
 	def [](key)
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + %w(get -ovalue -Hp) + [key.to_s, name]
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		stdout, stderr, status = Open3.capture3(*cmd)
 
-		if stderr.empty? and stdout.size == 1
-			return stdout.first.chomp
+		if status.success? and stderr.empty? and stdout.lines.count == 1
+			return stdout.chomp
 		else
 			raise Exception, "something went wrong"
 		end
 	end
 
 	def []=(key, value)
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['set', "#{key.to_s}=#{value}", name]
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		out, status = Open3.capture2e(*cmd)
 
-		if stderr.empty? and stdout.empty?
+		if status.success? and out.empty?
 			return value
 		else
 			raise Exception, "something went wrong"
@@ -157,28 +153,34 @@ class ZFS
 
 		# Get an Array of all pools
 		def pools
-			stdout, stderr = [], []
 			cmd = [ZFS.zpool_path].flatten + %w(list -Honame)
 
-			Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+			stdout, stderr, status = Open3.capture3(*cmd)
 
-			stdout.collect do |pool|
-				ZFS(pool.chomp)
+			if status.success? and stderr.empty?
+				stdout.lines.collect do |pool|
+					ZFS(pool.chomp)
+				end
+			else
+				raise Exception, "something went wrong"
 			end
 		end
 
 		# Get a Hash of all mountpoints and their filesystems
 		def mounts
-			stdout, stderr = [], []
 			cmd = [ZFS.zfs_path].flatten + %w(get -rHp -oname,value mountpoint)
 
-			Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+			stdout, stderr, status = Open3.capture3(*cmd)
 
-			mounts = stdout.collect do |line|
-				fs, path = line.chomp.split(/\t/, 2)
-				[path, ZFS(fs)]
+			if status.success? and stderr.empty?
+				mounts = stdout.lines.collect do |line|
+					fs, path = line.chomp.split(/\t/, 2)
+					[path, ZFS(fs)]
+				end
+				Hash[mounts]
+			else
+				raise Exception, "something went wrong"
 			end
-			Hash[mounts]
 		end
 
 		# Define an attribute
@@ -340,15 +342,14 @@ class ZFS::Snapshot < ZFS
 
 		newname = (parent + "@#{newname}").name
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['rename']
 		cmd << '-r' if opts[:children]
 		cmd << name
 		cmd << newname
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		out, status = Open3.capture2e(*cmd)
 
-		if stdout.empty? and stderr.empty?
+		if status.success? and out.empty?
 			initialize(newname)
 			return self
 		else
@@ -362,15 +363,14 @@ class ZFS::Snapshot < ZFS
 
 		raise AlreadyExists if ZFS(clone).exist?
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['clone']
 		cmd << '-p' if opts[:parents]
 		cmd << name
 		cmd << clone
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		out, status = Open3.capture2e(*cmd)
 
-		if stdout.empty? and stderr.empty?
+		if status.success? and out.empty?
 			return ZFS(clone)
 		else
 			raise Exception, "something went wrong"
@@ -419,8 +419,8 @@ class ZFS::Snapshot < ZFS
 		receive_opts << '-d' if opts[:use_sent_name]
 		receive_opts << dest
 
-		Open4::popen4(*receive_opts) do |rpid, rstdin, rstdout, rstderr|
-			Open4::popen4(*send_opts) do |spid, sstdin, sstdout, sstderr|
+		Open3.popen3(*receive_opts) do |rstdin, rstdout, rstderr, rthr|
+			Open3.popen3(*send_opts) do |sstdin, sstdout, sstderr, sthr|
 				while !sstdout.eof?
 					rstdin.write(sstdout.read(16384))
 				end
@@ -446,15 +446,14 @@ class ZFS::Filesystem < ZFS
 	def rename!(newname, opts={})
 		raise AlreadyExists if ZFS(newname).exist?
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['rename']
 		cmd << '-p' if opts[:parents]
 		cmd << name
 		cmd << newname
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		out, status = Open3.capture2e(*cmd)
 
-		if stdout.empty? and stderr.empty?
+		if status.success? and out.empty?
 			initialize(newname)
 			return self
 		else
@@ -467,14 +466,13 @@ class ZFS::Filesystem < ZFS
 		raise NotFound, "no such filesystem" if !exist?
 		raise AlreadyExists, "#{snapname} exists" if ZFS("#{name}@#{snapname}").exist?
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['snapshot']
 		cmd << '-r' if opts[:children]
 		cmd << "#{name}@#{snapname}"
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		out, status = Open3.capture2e(*cmd)
 
-		if stdout.empty? and stderr.empty?
+		if status.success? and out.empty?
 			return ZFS("#{name}@#{snapname}")
 		else
 			raise Exception, "something went wrong"
@@ -488,10 +486,14 @@ class ZFS::Filesystem < ZFS
 		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + %w(list -H -d1 -r -oname -tsnapshot) + [name]
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		stdout, stderr, status = Open3.capture3(*cmd)
 
-		stdout.collect do |snap|
-			ZFS(snap.chomp)
+		if status.success? and stderr.empty?
+			stdout.lines.collect do |snap|
+				ZFS(snap.chomp)
+			end
+		else
+			raise Exception, "something went wrong"
 		end
 	end
 
@@ -499,12 +501,11 @@ class ZFS::Filesystem < ZFS
 	def promote!
 		raise NotFound, "filesystem is not a clone" if self.origin.nil?
 
-		stdout, stderr = [], []
 		cmd = [ZFS.zfs_path].flatten + ['promote', name]
 
-		Open4::spawn(cmd, stdout: stdout, stderr: stderr)
+		out, status = Open3.capture2e(*cmd)
 
-		if stdout.empty? and stderr.empty?
+		if status.success? and out.empty?
 			return self
 		else
 			raise Exception, "something went wrong"

data/spec/spec_helper.rb

@@ -2,17 +2,17 @@
 $LOAD_PATH.push(File.expand_path('../lib/zfs'))
 
 require 'zfs'
-require 'open4'
+require 'open3'
 
 shared_context "vagrant" do
 	before(:all) do
-		ZFS.zfs_path   = %w(ssh vagrant-zfs sudo zfs)
-		ZFS.zpool_path = %w(ssh vagrant-zfs sudo zpool)
+		ZFS.zfs_path   = %w(ssh vagrant sudo zfs)
+		ZFS.zpool_path = %w(ssh vagrant sudo zpool)
 	end
 
 	after(:all) do
-		Open4::spawn([*ZFS.zfs_path]+['destroy -r tank/foo'], ignore_exit_failure: true)
-		Open4::spawn([*ZFS.zfs_path]+['destroy -r tank/bar'], ignore_exit_failure: true)
+		Open3.capture2e(*(ZFS.zfs_path+%w('destroy -r tank/foo'])))
+		Open3.capture2e(*(ZFS.zfs_path+%w('destroy -r tank/bar')))
 
 		ZFS.zfs_path   = 'zfs'
 		ZFS.zpool_path = 'zpool'

data/zfs.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'rake'
+
+Gem::Specification.new do |s|
+	s.name        = "zfs"
+	s.version     = "0.1.1"
+	s.platform    = Gem::Platform::RUBY
+	s.authors     = %w(kvs)
+	s.email       = %w(kvs@binarysolutions.dk)
+	s.homepage    = "https://github.com/kvs/ruby-zfs"
+	s.summary     = "An library for interacting with ZFS"
+	s.description = %q{Makes it possible to query and manipulate ZFS filesystems, snapshots, etc.}
+
+	s.files            = `git ls-files`.split("\n")
+	s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+	s.executables      = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+	s.require_paths    = ["lib"]
+
+	s.add_development_dependency "rspec", ["~> 2.9.0"]
+	s.add_development_dependency "guard-rspec"
+	s.add_development_dependency "guard-bundler"
+	s.add_development_dependency "rake"
+	s.add_development_dependency "vagrant"
+	s.add_development_dependency "vagrant-proxyssh"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zfs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,18 +13,18 @@ date: 2012-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70251194879920 !ruby/object:Gem::Requirement
+  requirement: &70359894859060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70251194879920
+  version_requirements: *70359894859060
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70251194879320 !ruby/object:Gem::Requirement
+  requirement: &70359894857920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251194879320
+  version_requirements: *70359894857920
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70251194878680 !ruby/object:Gem::Requirement
+  requirement: &70359894856640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251194878680
+  version_requirements: *70359894856640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70251194878160 !ruby/object:Gem::Requirement
+  requirement: &70359894855400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,18 +54,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251194878160
+  version_requirements: *70359894855400
 - !ruby/object:Gem::Dependency
-  name: open4
-  requirement: &70251199214680 !ruby/object:Gem::Requirement
+  name: vagrant
+  requirement: &70359894854060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: *70359894854060
+- !ruby/object:Gem::Dependency
+  name: vagrant-proxyssh
+  requirement: &70359894853300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *70251199214680
+  version_requirements: *70359894853300
 description: Makes it possible to query and manipulate ZFS filesystems, snapshots,
   etc.
 email:
@@ -83,6 +94,7 @@ files:
 - lib/zfs.rb
 - spec/spec_helper.rb
 - spec/zfs_spec.rb
+- zfs.gemspec
 homepage: https://github.com/kvs/ruby-zfs
 licenses: []
 post_install_message: