Merge lp:~therve/txaws/run-instances into lp:txaws

[Thomas Herve]

[Thomas Herve (therve)]

This add support for the RunInstances operation. Using the code from describe_instances, it's a relatively small change.

[Duncan McGreggor (oubiwann)]

Looks great!

[1] I see you imported b64encode; is there are reason you didn't use .encode("base64")?

review: Approve

[Thomas Herve (therve)]

> Looks great!
>
> [1] I see you imported b64encode; is there are reason you didn't use
> .encode("base64")?

It's not really equivalent, .encode("base64") has some quirks.

=== modified file 'txaws/ec2/client.py'
--- txaws/ec2/client.py	2009-10-12 17:02:33 +0000
+++ txaws/ec2/client.py	2009-10-13 09:15:23 +0000
@@ -7,6 +7,7 @@
 
 from datetime import datetime
 from urllib import quote
+from base64 import b64encode
 
 from twisted.internet import reactor, ssl
 from twisted.web.client import HTTPClientFactory
@@ -63,6 +64,36 @@
         d = q.submit()
         return d.addCallback(self._parse_describe_instances)
 
+    def _parse_instances_set(self, root, reservation):
+        instances = []
+        for instance_data in root.find("instancesSet"):
+            instance_id = instance_data.findtext("instanceId")
+            instance_state = instance_data.find(
+                "instanceState").findtext("name")
+            instance_type = instance_data.findtext("instanceType")
+            image_id = instance_data.findtext("imageId")
+            private_dns_name = instance_data.findtext("privateDnsName")
+            dns_name = instance_data.findtext("dnsName")
+            key_name = instance_data.findtext("keyName")
+            ami_launch_index = instance_data.findtext("amiLaunchIndex")
+            launch_time = instance_data.findtext("launchTime")
+            placement = instance_data.find("placement").findtext(
+                "availabilityZone")
+            products = []
+            product_codes = instance_data.find("productCodes")
+            if product_codes:
+                for product_data in instance_data.find("productCodes"):
+                    products.append(product_data.text)
+            kernel_id = instance_data.findtext("kernelId")
+            ramdisk_id = instance_data.findtext("ramdiskId")
+            instance = model.Instance(
+                instance_id, instance_state, instance_type, image_id,
+                private_dns_name, dns_name, key_name, ami_launch_index,
+                launch_time, placement, products, kernel_id, ramdisk_id,
+                reservation=reservation)
+            instances.append(instance)
+        return instances
+
     def _parse_describe_instances(self, xml_bytes):
         """
         Parse the reservations XML payload that is returned from an AWS
@@ -96,36 +127,58 @@
                 owner_id=reservation_data.findtext("ownerId"),
                 groups=groups)
             # Get the list of instances.
-            instances = []
-            for instance_data in reservation_data.find("instancesSet"):
-                instance_id = instance_data.findtext("instanceId")
-                instance_state = instance_data.find(
-                    "instanceState").findtext("name")
-                instance_type = instance_data.findtext("instanceType")
-                image_id = instance_data.findtext("imageId")
-                private_dns_name = instance_data.findtext("privateDnsName")
-                dns_name = instance_data.findtext("dnsName")
-                key_name = instance_data.findtext("keyName")
-                ami_launch_index = instance_data.findtext("amiLaunchIndex")
-                launch_time = instance_data.findtext("launchTime")
-                placement = instance_data.find("placement").findtext(
-                    "availabilityZone")
-                products = []
-                product_codes = instance_data.find("productCodes")
-                if product_codes:
-                    for product_data in instance_data.find("productCodes"):
-                        products.append(product_data.text)
-                kernel_id = instance_data.findtext("kernelId")
-                ramdisk_id = instance_data.findtext("ramdiskId")
-                instance = model.Instance(
-                    instance_id, instance_state, instance_type, image_id,
-                    private_dns_name, dns_name, key_name, ami_launch_index,
-                    launch_time, placement, products, kernel_id, ramdisk_id,
-                    reservation=reservation)
-                instances.append(instance)
+            instances = self._parse_instances_set(
+                reservation_data, reservation)
             results.extend(instances)
         return results
 
+    def run_instances(self, image_id, min_count, max_count,
+        security_groups=None, key_name=None, instance_type=None,
+        user_data=None, availability_zone=None, kernel_id=None,
+        ramdisk_id=None):
+        """Run new instances."""
+        params = {"ImageId": image_id, "MinCount": min_count,
+                  "MaxCount": max_count}
+        if security_groups is not None:
+            for i, name in enumerate(security_groups):
+                params["SecurityGroup.%d" % (i+1)] = name
+        if key_name is not None:
+            params["KeyName"] = key_name
+        if user_data is not None:
+            params["UserData"] = b64encode(user_data)
+        if instance_type is not None:
+            params["InstanceType"] = instance_type
+        if availability_zone is not None:
+            params["Placement.AvailabilityZone"] = availability_zone
+        if kernel_id is not None:
+            params["KernelId"] = kernel_id
+        if ramdisk_id is not None:
+            params["RamdiskId"] = ramdisk_id
+        q = self.query_factory(
+            "RunInstances", self.creds, self.endpoint, params)
+        d = q.submit()
+        return d.addCallback(self._parse_run_instances)
+
+    def _parse_run_instances(self, xml_bytes):
+        """
+        Parse the reservations XML payload that is returned from an AWS
+        RunInstances API call.
+        """
+        root = XML(xml_bytes)
+        # Get the security group information.
+        groups = []
+        for group_data in root.find("groupSet"):
+            group_id = group_data.findtext("groupId")
+            groups.append(group_id)
+        # Create a reservation object with the parsed data.
+        reservation = model.Reservation(
+            reservation_id=root.findtext("reservationId"),
+            owner_id=root.findtext("ownerId"),
+            groups=groups)
+        # Get the list of instances.
+        instances = self._parse_instances_set(root, reservation)
+        return instances
+
     def terminate_instances(self, *instance_ids):
         """Terminate some instances.
 
@@ -219,7 +272,6 @@
         @return: A C{Deferred} that will fire with a truth value for the
             success of the operation.
         """
-        group_names = None
         parameters = {"GroupName":  name, "GroupDescription": description}
         query = self.query_factory("CreateSecurityGroup", self.creds,
                                    self.endpoint, parameters)
@@ -690,7 +742,7 @@
                                    self.endpoint, zone_names)
         d = query.submit()
         return d.addCallback(self._parse_describe_availability_zones)
-        
+
     def _parse_describe_availability_zones(self, xml_bytes):
         results = []
         root = XML(xml_bytes)

=== modified file 'txaws/ec2/tests/test_client.py'
--- txaws/ec2/tests/test_client.py	2009-10-12 17:02:33 +0000
+++ txaws/ec2/tests/test_client.py	2009-10-13 09:15:23 +0000
@@ -260,6 +260,57 @@
         d.addCallback(check_transition)
         return d
 
+    def check_parsed_run_instances(self, results):
+        instance = results[0]
+        # check reservations
+        reservation = instance.reservation
+        self.assertEquals(reservation.reservation_id, "r-47a5402e")
+        self.assertEquals(reservation.owner_id, "495219933132")
+        # check groups
+        group = reservation.groups[0]
+        self.assertEquals(group, "default")
+        # check instance
+        self.assertEquals(instance.instance_id, "i-2ba64342")
+        self.assertEquals(instance.instance_state, "pending")
+        self.assertEquals(instance.instance_type, "m1.small")
+        self.assertEquals(instance.placement, "us-east-1b")
+        instance = results[1]
+        self.assertEquals(instance.instance_id, "i-2bc64242")
+        self.assertEquals(instance.instance_state, "pending")
+        self.assertEquals(instance.instance_type, "m1.small")
+        self.assertEquals(instance.placement, "us-east-1b")
+        instance = results[2]
+        self.assertEquals(instance.instance_id, "i-2be64332")
+        self.assertEquals(instance.instance_state, "pending")
+        self.assertEquals(instance.instance_type, "m1.small")
+        self.assertEquals(instance.placement, "us-east-1b")
+
+    def test_run_instances(self):
+
+        class StubQuery(object):
+            def __init__(stub, action, creds, endpoint, params):
+                self.assertEqual(action, "RunInstances")
+                self.assertEqual(creds.access_key, "foo")
+                self.assertEqual(creds.secret_key, "bar")
+                self.assertEquals(
+                    params,
+                    {"ImageId": "ami-1234", "MaxCount": 2, "MinCount": 1,
+                     "SecurityGroup.1": u"group1", "KeyName": u"default",
+                     "UserData": "Zm9v", "InstanceType": u"m1.small",
+                     "Placement.AvailabilityZone": u"us-east-1b",
+                     "KernelId": u"k-1234", "RamdiskId": u"r-1234"})
+            def submit(self):
+                return succeed(
+                    payload.sample_run_instances_result)
+
+        creds = AWSCredentials("foo", "bar")
+        ec2 = client.EC2Client(creds, query_factory=StubQuery)
+        d = ec2.run_instances("ami-1234", 1, 2, security_groups=[u"group1"],
+            key_name=u"default", user_data=u"foo", instance_type=u"m1.small",
+            availability_zone=u"us-east-1b", kernel_id=u"k-1234",
+            ramdisk_id=u"r-1234")
+        d.addCallback(self.check_parsed_run_instances)
+
 
 class EC2ClientSecurityGroupsTestCase(TXAWSTestCase):
 

=== modified file 'txaws/testing/ec2.py'
--- txaws/testing/ec2.py	2009-10-13 07:14:42 +0000
+++ txaws/testing/ec2.py	2009-10-13 09:15:23 +0000
@@ -33,6 +33,12 @@
     def describe_instances(self, *instances):
         return succeed(self.instances)
 
+    def run_instances(self, image_id, min_count, max_count,
+        security_groups=None, key_name=None, instance_type=None,
+        user_data=None, availability_zone=None, kernel_id=None,
+        ramdisk_id=None):
+        return succeed(self.instances)
+
     def describe_keypairs(self):
         return succeed(self.keypairs)
 

=== modified file 'txaws/testing/payload.py'
--- txaws/testing/payload.py	2009-10-05 23:50:35 +0000
+++ txaws/testing/payload.py	2009-10-13 09:15:23 +0000
@@ -81,6 +81,72 @@
 """ % (aws_api,)
 
 
+sample_run_instances_result = """\
+<?xml version="1.0"?>
+<RunInstancesResponse xmlns="http://ec2.amazonaws.com/doc/%s/">
+  <reservationId>r-47a5402e</reservationId>
+  <ownerId>495219933132</ownerId>
+  <groupSet>
+    <item>
+      <groupId>default</groupId>
+    </item>
+  </groupSet>
+  <instancesSet>
+    <item>
+      <instanceId>i-2ba64342</instanceId>
+      <imageId>ami-60a54009</imageId>
+      <instanceState>
+        <code>0</code>
+    <name>pending</name>
+      </instanceState>
+      <privateDnsName></privateDnsName>
+      <dnsName></dnsName>
+      <keyName>example-key-name</keyName>
+       <amiLaunchIndex>0</amiLaunchIndex>
+      <instanceType>m1.small</instanceType>
+      <launchTime>2007-08-07T11:51:50.000Z</launchTime>
+      <placement>
+        <availabilityZone>us-east-1b</availabilityZone>
+      </placement>
+    </item>
+    <item>
+      <instanceId>i-2bc64242</instanceId>
+      <imageId>ami-60a54009</imageId>
+      <instanceState>
+        <code>0</code>
+    <name>pending</name>
+      </instanceState>
+      <privateDnsName></privateDnsName>
+      <dnsName></dnsName>
+      <keyName>example-key-name</keyName>
+      <amiLaunchIndex>1</amiLaunchIndex>
+      <instanceType>m1.small</instanceType>
+      <launchTime>2007-08-07T11:51:50.000Z</launchTime>
+      <placement>
+        <availabilityZone>us-east-1b</availabilityZone>
+      </placement>
+    </item>
+    <item>
+      <instanceId>i-2be64332</instanceId>
+      <imageId>ami-60a54009</imageId>
+      <instanceState>
+        <code>0</code>
+    <name>pending</name>
+      </instanceState>
+      <privateDnsName></privateDnsName>
+      <dnsName></dnsName>
+      <keyName>example-key-name</keyName>
+      <amiLaunchIndex>2</amiLaunchIndex>
+      <instanceType>m1.small</instanceType>
+      <launchTime>2007-08-07T11:51:50.000Z</launchTime>
+      <placement>
+        <availabilityZone>us-east-1b</availabilityZone>
+      </placement>
+    </item>
+  </instancesSet>
+</RunInstancesResponse>
+""" % (aws_api,)
+
 sample_terminate_instances_result = """\
 <?xml version="1.0"?>
 <TerminateInstancesResponse xmlns="http://ec2.amazonaws.com/doc/%s/">