qfs 0.0.13

data/lib/qfs/version.rb

@@ -0,0 +1,3 @@
+module Qfs
+  VERSION = '0.0.13'
+end

data/qfs.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qfs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'qfs'
+  spec.version       = Qfs::VERSION
+  spec.authors       = ['Eric Culp', 'Noah Goldman']
+  spec.email         = ['ruby-qfs@quantcast.com']
+  spec.summary       = 'Bindings for QFS'
+  spec.description   = 'Client bindings for Quantcast File System, a distributed filesystem.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.extensions << 'ext/qfs/extconf.rb'
+  spec.platform = Gem::Platform::RUBY
+
+  spec.add_dependency 'ffi', '~> 1.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler', '~> 0.9'
+  spec.add_development_dependency 'minitest', '~> 5.5'
+end

data/test/qfs_test.rb

@@ -0,0 +1,393 @@
+require 'test_helper'
+require 'minitest/autorun'
+require 'qfs'
+
+class TestQfs < Minitest::Test
+  BASE_TEST_PATH = ENV['QFS_TEST_PATH'] || '/ruby-qfs'
+  TEST_HOST = ENV['QFS_TEST_HOST'] || 'localhost'
+  TEST_PORT = (ENV['QFS_TEST_PORT'] || 10000).to_i
+
+  def initialize(name = nil)
+    @test_name = name
+    super(name) unless name.nil?
+  end
+
+  def clear_test_files
+    if @client.exists?(@file)
+      @client.remove(@file) if @client.file?(@file)
+      @client.rm_rf(@file) if @client.directory?(@file)
+    end
+  end
+
+  def setup
+    @client = Qfs::Client.new TEST_HOST, TEST_PORT
+    @client.mkdir_p(BASE_TEST_PATH, 0777) if !@client.exists?(BASE_TEST_PATH)
+    @file = get_test_path(@test_name)
+    clear_test_files
+  end
+
+  def teardown
+    clear_test_files
+    @client.release
+  end
+
+  def get_test_path(p)
+    File.join(BASE_TEST_PATH, p)
+  end
+
+  def random_data(len = 20)
+    (0...len).map { (65 + rand(26)).chr }.join
+  end
+
+  def stat(path)
+    Qfs::Client.with_client(TEST_HOST, TEST_PORT) { |c| c.stat(path) }
+  end
+
+  def test_open
+    data = random_data
+    @client.open(@file, 'w') do |f|
+      f.write(data)
+    end
+    @client.open(@file, 'r') do |f|
+      assert_equal(data, f.read(data.length))
+    end
+  end
+
+  def test_tell
+    data = random_data
+    @client.open(@file, 'w') do |f|
+      f.write(data)
+      assert_equal(data.length, f.tell())
+    end
+    @client.open(@file, 'w') do |f|
+      assert_equal(0, f.tell())
+    end
+  end
+
+  def test_remove
+    @client.open(@file, 'w') do |f|
+      f.write('');
+    end
+    res = @client.remove(@file)
+    assert !@client.exists?(@file)
+    assert_equal(1, res)
+
+    assert_raises(Qfs::Error) { @client.remove(@file) }
+  end
+
+  def test_exists
+    @client.open(@file, 'w') do |f|
+      f.write('')
+    end
+    assert @client.exists?(@file)
+
+    @client.remove(@file)
+    assert !@client.exists?(@file)
+  end
+
+  def test_mkdir_rmdir
+    assert @client.mkdir(@file)
+    assert @client.exists?(@file)
+
+    assert_raises(Qfs::Error) { @client.mkdir(@file) }
+    assert @client.rmdir(@file)
+    assert !@client.exists?(@file)
+
+    assert_raises(Errno::ENOENT) { @client.rmdir(@file) }
+    assert_equal(0, @client.rmdir(@file, true))
+  end
+
+  def test_mkdirp_rmdirs
+    # Stock local development servers have odd permission
+    # settings that seem to be causing "qfs_mkdirs" to fail
+    # on creating multiple levels of folder.
+    #file = File.join(@file, 'test', 'a', 'long' 'path')
+    file = File.join(@file)
+    assert @client.mkdir_p(file, 777)
+    assert @client.exists?(file)
+
+    assert @client.rmdirs(file)
+    assert !@client.exists(file)
+  end
+
+  def test_directory
+    @client.mkdir(@file)
+    assert @client.directory?(@file)
+    @client.rmdir(@file)
+
+    @client.open(@file, 'w') { |f| f.write('') }
+    assert !@client.directory?(@file)
+    @client.remove(@file)
+
+    assert !@client.directory?(@file)
+  end
+
+  def test_client_stat
+    data = random_data(rand(1000))
+    @client.open(@file, 'w') do |f|
+      f.write(data)
+    end
+
+    res = @client.stat(@file)
+
+    assert_equal(data.length, res.size)
+    assert_equal(File.basename(@file), res.filename)
+
+    assert_raises(Qfs::Error) { @client.stat('not a real file') }
+  end
+
+  def test_file_stat
+    data = random_data(rand(1000))
+    @client.open(@file, 'w') do |f|
+      f.write(data)
+    end
+
+    @client.open(@file, 'r') do |f|
+      res = f.stat
+      assert_equal(data.length, res.size)
+      assert_equal(File.basename(@file), res.filename)
+    end
+  end
+
+  def test_read_all
+    data = random_data(rand(1000))
+    @client.open(@file, 'w') { |f| f.write(data) }
+    @client.open(@file, 'r') do |f|
+      len = rand(data.length)
+      assert_equal(data[0..(len-1)], f.read(len))
+    end
+    @client.open(@file, 'r') do |f|
+      assert_equal(data, f.read)
+    end
+  end
+
+  def test_read_client
+    data = random_data(rand(1000))
+    len = rand(data.length)
+    @client.open(@file, 'w') { |f| f.write(data) }
+    assert_equal(data[0...len], @client.read(@file, len))
+    assert_equal(data, @client.read(@file))
+  end
+
+  def test_open_no_block
+    data = random_data
+    f = @client.open(@file, 'w')
+    f.write(data)
+    f.close
+
+    f = @client.open(@file, 'r')
+    assert_equal(data, f.read())
+    f.close
+  end
+
+  def test_chmod
+    @client.open(@file, 'w') { |f| f.write('test') }
+
+    run_chmod = proc do |mode|
+      @client.chmod(@file, mode)
+      Qfs::Client.with_client(TEST_HOST, TEST_PORT) do |c|
+        assert_equal(mode, c.stat(@file).mode)
+      end
+    end
+
+    run_chmod.call(0654)
+    run_chmod.call(0643)
+    run_chmod.call(0777)
+  end
+
+  def test_chmod_file
+    @client.write(@file, '')
+
+    run_chmod = proc do |mode|
+      @client.open(@file, 'r') { |f| f.chmod(mode) }
+      Qfs::Client.with_client(TEST_HOST, TEST_PORT) do |c|
+        assert_equal(mode, c.stat(@file).mode)
+      end
+    end
+
+    run_chmod.call(0654)
+    run_chmod.call(0643)
+    run_chmod.call(0777)
+  end
+
+  def test_chmod_recursive
+    @client.mkdir(@file, 0777)
+    testfile = File.join(@file, 'testfile')
+    @client.write(testfile, '')
+
+    run_chmod = proc do |mode|
+      @client.chmod(@file, mode, recursive: true)
+      assert_equal(mode, @client.stat(@file).mode)
+      assert_equal(mode, @client.stat(testfile).mode)
+    end
+
+    run_chmod.call(0777)
+    run_chmod.call(0766)
+    run_chmod.call(0755)
+
+    @client.remove(testfile)
+  end
+
+  def test_readdir
+    @client.mkdir(@file, 0777)
+    files = [0..5].map do
+      name = random_data(10)
+      @client.write(File.join(@file, name), 'test')
+      name
+    end
+
+    @client.readdir(@file) { |f| assert_includes(files, f.filename) }
+
+    attrs = @client.readdir(@file)
+    attrs.each { |f| assert_includes(files, f.filename) }
+
+    assert_raises(Qfs::Error) { @client.readdir('not a real path') }
+  end
+
+  def test_client_read_write
+    [0..5].each do
+      data = random_data
+      @client.write(@file, data)
+      assert_equal(data, @client.read(@file))
+    end
+  end
+
+  def test_rm_rf
+    @client.mkdir(@file, 0777)
+    data = random_data
+    data.length.times do |i|
+      args = [@file].concat(data.chars.to_a[0..i])
+      path = File.send(:join, args)
+      @client.mkdir(path, 0777)
+      @client.write(File.join(path, 'file'), data)
+    end
+
+    @client.rm_rf(@file)
+    assert !@client.exists?(@file)
+  end
+
+  def test_attr_to_s
+    assert_attr = proc do |mode, str|
+      @client.write(@file, '')
+      @client.chmod(@file, mode)
+      assert_includes(stat(@file).to_s, str)
+    end
+
+    assert_attr.call(0777, '-rwxrwxrwx')
+    assert_attr.call(0644, '-rw-r--r--')
+    assert_attr.call(0473, '-r--rwx-wx')
+  end
+
+  def test_client_move
+    newpath = get_test_path('new_test_file')
+    @client.write(@file, '')
+
+    assert !@client.exists(newpath)
+    @client.move(@file, newpath)
+
+    assert !@client.exists(@file)
+    assert @client.exists(newpath)
+
+    @client.remove(newpath)
+  end
+
+  def test_client_cd
+    @client.mkdir(@file)
+    @client.cd(@file)
+
+    assert_equal(@file, @client.cwd)
+
+    @client.cd('../')
+    assert_equal(BASE_TEST_PATH, @client.cwd)
+  end
+
+  def test_client_cd_fail
+    assert_raises(Qfs::Error) { @client.cd('/fake/directory') }
+  end
+
+  def test_client_setwd
+    @client.mkdir(@file)
+    @client.setwd(@file)
+
+    assert_equal(@file, @client.cwd)
+
+    @client.setwd('../')
+    assert_equal(BASE_TEST_PATH, @client.cwd)
+  end
+
+  def test_mkdir_permissions
+    [0755, 0755, 0600].each do |mode|
+      @client.mkdir_p(@file, mode)
+      Qfs::Client.with_client(TEST_HOST, TEST_PORT) do |c|
+        assert_equal(mode, c.stat(@file).mode)
+      end
+      @client.rmdir(@file)
+    end
+  end
+
+  def test_client_cwd
+    test_cwd = lambda do |path|
+      @client.mkdir_p(path, 0777)
+      @client.cd(path)
+      assert_equal(path, @client.cwd)
+    end
+
+    test_cwd.call(@file)
+    # This should still work for a very long path (>5kb).  Since qfs has a max
+    # filename length of 255 characters, multiple directories must be created
+    files = ['a' * 255] * 7
+    subdir = files.reduce(@file) { |sum, x| File.join(sum, x) }
+    test_cwd.call(subdir)
+
+    # A ridiculously long path (>10kb) should fail
+    files = files * 4
+    subdir = files.reduce(@file) { |sum, x| File.join(sum, x) }
+    assert_raises(Errno::ENAMETOOLONG) { test_cwd.call(subdir) }
+  end
+
+  # It should be possible to change the properties of a file and see stat
+  # return a different result
+  def test_stat_modifications
+    @client.write(@file, '')
+
+    [0745, 0600, 0443].each do |mode|
+      @client.chmod(@file, mode)
+      assert_equal mode, @client.stat(@file, refresh: true).mode
+    end
+  end
+
+  def test_seek
+    data = random_data
+    @client.write(@file, data)
+
+    @client.open(@file, 'r') do |f|
+      assert_equal 0, f.tell
+
+      # now seek into the file
+      f.seek(1, IO::SEEK_SET)
+      assert_equal 1, f.tell
+
+      # Seek a little farther
+      f.seek(5)
+      assert_equal 6, f.tell
+
+      # Seek to the end
+      f.seek(0, IO::SEEK_END)
+      assert_equal data.length, f.tell
+    end
+  end
+
+  def test_open_append
+    data = random_data
+    @client.write(@file, data)
+
+    data2 = random_data
+    @client.open(@file, 'a') do |f|
+      f.write(data2)
+    end
+
+    res = @client.read(@file)
+
+    assert_equal(data + data2, @client.read(@file))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: qfs
+version: !ruby/object:Gem::Version
+  version: 0.0.13
+  prerelease: 
+platform: ruby
+authors:
+- Eric Culp
+- Noah Goldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: Client bindings for Quantcast File System, a distributed filesystem.
+email:
+- ruby-qfs@quantcast.com
+executables: []
+extensions:
+- ext/qfs/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/qfs/attr.c
+- ext/qfs/attr.h
+- ext/qfs/extconf.rb
+- ext/qfs/file.c
+- ext/qfs/file.h
+- ext/qfs/qfs.c
+- ext/qfs/qfs.h
+- ext/qfs/qfs_ext.version
+- ext/qfs/util.h
+- lib/qfs.rb
+- lib/qfs/version.rb
+- qfs.gemspec
+- test/qfs_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Bindings for QFS
+test_files:
+- test/qfs_test.rb
+- test/test_helper.rb