right_aws 1.9.0 → 3.1.0

data/right_aws.gemspec

@@ -0,0 +1,91 @@
+#--  -*- mode: ruby; encoding: utf-8 -*-
+# Copyright: Copyright (c) 2010 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), "lib", "awsbase", "version"))
+
+Gem::Specification.new do |spec|
+  spec.name = 'right_aws'
+  spec.rubyforge_project = 'rightaws'
+  spec.version = RightAws::VERSION::STRING
+  spec.authors = ['RightScale, Inc.']
+  spec.email = 'support@rightscale.com'
+  spec.summary = 'Interface classes for the Amazon EC2, SQS, and S3 Web Services'
+  spec.rdoc_options = ['--main', 'README.txt', '--title', '']
+  spec.extra_rdoc_files = ['README.txt']
+  spec.required_ruby_version = '>= 1.8.7'
+  spec.require_path = 'lib'
+
+  spec.add_dependency('right_http_connection', '>= 1.2.5')
+  #spec.requirements << "uuidtools >= 1.0.7 if you want to use ActiveSdb"
+  spec.requirements << "libxml-ruby >= 0.5.2.0 is encouraged"
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rcov')
+
+  spec.summary = 'The RightScale AWS gems have been designed to provide a robust, fast, and secure interface to Amazon EC2, EBS, S3, SQS, SDB, and CloudFront.'
+  spec.description = <<-EOF
+== DESCRIPTION:
+
+The RightScale AWS gems have been designed to provide a robust, fast, and secure interface to Amazon EC2, EBS, S3, SQS, SDB, and CloudFront.
+These gems have been used in production by RightScale since late 2006 and are being maintained to track enhancements made by Amazon.
+The RightScale AWS gems comprise:
+
+- RightAws::Ec2 -- interface to Amazon EC2 (Elastic Compute Cloud) and the
+  associated EBS (Elastic Block Store)
+- RightAws::S3 and RightAws::S3Interface -- interface to Amazon S3 (Simple Storage Service)
+- RightAws::Sqs and RightAws::SqsInterface -- interface to first-generation Amazon SQS (Simple Queue Service) (API version 2007-05-01)
+- RightAws::SqsGen2 and RightAws::SqsGen2Interface -- interface to second-generation Amazon SQS (Simple Queue Service) (API version 2008-01-01)
+- RightAws::SdbInterface and RightAws::ActiveSdb -- interface to Amazon SDB (SimpleDB)
+- RightAws::AcfInterface -- interface to Amazon CloudFront, a content distribution service
+
+== FEATURES:
+
+- Full programmmatic access to EC2, EBS, S3, SQS, SDB, and CloudFront.
+- Complete error handling: all operations check for errors and report complete
+  error information by raising an AwsError.
+- Persistent HTTP connections with robust network-level retry layer using
+  RightHttpConnection).  This includes socket timeouts and retries.
+- Robust HTTP-level retry layer.  Certain (user-adjustable) HTTP errors returned
+  by Amazon's services are classified as temporary errors.
+  These errors are automaticallly retried using exponentially increasing intervals.
+  The number of retries is user-configurable.
+- Fast REXML-based parsing of responses (as fast as a pure Ruby solution allows).
+- Uses libxml (if available) for faster response parsing.
+- Support for large S3 list operations.  Buckets and key subfolders containing
+  many (> 1000) keys are listed in entirety.  Operations based on list (like
+  bucket clear) work on arbitrary numbers of keys.
+- Support for streaming GETs from S3, and streaming PUTs to S3 if the data source is a file.
+- Support for single-threaded usage, multithreaded usage, as well as usage with multiple
+  AWS accounts.
+- Support for both first- and second-generation SQS (API versions 2007-05-01
+  and 2008-01-01).  These versions of SQS are not compatible.
+- Support for signature versions 0 and 1 on SQS, SDB, and EC2.
+- Interoperability with any cloud running Eucalyptus (http://eucalyptus.cs.ucsb.edu)
+- Test suite (requires AWS account to do "live" testing).
+EOF
+
+  candidates = Dir.glob('{lib,test}/**/*') + ['History.txt', 'Manifest.txt', 'README.txt', 'Rakefile', 'right_aws.gemspec']
+  spec.files = candidates.sort
+  spec.test_files = Dir.glob('test/**/*')
+end

data/test/README.mdown

@@ -0,0 +1,39 @@
+# Notes and tips for developers
+
+## Setting up credentials for testing
+
+Before you can run any tests, you need to set up credentials (API key and secret) that
+will be used when talking to AWS.  The credentials are loaded in `test/test_credentials.rb`
+and are expected to be found in `~/.rightscale/testcredentials.rb` and look like this:
+
+    TestCredentials.aws_access_key_id= 'AAAAAAAAAAAAAAAAAAAA'
+    TestCredentials.aws_secret_access_key= 'asdfasdfsadf'
+    TestCredentials.account_number= '???'
+
+If you prefer to store your secret key in the OS X keychain, you can do this:
+
+    def secret_access_key_from_keychain (key_id)
+      dump = `security -q find-generic-password -a "#{key_id}" -g 2>&1`
+      dump[/password: "(.*)"/, 1]
+    end
+
+    TestCredentials.aws_access_key_id= 'AAAAAAAAAAAAAAAAAAAA'
+    TestCredentials.aws_secret_access_key= secret_access_key_from_keychain(TestCredentials.aws_access_key_id)
+    TestCredentials.account_number= '???'
+
+## Running tests
+
+There is no test suite that runs all tests.  Each module is tested separately.  E.g.,
+to run the Load Balancer tests, run `rake testelb`.  Run `rake -T` for a full list.
+
+Some tests need to launch services on AWS to have something to test.  This means two things:
+
+1. Running all the tests will cost you money.
+2. You will need to shut down some services separately once you are done, or things
+    will keep running and cost you money.
+
+As an example, the ELB and Route 53 tests need a load balancer for testing.  Starting a load balancer
+for every test would make every test case cost as much as running the LB for one hour, so it makes
+more sense to leave it running until it's no longer needed.
+
+The ELB tests contain instructions for shutting down the load balancer.

data/test/acf/test_right_acf.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestS3 < Test::Unit::TestCase
+class TestAcf < Test::Unit::TestCase
 
   RIGHT_OBJECT_TEXT     = 'Right test message'
   
@@ -9,7 +9,7 @@ class TestS3 < Test::Unit::TestCase
   def setup
     @acf= Rightscale::AcfInterface.new(TestCredentials.aws_access_key_id, TestCredentials.aws_secret_access_key)
     @s3 = Rightscale::S3.new(TestCredentials.aws_access_key_id, TestCredentials.aws_secret_access_key)
-    @bucket_name   = "right-acf-awesome-test-bucket-0001"
+    @bucket_name   = "right-acf-awesome-test-bucket-xxx1"
     @bucket_domain = "#{@bucket_name}.s3.amazonaws.com"
   end
 
@@ -27,13 +27,18 @@ class TestS3 < Test::Unit::TestCase
       @acf.create_distribution("right-cloudfront-awesome-test-bucket-not-exist", "Mustn't to be born", true)
     end
     # a bucket is not a domain naming complied guy
-    bucket_name = 'right_cloudfront_awesome_test_bucket_BAD'
+    bucket_name = 'right_cloudfront_awesome_test_bucket_BAD_XXX'
     @s3.bucket(bucket_name, :create)
     assert_raise(Rightscale::AwsError) do
       @acf.create_distribution(bucket_name, "Mustn't to be born", true)
     end
   end
 
+  def test_02_x_delete_bad_bucket
+    bucket_name = 'right_cloudfront_awesome_test_bucket_BAD_XXX'
+    @s3.bucket(bucket_name, false).delete
+  end
+
   def test_03_create
     comment = 'WooHoo!!!'
     # create a test bucket
@@ -69,8 +74,8 @@ class TestS3 < Test::Unit::TestCase
     end
     # change a config
     config[:enabled] = false
-    config[:cnames] << 'x1.myawesomesite.com'
-    config[:cnames] << 'x2.myawesomesite.com'
+    config[:cnames] << 'xxx1.myawesomesite.com'
+    config[:cnames] << 'xxx2.myawesomesite.com'
     # set config
     set_config_result = nil
     assert_nothing_raised do
@@ -83,7 +88,7 @@ class TestS3 < Test::Unit::TestCase
       new_config = @acf.get_distribution_config(old[:aws_id])
     end
     assert           !new_config[:enabled]
-    assert_equal     new_config[:cnames].sort, ['x1.myawesomesite.com', 'x2.myawesomesite.com']
+    assert_equal     new_config[:cnames].sort, ['xxx1.myawesomesite.com', 'xxx2.myawesomesite.com']
     assert_not_equal config[:e_tag], new_config[:e_tag]
 
     # try to update the old config again (must fail because ETAG has changed)
@@ -92,19 +97,6 @@ class TestS3 < Test::Unit::TestCase
     end
   end
 
-  def test_07_caching
-    # enable caching
-    @acf.params[:cache] = true
-    # list distributions
-    @acf.list_distributions
-    # list the distributions again - cache should hit
-    assert_raise(Rightscale::AwsNoChange) do
-      @acf.list_distributions
-    end
-    # disable caching
-    @acf.params[:cache] = true
-  end
-
   def test_08_delete_distribution
     # we need ETAG so use get_distribution
     distribution = @acf.get_distribution(get_test_distribution[:aws_id])

data/test/awsbase/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../../lib/right_aws'

data/test/awsbase/test_right_awsbase.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestAwsbase < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_01_create_describe_key_pairs
+  end
+  
+end

data/test/ec2/test_right_ec2.rb

@@ -1,5 +1,4 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
-require 'pp'
 
 class TestEc2 < Test::Unit::TestCase
 
@@ -72,5 +71,37 @@ class TestEc2 < Test::Unit::TestCase
     # check that the request has correct signature version
     assert ec2.last_request.path.include?('SignatureVersion=0')
   end
+
+  def test_11_regions
+    regions = nil
+    assert_nothing_raised do
+      regions = @ec2.describe_regions
+    end
+    # check we got more that 0 regions
+    assert regions.size > 0
+    # check an access to regions
+    regions.each do |region|
+      regional_ec2 = Rightscale::Ec2.new(TestCredentials.aws_access_key_id, TestCredentials.aws_secret_access_key, :region => region)
+      # do we have a correct endpoint server?
+      assert_equal "#{region}.ec2.amazonaws.com", regional_ec2.params[:server]
+      # get a list of images from every region
+      images = nil
+      assert_nothing_raised do
+        images = regional_ec2.describe_regions
+      end
+      # every region must have images
+      assert images.size > 0
+    end
+  end
   
+  def test_12_endpoint_url
+    ec2 = Rightscale::Ec2.new(TestCredentials.aws_access_key_id, TestCredentials.aws_secret_access_key, :endpoint_url => 'a://b.c:0/d/', :region => 'z')
+    # :endpoint_url has a priority hence :region should be ommitted
+    assert_equal 'a',   ec2.params[:protocol]
+    assert_equal 'b.c', ec2.params[:server]
+    assert_equal '/d/', ec2.params[:service]
+    assert_equal 0,     ec2.params[:port]
+    assert_nil          ec2.params[:region]
+  end
+
 end

data/test/elb/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../../lib/right_aws'

data/test/elb/test_right_elb.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestElb < Test::Unit::TestCase
+
+  STDOUT.sync = true
+  BALANCER_NAME = 'right-aws-test-lb'
+
+  def setup
+    @elb = Rightscale::ElbInterface.new(TestCredentials.aws_access_key_id, TestCredentials.aws_secret_access_key, :logger => Logger.new('/dev/null'))
+
+    unless @elb.describe_load_balancers.detect { |lb| lb[:load_balancer_name] == BALANCER_NAME }
+      @elb.create_load_balancer(BALANCER_NAME, %w[us-east-1b], [])
+    end
+    @lb = @elb.describe_load_balancers.detect { |lb| lb[:load_balancer_name] == BALANCER_NAME }
+  end
+
+  # At the end of the day when you want to shut down the test balancer:
+  # * Uncomment this method.
+  # * Comment out all test except one.
+  # * Run this test file.
+  #
+  # def teardown
+  #   @elb.delete_load_balancer BALANCER_NAME
+  # end
+
+  def test_00_describe_load_balancers
+    items = @elb.describe_load_balancers
+    assert items.is_a?(Array)
+  end
+
+  def test_description
+    assert_match /^#{BALANCER_NAME}-\d+\.us-east-1\.elb\.amazonaws\.com$/, @lb[:dns_name]
+  end
+
+  def test_description_has_canonical_hosted_zone_name
+    assert_match /^#{BALANCER_NAME}-\d+\.us-east-1\.elb\.amazonaws\.com$/, @lb[:canonical_hosted_zone_name]
+  end
+
+  def test_description_has_canonical_hosted_zone_name_id
+    assert_match /^[A-Z0-9]+$/, @lb[:canonical_hosted_zone_name_id]
+  end
+
+end

data/test/rds/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../../lib/right_aws'

data/test/rds/test_right_rds.rb

@@ -0,0 +1,120 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRds < Test::Unit::TestCase
+
+  STDOUT.sync = true
+
+  TEST_SG_NAME = 'RightRdsSGTest0123456789'
+
+  def setup
+    @rds = Rightscale::RdsInterface.new(TestCredentials.aws_access_key_id, TestCredentials.aws_secret_access_key, :logger => Logger.new('/dev/null'))
+  end
+
+  def test_00_instances
+    assert_nothing_raised do
+      items = @rds.describe_db_instances
+      assert items.is_a?(Array)
+    end
+    #
+    assert_nothing_raised do
+      @rds.describe_db_instances do |response|
+        assert response.is_a?(Hash)
+        assert response[:db_instances].is_a?(Array)
+      end
+    end
+  end
+
+  def test_10_security_groups
+    assert_nothing_raised do
+      items = @rds.describe_db_security_groups
+      assert items.is_a?(Array)
+    end
+    #
+    assert_nothing_raised do
+      @rds.describe_db_security_groups do |response|
+        assert response.is_a?(Hash)
+        assert response[:db_security_groups].is_a?(Array)
+      end
+    end
+  end
+
+  def test_11_remove_security_group
+    @rds.delete_db_security_group rescue nil
+  end
+
+  def test_12_create_security_group
+    sg = nil
+    assert_nothing_raised do
+      sg = @rds.create_db_security_group(TEST_SG_NAME, 'sg-description')
+    end
+    assert sg.is_a?(Hash)
+  end
+
+  def test_13_authorize
+    assert_nothing_raised do
+      sg = @rds.authorize_db_security_group_ingress(TEST_SG_NAME, :cidrip => '131.0.0.1/8')
+      assert sg.is_a?(Hash)
+      assert_equal 1, sg[:ip_ranges].size
+    end
+    assert_nothing_raised do
+      sg = @rds.authorize_db_security_group_ingress(TEST_SG_NAME, :ec2_security_group_owner => '826693181925',
+                                                                  :ec2_security_group_name  => 'default' )
+      assert sg.is_a?(Hash)
+      assert_equal 1, sg[:ec2_security_groups].size
+    end
+    sleep 30
+  end
+
+  def test_14_revoke
+    assert_nothing_raised do
+      sg = @rds.revoke_db_security_group_ingress(TEST_SG_NAME, :cidrip => '131.0.0.1/8')
+      assert sg.is_a?(Hash)
+    end
+    assert_nothing_raised do
+      sg = @rds.revoke_db_security_group_ingress(TEST_SG_NAME, :ec2_security_group_owner => '826693181925',
+                                                               :ec2_security_group_name  => 'default' )
+      assert sg.is_a?(Hash)
+    end
+    sleep 30
+    #
+    sg = @rds.describe_db_security_groups(TEST_SG_NAME).first
+    assert_equal 0, sg[:ip_ranges].size
+    assert_equal 0, sg[:ec2_security_groups].size
+  end
+
+  def test_15_delete_security_group
+    assert_nothing_raised do
+      @rds.delete_db_security_group(TEST_SG_NAME)
+    end
+  end
+
+
+  def test_20_db_snapshots
+    assert_nothing_raised do
+      items = @rds.describe_db_snapshots
+      assert items.is_a?(Array)
+    end
+    #
+    assert_nothing_raised do
+      @rds.describe_db_snapshots do |response|
+        assert response.is_a?(Hash)
+        assert response[:db_snapshots].is_a?(Array)
+      end
+    end
+  end
+
+  def test_30_events
+    assert_nothing_raised do
+      items = @rds.describe_events
+      assert items.is_a?(Array)
+    end
+    #
+    assert_nothing_raised do
+      @rds.describe_events do |response|
+        assert response.is_a?(Hash)
+        assert response[:events].is_a?(Array)
+      end
+    end
+  end
+
+end

data/test/route_53/fixtures/a_record.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ChangeResourceRecordSetsRequest xmlns="https://route53.amazonaws.com/doc/2011-05-05/">
+  <ChangeBatch>
+    <Changes>
+      <Change>
+        <Action>CREATE</Action>
+        <ResourceRecordSet>
+          <Name>host.right-aws.example.com.</Name>
+          <Type>A</Type>
+          <TTL>600</TTL>
+          <ResourceRecords>
+            <ResourceRecord><Value>10.0.0.1</Value></ResourceRecord>
+          </ResourceRecords>
+        </ResourceRecordSet>
+      </Change>
+    </Changes>
+  </ChangeBatch>
+</ChangeResourceRecordSetsRequest>