visor-meta 0.0.1

data/spec/lib/backends/base_spec.rb

@@ -0,0 +1,209 @@
+require "spec_helper"
+
+include Visor::Meta::Backends
+
+module Visor::Meta::Backends
+  describe Base do
+
+    before(:each) do
+      @sample = {
+          name: 'testsample',
+          architecture: 'i386',
+          access: 'public',
+          format: 'iso'
+      }
+
+      @base = Base.new(host: 'fake', port: 'fake', db: 'fake')
+    end
+
+    describe "#initialize" do
+      it "should create an Base instance" do
+        base = Base.new(host: 'fake')
+        base.host.should == 'fake'
+      end
+    end
+
+    describe "#validate_data_post" do
+      it "should validate that no read-only field is setted" do
+        Base::READONLY.each do |field|
+          l = lambda { @base.validate_data_post @sample.merge(field => 'some value') }
+          l.should raise_error(ArgumentError, /#{field}/)
+        end
+      end
+
+      it "should validate that all mandatory fields are setted" do
+        Base::MANDATORY.each do |field|
+          l = lambda { @base.validate_data_post(@sample.select { |k, v| k != field }) }
+          l.should raise_error(ArgumentError, /#{field}/)
+        end
+      end
+
+      it "should validate fields values" do
+        fields = [:architecture, :access, :store, :format, :type]
+        fields.each do |field|
+          inv = @sample.merge(field => 'invalid value!')
+          l = lambda { @base.validate_data_post inv }
+          l.should raise_error(ArgumentError, /#{field}/)
+        end
+      end
+    end
+
+    describe "#validate_data_put" do
+      it "should validate that no read-only field is setted" do
+        Base::READONLY.each do |field|
+          l = lambda { @base.validate_data_put @sample.merge(field => 'some value') }
+          l.should raise_error(ArgumentError, /#{field}/)
+        end
+      end
+
+      it "should validate the the fields values" do
+        fields = [:architecture, :access, :store, :format, :type]
+        fields.each do |field|
+          inv = @sample.merge(field => 'invalid value!')
+          l = lambda { @base.validate_data_post inv }
+          l.should raise_error(ArgumentError, /#{field}/)
+        end
+      end
+    end
+
+    describe "#validate_query_filters" do
+      it "should validate if query only contains valid filter keys" do
+        @base.validate_query_filters(Base::FILTERS.sample => 'value')
+      end
+
+      it "should raise if query has some invalid filter key" do
+        l = lambda { @base.validate_query_filters(invalid_filter: 'value') }
+        l.should raise_error(ArgumentError, /invalid_filter/)
+      end
+    end
+
+    describe "#set_protected_post" do
+      before(:each) do
+        @meta = {name: 'testsample',
+                 architecture: 'i386',
+                 format: 'iso',
+                 owner: 'someone',
+                 size: 1}
+        @base.set_protected_post @meta
+      end
+
+      it "should set the _id to a SecureRandom UUID" do
+        @meta[:_id].should be_a String
+        @meta[:_id].size.should == 36
+      end
+
+      it "should set the access to public if not provided" do
+        @meta[:access].should == 'public'
+      end
+
+      it "should set the created_at" do
+        @meta[:created_at].should be_a Time
+      end
+
+      it "should set the uri" do
+        @meta[:uri].should be_a String
+        @meta[:uri] =~ /#{@meta[:_id]}/
+      end
+
+      it "should set the status to locked" do
+        @meta[:status].should == 'locked'
+      end
+
+      it "should set the owner if provided" do
+        @meta[:owner].should == 'someone'
+      end
+
+      it "should set the size if provided" do
+        @meta[:size].should == 1
+      end
+    end
+
+    describe "#set_protected_put" do
+      it "should set the updated_at" do
+        meta = {name: 'new name',
+                architecture: 'i386'}
+        @base.set_protected_put meta
+        meta[:updated_at].should be_a Time
+      end
+    end
+    
+    describe "#build_uri" do
+      it "should build a new URI" do
+        uri = @base.build_uri('some_id')
+        uri.should be_a String
+        uri =~ %r{^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/}ix
+      end
+    end
+
+    describe "#serialize_others" do
+      it "should encapsulate extra fields on the others field" do
+        sample = {name: 'example', access: 'public', extra_key: 'value', another: 'value'}
+        new = @base.serialize_others(sample)
+        new[:others].should == "{\"extra_key\":\"value\",\"another\":\"value\"}"
+      end
+    end
+
+    describe "#serialize_others" do
+      it "should encapsulate extra fields on the others field as JSON" do
+        sample = {name: 'example', access: 'public', extra_key: 'value', another: 'value'}
+        @base.serialize_others(sample)
+        sample[:others].should == "{\"extra_key\":\"value\",\"another\":\"value\"}"
+      end
+
+      it "should do nothing if there are no extra fields" do
+        sample = {name: 'example', access: 'public'}
+        copy = sample.dup
+        @base.serialize_others(sample)
+        sample.should == copy
+      end
+    end
+
+    describe "#deserialize_others" do
+      it "should decapsulate extra fields from the others field" do
+        sample = {name: 'example', access: 'public', extra_key: 'value', another: 'value'}
+        new = @base.deserialize_others(@base.serialize_others(sample))
+        new.should == sample
+      end
+
+      it "should do nothing if there are no extra fields" do
+        sample = {name: 'example', access: 'public'}
+        copy = sample.dup
+        @base.deserialize_others(sample)
+        sample.should == copy
+      end
+    end
+    
+    describe "#string_time_or_hash?" do
+      it "should return true if parameter is a String a Time or a Hash" do
+         @base.string_time_or_hash?("").should be_true
+         @base.string_time_or_hash?(Time.now).should be_true
+         @base.string_time_or_hash?({}).should be_true
+      end
+
+      it "should return false if parameter is of other class" do
+        @base.string_time_or_hash?(1).should be_false
+      end
+    end
+    
+    describe "#to_sql_where" do
+      it "should return a AND joined valid SQL WHERE string from a hash" do
+        str = @base.to_sql_where(a: 1, b: 'something')
+        str.should == "a=1 AND b='something'"
+      end
+    end
+
+    describe "#to_sql_update" do
+      it "should return a comma joined valid SQL UPDATE string from a hash" do
+        str = @base.to_sql_update(a: 1, b: 'something')
+        str.should == "a=1, b='something'"
+      end
+    end
+
+    describe "#to_sql_insert" do
+      it "should return a VALUES joined valid SQL INSERT array from a hash" do
+        arr = @base.to_sql_insert(a: 1, b: 'something')
+        arr.should == ["(a, b)", "(1, 'something')"]
+      end
+    end
+  end
+end

data/spec/lib/backends/mongo_db_spec.rb

@@ -0,0 +1,152 @@
+require "spec_helper"
+
+include Visor::Common::Exception
+include Visor::Meta::Backends
+
+module Visor::Meta::Backends
+  describe MongoDB do
+
+    let(:conn) { MongoDB.connect uri: 'mongodb://:@127.0.0.1:27017/visor_test' }
+
+    before(:each) do
+      conn.post_image ({:name => 'testsample',
+                        :architecture => 'i386',
+                        :access => 'public',
+                        :format => 'iso'})
+
+      @sample = {:name => 'xyz',
+                 :architecture => 'x86_64',
+                 :access => 'public',
+                 :type => 'kernel'}
+    end
+
+    after(:all) do
+      conn.delete_all!
+    end
+
+    describe "#connect" do
+      it "should instantiate a new object trougth options" do
+        obj = conn
+        obj.db.should == 'visor_test'
+        obj.host.should == MongoDB::DEFAULT_HOST
+      end
+
+      it "should instantiate a new object trougth URI" do
+        uri = "mongodb://:@#{MongoDB::DEFAULT_HOST}:#{MongoDB::DEFAULT_PORT}/visor_test"
+        obj = MongoDB.connect uri: uri
+        obj.db.should == 'visor_test'
+        obj.host.should == MongoDB::DEFAULT_HOST
+      end
+    end
+
+    describe "#connection" do
+      it "should return a collection connection" do
+        conn.connection.should be_a Mongo::Collection
+      end
+    end
+
+    describe "#get_public_images" do
+      it "should return an array with all public images meta" do
+        pub = conn.get_public_images
+        pub.should be_a Array
+        pub.each { |img| img['access'].should == 'public' }
+      end
+
+      it "should return only brief information" do
+        pub = conn.get_public_images(true)
+        pub.each { |img| (img.keys & MongoDB::BRIEF).should be_empty }
+      end
+
+      it "should filter results if asked to" do
+        pub = conn.get_public_images(false, architecture: 'i386')
+        pub.each { |img| img['architecture'].should == 'i386' }
+      end
+
+      it "should sort results if asked to" do
+        conn.post_image @sample
+        pub = conn.get_public_images(false, sort: 'architecture', dir: 'desc')
+        pub.first['architecture'].should == 'x86_64'
+      end
+
+      it "should raise an NotFound exception if there are no public images" do
+        conn.delete_all!
+        lambda { conn.get_public_images }.should raise_error(NotFound, /public/)
+      end
+    end
+
+    describe "#get_image" do
+      before(:each) do
+        @id = conn.get_public_images.first['_id']
+      end
+
+      it "should return a bson hash with the asked image" do
+        img = conn.get_image(@id)
+        img.should be_a BSON::OrderedHash
+        img['_id'].should == @id
+      end
+
+      it "should return only detail information fields" do
+        img = conn.get_image(@id)
+        (img.keys & Base::DETAIL_EXC).should be_empty
+      end
+
+      it "should raise an NotFound exception if image not found" do
+        fake_id = 0
+        lambda { conn.get_image(fake_id) }.should raise_error(NotFound, /id/)
+      end
+    end
+
+    describe "#delete_image" do
+      it "should return a bson hash with the deleted image" do
+        id = conn.get_public_images.first['_id']
+        img = conn.delete_image(id)
+        img.should be_a BSON::OrderedHash
+        img['_id'].should == id
+      end
+
+      it "should raise an NotFound exception if image not found" do
+        fake_id = 0
+        lambda { conn.get_image(fake_id) }.should raise_error(NotFound, /id/)
+      end
+    end
+
+    describe "#delete_all!" do
+      it "should delete all records in images and counters collection" do
+        conn.delete_all!
+        conn.connection.find.to_a.should == []
+      end
+    end
+
+    describe "#post_image" do
+      it "should post an image and return its meta" do
+        image = conn.post_image(@sample)
+        image.should be_a(Hash)
+        image['name'].should == @sample[:name]
+      end
+
+      it "should raise an ArgumentError exception if meta validation fails" do
+        img = @sample.merge(:_id => 'cant define _id')
+        lambda { conn.post_image(img) }.should raise_error(ArgumentError, /_id/)
+      end
+    end
+
+    describe "#put_image" do
+      before(:each) do
+        @id = conn.get_public_images.first['_id']
+      end
+
+      it "should return a bson hash with updated image meta" do
+        update = {:name => 'updated', :type => 'machine'}
+        img = conn.put_image(@id, update)
+        img.should be_a BSON::OrderedHash
+        img['name'].should == 'updated'
+        img['type'].should == 'machine'
+      end
+
+      it "should raise an ArgumentError exception if meta validation fails" do
+        update = {:uri => 'cant define uri'}
+        lambda { conn.put_image(@id, update) }.should raise_error(ArgumentError, /uri/)
+      end
+    end
+  end
+end

data/spec/lib/backends/mysql_db_spec.rb

@@ -0,0 +1,164 @@
+require "spec_helper"
+
+include Visor::Common::Exception
+include Visor::Meta::Backends
+
+module Visor::Meta::Backends
+  describe MySQL do
+
+    let(:conn) { MySQL.connect uri: 'mysql://visor:passwd@127.0.0.1:3306/visor_test' }
+
+    before(:each) do
+      conn.post_image ({:name => 'testsample',
+                        :architecture => 'i386',
+                        :access => 'public',
+                        :format => 'iso'})
+
+      @sample = {:name => 'xyz',
+                 :architecture => 'x86_64',
+                 :access => 'public',
+                 :type => 'kernel'}
+    end
+
+    after(:all) do
+      conn.delete_all!
+    end
+
+    describe "#connect" do
+      it "should instantiate a new object trougth options" do
+        obj = conn
+        obj.db.should == 'visor_test'
+        obj.host.should == MySQL::DEFAULT_HOST
+      end
+    end
+
+    describe "#connection" do
+      it "should return a connection to the dabatase" do
+        conn.connection.should be_an_instance_of Mysql2::Client
+      end
+    end
+
+    describe "#get_public_images" do
+      it "should return an array with all public images meta" do
+        pub = conn.get_public_images
+        pub.should be_an_instance_of Array
+        pub.each { |img| img[:access].should == 'public' }
+      end
+
+      it "should return extra fields" do
+        conn.post_image(@sample.merge(extra_field: 'value'))
+        returned = 0
+        pub = conn.get_public_images
+        pub.each { |img| returned = 1 if img[:extra_field] }
+        returned.should == 1
+      end
+
+      it "should return only brief information" do
+        pub = conn.get_public_images(true)
+        pub.each { |img| (img.keys - Base::BRIEF).should be_empty }
+      end
+
+      it "should sort results if asked to" do
+        conn.post_image(@sample)
+        pub = conn.get_public_images(false, sort: 'architecture', dir: 'desc')
+        pub.first[:architecture].should == 'x86_64'
+      end
+
+      it "should raise an NotFound exception if there are no public images" do
+        conn.delete_all!
+        lambda { conn.get_public_images }.should raise_error(NotFound, /public/)
+      end
+    end
+
+    describe "#get_image" do
+      before(:each) do
+        @id = conn.get_public_images.first[:_id]
+      end
+
+      it "should return a hash with the asked image meta" do
+        img = conn.get_image(@id)
+        img.should be_a(Hash)
+        img[:_id].should == @id
+      end
+
+      it "should return only detail information fields" do
+        img = conn.get_image(@id)
+        (img.keys & Base::DETAIL_EXC).should be_empty
+      end
+
+      it "should return extra fields" do
+        image = conn.post_image(@sample.merge(extra_field: 'value'))
+        image[:extra_field].should == 'value'
+      end
+
+      it "should raise an NotFound exception if image not found" do
+        fake_id = 0
+        lambda { conn.get_image(fake_id) }.should raise_error(NotFound, /id/)
+      end
+    end
+
+    describe "#delete_image" do
+      it "should return a hash with the deleted image meta" do
+        id = conn.get_public_images.first[:_id]
+        img = conn.delete_image(id)
+        img.should be_a(Hash)
+        img[:_id].should == id
+      end
+
+      it "should raise an exception if image not found" do
+        fake_id = 0
+        lambda { conn.delete_image(fake_id) }.should raise_error(NotFound, /id/)
+      end
+    end
+
+    describe "#delete_all!" do
+      it "should delete all records in images and counters collection" do
+        conn.delete_all!
+        lambda { conn.get_public_images }.should raise_error(NotFound, /public/)
+      end
+    end
+
+    describe "#post_image" do
+      it "should post an image and return it" do
+        image = conn.post_image(@sample, method: 1)
+        image.should be_a(Hash)
+        image[:name].should == @sample[:name]
+      end
+
+      it "should post an image with additional fields" do
+        image = conn.post_image(@sample.merge(extra_field: 'value'))
+        image[:extra_field].should == 'value'
+      end
+
+      it "should raise an exception if meta validation fails" do
+        img = @sample.merge(:_id => '_id can not be set')
+        lambda { conn.post_image(img) }.should raise_error(ArgumentError, /_id/)
+      end
+    end
+
+    describe "#put_image" do
+      before(:each) do
+        @id = conn.get_public_images.first[:_id]
+      end
+
+      it "should return a hash with updated image" do
+        update = {:name => 'updated', :type => 'kernel'}
+        img = conn.put_image(@id, update)
+        img.should be_a(Hash)
+        img[:name].should == 'updated'
+        img[:type].should == 'kernel'
+      end
+
+      it "should update extra fields too" do
+        id = conn.post_image(@sample.merge(extra_field: 'value'))[:_id]
+        image = conn.put_image(id, extra_field: 'new value')
+        image[:extra_field].should == 'new value'
+      end
+
+      it "should raise an exception if meta validation fails" do
+        update = {:uri => 'uri can not be set'}
+        lambda { conn.put_image(@id, update) }.should raise_error(ArgumentError, /uri/)
+      end
+    end
+  end
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,179 @@
+require "spec_helper"
+
+module Visor::Meta
+  describe Client do
+
+    include Visor::Meta
+    include Visor::Common::Exception
+
+    let(:client) { Client.new }
+    let(:not_found) { Visor::Common::Exception::NotFound }
+    let(:invalid) { Visor::Common::Exception::Invalid }
+
+    let(:valid_post) { {name: 'client_spec', architecture: 'i386', access: 'public'} }
+    let(:invalid_post) { {name: 'client_spec', architecture: 'i386', access: 'invalid'} }
+
+    let(:valid_update) { {architecture: 'x86_64'} }
+    let(:invalid_update) { {architecture: 'invalid'} }
+
+    inserted = []
+
+    before(:all) do
+      inserted << client.post_image(valid_post)[:_id]
+      inserted << client.post_image(valid_post.merge(architecture: 'x86_64'))[:_id]
+    end
+
+    after(:all) do
+      inserted.each { |id| client.delete_image(id) }
+    end
+
+    describe "#initialize" do
+      it "should instantiate a new client with default options" do
+        client.host.should == Client::DEFAULT_HOST
+        client.port.should == Client::DEFAULT_PORT
+        client.ssl.should be_false
+      end
+
+      it "should instantiate a new client with provided options" do
+        c = Visor::Meta::Client.new(host: '1.1.1.1', port: 1, ssl: true)
+        c.host.should == '1.1.1.1'
+        c.port.should == 1
+        c.ssl.should be_true
+      end
+    end
+
+    describe "#get_images" do
+      before(:each) do
+        @images = client.get_images
+      end
+
+      it "should return an array" do
+        @images.should be_a Array
+      end
+
+      it "should filter results if asked to" do
+        pub = client.get_images(architecture: 'x86_64')
+        pub.each { |img| img[:architecture].should == 'x86_64' }
+      end
+
+      it "should sort results if asked to" do
+        pub = client.get_images(sort: 'architecture', dir: 'desc')
+        pub.first[:architecture].should == 'x86_64'
+        pub = client.get_images(sort: 'architecture', dir: 'asc')
+        pub.first[:architecture].should == 'i386'
+      end
+    end
+
+    describe "#get_images_detail" do
+      before(:each) do
+        @images = client.get_images_detail
+      end
+
+      it "should return an array" do
+        @images.should be_a Array
+      end
+
+      it "should return all public images" do
+        @images.each { |image| image[:access].should == 'public' }
+      end
+
+      it "should filter results if asked to" do
+        pub = client.get_images_detail(architecture: 'x86_64')
+        pub.each { |img| img[:architecture].should == 'x86_64' }
+      end
+
+      it "should sort results if asked to" do
+        pub = client.get_images(sort: 'architecture', dir: 'desc')
+        pub.first[:architecture].should == 'x86_64'
+        pub = client.get_images(sort: 'architecture', dir: 'asc')
+        pub.first[:architecture].should == 'i386'
+      end
+    end
+
+    describe "#get_image" do
+      before(:each) do
+        @id = client.post_image(valid_post)[:_id]
+        inserted << @id
+        @image = client.get_image(@id)
+      end
+
+      it "should return a hash" do
+        @image.should be_a Hash
+      end
+
+      it "should return the asked image metadata" do
+        @image[:_id].should == @id
+      end
+
+      it "should raise an exception if image not found" do
+        fake_id = 0
+        lambda { client.get_image(fake_id) }.should raise_error not_found
+      end
+    end
+
+    describe "#delete_image" do
+      before(:each) do
+        @id = client.post_image(valid_post)[:_id]
+        @image = client.delete_image(@id)
+      end
+
+      it "should return a hash" do
+        @image.should be_a Hash
+      end
+
+      it "should return the deleted image metadata" do
+        @image[:_id].should == @id
+      end
+
+      it "should trully delete that image from database" do
+        lambda { client.get_image(@id) }.should raise_error not_found
+      end
+
+      it "should raise an exception if image not found" do
+        fake_id = 0
+        lambda { client.delete_image(fake_id) }.should raise_error not_found
+      end
+    end
+
+    describe "#post_image" do
+      before(:each) do
+        @image = client.post_image(valid_post)
+        inserted << @image[:_id]
+      end
+
+      it "should return a hash" do
+        @image.should be_a Hash
+      end
+
+      it "should return posted image metadata" do
+        @image[:_id].should be_a(String)
+        @image[:access].should == valid_post[:access]
+      end
+
+      it "should raise an exception if meta validation fails" do
+        lambda { client.post_image(invalid_post) }.should raise_error invalid
+      end
+    end
+
+    describe "#put_image" do
+      before :each do
+        @id = client.post_image(valid_post)[:_id]
+        inserted << @id
+        @image = client.put_image(@id, valid_update)
+      end
+
+      it "should return a hash" do
+        @image.should be_a Hash
+      end
+
+      it "should return update image metadata" do
+        @image[:_id].should == @id
+        @image[:architecture].should == valid_update[:architecture]
+      end
+
+      it "should raise an exception if meta validation fails" do
+        lambda { client.put_image(@id, invalid_update) }.should raise_error invalid
+      end
+    end
+  end
+end