visor-image 0.0.1

data/bin/visor

@@ -0,0 +1,423 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'uri'
+require 'progressbar'
+require 'visor-common'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'image/version'
+require 'image/client'
+
+# VISoR management command line interface script.
+#
+# Commands:
+#
+# brief          Show brief metadata of all public images
+# detail         Show detailed metadata of all public images
+# head           Show image detailed metadata
+# get            Retrieve an image metadata and file
+# add            Add a new image metadata and optionally upload its file
+# update         Update an image metadata and/or upload its file
+# delete         Delete an image metadata and its file
+# help <cmd>     Show help message for one of the above commands
+#
+# Run <visor -h> to get more usage help.
+#
+class VisorCLI
+  include Visor::Common::Exception
+  include Visor::Common::Config
+
+  # VISoR Image CLI version
+  VERSION = '0.0.1'
+
+  attr_reader :argv, :options, :parser, :command
+
+  # Initialize a new CLI
+  def initialize(argv=ARGV)
+    @argv    = argv
+    @options = load_conf_file
+    @parser  = parser
+    @command = parse!
+  end
+
+  # OptionParser parser
+  def parser
+    OptionParser.new do |opts|
+      opts.banner = "Usage: visor <command> [options]"
+
+      opts.separator ""
+      opts.separator "Commands:"
+      opts.separator "     brief          Show brief metadata of all public images"
+      opts.separator "     detail         Show detailed metadata of all public images"
+      opts.separator "     head           Show image detailed metadata"
+      opts.separator "     get            Retrieve an image metadata and file"
+      opts.separator "     add            Add a new image metadata and optionally upload its file"
+      opts.separator "     update         Update an image metadata and/or upload its file"
+      opts.separator "     delete         Delete an image metadata and its file"
+      opts.separator "     clean          Delete all images metadata and files"
+      opts.separator "     help <cmd>     Show help message for one of the above commands"
+
+
+      opts.separator ""
+      opts.separator "Options:"
+      opts.on("-a", "--address HOST", "Address of VISoR Image host (default: #{options[:host]})") { |addr| options[:host] = addr }
+      opts.on("-p", "--port PORT", "Port were VISoR Image host listens (default: #{options[:port]})") { |port| options[:port] = port }
+      opts.on("-q", "--query QUERY", "HTTP query like string to filter results") do |query|
+        begin
+          options[:query] = URI.decode_www_form(query)
+        rescue
+          abort "The provided query string is not valid."
+        end
+      end
+      opts.on("-s", "--sort ATTRIBUTE", "Attribute to sort results (default: _id)") do |attr|
+        options[:query] = [] unless options[:query]
+        options[:query] << URI.decode_www_form("sort=#{attr}").flatten
+      end
+      opts.on("-d", "--dir DIRECTION", "Direction to sort results (asc/desc) (default: asc)") do |dir|
+        options[:query] = [] unless options[:query]
+        options[:query] << URI.decode_www_form("dir=#{dir}").flatten
+      end
+      opts.on("-f", "--file IMAGE", "Image file path to upload") { |path| options[:file] = path }
+      opts.on("-S", "--save DIRECTORY", "Directory to save downloaded image (default: './')") { |path| options[:save] = path }
+
+      opts.separator ""
+      opts.separator "Common options:"
+      opts.on_tail("-D", "--dry-run", "Don't persist results, just print what would it do") { options[:dry] = true }
+      opts.on_tail('-v', '--verbose', "Enable verbose") { options[:verbose] = true }
+      opts.on_tail("-h", "--help", "Show this help message") { puts opts; exit 0 }
+      opts.on_tail('-V', '--version', "Show version") { puts "VISoR Image CLI v#{VERSION}"; exit 0 }
+    end
+  end
+
+  # Parse argv arguments
+  def parse!
+    parser.parse! ARGV
+    ARGV.shift
+  end
+
+  # Parse the current shell arguments and run the command
+  def run!
+    abort parser.to_s if command.nil?
+    start = Time.now
+    case command
+    when 'brief' then
+      brief
+    when 'detail' then
+      detail
+    when 'head' then
+      head
+    when 'get' then
+      get
+    when 'add' then
+      add
+    when 'update' then
+      update
+    when 'delete' then
+      delete
+    when 'help' then
+      help
+    else
+      abort "Unknown command '#{command}'"
+    end
+    finish = Time.now
+    printf("Done in %-0.4f seconds", finish - start) if verbose?
+    exit 0
+  end
+
+  # Show brief metadata of all public images
+  def brief
+    str    = "%-37s %-21s %-13s %-12s %-8s %-10s %-10s\n"
+    images = client.get_images(options[:query])
+
+    puts "Found #{images.size} public images records..."
+    printf(str, 'ID', 'NAME', 'ARCHITECTURE', 'TYPE', 'FORMAT', 'STORE', 'SIZE')
+    puts "#{'-'*36+"  "+'-'*20+"  "+'-'*12+"  "+'-'*11+"  "+'-'*6+"  "+'-'*10+"  "+'-'*10}"
+
+    images.each do |image|
+      printf(str, image[:_id], image[:name], image[:architecture], image[:type] || '-', image[:format] || '-', image[:store] || '-', image[:size] || '-')
+    end
+  rescue NotFound => e
+    puts e.message
+  rescue => e
+    abort "Failure while executing 'brief':\n#{e.message}"
+  end
+
+  # Show detailed metadata of all public images
+  def detail
+    images = client.get_images_detail(options[:query])
+    puts "Found #{images.size} public images records..."
+
+    images.each do |image|
+      puts('-'*80)
+      print_meta(image, false)
+    end
+  rescue NotFound => e
+    puts e.message
+  rescue => e
+    abort "Failure while executing 'detail':\n#{e.message}"
+  end
+
+  # Show image detailed metadata
+  def head
+    id = argv.shift
+    abort "No image ID provided as first argument, please provide it." unless id
+    image = client.head_image(id)
+    print_meta(image)
+  rescue NotFound => e
+    puts e.message
+  rescue => e
+    abort "Failure while executing 'head':\n#{e.message}"
+  end
+
+  # Retrieve an image metadata and file
+  def get
+    id = argv.shift
+    abort "No image ID provided as first argument, please provide it." unless id
+
+    image = client.head_image(id)
+    print_meta(image)
+    path = File.expand_path(options[:save] || './')
+    fp   = File.expand_path(File.join(path, "#{id}.#{image[:format] || 'none'}"))
+
+    raise "Cannot locate directory '#{path}'." unless Dir.exists? path
+    #raise "File #{fp} already exists." if File.exists? fp  #TODO: restore this
+
+    if File.exists? fp
+      require "securerandom"
+      fp = "#{fp}_#{SecureRandom.random_number.to_s[11..-1]}"
+    end
+
+    file          = File.open(fp, 'wb')
+    pbar          = ProgressBar.new("Progress", image[:size])
+    pbar.bar_mark = '='
+
+    puts "Downloading image #{id}..."
+    client.get_image(id) do |chunk|
+      pbar.inc(chunk.size)
+      file.write(chunk)
+    end
+    pbar.finish
+    file.close
+  rescue NotFound => e
+    puts e.message
+  rescue => e
+    abort "Failure while executing 'get':\n#{e.message}"
+  end
+
+# Add a new image metadata and optionally upload its file
+  def add
+    file = options[:file]
+    if file
+      fp = File.expand_path(file)
+      abort "Cannot locate image file at #{fp}." unless File.exists? fp
+      puts "Adding new metadata and uploading file..."
+    end
+
+    begin
+      meta  = parse_meta_from_args
+      image = client.post_image(meta, file)
+      puts "Successfully added new metadata and image with ID #{image[:_id]}." if file
+      puts "Successfully added new metadata with ID #{image[:_id]}." unless file
+      print_meta(image)
+    rescue NotFound => e
+      puts e.message
+    rescue => e
+      abort "Failure while executing 'add':\n#{e.message}"
+    end
+  end
+
+# Update an image metadata and/or upload its file
+  def update
+    id   = argv.shift
+    file = options[:file]
+    abort "No image ID provided as first argument, please provide it." unless id
+    if file
+      fp = File.expand_path(file)
+      abort "Cannot locate image file at #{fp}." unless File.exists?(fp)
+      puts "Updating metadata and uploading file..."
+    end
+
+    begin
+      meta  = parse_meta_from_args
+      image = client.put_image(id, meta, file)
+      puts "Successfully updated and uploaded image #{id}." if file
+      puts "Successfully updated image #{id}." unless file
+      print_meta(image) if verbose?
+    rescue NotFound => e
+      puts e.message
+    rescue => e
+      abort "Failure while executing 'update':\n#{e.message}"
+    end
+  end
+
+# Delete an image metadata and its file
+  def delete
+    begin
+      if query = options[:query]
+        result = client.delete_by_query(query)
+        result.each { |image| puts "Successfully deleted image #{image[:_id]}." }
+      else
+        argv.each do |id|
+          abort "No image ID provided as first argument, please provide it." unless id
+          image = client.delete_image(id)
+          puts "Successfully deleted image #{id}."
+          print_meta(image) if verbose?
+        end
+      end
+    rescue NotFound => e
+      puts e.message
+    rescue => e
+      abort "Failure while executing 'delete':\n#{e.message}"
+    end
+  end
+
+# Show help message for one of the above commands
+  def help
+    cmd = argv[0]
+    abort "Please provide a command name as argument (example: visor help brief)." unless cmd
+
+    case cmd.to_sym
+    when :brief
+      puts %q[Usage: visor brief [options]
+
+Returns brief metadata of all public images.
+
+You can filter results based on a query using the --query (-q) option.
+It's possible to sort and order results with the --sort (-s) and --dir (-d) options.
+
+Examples:
+  $ visor brief --query 'architecture=i386'
+  $ visor brief --query 'architecture=i386&format=iso'
+  $ visor detail --sort name --dir desc]
+    when :detail
+      %q[Usage: visor detail [options]
+
+Returns detailed metadata of all public images.
+
+You can filter results based on a query using the --query (-q) option.
+It's possible to sort and order results with the --sort (-s) and --dir (-d) options.
+
+Examples:
+  $ visor detail --query 'architecture=i386'
+  $ visor detail --query 'architecture=i386&format=iso'
+  $ visor detail --sort name --dir desc]
+    when :head
+      puts "Usage: visor head <ID> [options]\n\nReturns detailed metadata of the image with the given ID."
+    when :get
+      puts %q[Usage: visor get <ID> [options]
+
+Returns detailed metadata and image file of the image with the given ID.
+You can provide the --save (-S) option defining the path where the image should be saved.
+
+Examples:
+  $ visor get 8074d23e-a9c0-454d-b935-cda5f6eb1bc8 --save '~/VMs/']
+    when :add
+      puts %q[Usage: visor add <ATTRIBUTES> [options]
+
+Add new metadata and optionally upload the image file.
+
+The following attributes can be specified as key/value pairs:
+
+        name: The image name
+architecture: The Image operating system architecture (available: i386 x86_64)
+      access: If the image is public or private (available: public private)
+      format: The format of the image's disk (available: none iso vhd vdi vmdk ami aki ari)
+        type: The type of the image (available: none kernel ramdisk amazon eucalyptus openstack opennebula nimbus)
+       store: The storage system to save image in (available: s3 http file)
+    location: The location URI of the already somewhere stored image
+
+Any other custom image property can be passed too as additional key/value pairs.
+
+Provide the --file option with the path to the image to be uploaded and the 'store' attribute,
+defining the store where the image should be uploaded to.
+
+Examples:
+  $ visor add name='Ubuntu 11.10' architecture='x86_64' location='http://www.domain.com/path-to-image'
+  $ visor add name='Ubuntu 11.10' architecture='x86_64' store='s3' --file '~/VMs/ubuntu-11.10-x86_64.iso']
+    when :update
+      puts %q[Usage: visor update <ID> [options]
+
+Updates metadata and/or uploads image file of the image with the given ID.
+
+The following attributes can be specified as key/value pairs:
+
+        name: The image name
+architecture: The Image operating system architecture (available: i386 x86_64)
+      access: If the image is public or private (available: public private)
+      format: The format of the image's disk (available: none iso vhd vdi vmdk ami aki ari)
+        type: The type of the image (available: none kernel ramdisk amazon eucalyptus openstack opennebula nimbus)
+       store: The storage system to save image in (available: s3 http file)
+    location: The location URI of the already somewhere stored image
+
+Any other custom image property can be passed too as additional key/value pairs.
+
+It is possible to upload and assign an image file to an already registered metadata:
+
+Provide the --file option with the path to the image to be uploaded and the 'store' attribute,
+defining the store where the image should be uploaded to.
+
+Examples:
+  $ visor update 8074d23e... format='iso'
+  $ visor update 8074d23e... format='iso' location='http://www.domain.com/path-to-image'
+  $ visor update 8074d23e... store='s3' --file '~/VMs/ubuntu-11.10-x86_64.iso']
+    when :delete
+      puts "Usage: visor delete <ID> [options]\n\nDeletes metadata and image file of the image with the given ID."
+    else
+      abort "Unknown command '#{cmd}'"
+    end
+  end
+
+  private
+
+# Pretty print image metadata
+  def print_meta(meta, breaklines=true)
+    puts '' if breaklines
+    order_attributes(meta).each { |k, v| puts "#{k.upcase.to_s.rjust(12)}: #{v}" }
+    puts '' if breaklines
+  end
+
+# Load configuration file options
+  def load_conf_file
+    config = Visor::Common::Config.load_config(:visor_image)
+    {host: config[:bind_host], port: config[:bind_port]}
+  rescue => e
+    raise "There was an error loading the configuration file: #{e.message}"
+  end
+
+# Get a new VISoR Image Client instance
+  def client
+    Visor::Image::Client.new(options)
+  end
+
+# Find if verbose mode is active
+  def verbose?
+    options[:verbose]
+  end
+
+# Properly order metadata hashes
+  def order_attributes(hash)
+    order = {_id:  '-', uri: '-', name: '-', architecture: '-', access: '-', status: '-', type: '-', format: '-',
+             size: '-', store: '-', location: '-', kernel: '-', ramdisk: '-', created_at: '-', updated_at: '-', checksum: '-'}
+    order.merge(hash)
+  end
+
+# Parse key/value pair arguments to a valid metadata hash
+  def parse_meta_from_args
+    meta = {}
+    raise "You should provide at least one key=value pair." if argv.empty?
+    argv.each do |arg|
+      k, v = arg.split('=')
+      raise "Arguments should be in the form of key=value pairs." unless k && v
+      meta[k.downcase.sub('-', '_')] = v
+    end
+    meta
+  end
+
+end
+
+# Execute if file is called
+#if __FILE__ == $0
+VisorCLI.new.run!
+#end
+

data/bin/visor-image

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# VISoR Image Server command line interface script.
+# Run <visor-image -h> to get more usage help.
+
+require File.expand_path('../../lib/visor-image', __FILE__)
+
+ENV['GOLIATH_CONF'] = File.expand_path('../../config/server.rb', __FILE__)
+STDERR.puts ENV['GOLIATH_CONF']
+Visor::Image::CLI.new(ARGV).run!

data/config/server.rb

@@ -0,0 +1,14 @@
+conf      = Visor::Common::Config.load_config
+
+meta_host = conf[:visor_meta][:bind_host]
+meta_port = conf[:visor_meta][:bind_port]
+
+auth_host = conf[:visor_auth][:bind_host]
+auth_port = conf[:visor_auth][:bind_port]
+
+log_level = conf[:visor_image][:log_level]
+
+logger.level      = (log_level == 'INFO' ? 1 : 0)
+config['vms']     = Visor::Image::Meta.new(host: meta_host, port: meta_port)
+config['vas']     = Visor::Image::Auth.new(host: auth_host, port: auth_port)
+config['configs'] = conf[:visor_store]

data/lib/image/auth.rb

@@ -0,0 +1,147 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module Visor
+  module Image
+
+    # The Client API for the VISoR Auth.
+    #
+    # After Instantiate a Client object its possible to directly interact with the auth server and its
+    # database backend.
+    #
+    class Auth
+
+      include Visor::Common::Exception
+
+      configs = Common::Config.load_config :visor_auth
+
+      DEFAULT_HOST = configs[:bind_host] || '0.0.0.0'
+      DEFAULT_PORT = configs[:bind_port] || 4567
+
+      attr_reader :host, :port, :ssl
+
+      def initialize(opts = {})
+        @host       = opts[:host] || DEFAULT_HOST
+        @port       = opts[:port] || DEFAULT_PORT
+        @ssl        = opts[:ssl] || false
+      end
+
+      def get_users(query = {})
+        str     = build_query(query)
+        request = Net::HTTP::Get.new("/users#{str}")
+        do_request(request)
+      end
+
+      def get_user(access_key)
+        request = Net::HTTP::Get.new("/users/#{access_key}")
+        do_request(request)
+      end
+
+      def post_user(info)
+        request      = Net::HTTP::Post.new('/users')
+        request.body = prepare_body(info)
+        do_request(request)
+      end
+
+      def put_user(access_key, info)
+        request      = Net::HTTP::Put.new("/users/#{access_key}")
+        request.body = prepare_body(info)
+        do_request(request)
+      end
+
+      def delete_user(access_key)
+        request = Net::HTTP::Delete.new("/users/#{access_key}")
+        do_request(request)
+      end
+
+      private
+
+      # Parses a response body with the JSON parser and extracts and returns a single
+      # key value from it if defined, otherwise returns all the body.
+      #
+      # @param key (nil) [Symbol] The hash key to extract the wanted value.
+      # @param response [Net::HTTPResponse] The response which contains the body to parse.
+      #
+      # @return [String, Hash] If key is provided and exists on the response body, them return
+      #   its value, otherwise return all the body hash.
+      #
+      def parse(key=nil, response)
+        parsed = JSON.parse(response.body, symbolize_names: true)
+        key ? parsed[key] : parsed
+      end
+
+      # Generate a valid URI query string from key/value pairs of the given hash.
+      #
+      # @param opts [Hash] The hash with the key/value pairs to generate query from.
+      #
+      # @return [String] The generated query in the form of "?k=v&k1=v1".
+      #
+      def build_query(opts)
+        opts.empty? ? '' : '?' + URI.encode_www_form(opts)
+      end
+
+      # Fill common header keys before each request. This sets the 'User-Agent' and 'Accept'
+      # headers for every request and additionally sets the 'content-type' header
+      # for POST and PUT requests.
+      #
+      # @param request [Net::HTTPResponse] The request which will be modified in its headers.
+      #
+      def prepare_headers(request)
+        request['User-Agent'] = 'VISoR image server'
+        request['Accept']     = 'application/json'
+        request['content-type'] = 'application/json' if ['POST', 'PUT'].include?(request.method)
+      end
+
+      # Generate a valid JSON request body for POST and PUT requests.
+      # It generates a JSON object encapsulated inside a :image key and then returns it.
+      #
+      # @param hash [Hash] The hash with the key/value pairs to generate a JSON object from.
+      #
+      # @return [Hash] If an :image key is already present in the hash, it just returns the plain
+      #   JSON object, otherwise, encapsulate the hash inside a :image key and returns it.
+      #
+      def prepare_body(hash)
+        hash.has_key?(:user) ? hash.to_json : {user: hash}.to_json
+      end
+
+      # Process requests by preparing its headers, launch them and assert or raise their response.
+      #
+      # @param request [Net::HTTPResponse] The request which will be launched.
+      #
+      # @return [String, Hash] If an error is raised, then it parses and returns its message,
+      #   otherwise it properly parse and return the response body.
+      #
+      # @raise [NotFound] If required image was not found (on a GET, PUT or DELETE request).
+      # @raise [Invalid] If image meta validation fails (on a POST or PUT request).
+      #
+      def do_request(request)
+        prepare_headers(request)
+        response = http_or_https.request(request)
+        case response
+        when Net::HTTPNotFound then
+          raise NotFound, parse(:message, response)
+        when Net::HTTPBadRequest then
+          raise Invalid, parse(:message, response)
+        else
+          parse(:user, response) or parse(:users, response)
+        end
+      end
+
+      # Generate a new HTTP or HTTPS connection based on initialization parameters.
+      #
+      # @return [Net::HTTP] A HTTP or HTTPS (not done yet) connection ready to use.
+      #
+      def http_or_https
+        if @ssl
+          #TODO: ssl connection
+          #https://github.com/augustl/net-http-cheat-sheet/blob/master/ssl_and_https.rb
+        else
+          Net::HTTP.new(@host, @port)
+        end
+      end
+
+    end
+  end
+end