itchy 0.0.1

data/lib/itchy/metadata_archiver.rb

@@ -0,0 +1,59 @@
+module Itchy
+  # Wraps vmcatcher event handling methods. All events are
+  # stored for subsequent processing. There is no actual image
+  # handling happening here.
+  class MetadataArchiver
+    attr_reader :vmc_configuration, :options
+
+    # Creates an archiver instance for storing vmcatcher
+    # events to the file system for delayed processing.
+    #
+    # @param vmc_configuration [Itchy::VmcatcherConfiguration] vmcatcher configuration
+    # @param options [Hashie::Mash] hash-like structure with options
+    def initialize(vmc_configuration, options)
+      fail ArgumentError, '"vmc_configuration" must be an instance ' \
+           'of Itchy::VmcatcherConfiguration' unless vmc_configuration.is_a? Itchy::VmcatcherConfiguration
+
+      @vmc_configuration = vmc_configuration
+      @options = options || ::Hashie::Mash.new
+
+      init_metadata_dir!
+    end
+
+    # Triggers archiving of the provided event. Event is written
+    # to the file system as a JSON-formatted document for delayed
+    # processing.
+    #
+    # @param vmc_event [Itchy::VmcatcherEvent] event to store
+    def archive!(vmc_event)
+      fail ArgumentError, '"vmc_event" must be an instance ' \
+           'of Itchy::VmcatcherEvent' unless vmc_event.is_a? Itchy::VmcatcherEvent
+
+      Itchy::Log.info "[#{self.class.name}] Archiving " \
+                             "#{vmc_event.type.inspect} " \
+                             "for #{vmc_event.dc_identifier.inspect}"
+
+      begin
+        event_handler = Itchy::EventHandlers.const_get("#{vmc_event.type}EventHandler")
+      rescue NameError => ex
+        raise Itchy::Errors::UnknownEventError,
+              "Unknown event type #{vmc_event.type.inspect} detected: #{ex.message}"
+      end
+
+      event_handler = event_handler.new(vmc_configuration, options)
+      event_handler.archive!(vmc_event)
+    end
+
+    private
+
+    # Runs a basic check on the metadata directory.
+    def init_metadata_dir!
+      Itchy::Log.debug "[#{self.class.name}] Checking metadata directory #{options.metadata_dir.inspect}"
+
+      fail ArgumentError, 'Metadata directory is ' \
+                          'not a directory!' unless File.directory? options.metadata_dir
+      fail ArgumentError, 'Metadata directory is ' \
+                          'not writable!' unless File.writable? options.metadata_dir
+    end
+  end
+end

data/lib/itchy/settings.rb

@@ -0,0 +1,35 @@
+module Itchy
+  # Wraps access to configuration files. Files are loaded
+  # in the following order:
+  #
+  # 1.) ~/.itchy.yml
+  # 2.) /etc/itchy/itchy.yml
+  # 3.) GEM_INSTALL_DIR/config/itchy.yml
+  #
+  # The first available file will be used. Settings are never
+  # merged from multiple files.
+  class Settings < Settingslogic
+    HOME_CONF = File.join(
+      ENV['HOME'],
+      '.itchy.yml'
+    )
+    GLOBAL_CONF = File.join(
+      "#{File::SEPARATOR}etc",
+      'itchy',
+      'itchy.yml'
+    )
+    GEM_CONF = File.join(
+      File.expand_path(File.join('..', '..', '..'), __FILE__),
+      'config',
+      'itchy.yml'
+    )
+
+    source HOME_CONF if File.readable? HOME_CONF
+    source GLOBAL_CONF if File.readable? GLOBAL_CONF
+    source GEM_CONF
+
+    namespace ENV['RAILS_ENV'].blank? ? 'production' : ENV['RAILS_ENV']
+
+    load!
+  end
+end

data/lib/itchy/version.rb

@@ -0,0 +1,3 @@
+module Itchy
+  VERSION = '0.0.1' unless defined?(::Itchy::VERSION)
+end

data/lib/itchy/vmcatcher_configuration.rb

@@ -0,0 +1,62 @@
+module Itchy
+  # Wraps vmcatcher configuration meta data.
+  class VmcatcherConfiguration < VmcatcherEnv
+    # Known methods names used by this class
+    KNOWN_METHOD_NAMES = %w(
+      rdbms
+      cache_event
+      log_conf
+      dir_cert
+      cache_dir_cache
+      cache_dir_download
+      cache_dir_expire
+      cache_action_download
+      cache_action_check
+      cache_action_expire).freeze
+
+    # Prefix for making vmcatcher attributes
+    VMCATCHER_ATTR_PREFIX = 'VMCATCHER_'
+
+    # Known vmcatcher configuration attributes
+    REGISTERED_ENV_KEYS = %w(
+      VMCATCHER_RDBMS
+      VMCATCHER_CACHE_EVENT
+      VMCATCHER_LOG_CONF
+      VMCATCHER_DIR_CERT
+      VMCATCHER_CACHE_DIR_CACHE
+      VMCATCHER_CACHE_DIR_DOWNLOAD
+      VMCATCHER_CACHE_DIR_EXPIRE
+      VMCATCHER_CACHE_ACTION_DOWNLOAD
+      VMCATCHER_CACHE_ACTION_CHECK
+      VMCATCHER_CACHE_ACTION_EXPIRE).freeze
+
+    #    REGISTERED_ENV_KEYS.each do |registered_env_key|
+    #      short_env_key = registered_env_key.gsub(/^VMCATCHER_/, '')
+
+    #      class_eval %Q|
+    # def #{short_env_key.downcase}
+    #  attributes["#{registered_env_key}"]
+    # end
+    # |
+    #    end
+    def method_missing(method_id, *arguments, &block)
+      if KNOWN_METHOD_NAMES.include? method_id.to_s
+        self.class.send :define_method, method_id do
+          temp = VMCATCHER_ATTR_PREFIX + method_id.to_s.upcase
+          attributes["#{temp}"]
+        end
+        send(method_id)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_id, include_private = false)
+      if KNOWN_METHOD_NAMES.include? method_id.to_s
+        true
+      else
+        super
+      end
+    end
+  end
+end

data/lib/itchy/vmcatcher_env.rb

@@ -0,0 +1,58 @@
+module Itchy
+  # Wraps vmcatcher metadata taken from the environment.
+  class VmcatcherEnv
+    # Dummy keys
+    REGISTERED_ENV_KEYS = [].freeze
+
+    attr_reader :attributes
+
+    # Creates an environment instance with pre-filtered
+    # attributes.
+    #
+    # @param env [Object] hash-like or JSON-like object storing the raw environment
+    def initialize(env)
+      env = ::JSON.parse(env) if env.is_a?(String)
+
+      @attributes = Itchy::Helpers::VmcatcherEnvHelper.select_from_env(
+        env,
+        self.class::REGISTERED_ENV_KEYS
+      )
+    end
+
+    # Generates a human-readable JSON document
+    # from available ENV attributes.
+    #
+    # @return [String] pretty JSON document
+    def to_pretty_json
+      ::JSON.pretty_generate attributes
+    end
+
+    # Generates an ordinary JSON document
+    # from available ENV attributes.
+    #
+    # @return [String] JSON document
+    def to_json
+      ::JSON.generate attributes
+    end
+
+    # Converts event attributes into a hash-like
+    # structure.
+    #
+    # @return [Hashie::Mash] hash-like structure with metadata
+    def to_hash
+      attr_converted = ::Hashie::Mash.new
+      attributes.each_pair { |name, val| attr_converted[name.downcase] = val }
+      attr_converted
+    end
+
+    class << self
+      # Creates an instance from a JSON document.
+      #
+      # @param json [String] JSON to create an instance from
+      # @return [Itchy::VmcatcherEnv] instance
+      def from_json(json)
+        new ::JSON.parse(json)
+      end
+    end
+  end
+end

data/lib/itchy/vmcatcher_event.rb

@@ -0,0 +1,71 @@
+module Itchy
+  # Wraps vmcatcher event meta data.
+  class VmcatcherEvent < VmcatcherEnv
+    # Known methods names used by this class
+    KNOWN_METHOD_NAMES = %w(
+      type
+      dc_description
+      dc_identifier
+      dc_title
+      hv_hypervisor
+      hv_size
+      hv_uri
+      hv_format
+      hv_version
+      sl_arch
+      sl_checksum_sha512
+      sl_comments
+      sl_os
+      sl_osversion
+      il_dc_identifier
+      ad_mpuri
+      filename
+      vo).freeze
+
+    # Prefix for making vmcatcher attributes
+    VMCATCHER_ATTR_PREFIX = 'VMCATCHER_EVENT_'
+
+    # Known event attributes used by vmcatcher
+    REGISTERED_ENV_KEYS = %w(
+      VMCATCHER_EVENT_TYPE
+      VMCATCHER_EVENT_DC_DESCRIPTION
+      VMCATCHER_EVENT_DC_IDENTIFIER
+      VMCATCHER_EVENT_DC_TITLE
+      VMCATCHER_EVENT_HV_HYPERVISOR
+      VMCATCHER_EVENT_HV_SIZE
+      VMCATCHER_EVENT_HV_URI
+      VMCATCHER_EVENT_HV_FORMAT
+      VMCATCHER_EVENT_HV_VERSION
+      VMCATCHER_EVENT_SL_ARCH
+      VMCATCHER_EVENT_SL_CHECKSUM_SHA512
+      VMCATCHER_EVENT_SL_COMMENTS
+      VMCATCHER_EVENT_SL_OS
+      VMCATCHER_EVENT_SL_OSVERSION
+      VMCATCHER_EVENT_IL_DC_IDENTIFIER
+      VMCATCHER_EVENT_AD_MPURI
+      VMCATCHER_EVENT_FILENAME
+      VMCATCHER_EVENT_VO).freeze
+
+    def method_missing(method_id, *arguments, &block)
+      if KNOWN_METHOD_NAMES.include? method_id.to_s
+        self.class.send :define_method, method_id do
+          temp = VMCATCHER_ATTR_PREFIX + method_id.to_s.upcase
+
+          Itchy::Log.debug "[#{method_id}] METHOD MISSING CALL "
+          attributes[temp]
+        end
+        send(method_id)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_id, include_private = false)
+      if KNOWN_METHOD_NAMES.include? method_id.to_s
+        true
+      else
+        super
+      end
+    end
+  end
+end

data/lib/itchy.rb

@@ -0,0 +1,26 @@
+require 'active_support/all'
+require 'settingslogic'
+require 'multi_json'
+require 'mixlib/shellout'
+require 'logger'
+require 'uri'
+require 'erb'
+require 'hashie/mash'
+require 'cloud-appliance-descriptor'
+
+# Wraps all internals of the handler.
+module Itchy; end
+
+require 'itchy/version'
+require 'itchy/settings'
+require 'itchy/log'
+require 'itchy/errors'
+require 'itchy/helpers'
+require 'itchy/event_handlers'
+require 'itchy/metadata_archiver'
+require 'itchy/image_transformer'
+require 'itchy/vmcatcher_env'
+require 'itchy/vmcatcher_configuration'
+require 'itchy/vmcatcher_event'
+require 'itchy/event_processer'
+require 'itchy/format_converter'

data/spec/itchy/vmcatcher_env_spec.rb

@@ -0,0 +1 @@
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+# enable coverage reports
+if ENV['COVERAGE']
+  require 'simplecov'
+
+  SimpleCov.add_filter '/spec/'
+  SimpleCov.start
+end
+
+require 'itchy'