bbrowning-deltacloud-core 0.0.4-java

data/lib/deltacloud/base_driver/features.rb

@@ -0,0 +1,166 @@
+require 'deltacloud/validation'
+
+# Add advertising of optional features to the base driver
+module Deltacloud
+
+  class FeatureError < StandardError; end
+  class DuplicateFeatureDeclError < FeatureError; end
+  class UndeclaredFeatureError < FeatureError; end
+
+  class BaseDriver
+
+    # An operation on a collection like cretae or show. Features
+    # can add parameters to operations
+    class Operation
+      attr_reader :name
+
+      include Deltacloud::Validation
+
+      def initialize(name, &block)
+        @name = name
+        @params = {}
+        instance_eval &block
+      end
+    end
+
+    # The declaration of a feature, defines what operations
+    # are modified by it
+    class FeatureDecl
+      attr_reader :name, :operations
+
+      def initialize(name, &block)
+        @name = name
+        @operations = []
+        instance_eval &block
+      end
+
+      def description(text=nil)
+        @description = text if text
+        @description
+      end
+
+      # Add a new operation or modify an existing one through BLOCK
+      def operation(name, &block)
+        unless op = @operations.find { |op| op.name == name }
+          op = Operation.new(name, &block)
+          @operations << op
+        else
+          op.instance_eval(&block) if block_given?
+        end
+        op
+      end
+    end
+
+    # A specific feature enabled by a driver (see +feature+)
+    class Feature
+      attr_reader :decl
+
+      def initialize(decl, &block)
+        @decl = decl
+        instance_eval &block if block_given?
+      end
+
+      def name
+        decl.name
+      end
+
+      def operations
+        decl.operations
+      end
+
+      def description
+        decl.description
+      end
+    end
+
+    def self.feature_decls
+      @@feature_decls ||= {}
+    end
+
+    def self.feature_decl_for(collection, name)
+      decls = feature_decls[collection]
+      if decls
+        decls.find { |dcl| dcl.name == name }
+      else
+        nil
+      end
+    end
+
+    # Declare a new feature
+    def self.declare_feature(collection, name, &block)
+      feature_decls[collection] ||= []
+      raise DuplicateFeatureDeclError if feature_decl_for(collection, name)
+      feature_decls[collection] << FeatureDecl.new(name, &block)
+    end
+
+    def self.features
+      @@features ||= {}
+    end
+
+    # Declare in a driver that it supports a specific feature
+    #
+    # The same feature can be declared multiple times in a driver, so that
+    # it can be changed successively by passing in different blocks.
+    def self.feature(collection, name, &block)
+      features[collection] ||= []
+      if f = features[collection].find { |f| f.name == name }
+        f.instance_eval(&block) if block_given?
+        return f
+      end
+      unless decl = feature_decl_for(collection, name)
+        raise UndeclaredFeatureError, "No feature #{name} for #{collection}"
+      end
+      features[collection] << Feature.new(decl, &block)
+    end
+
+    def features(collection)
+      self.class.features[collection] || []
+    end
+
+    #
+    # Declaration of optional features
+    #
+    declare_feature :images,  :owner_id do
+      description "Filter images using owner id"
+      operation :index do
+        param :owner_id,  :string,  :optional,  nil,  "Owner ID"
+      end
+    end
+
+    declare_feature :instances, :user_name do
+      description "Accept a user-defined name on instance creation"
+      operation :create do
+        param :name, :string, :optional, nil,
+        "The user-defined name"
+      end
+    end
+
+    declare_feature :instances, :user_data do
+      description "Make user-defined data available on a special webserver"
+      operation :create do
+        param :user_data, :string, :optional, nil,
+        "Base64 encoded user data will be published to internal webserver"
+      end
+    end
+
+    declare_feature :instances, :authentication_key do
+      operation :create do
+        param :keyname, :string,  :optional, nil
+        "EC2 key authentification method"
+      end
+      operation :show do
+      end
+    end
+
+    declare_feature :instances, :authentication_password do
+      operation :create do
+        param :password, :string, :optional
+      end
+    end
+
+    declare_feature :instances, :hardware_profiles do
+      description "Size instances according to changes to a hardware profile"
+      # The parameters are filled in from the hardware profiles
+    end
+  end
+end

data/lib/deltacloud/base_driver/mock_driver.rb

@@ -0,0 +1,40 @@
+require 'deltacloud/method_serializer'
+
+# Create 'mock' version of original driver client/gem:
+
+module Mock
+  class EC2 < AWS::EC2::Base
+
+    include MethodSerializer::Cache
+
+    def self.cached_methods
+      [
+        :describe_images,
+        :describe_availability_zones,
+        :describe_keypairs,
+        :create_keypair,
+        :run_instances,
+        :describe_instances,
+        :reboot_instances,
+        :terminate_instances,
+        :delete_keypair
+      ]
+    end
+
+    MethodSerializer::Cache::wrap_methods(self, :cache_dir => File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'tests', 'ec2', 'support'))
+  end
+end
+
+
+# Replace original client with mock client
+Deltacloud::Drivers::EC2::EC2Driver.class_eval do
+  alias_method :original_new_client, :new_client
+
+  def new_client(credentials, opts={})
+    Mock::EC2.new(
+      :access_key_id => credentials.user,
+      :secret_access_key => credentials.password
+    )
+  end
+
+end

data/lib/deltacloud/base_driver.rb

@@ -0,0 +1,20 @@
+#
+# Copyright (C) 2009  Red Hat, Inc.
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+require 'deltacloud/base_driver/base_driver'
+require 'deltacloud/base_driver/features'

data/lib/deltacloud/drivers/ec2/ec2_driver.rb

@@ -0,0 +1,410 @@
+#
+# Copyright (C) 2009  Red Hat, Inc.
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+require 'deltacloud/base_driver'
+require 'AWS'
+
+class Instance
+  attr_accessor :keyname
+  attr_accessor :authn_error
+
+  def authn_feature_failed?
+    return true unless authn_error.nil?
+  end
+
+end
+
+module Deltacloud
+  module Drivers
+    module EC2
+class EC2Driver < Deltacloud::BaseDriver
+
+  def supported_collections
+    DEFAULT_COLLECTIONS + [ :keys ]
+  end
+
+  feature :instances, :user_data
+  feature :instances, :authentication_key
+  feature :images, :owner_id
+
+  define_hardware_profile('m1.small') do
+    cpu                1
+    memory             1.7 * 1024
+    storage            160
+    architecture       'i386'
+  end
+
+  define_hardware_profile('m1.large') do
+    cpu                4
+    memory             7.5 * 1024
+    storage            850
+    architecture       'x86_64'
+  end
+
+  define_hardware_profile('m1.xlarge') do
+    cpu                8
+    memory             15 * 1024
+    storage            1690
+    architecture       'x86_64'
+  end
+
+  define_hardware_profile('c1.medium') do
+    cpu                5
+    memory             1.7 * 1024
+    storage            350
+    architecture       'i386'
+  end
+
+  define_hardware_profile('c1.xlarge') do
+    cpu                20
+    memory             7 * 1024
+    storage            1690
+    architecture       'x86_64'
+  end
+
+  define_hardware_profile('m2.xlarge') do
+    cpu                6.5
+    memory             17.1 * 1024
+    storage            420
+    architecture       'x86_64'
+  end
+
+  define_hardware_profile('m2.2xlarge') do
+    cpu                13
+    memory             34.2 * 1024
+    storage            850
+    architecture       'x86_64'
+  end
+
+  define_hardware_profile('m2.4xlarge') do
+    cpu                26
+    memory             68.4 * 1024
+    storage            1690
+    architecture       'x86_64'
+  end
+
+  define_instance_states do
+    start.to( :pending )          .automatically
+    pending.to( :running )        .automatically
+    pending.to( :stopping )       .on( :stop )
+    pending.to( :stopped )        .automatically
+    stopped.to( :running )        .on( :start )
+    running.to( :running )        .on( :reboot )
+    running.to( :stopping )       .on( :stop )
+    shutting_down.to( :stopped )  .automatically
+    stopped.to( :finish )         .automatically
+  end
+
+  #
+  # Images
+  #
+
+  def images(credentials, opts={} )
+    ec2 = new_client(credentials)
+    img_arr = []
+    # if we know the image_id, we don't want to limit by owner_id, since this
+    # will exclude public images
+    if (opts and opts[:id])
+      config = { :image_id => opts[:id] }
+    else
+      config = { :owner_id => "amazon" }
+      config.merge!({ :owner_id => opts[:owner_id] }) if opts and opts[:owner_id]
+    end
+    safely do
+      ec2.describe_images(config).imagesSet.item.each do |image|
+        img_arr << convert_image(image)
+      end
+    end
+    img_arr = filter_on( img_arr, :architecture, opts )
+    img_arr.sort_by{|e| [e.owner_id, e.name]}
+  end
+
+  #
+  # Realms
+  #
+
+  def realms(credentials, opts=nil)
+    ec2 = new_client(credentials)
+    realms = []
+    safely do
+      ec2.describe_availability_zones.availabilityZoneInfo.item.each do |ec2_realm|
+        realms << convert_realm( ec2_realm )
+      end
+    end
+    realms
+  end
+
+  #
+  # Instances
+  #
+  def instances(credentials, opts=nil)
+    ec2 = new_client(credentials)
+    instances = []
+    safely do
+      param = opts.nil? ? nil : opts[:id]
+      ec2_instances = ec2.describe_instances.reservationSet
+      return [] unless ec2_instances
+      ec2_instances.item.each do |item|
+        item.instancesSet.item.each do |ec2_instance|
+          instances << convert_instance( ec2_instance, item.ownerId )
+        end
+      end
+    end
+    instances = filter_on( instances, :id, opts )
+    instances = filter_on( instances, :state, opts )
+    instances
+  end
+
+
+  def create_instance(credentials, image_id, opts)
+    ec2 = new_client( credentials )
+    realm_id = opts[:realm_id]
+    safely do
+      image = image(credentials, :id => image_id )
+      hwp = find_hardware_profile(credentials, opts[:hwp_id], image.id)
+      ec2_instances = ec2.run_instances(
+        :image_id => image.id,
+        :user_data => opts[:user_data],
+        :key_name => opts[:keyname],
+        :availability_zone => realm_id,
+        :monitoring_enabled => true,
+        :instance_type => hwp.name,
+        :disable_api_termination => false,
+        :instance_initiated_shutdown_behavior => 'terminate'
+      )
+      return convert_instance( ec2_instances.instancesSet.item.first, 'pending' )
+    end
+  end
+
+  def generate_instance(ec2, id, backup)
+    begin
+      this_instance = ec2.describe_instances( :instance_id => id ).reservationSet.item.first.instancesSet.item.first
+      convert_instance(this_instance, this_instance.ownerId)
+    rescue Exception => e
+      puts "WARNING: ignored error during instance refresh: #{e.message}"
+      # at this point, the action has succeeded but our follow-up
+      # "describe_instances" failed for some reason.  Create a simple Instance
+      # object with only the ID and new state in place
+      state = backup.instancesSet.item.first.currentState.name
+      Instance.new( {
+        :id => id,
+        :state => state,
+        :actions => instance_actions_for( state ),
+      } )
+    end
+  end
+
+  def reboot_instance(credentials, id)
+    ec2 = new_client(credentials)
+    backup = ec2.reboot_instances( :instance_id => id )
+
+    generate_instance(ec2, id, backup)
+  end
+
+  def stop_instance(credentials, id)
+    ec2 = new_client(credentials)
+    backup = ec2.terminate_instances( :instance_id => id )
+
+    generate_instance(ec2, id, backup)
+  end
+
+  def destroy_instance(credentials, id)
+    ec2 = new_client(credentials)
+    backup = ec2.terminate_instances( :instance_id => id )
+
+    generate_instance(ec2, id, backup)
+  end
+
+  #
+  # Storage Volumes
+  #
+
+  def storage_volumes(credentials, opts=nil)
+    ec2 = new_client( credentials )
+    volumes = []
+    safely do
+      if (opts)
+        ec2.describe_volumes(:volume_id => opts[:id]).volumeSet.item.each do |ec2_volume|
+          volumes << convert_volume( ec2_volume )
+        end
+      else
+        ec2_volumes = ec2.describe_volumes.volumeSet
+        return [] unless ec2_volumes
+        ec2_volumes.item.each do |ec2_volume|
+          volumes << convert_volume( ec2_volume )
+        end
+      end
+    end
+    volumes
+  end
+
+  #
+  # Storage Snapshots
+  #
+
+  def storage_snapshots(credentials, opts=nil)
+    ec2 = new_client( credentials )
+    snapshots = []
+    safely do
+      if (opts)
+        ec2.describe_snapshots(:owner => 'self', :snapshot_id => opts[:id]).snapshotSet.item.each do |ec2_snapshot|
+          snapshots << convert_snapshot( ec2_snapshot )
+        end
+      else
+        ec2_snapshots = ec2.describe_snapshots(:owner => 'self').snapshotSet
+        return [] unless ec2_snapshots
+        ec2_snapshots.item.each do |ec2_snapshot|
+          snapshots << convert_snapshot( ec2_snapshot )
+        end
+      end
+    end
+    snapshots
+  end
+
+  def key(credentials, opts=nil)
+    keys(credentials, opts).first
+  end
+
+  def keys(credentials, opts=nil)
+    ec2 = new_client( credentials )
+    opts[:key_name] = opts[:id] if opts and opts[:id]
+    keypairs = ec2.describe_keypairs(opts || {})
+    result = []
+    safely do
+      keypairs.keySet.item.each do |keypair|
+        result << convert_key(keypair)
+      end
+    end
+    result
+  end
+
+  def create_key(credentials, opts={})
+    key = Key.new
+    ec2 = new_client( credentials )
+    safely do
+      key = convert_key(ec2.create_keypair(opts))
+    end
+    return key
+  end
+
+  def destroy_key(credentials, opts={})
+    safely do
+      ec2 = new_client( credentials )
+      ec2.delete_keypair(opts)
+    end
+  end
+
+  private
+
+  def new_client(credentials)
+    opts = {
+      :access_key_id => credentials.user,
+      :secret_access_key => credentials.password
+    }
+    opts[:server] = ENV['DCLOUD_EC2_URL'] if ENV['DCLOUD_EC2_URL']
+    safely do
+      AWS::EC2::Base.new(opts)
+    end
+  end
+
+  def convert_key(key)
+    Key.new({
+      :id => key['keyName'],
+      :fingerprint => key['keyFingerprint'],
+      :credential_type => :key,
+      :pem_rsa_key => key['keyMaterial']
+    })
+  end
+
+  def convert_image(ec2_image)
+    Image.new( {
+      :id=>ec2_image['imageId'],
+      :name=>ec2_image['name'] || ec2_image['imageId'],
+      :description=>ec2_image['description'] || ec2_image['imageLocation'] || '',
+      :owner_id=>ec2_image['imageOwnerId'],
+      :architecture=>ec2_image['architecture'],
+    } )
+  end
+
+  def convert_realm(ec2_realm)
+    Realm.new( {
+      :id=>ec2_realm['zoneName'],
+      :name=>ec2_realm['regionName'],
+      :limit=>ec2_realm['zoneState'].eql?('available') ? :unlimited : 0,
+      :state=>ec2_realm['zoneState'].upcase,
+    } )
+  end
+
+  def convert_instance(ec2_instance, owner_id)
+    state = ec2_instance['instanceState']['name'].upcase
+    state_key = state.downcase.underscore.to_sym
+    realm_id = ec2_instance['placement']['availabilityZone']
+    (realm_id = nil ) if ( realm_id == '' )
+    hwp_name = ec2_instance['instanceType']
+    instance = Instance.new( {
+      :id=>ec2_instance['instanceId'],
+      :name => ec2_instance['imageId'],
+      :state=>state,
+      :image_id=>ec2_instance['imageId'],
+      :owner_id=>owner_id,
+      :realm_id=>realm_id,
+      :public_addresses=>( ec2_instance['dnsName'] == '' ? [] : [ec2_instance['dnsName']] ),
+      :private_addresses=>( ec2_instance['privateDnsName'] == '' ? [] : [ec2_instance['privateDnsName']] ),
+      :instance_profile =>InstanceProfile.new(hwp_name),
+      :actions=>instance_actions_for( state ),
+      :keyname => ec2_instance['keyName'],
+      :launch_time => ec2_instance['launchTime']
+    } )
+    instance.authn_error = "Key not set for instance" unless ec2_instance['keyName']
+    return instance
+  end
+
+  def convert_volume(ec2_volume)
+    StorageVolume.new( {
+      :id=>ec2_volume['volumeId'],
+      :created=>ec2_volume['createTime'],
+      :state=>ec2_volume['status'].upcase,
+      :capacity=>ec2_volume['size'],
+      :instance_id=>ec2_volume['snapshotId'],
+      :device=>ec2_volume['attachmentSet'],
+    } )
+  end
+
+  def convert_snapshot(ec2_snapshot)
+    StorageSnapshot.new( {
+      :id=>ec2_snapshot['snapshotId'],
+      :state=>ec2_snapshot['status'].upcase,
+      :storage_volume_id=>ec2_snapshot['volumeId'],
+      :created=>ec2_snapshot['startTime'],
+    } )
+  end
+
+  def catched_exceptions_list
+    {
+      :auth => [ AWS::AuthFailure ],
+      :error => [],
+      :glob => [ /AWS::(\w+)/ ]
+    }
+  end
+
+end
+
+    end
+  end
+end