ceph_storage 0.1.0

data/spec/ceph_storage_rados_storage_object_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require 'logger'
+describe CephStorage::StorageObject::RadosStorageObject do
+  let(:config) { cluster_config }
+  let(:spconfig) { spec_config }
+  let(:cluster) { CephStorage::ClusterFactory.build config }
+  let(:rule_id) { spconfig[:pool][:rule_id] }
+  let(:pool_name) { spconfig[:pool][:name] }
+  let(:pool) { cluster.pool(pool_name) }
+
+  describe 'pool creation' do
+    subject { pool }
+    it 'should be able to create pool' do
+      expect { subject.create(rule_id: rule_id) }.to_not raise_exception
+    end
+
+    it 'should be writable' do
+      expect { pool.stat }.not_to raise_exception
+      expect(pool.stat).to be_a Hash
+    end
+  end
+
+  let(:object_name) { spconfig[:pool][:object_name] }
+  let(:storage_object) { pool.storage_object(object_name) }
+  subject { storage_object }
+
+  it 'should be a RadosStorageObject' do
+    expect(subject).to be_a ::CephStorage::StorageObject::RadosStorageObject
+  end
+
+  it 'should be a CephRuby::RadosObject' do
+    expect(subject).to be_a ::CephRuby::RadosObject
+  end
+
+  it 'should be a StorageObject' do
+    expect(subject).to be_a ::CephStorage::StorageObject
+  end
+
+  it 'should respond to write_file' do
+    expect(subject).to respond_to :write_file
+  end
+
+  it 'should respond to read_file' do
+    expect(subject).to respond_to :read_file
+  end
+
+  it 'should respond to path' do
+    expect(subject).to respond_to :path
+  end
+
+  describe 'write_file' do
+    it 'should not raise exception' do
+      expect do
+        subject.write_file('content string to be written')
+      end.not_to raise_exception
+    end
+  end
+
+  describe 'read_file' do
+    it 'should call ::CephRuby::RadosObject.read_full' do
+      expect(subject).to receive(:read_full)
+      subject.read_file
+    end
+
+    it 'should return the file contents' do
+      expect(subject.read_file).to eq('content string to be written')
+    end
+  end
+
+  describe 'path' do
+    let(:cluster_name) { config[:cluster] }
+    it 'should have a specific format' do
+      expect(subject.path).to eq(
+        "ceph://#{cluster_name}/#{pool_name}/#{object_name}"
+      )
+    end
+  end
+
+  describe 'parent methods should run with wrapper' do
+    let(:new_content) { 'asdkljasdkjlasdjkladasjkdakjdassjkladsjkladsjkladsjk' }
+    describe 'exists?' do
+      it 'should return true' do
+        expect(subject.exists?).to eq(true)
+      end
+    end
+
+    # Skip stat as it is covered by size/exists?
+
+    describe 'read/write' do
+      it 'should write different content to the file' do
+        expect { subject.write(0, new_content) }.not_to raise_exception
+      end
+
+      it 'should be readable' do
+        expect(subject.read(0, new_content.length)).to eq(new_content)
+      end
+    end
+
+    describe 'size' do
+      it 'should equal size of new_content' do
+        expect(subject.size).to eq(new_content.length)
+      end
+    end
+  end
+
+  describe 'pool deletion' do
+    subject { pool }
+    it 'should be able to delete pool' do
+      expect { subject.destroy }.not_to raise_exception
+    end
+  end
+end

data/spec/ceph_storage_storage_object_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+# Dummy storage_Object to represent a file
+
+class DummyXattr
+  attr_accessor :name
+  attr_accessor :value
+  def initialize(name)
+    self.name = name
+  end
+end
+
+class DummyXattrEnumerator
+  include ::Enumerable
+
+  attr_accessor :xattrs
+  def initialize
+    self.xattrs = []
+    10.times do |i|
+      xattr = DummyXattr.new("key#{i}")
+      xattr.value = i
+      xattrs << xattr
+    end
+  end
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    xattrs.each do |x|
+      yield x
+    end
+  end
+end
+
+class DummyStorage
+  extend CephStorage::StorageObject
+  include CephStorage::StorageObject
+
+  attr_accessor :contents
+
+  def write_file(contents)
+    self.contents = contents
+  end
+
+  def read_file
+    contents
+  end
+
+  def xattr(name)
+    DummyXattr.new(name)
+  end
+
+  def xattr_enumerator
+    puts 'call xattr_enumerator'
+    DummyXattrEnumerator.new
+  end
+
+  def destroy
+    self.contents = nil
+  end
+end
+describe CephStorage::StorageObject do
+  before do
+    @storage_object1 = DummyStorage.new
+    @storage_object2 = DummyStorage.new
+  end
+  subject { @storage_object1 }
+
+  it 'should respond to move' do
+    expect(subject).to respond_to :move
+  end
+
+  it 'should respond to copy' do
+    expect(subject).to respond_to :copy
+  end
+
+  it 'should respond to copy_xattrs' do
+    expect(subject).to respond_to :copy_xattrs
+  end
+
+  describe 'copying file' do
+    it 'should read from storage_object1 and write to storage_object2' do
+      expect(@storage_object1).to receive(:read_file)
+      expect(@storage_object2).to receive(:write_file)
+      expect(@storage_object1).to receive(:copy_xattrs)
+      @storage_object1.copy(@storage_object2)
+    end
+  end
+
+  describe 'moving file' do
+    it 'should read from object1, write object2, delete object1' do
+      expect(@storage_object1).to receive(:read_file)
+      expect(@storage_object2).to receive(:write_file)
+      expect(@storage_object1).to receive(:copy_xattrs)
+      expect(@storage_object1).to receive(:destroy)
+      @storage_object1.move(@storage_object2)
+    end
+  end
+end

data/spec/ceph_storage_xattr_enumerator_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'logger'
+describe CephStorage::StorageObject::XattrEnumerator do
+  let(:config) { cluster_config }
+  let(:spconfig) { spec_config }
+  let(:cluster) { CephStorage::ClusterFactory.build config }
+  let(:rule_id) { spconfig[:pool][:rule_id] }
+  let(:pool_name) { spconfig[:pool][:name] }
+  let(:pool) { cluster.pool(pool_name) }
+
+  describe 'pool creation' do
+    subject { pool }
+    it 'should be able to create pool' do
+      expect { subject.create(rule_id: rule_id) }.to_not raise_exception
+    end
+
+    it 'should be writable' do
+      expect { pool.stat }.not_to raise_exception
+      expect(pool.stat).to be_a Hash
+    end
+  end
+
+  let(:object_name) { spconfig[:pool][:object_name] }
+  let(:storage_object) { pool.storage_object(object_name) }
+
+  describe 'Storage Object' do
+    subject { storage_object }
+
+    it 'should be writeable' do
+      expect { subject.overwrite('some content') }.not_to raise_exception
+    end
+  end
+
+  describe 'XattrEnumerator' do
+    let(:xattr_name) { spconfig[:pool][:xattr_name] }
+    let(:xattr_value) { spconfig[:pool][:xattr_value] }
+    let(:xattr_enumerator) { storage_object.xattr_enumerator }
+    subject { xattr_enumerator }
+
+    it 'should be a CephRuby::XattrEnumerator' do
+      expect(subject).to be_a ::CephStorage::StorageObject::XattrEnumerator
+    end
+
+    it 'should be a CephRuby::XattrEnumerator' do
+      expect(subject).to be_a ::CephRuby::XattrEnumerator
+    end
+
+    it 'should have 0 xattrs' do
+      expect(subject.inject(0) { |a, _e| a + 1 }).to be 0
+    end
+
+    describe 'after populating' do
+      before do
+        10.times do |i|
+          storage_object.xattr("#{xattr_name}.#{i}").value = xattr_value
+        end
+      end
+
+      it 'should have 10 xattrs' do
+        expect(subject.inject(0) { |a, _e| a + 1 }).to be 10
+      end
+
+      it 'should return CephStorage::Xattrs' do
+        expect(subject.first).to be_a CephStorage::StorageObject::Xattr
+      end
+    end
+  end
+
+  describe 'pool deletion' do
+    subject { pool }
+    it 'should be able to delete pool' do
+      expect { subject.destroy }.not_to raise_exception
+    end
+  end
+end

data/spec/ceph_storage_xattr_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'logger'
+describe CephStorage::StorageObject::Xattr do
+  let(:config) { cluster_config }
+  let(:spconfig) { spec_config }
+  let(:cluster) { CephStorage::ClusterFactory.build config }
+  let(:rule_id) { spconfig[:pool][:rule_id] }
+  let(:pool_name) { spconfig[:pool][:name] }
+  let(:pool) { cluster.pool(pool_name) }
+
+  describe 'pool creation' do
+    subject { pool }
+    it 'should be able to create pool' do
+      expect { subject.create(rule_id: rule_id) }.to_not raise_exception
+    end
+
+    it 'should be writable' do
+      expect { pool.stat }.not_to raise_exception
+      expect(pool.stat).to be_a Hash
+    end
+  end
+
+  let(:object_name) { spconfig[:pool][:object_name] }
+  let(:storage_object) { pool.storage_object(object_name) }
+
+  describe 'Storage Object' do
+    subject { storage_object }
+
+    it 'should be writeable' do
+      expect { subject.overwrite('some content') }.not_to raise_exception
+    end
+  end
+
+  describe 'xattr' do
+    let(:xattr_name) { spconfig[:pool][:xattr_name] }
+    let(:xattr_value) { spconfig[:pool][:xattr_value] }
+    let(:xattr) { storage_object.xattr(xattr_name) }
+    subject { xattr }
+
+    it 'should be a StorageObject::Xattr' do
+      expect(subject).to be_a ::CephStorage::StorageObject::Xattr
+    end
+
+    it 'should be a CephRuby::Xattr' do
+      expect(subject).to be_a ::CephRuby::Xattr
+    end
+
+    describe 'before creation' do
+      it 'should not throw an exception on read' do
+        expect { subject.value }.to raise_exception Errno::ENODATA
+      end
+
+      it 'should be writable' do
+        expect { subject.value = xattr_value }.not_to raise_exception
+      end
+
+      it 'should match the new value' do
+        expect(subject.value).to eq(xattr_value)
+      end
+    end
+  end
+
+  describe 'pool deletion' do
+    subject { pool }
+    it 'should be able to delete pool' do
+      expect { subject.destroy }.not_to raise_exception
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'ceph_storage'
+require 'yaml'
+
+def spec_config
+  YAML.load(File.read('.cluster.yml')) if File.exist? '.cluster.yml'
+end
+
+def cluster_config
+  sp_config = spec_config
+  hash = {}
+  hash[:config_dir] = sp_config[:config_dir]
+  hash[:user] = sp_config[:user]
+  hash[:cluster] = sp_config[:cluster]
+  hash[:flags] = sp_config[:flags]
+  hash
+end
+
+RSpec.configure do |c|
+  config = spec_config
+  c.fail_fast = true
+  c.filter_run_excluding(
+    requires_cluster_readable: true
+  ) unless config[:readable]
+  c.filter_run_excluding(
+    requires_create_delete: true
+  ) unless config[:pool][:create_delete]
+  c.filter_run_excluting(
+    requires_create_delete: true
+  ) unless config[:pool][:create_delete]
+end

data/tasks/rspec.rake

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+
+desc 'rspec tasks for spec directory'
+RSpec::Core::RakeTask.new(:spec)

data/tasks/rubocop.rake

@@ -0,0 +1,13 @@
+require 'rubocop/rake_task'
+
+desc 'Rub RoboCop on the lib and spec directory'
+RuboCop::RakeTask.new(:rubocop_dev) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = false
+end
+
+RuboCop::RakeTask.new(:rubocop_test) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.formatters = ['files']
+  task.fail_on_error = true
+end

metadata

@@ -0,0 +1,281 @@
+--- !ruby/object:Gem::Specification
+name: ceph_storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Livelink Technology LTD
+- Stuart Harland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: ceph-ruby-livelink
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.6
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Easy access of Objects in ceph
+email:
+- infraops@livelinktechnology.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cluster.yml.example"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- ceph_storage.gemspec
+- lib/ceph_storage.rb
+- lib/ceph_storage/cluster.rb
+- lib/ceph_storage/cluster_factory.rb
+- lib/ceph_storage/cluster_wrapper.rb
+- lib/ceph_storage/pool.rb
+- lib/ceph_storage/pool_enumerator.rb
+- lib/ceph_storage/pool_factory.rb
+- lib/ceph_storage/pool_wrapper.rb
+- lib/ceph_storage/storage_object.rb
+- lib/ceph_storage/storage_object/file_storage_object.rb
+- lib/ceph_storage/storage_object/rados_storage_object.rb
+- lib/ceph_storage/storage_object/rados_storage_object_enumerator.rb
+- lib/ceph_storage/storage_object/rados_wrapper.rb
+- lib/ceph_storage/storage_object/url_storage_object.rb
+- lib/ceph_storage/storage_object/xattr.rb
+- lib/ceph_storage/storage_object/xattr_enumerator.rb
+- lib/ceph_storage/version.rb
+- spec/ceph_storage_cluster_factory_spec.rb
+- spec/ceph_storage_cluster_spec.rb
+- spec/ceph_storage_file_storage_object_spec.rb
+- spec/ceph_storage_pool_enumerator.rb
+- spec/ceph_storage_pool_factory_spec.rb
+- spec/ceph_storage_pool_spec.rb
+- spec/ceph_storage_rados_storage_object_enumerator_spec.rb
+- spec/ceph_storage_rados_storage_object_spec.rb
+- spec/ceph_storage_storage_object_spec.rb
+- spec/ceph_storage_xattr_enumerator_spec.rb
+- spec/ceph_storage_xattr_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- tasks/rubocop.rake
+homepage: https://github.com/livelink/ceph_storage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Ceph-ruby provides an API, however this gem provides consistent connection
+  to ceph pools and clusters using multiton objects
+test_files:
+- spec/ceph_storage_cluster_factory_spec.rb
+- spec/ceph_storage_cluster_spec.rb
+- spec/ceph_storage_file_storage_object_spec.rb
+- spec/ceph_storage_pool_enumerator.rb
+- spec/ceph_storage_pool_factory_spec.rb
+- spec/ceph_storage_pool_spec.rb
+- spec/ceph_storage_rados_storage_object_enumerator_spec.rb
+- spec/ceph_storage_rados_storage_object_spec.rb
+- spec/ceph_storage_storage_object_spec.rb
+- spec/ceph_storage_xattr_enumerator_spec.rb
+- spec/ceph_storage_xattr_spec.rb
+- spec/spec_helper.rb
+has_rdoc: