Merge lp:~axwalk/goamz/ec2-describeavailabilityzones into lp:goamz

[Andrew Wilkins]

ec2: expose DescribeAvailabilityZone

Juju is growing support for manual
and automatic availability zone
distribution. Since availability zones
may differ between accounts, we need
to use DescribeAvailabilityZones to
enumerate them.

https://codereview.appspot.com/101980044/

ec2: expose DescribeAvailabilityZone

Juju is growing support for manual
and automatic availability zone
distribution. Since availability zones
may differ between accounts, we need
to use DescribeAvailabilityZones to
enumerate them.

https://codereview.appspot.com/101980044/

[Andrew Wilkins (axwalk)]

Reviewers: mp+221508_code.launchpad.net,

Message:
Please take a look.

Description:
ec2: expose DescribeAvailabilityZone

Juju is growing support for manual
and automatic availability zone
distribution. Since availability zones
may differ between accounts, we need
to use DescribeAvailabilityZones to
enumerate them.

https://code.launchpad.net/~axwalk/goamz/ec2-describeavailabilityzones/+merge/221508

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/101980044/

Affected files (+289, -11 lines):
   A [revision details]
   M ec2/ec2.go
   M ec2/ec2_test.go
   M ec2/ec2t_test.go
   M ec2/ec2test/server.go
   M ec2/responses_test.go

[Andrew Wilkins (axwalk)]

Please take a look.

https://codereview.appspot.com/101980044/

[Ian Booth (wallyworld)]

LGTM

https://codereview.appspot.com/101980044/

[Andrew Wilkins (axwalk)]

Please take a look.

https://codereview.appspot.com/101980044/

[Andrew Wilkins (axwalk)]

On 2014/07/08 15:44:00, axw wrote:
> Please take a look.

uh oh, ignore me

https://codereview.appspot.com/101980044/

=== modified file 'ec2/ec2.go'
--- ec2/ec2.go	2014-05-09 15:01:24 +0000
+++ ec2/ec2.go	2014-05-30 09:44:09 +0000
@@ -1012,6 +1012,47 @@
 	return resp, nil
 }
 
+// ----------------------------------------------------------------------------
+// Availability zone management functions and types.
+// See http://goo.gl/ylxT4R for more details.
+
+// AvailabilityZonesResp represents a response to a DescribeAvailabilityZones
+// request in EC2.
+type AvailabilityZonesResp struct {
+	RequestId string                 `xml:"requestId"`
+	Zones     []AvailabilityZoneInfo `xml:"availabilityZoneInfo>item"`
+}
+
+// AvailabilityZoneInfo encapsulates details for an availability zone in EC2.
+type AvailabilityZoneInfo struct {
+	AvailabilityZone
+	State      string   `xml:"zoneState"`
+	MessageSet []string `xml:"messageSet>item"`
+}
+
+// AvailabilityZone represents an EC2 availability zone.
+type AvailabilityZone struct {
+	Name   string `xml:"zoneName"`
+	Region string `xml:"regionName"`
+}
+
+// AvailabilityZones returns details about availability zones in EC2.
+// The filter parameter is optional, and if provided will limit the
+// availability zones returned to those matching the given filtering
+// rules.
+//
+// See http://goo.gl/ylxT4R for more details.
+func (ec2 *EC2) AvailabilityZones(filter *Filter) (resp *AvailabilityZonesResp, err error) {
+	params := makeParams("DescribeAvailabilityZones")
+	filter.addParams(params)
+	resp = &AvailabilityZonesResp{}
+	err = ec2.query(params, resp)
+	if err != nil {
+		return nil, err
+	}
+	return
+}
+
 // AccountAttribute holds information about an account attribute.
 //
 // See http://goo.gl/hBc28j for more details.

=== modified file 'ec2/ec2_test.go'
--- ec2/ec2_test.go	2014-05-09 15:01:24 +0000
+++ ec2/ec2_test.go	2014-05-30 09:44:09 +0000
@@ -807,6 +807,68 @@
 	c.Assert(req.Form["Signature"], DeepEquals, []string{"gdG/vEm+c6ehhhfkrJy3+wuVzw/rzKR42TYelMwti7M="})
 }
 
+func (s *S) TestAvailabilityZonesExample1(c *C) {
+	testServer.Response(200, nil, DescribeAvailabilityZonesExample1)
+
+	resp, err := s.ec2.AvailabilityZones(nil)
+
+	req := testServer.WaitRequest()
+	c.Assert(req.Form["Action"], DeepEquals, []string{"DescribeAvailabilityZones"})
+
+	c.Assert(err, IsNil)
+	c.Assert(resp.RequestId, Equals, "59dbff89-35bd-4eac-99ed-be587EXAMPLE")
+	c.Assert(resp.Zones, HasLen, 4)
+
+	z0 := resp.Zones[0]
+	c.Assert(z0.Name, Equals, "us-east-1a")
+	c.Assert(z0.Region, Equals, "us-east-1")
+	c.Assert(z0.State, Equals, "available")
+	c.Assert(z0.MessageSet, HasLen, 0)
+
+	z1 := resp.Zones[1]
+	c.Assert(z1.Name, Equals, "us-east-1b")
+	c.Assert(z1.Region, Equals, "us-east-1")
+	c.Assert(z1.State, Equals, "available")
+	c.Assert(z1.MessageSet, HasLen, 0)
+
+	z2 := resp.Zones[2]
+	c.Assert(z2.Name, Equals, "us-east-1c")
+	c.Assert(z2.Region, Equals, "us-east-1")
+	c.Assert(z2.State, Equals, "available")
+	c.Assert(z2.MessageSet, HasLen, 0)
+
+	z3 := resp.Zones[3]
+	c.Assert(z3.Name, Equals, "us-east-1d")
+	c.Assert(z3.Region, Equals, "us-east-1")
+	c.Assert(z3.State, Equals, "available")
+	c.Assert(z3.MessageSet, HasLen, 0)
+}
+
+func (s *S) TestAvailabilityZonesExample2(c *C) {
+	testServer.Response(200, nil, DescribeAvailabilityZonesExample2)
+
+	resp, err := s.ec2.AvailabilityZones(nil)
+
+	req := testServer.WaitRequest()
+	c.Assert(req.Form["Action"], DeepEquals, []string{"DescribeAvailabilityZones"})
+
+	c.Assert(err, IsNil)
+	c.Assert(resp.RequestId, Equals, "59dbff89-35bd-4eac-99ed-be587EXAMPLE")
+	c.Assert(resp.Zones, HasLen, 2)
+
+	z0 := resp.Zones[0]
+	c.Assert(z0.Name, Equals, "us-east-1a")
+	c.Assert(z0.Region, Equals, "us-east-1")
+	c.Assert(z0.State, Equals, "impaired")
+	c.Assert(z0.MessageSet, HasLen, 0)
+
+	z1 := resp.Zones[1]
+	c.Assert(z1.Name, Equals, "us-east-1b")
+	c.Assert(z1.Region, Equals, "us-east-1")
+	c.Assert(z1.State, Equals, "unavailable")
+	c.Assert(z1.MessageSet, DeepEquals, []string{"us-east-1b is currently down for maintenance."})
+}
+
 func (s *S) TestDescribeAccountAttributesExamples(c *C) {
 	testServer.Response(200, nil, DescribeAccountAttributesExample)
 

=== modified file 'ec2/ec2t_test.go'
--- ec2/ec2t_test.go	2014-05-21 13:52:28 +0000
+++ ec2/ec2t_test.go	2014-05-30 09:44:09 +0000
@@ -152,6 +152,51 @@
 	return ip.String()
 }
 
+func (s *LocalServerSuite) TestAvailabilityZones(c *C) {
+	s.srv.srv.SetAvailabilityZones([]ec2.AvailabilityZoneInfo{{
+		AvailabilityZone: ec2.AvailabilityZone{
+			Name:   "us-east-1a",
+			Region: "us-east-1",
+		},
+		State: "available",
+	}, {
+		AvailabilityZone: ec2.AvailabilityZone{
+			Name:   "us-east-1b",
+			Region: "us-east-1",
+		},
+		State: "impaired",
+	}, {
+		AvailabilityZone: ec2.AvailabilityZone{
+			Name:   "us-west-1a",
+			Region: "us-west-1",
+		},
+		State: "available",
+	}, {
+		AvailabilityZone: ec2.AvailabilityZone{
+			Name:   "us-west-1b",
+			Region: "us-west-1",
+		},
+		State:      "unavailable",
+		MessageSet: []string{"down for maintenance"},
+	}})
+
+	resp, err := s.ec2.AvailabilityZones(nil)
+	c.Assert(err, IsNil)
+	c.Assert(resp.Zones, HasLen, 4)
+	c.Assert(resp.Zones[0].Name, Equals, "us-east-1a")
+	c.Assert(resp.Zones[1].Name, Equals, "us-east-1b")
+	c.Assert(resp.Zones[2].Name, Equals, "us-west-1a")
+	c.Assert(resp.Zones[3].Name, Equals, "us-west-1b")
+
+	filter := ec2.NewFilter()
+	filter.Add("region-name", "us-east-1")
+	resp, err = s.ec2.AvailabilityZones(filter)
+	c.Assert(err, IsNil)
+	c.Assert(resp.Zones, HasLen, 2)
+	c.Assert(resp.Zones[0].Name, Equals, "us-east-1a")
+	c.Assert(resp.Zones[1].Name, Equals, "us-east-1b")
+}
+
 // AmazonServerSuite runs the ec2test server tests against a live EC2 server.
 // It will only be activated if the -amazon flag is specified.
 type AmazonServerSuite struct {

=== modified file 'ec2/ec2test/server.go'
--- ec2/ec2test/server.go	2014-05-27 13:26:01 +0000
+++ ec2/ec2test/server.go	2014-05-30 09:44:09 +0000
@@ -53,10 +53,11 @@
 	instances            map[string]*Instance      // id -> instance
 	reservations         map[string]*reservation   // id -> reservation
 	groups               map[string]*securityGroup // id -> group
-	vpcs                 map[string]*vpc           // id -> vpc
-	subnets              map[string]*subnet        // id -> subnet
-	ifaces               map[string]*iface         // id -> iface
-	attachments          map[string]*attachment    // id -> attachment
+	zones                []availabilityZone
+	vpcs                 map[string]*vpc        // id -> vpc
+	subnets              map[string]*subnet     // id -> subnet
+	ifaces               map[string]*iface      // id -> iface
+	attachments          map[string]*attachment // id -> attachment
 	maxId                counter
 	reqId                counter
 	reservationId        counter
@@ -86,6 +87,7 @@
 	imageId     string
 	reservation *reservation
 	instType    string
+	availZone   string
 	state       ec2.InstanceState
 	subnetId    string
 	vpcId       string
@@ -343,6 +345,7 @@
 	"TerminateInstances":            (*Server).terminateInstances,
 	"DescribeInstances":             (*Server).describeInstances,
 	"CreateSecurityGroup":           (*Server).createSecurityGroup,
+	"DescribeAvailabilityZones":     (*Server).describeAvailabilityZones,
 	"DescribeSecurityGroups":        (*Server).describeSecurityGroups,
 	"DeleteSecurityGroup":           (*Server).deleteSecurityGroup,
 	"AuthorizeSecurityGroupIngress": (*Server).authorizeSecurityGroupIngress,
@@ -363,7 +366,10 @@
 	"UnassignPrivateIpAddresses":    (*Server).unassignPrivateIP,
 }
 
-const ownerId = "9876"
+const (
+	ownerId          = "9876"
+	defaultAvailZone = "us-east-1a"
+)
 
 // newAction allocates a new action and adds it to the
 // recorded list of server actions.
@@ -418,6 +424,13 @@
 	}
 	srv.groups[g.id] = g
 
+	// Add a default availability zone.
+	var z availabilityZone
+	z.Name = defaultAvailZone
+	z.Region = "us-east-1"
+	z.State = "available"
+	srv.zones = []availabilityZone{z}
+
 	l, err := net.Listen("tcp", "localhost:0")
 	if err != nil {
 		return nil, fmt.Errorf("cannot listen on localhost: %v", err)
@@ -446,6 +459,15 @@
 	srv.mu.Unlock()
 }
 
+func (srv *Server) SetAvailabilityZones(zones []ec2.AvailabilityZoneInfo) {
+	srv.mu.Lock()
+	srv.zones = make([]availabilityZone, len(zones))
+	for i, z := range zones {
+		srv.zones[i] = availabilityZone{z}
+	}
+	srv.mu.Unlock()
+}
+
 // SetInitialAttributes sets the given account attributes on the server.
 func (srv *Server) SetInitialAttributes(attrs map[string][]string) {
 	for attrName, values := range attrs {
@@ -855,6 +877,7 @@
 	// make sure that form fields are correct before creating the reservation.
 	instType := req.Form.Get("InstanceType")
 	imageId := req.Form.Get("ImageId")
+	availZone := req.Form.Get("AvailZone")
 
 	r := srv.newReservation(srv.formToGroups(req.Form))
 
@@ -892,7 +915,7 @@
 	resp.OwnerId = ownerId
 
 	for i := 0; i < max; i++ {
-		inst := srv.newInstance(r, instType, imageId, srv.initialInstanceState)
+		inst := srv.newInstance(r, instType, imageId, availZone, srv.initialInstanceState)
 		// Create any NICs on the instance subnet (if any), and then
 		// save the VPC and subnet ids on the instance, as EC2 does.
 		inst.ifaces = srv.createNICsOnRun(inst.id(), instSubnet, ifacesToCreate)
@@ -942,7 +965,7 @@
 
 	ids := make([]string, n)
 	for i := 0; i < n; i++ {
-		inst := srv.newInstance(r, instType, imageId, state)
+		inst := srv.newInstance(r, instType, imageId, defaultAvailZone, state)
 		inst.vpcId = vpcId
 		inst.subnetId = subnetId
 		ids[i] = inst.id()
@@ -958,11 +981,12 @@
 	return srv.NewInstancesVPC("", "", n, instType, imageId, state, groups)
 }
 
-func (srv *Server) newInstance(r *reservation, instType string, imageId string, state ec2.InstanceState) *Instance {
+func (srv *Server) newInstance(r *reservation, instType string, imageId string, availZone string, state ec2.InstanceState) *Instance {
 	inst := &Instance{
 		seq:         srv.maxId.next(),
 		instType:    instType,
 		imageId:     imageId,
+		availZone:   availZone,
 		state:       state,
 		reservation: r,
 	}
@@ -1036,6 +1060,7 @@
 		IPAddress:         fmt.Sprintf("8.0.0.%d", inst.seq%256),
 		PrivateIPAddress:  fmt.Sprintf("127.0.0.%d", inst.seq%256),
 		State:             inst.state,
+		AvailZone:         inst.availZone,
 		VPCId:             inst.vpcId,
 		SubnetId:          inst.subnetId,
 		NetworkInterfaces: inst.ifaces,
@@ -1047,6 +1072,8 @@
 	switch attr {
 	case "architecture":
 		return value == "i386", nil
+	case "availability-zone":
+		return value == inst.availZone, nil
 	case "instance-id":
 		return inst.id() == value, nil
 	case "subnet-id":
@@ -1467,6 +1494,51 @@
 	}
 }
 
+type availabilityZone struct {
+	ec2.AvailabilityZoneInfo
+}
+
+func (z *availabilityZone) matchAttr(attr, value string) (ok bool, err error) {
+	switch attr {
+	case "message":
+		for _, m := range z.MessageSet {
+			if m == value {
+				return true, nil
+			}
+		}
+		return false, nil
+	case "region-name":
+		return z.Region == value, nil
+	case "state":
+		switch value {
+		case "available", "impaired", "unavailable":
+			return z.State == value, nil
+		}
+		return false, fmt.Errorf("invalid state %q", value)
+	case "zone-name":
+		return z.Name == value, nil
+	}
+	return false, fmt.Errorf("unknown attribute %q", attr)
+}
+
+func (srv *Server) describeAvailabilityZones(w http.ResponseWriter, req *http.Request, reqId string) interface{} {
+	srv.mu.Lock()
+	defer srv.mu.Unlock()
+
+	f := newFilter(req.Form)
+	var resp ec2.AvailabilityZonesResp
+	resp.RequestId = reqId
+	for _, zone := range srv.zones {
+		ok, err := f.ok(&zone)
+		if ok {
+			resp.Zones = append(resp.Zones, zone.AvailabilityZoneInfo)
+		} else if err != nil {
+			fatalf(400, "InvalidParameterValue", "describe availability zones: %v", err)
+		}
+	}
+	return &resp
+}
+
 func (srv *Server) createVpc(w http.ResponseWriter, req *http.Request, reqId string) interface{} {
 	cidrBlock := parseCidr(req.Form.Get("CidrBlock"))
 	tenancy := req.Form.Get("InstanceTenancy")

=== modified file 'ec2/responses_test.go'
--- ec2/responses_test.go	2014-05-08 16:37:32 +0000
+++ ec2/responses_test.go	2014-05-30 09:44:09 +0000
@@ -662,6 +662,62 @@
 </RebootInstancesResponse>
 `
 
+// http://goo.gl/ylxT4R
+var DescribeAvailabilityZonesExample1 = `
+<DescribeAvailabilityZonesResponse xmlns="http://ec2.amazonaws.com/doc/2014-05-01/">
+   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> 
+   <availabilityZoneInfo>
+   <item>
+      <zoneName>us-east-1a</zoneName>
+      <zoneState>available</zoneState>
+      <regionName>us-east-1</regionName>
+      <messageSet/>
+   </item>
+   <item>
+      <zoneName>us-east-1b</zoneName>
+      <zoneState>available</zoneState>
+      <regionName>us-east-1</regionName>
+      <messageSet/>
+   </item>
+   <item>
+      <zoneName>us-east-1c</zoneName>
+      <zoneState>available</zoneState>
+      <regionName>us-east-1</regionName>
+      <messageSet/>
+   </item>
+   <item>
+      <zoneName>us-east-1d</zoneName>
+      <zoneState>available</zoneState>
+      <regionName>us-east-1</regionName>
+      <messageSet/>
+   </item>
+   </availabilityZoneInfo>
+</DescribeAvailabilityZonesResponse>
+`
+
+// http://goo.gl/ylxT4R
+var DescribeAvailabilityZonesExample2 = `
+<DescribeAvailabilityZonesResponse xmlns="http://ec2.amazonaws.com/doc/2014-05-01/">
+   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> 
+   <availabilityZoneInfo>
+   <item>
+      <zoneName>us-east-1a</zoneName>
+      <zoneState>impaired</zoneState>
+      <regionName>us-east-1</regionName>
+      <messageSet/>
+   </item>
+   <item>
+      <zoneName>us-east-1b</zoneName>
+      <zoneState>unavailable</zoneState>
+      <regionName>us-east-1</regionName>
+      <messageSet>
+         <item>us-east-1b is currently down for maintenance.</item>
+      </messageSet>
+   </item>
+   </availabilityZoneInfo>
+</DescribeAvailabilityZonesResponse>
+`
+
 // http://goo.gl/nkwjv
 var CreateVpcExample = `
 <CreateVpcResponse xmlns="http://ec2.amazonaws.com/doc/2013-10-15/">