visor-image 0.0.1

data/lib/image/store/store.rb

@@ -0,0 +1,39 @@
+require 'uri'
+
+module Visor
+  module Image
+
+    # Visor Image Store module encapsulates all store backend classes, plus a set of
+    # utility methods common to all stores.
+    #
+    module Store
+      extend self
+      include Visor::Common::Exception
+
+      # Base API mapping for the multiple storage backend classes
+      BACKENDS = {:s3        => Visor::Image::Store::S3,
+                  :cumulus   => Visor::Image::Store::Cumulus,
+                  :walrus    => Visor::Image::Store::Walrus,
+                  :lunacloud => Visor::Image::Store::Lunacloud,
+                  :hdfs      => Visor::Image::Store::HDFS,
+                  :file      => Visor::Image::Store::FileSystem,
+                  :http      => Visor::Image::Store::HTTP}
+
+      # Get a store backend class object ready to use, based on a file URI or store name.
+      #
+      # @param string [String] The file location URI or backend name.
+      # @param config [Hash] A set of configurations for the wanted store, loaded from
+      #   VISoR configuration file.
+      #
+      # @return [Object] An instantiated store object ready to use.
+      #
+      def get_backend(string, config)
+        name  = URI(string).scheme || string
+        store = BACKENDS[name.to_sym]
+        raise UnsupportedStore, "The store '#{name}' is not supported" unless store
+        store.new(string, config)
+      end
+
+    end
+  end
+end

data/lib/image/store/walrus.rb

@@ -0,0 +1,130 @@
+require 'uri'
+require 's3restful'
+require 'em-synchrony'
+require 'em-synchrony/em-http'
+
+module Visor
+  module Image
+    module Store
+
+      # The Eucalyptus Walrus (Walrus) backend store.
+      #
+      # This class handles the management of image files located in the Walrus storage system,
+      # based on a URI like *walrus://<access_key>:<secret_key>@<host>:<port>/<bucket>/<image>*.
+      #
+      class Walrus
+        include Visor::Common::Exception
+
+        attr_accessor :uri, :config, :access_key, :secret_key, :bucket, :file, :host, :port
+
+        # Initializes a new Walrus store client object. Walrus credentials are loaded from the URI,
+        # on GET and DELETE operations, or from the configuration file for POST and PUT operation.
+        #
+        # @param [String] uri The URI of the file location.
+        # @param config [Hash] A set of configurations for the wanted store, loaded from
+        #   VISoR configuration file.
+        #
+        # @return [Object] An instantiated Walrus store object ready to use.
+        #
+        def initialize(uri, config)
+          @uri    = URI(uri)
+          @config = config[:walrus]
+
+          if @uri.scheme
+            @access_key = @uri.user
+            @secret_key = @uri.password
+            # Trick:
+            # To build a successful Walrus connection we need happening to sign the
+            # '/services/Walrus' in path too. If we append it to server's address it wont get
+            # signed in the authorization string, we need to prepend it to the bucket name
+            @bucket     = File.join('services/Walrus', @uri.path.split('/')[3])
+            @file       = @uri.path.split('/').last
+            @host       = @uri.host
+            @port       = @uri.port
+          else
+            @access_key = @config[:access_key]
+            @secret_key = @config[:secret_key]
+            @bucket     = File.join('services/Walrus', @config[:bucket])
+            @host       = @config[:host]
+            @port       = @config[:port]
+          end
+        end
+
+        # Returns a Happening library S3 Walrus compatible connection object.
+        #
+        # @return [Happening::S3::Item] A new Walrus connection object.
+        #
+        def connection
+          S3restful::S3::Item.new(bucket, file, server: host, port: port, protocol: 'http',
+                                  aws_access_key_id: access_key, aws_secret_access_key: secret_key)
+        end
+
+        # Returns the image file to clients, streamed in chunks.
+        #
+        # @return [Object] Yields the file, a chunk at time.
+        #
+        def get
+          s3     = connection.aget
+          finish = proc { yield nil }
+
+          s3.stream { |chunk| yield chunk }
+          s3.callback &finish
+          s3.errback &finish
+        end
+
+        # Saves the image file to the its final destination, based on the temporary file
+        # created by the server at data reception time.
+        #
+        # @param [String] id The image id.
+        # @param [File] tmp_file The temporary file descriptor.
+        # @param [String] format The image file format.
+        #
+        # @return [String, Integer] The generated file location URI and image file size.
+        #
+        # @raise [Duplicated] If the image file already exists.
+        #
+        def save(id, tmp_file, format)
+          @file = "#{id}.#{format}"
+          uri   = "walrus://#{access_key}:#{secret_key}@#{host}:#{port}/#{bucket}/#{file}"
+          size  = tmp_file.size
+
+          raise Duplicated, "The image file #{fp} already exists" if file_exists?(false)
+          STDERR.puts "COPYING!!"
+
+          connection.store tmp_file.path
+
+          [uri, size]
+        end
+
+        # Deletes the image file from its location.
+        #
+        # @raise [NotFound] If the image file was not found.
+        #
+        def delete
+          connection.delete
+        end
+
+        # Check if the image file exists.
+        #
+        # @param [True, False] raise_exc (true) If it should raise exception or return
+        #   true/false whether the file exists or not.
+        #
+        # @return [True, False] If raise_exc is false, return true/false whether the
+        #   file exists or not.
+        #
+        # @raise [NotFound] If the image file was not found.
+        #
+        def file_exists?(raise_exc=true)
+          exist   = nil
+          error   = proc { exist = false }
+          success = proc { |res| exist = true if res.response_header.status == 200 }
+
+          connection.head(on_error: error, on_success: success)
+          raise NotFound, "No image file found at #{uri}" if raise_exc && !exist
+          exist
+        end
+      end
+
+    end
+  end
+end

data/lib/image/version.rb

@@ -0,0 +1,5 @@
+module Visor
+  module Image
+    VERSION = "0.0.1"
+  end
+end

data/lib/visor-image.rb

@@ -0,0 +1,30 @@
+require 'goliath'
+require 'visor-common'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'image/version'
+require 'image/meta'
+require 'image/auth'
+require 'image/cli'
+require 'image/store/s3'
+require 'image/store/cumulus'
+require 'image/store/walrus'
+require 'image/store/lunacloud'
+require 'image/store/hdfs'
+require 'image/store/http'
+require 'image/store/file_system'
+require 'image/store/store'
+require 'image/routes/head_image'
+require 'image/routes/get_images'
+require 'image/routes/get_images_detail'
+require 'image/routes/get_image'
+require 'image/routes/post_image'
+require 'image/routes/put_image'
+require 'image/routes/delete_image'
+require 'image/routes/delete_all_images'
+require 'image/server'
+require 'image/client'
+
+
+

data/spec/lib/meta_spec.rb

@@ -0,0 +1,230 @@
+require "spec_helper"
+
+describe Visor::Image::Meta do
+
+  let(:meta) { Visor::Image::Meta.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
+    EM.synchrony do
+      inserted << meta.post_image(valid_post)[:_id]
+      inserted << meta.post_image(valid_post.merge(architecture: 'x86_64'))[:_id]
+      EM.stop
+    end
+  end
+
+  after(:all) do
+    EM.synchrony do
+      inserted.each { |id| meta.delete_image(id) }
+      EM.stop
+    end
+  end
+
+  describe "#initialize" do
+    it "should create a new meta api object with default parameters" do
+      meta.host.should == Visor::Image::Meta::DEFAULT_HOST
+      meta.port.should == Visor::Image::Meta::DEFAULT_PORT
+    end
+
+    it "should create a new meta api object with custom parameters" do
+      custom = Visor::Image::Meta.new(host: '0.0.0.0', port: 1111)
+      custom.host.should == '0.0.0.0'
+      custom.port.should == 1111
+    end
+  end
+
+  describe "#get_images" do
+    it "should return an array of hashes" do
+      EM.synchrony do
+        res = meta.get_images
+        res.should be_a Array
+        res.each { |h| h.should be_a Hash }
+        EM.stop
+      end
+    end
+
+    it "should filter results by parameter" do
+      EM.synchrony do
+        res = meta.get_images(architecture: 'i386')
+        res.each { |h| h[:architecture].should == 'i386' }
+        EM.stop
+      end
+    end
+
+    it "should sort results by parameter and direction" do
+      EM.synchrony do
+        pub = meta.get_images(sort: 'architecture', dir: 'desc')
+        pub.first[:architecture].should == 'x86_64'
+        pub = meta.get_images(sort: 'architecture', dir: 'asc')
+        pub.first[:architecture].should == 'i386'
+        EM.stop
+      end
+    end
+
+    it "should raise if no matches found" do
+      EM.synchrony do
+        lambda { meta.get_images(:name => 'fake') }.should raise_error not_found
+        EM.stop
+      end
+    end
+  end
+
+  describe "#get_images_detail" do
+    it "should return an array of hashes" do
+      EM.synchrony do
+        res = meta.get_images
+        res.should be_a Array
+        res.each { |h| h.should be_a Hash }
+        EM.stop
+      end
+    end
+
+    it "should filter results by parameter" do
+      EM.synchrony do
+        res = meta.get_images(architecture: 'x86_64')
+        res.each { |h| h[:architecture].should == 'x86_64' }
+        EM.stop
+      end
+    end
+
+    it "should sort results by parameter and direction" do
+      EM.synchrony do
+        pub = meta.get_images(sort: 'architecture', dir: 'desc')
+        pub.first[:architecture].should == 'x86_64'
+        pub = meta.get_images(sort: 'architecture', dir: 'asc')
+        pub.first[:architecture].should == 'i386'
+        EM.stop
+      end
+    end
+
+    it "should raise if no matches found" do
+      EM.synchrony do
+        lambda { meta.get_images(:name => 'fake') }.should raise_error not_found
+        EM.stop
+      end
+    end
+  end
+
+  describe "#get_image" do
+    before(:each) do
+      EM.synchrony do
+        @id = meta.post_image(valid_post)[:_id]
+        inserted << @id
+        @image = meta.get_image(@id)
+        EM.stop
+      end
+    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
+      EM.synchrony do
+        lambda { meta.get_image(fake_id) }.should raise_error not_found
+        EM.stop
+      end
+    end
+  end
+
+  describe "#delete_image" do
+    before(:each) do
+      EM.synchrony do
+        @id    = meta.post_image(valid_post)[:_id]
+        @image = meta.delete_image(@id)
+        EM.stop
+      end
+    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
+      EM.synchrony do
+        lambda { meta.get_image(@id) }.should raise_error not_found
+        EM.stop
+      end
+    end
+
+    it "should raise an exception if image not found" do
+      fake_id = 0
+      EM.synchrony do
+        lambda { meta.delete_image(fake_id) }.should raise_error not_found
+        EM.stop
+      end
+    end
+  end
+
+  describe "#post_image" do
+    before(:each) do
+      EM.synchrony do
+        @image = meta.post_image(valid_post)
+        inserted << @image[:_id]
+        EM.stop
+      end
+    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
+      EM.synchrony do
+        lambda { meta.post_image(invalid_post) }.should raise_error invalid
+        EM.stop
+      end
+    end
+  end
+
+  describe "#put_image" do
+    before :each do
+      EM.synchrony do
+        @id = meta.post_image(valid_post)[:_id]
+        inserted << @id
+        @image = meta.put_image(@id, valid_update)
+        EM.stop
+      end
+    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
+      EM.synchrony do
+        lambda { meta.put_image(@id, invalid_update) }.should raise_error invalid
+        EM.stop
+      end
+    end
+  end
+
+end

data/spec/lib/routes/delete_image_spec.rb

@@ -0,0 +1,98 @@
+require "spec_helper"
+
+describe Visor::Image::Server do
+
+  let(:test_api) { Visor::Image::Server }
+  let(:err) { Proc.new { fail "API request failed" } }
+
+  let(:accept_json) { {'Accept' => 'application/json'} }
+  let(:accept_xml) { {'Accept' => 'application/xml'} }
+
+  let(:parse_opts) { {symbolize_names: true} }
+  let(:valid_post) { {name: 'server_spec', architecture: 'i386', access: 'public'} }
+  let(:api_options) { {config: File.expand_path(File.join(File.dirname(__FILE__), '../../../', 'config/server.rb'))} }
+
+  inserted = []
+
+  before(:each) do
+    EM.synchrony do
+      inserted << DB.post_image(valid_post)[:_id]
+      EM.stop
+    end
+  end
+
+  after(:all) do
+    EM.synchrony do
+      inserted.each { |id| DB.delete_image(id) }
+      EM.stop
+    end
+  end
+
+  #
+  # DELETE     /images/<id>
+  #
+  describe "DELETE /images/:id" do
+
+    it "should delete an image metadata" do
+      id = inserted.delete_at(0)
+
+      with_api(test_api, api_options) do
+        delete_request({:path => "/images/#{id}"}, err) do |c|
+          assert_200 c
+          c.response.should be_a String
+        end
+      end
+
+      with_api(test_api, api_options) do
+        delete_request({:path => "/images/#{id}"}, err) do |c|
+          assert_404 c
+          c.response.should match /id/
+        end
+      end
+    end
+
+    it "should return a JSON string if no accept header provided" do
+      with_api(test_api, api_options) do
+        id = inserted.delete_at(0)
+        delete_request({:path => "/images/#{id}"}, err) do |c|
+          assert_200 c
+          c.response.should match /\{/
+        end
+      end
+    end
+
+    it "should return a JSON string if accepted" do
+      with_api(test_api, api_options) do
+        id = inserted.delete_at(0)
+        delete_request({:path => "/images/#{id}", head: accept_json}, err) do |c|
+          assert_200 c
+          c.response.should match /\{/
+        end
+      end
+    end
+
+    it "should return a XML document if accepted" do
+      with_api(test_api, api_options) do
+        id = inserted.delete_at(0)
+        delete_request({:path => "/images/#{id}", head: accept_xml}, err) do |c|
+          assert_200 c
+          c.response.should match /\<?xml/
+        end
+      end
+    end
+
+    it "should raise a HTTPNotFound 404 error if no images found" do
+      with_api(test_api, api_options) do
+        delete_request({:path => "/images/fakeid"}, err) do |c|
+          assert_404 c
+          c.response.should match /fakeid/
+        end
+      end
+    end
+
+    it "should raise a HTTPInternalServer 500 error if no server error" do
+
+    end
+
+  end
+end