Merge lp:~allenap/gwacl/list-deployments into lp:gwacl

[Gavin Panella]

Convenience function to list deployments.

The list can be narrowed by passing an optional list of deployment names.

[Raphaël Badin (rvb)]

Looks good!

[0]

We should probably optimize ListDeployments for the case where len(DeploymentNames) == 1 and use GetDeployment in this case. This is just an optimization but I suspect the Azure provider will do that so would you mind adding a TODO?

[1]

Again, something that can be done later but it would be nice to add a call to ListDeployments() in example/management/run.go.

review: Approve

[Gavin Panella (allenap)]

> [0]
>
> We should probably optimize ListDeployments for the case where
> len(DeploymentNames) == 1 and use GetDeployment in this case. This is just an
> optimization but I suspect the Azure provider will do that so would you mind
> adding a TODO?

This seems like an unnecessary optimisation. If it proves to be much
slower to filter the response from GetHostedServiceProperties instead
of calling GetDeployment then we have reason to do this. Until then
this is just more code and more testing, and more places for bugs to
hide.

>
> [1]
>
> Again, something that can be done later but it would be nice to add a call to
> ListDeployments() in example/management/run.go.

Okay, I'll do that in a second branch now, so that this unblocks you.

Thanks for the review!

=== modified file 'management.go'
--- management.go	2013-06-24 16:01:59 +0000
+++ management.go	2013-06-26 12:35:35 +0000
@@ -20,3 +20,30 @@
     }
     return instances, nil
 }
+
+type ListDeploymentsRequest struct {
+    ServiceName     string
+    DeploymentNames []string
+}
+
+func (api *ManagementAPI) ListDeployments(request *ListDeploymentsRequest) ([]Deployment, error) {
+    properties, err := api.GetHostedServiceProperties(request.ServiceName, true)
+    if err != nil {
+        return nil, err
+    }
+    // Return all deployments if no deployment names were specified.
+    if len(request.DeploymentNames) == 0 {
+        return properties.Deployments, nil
+    }
+    // Filter the deployment list according to the given names.
+    deployments := []Deployment{}
+    for _, deployment := range properties.Deployments {
+        for _, name := range request.DeploymentNames {
+            if deployment.Name == name {
+                deployments = append(deployments, deployment)
+                break
+            }
+        }
+    }
+    return deployments, nil
+}

=== modified file 'management_test.go'
--- management_test.go	2013-06-24 14:37:31 +0000
+++ management_test.go	2013-06-26 12:35:35 +0000
@@ -81,3 +81,72 @@
     c.Assert(err, NotNil)
     c.Assert(err.Error(), Equals, "GET request failed (404: Not Found)")
 }
+
+// TestListDeployments goes through the happy path for ListDeployments.
+func (suite *managementAPISuite) TestListDeployments(c *C) {
+    // The list of properties for "S1".
+    propertiesS1 := HostedService{
+        ServiceName: "S1",
+        Deployments: []Deployment{
+            {Name: "one"}, {Name: "two"},
+        },
+    }
+    propertiesS1XML, err := propertiesS1.Serialize()
+    c.Assert(err, IsNil)
+    propertiesS1Response := DispatcherResponse{
+        response: &x509Response{
+            Body:       []byte(propertiesS1XML),
+            StatusCode: http.StatusOK,
+        },
+    }
+    // Rig the prepared response in.
+    record := []*x509Request{}
+    rigRecordingPreparedResponseDispatcher(
+        &record, []DispatcherResponse{propertiesS1Response},
+    )
+    // Finally, exercise ListDeployments.
+    api := makeAPI(c)
+    request := &ListDeploymentsRequest{ServiceName: propertiesS1.ServiceName}
+    deployments, err := api.ListDeployments(request)
+    c.Assert(err, IsNil)
+    c.Check(deployments, DeepEquals, propertiesS1.Deployments)
+    // Only one request to the API is made.
+    c.Assert(len(record), Equals, 1)
+}
+
+// TestListDeploymentsWithNames demonstrates that only the named deployments
+// are returned.
+func (suite *managementAPISuite) TestListDeploymentsWithNames(c *C) {
+    // The list of properties for "S1".
+    propertiesS1 := HostedService{
+        ServiceName: "S1",
+        Deployments: []Deployment{
+            {Name: "Arthur"}, {Name: "Bobby"},
+        },
+    }
+    propertiesS1XML, err := propertiesS1.Serialize()
+    c.Assert(err, IsNil)
+    propertiesS1Response := DispatcherResponse{
+        response: &x509Response{
+            Body:       []byte(propertiesS1XML),
+            StatusCode: http.StatusOK,
+        },
+    }
+    // Rig the prepared response in.
+    record := []*x509Request{}
+    rigRecordingPreparedResponseDispatcher(
+        &record, []DispatcherResponse{propertiesS1Response},
+    )
+    // Finally, exercise ListDeployments.
+    api := makeAPI(c)
+    request := &ListDeploymentsRequest{
+        ServiceName:     propertiesS1.ServiceName,
+        DeploymentNames: []string{"Arthur"},
+    }
+    deployments, err := api.ListDeployments(request)
+    c.Assert(err, IsNil)
+    // Only the first deployment - named "Arthur" - is returned.
+    c.Check(deployments, DeepEquals, []Deployment{propertiesS1.Deployments[0]})
+    // Only one request to the API is made.
+    c.Assert(len(record), Equals, 1)
+}