Follow next_url links in paginated API responses

Fixes #2
Fixes #3

[#135595571]

Signed-off-by: Andreas Fleig <[email protected]>

Author: waterlink

cfmysql/api_client.go

@@ -21,12 +21,22 @@ type ApiClientImpl struct {
 }
 
 func (self *ApiClientImpl) GetServiceInstances(cliConnection plugin.CliConnection) ([]pluginModels.ServiceInstance, error) {
-	instanceResponse, err := self.getFromCfApi("/v2/service_instances", cliConnection)
-	if err != nil {
-		return nil, fmt.Errorf("Unable to retrieve service instances: %s", err)
+	var err error
+	var allInstances []pluginModels.ServiceInstance
+	nextUrl := "/v2/service_instances"
+
+	for nextUrl != "" {
+		instanceResponse, err := self.getFromCfApi(nextUrl, cliConnection)
+		if err != nil {
+			return nil, fmt.Errorf("Unable to retrieve service instances: %s", err)
+		}
+
+		var instances []pluginModels.ServiceInstance
+		nextUrl, instances, err = deserializeInstances(instanceResponse)
+		allInstances = append(allInstances, instances...)
 	}
 
-	return deserializeInstances(instanceResponse)
+	return allInstances, err
 }
 
 func (self *ApiClientImpl) getFromCfApi(path string, cliConnection plugin.CliConnection) ([]byte, error) {
@@ -43,35 +53,49 @@ func (self *ApiClientImpl) getFromCfApi(path string, cliConnection plugin.CliCon
 	return self.HttpClient.Get(endpoint + path, accessToken)
 }
 
-func deserializeInstances(jsonResponse []byte) ([]pluginModels.ServiceInstance, error) {
+func deserializeInstances(jsonResponse []byte) (string, []pluginModels.ServiceInstance, error) {
 	paginatedResources := new(resources.PaginatedServiceInstanceResources)
 	err := json.Unmarshal(jsonResponse, paginatedResources)
 
 	if err != nil {
-		return nil, fmt.Errorf("Unable to deserialize service instances: %s", err)
+		return "", nil, fmt.Errorf("Unable to deserialize service instances: %s", err)
 	}
 
-	return paginatedResources.ToModel(), nil
+	return paginatedResources.NextUrl, paginatedResources.ToModel(), nil
 }
 
 func (self *ApiClientImpl) GetServiceBindings(cliConnection plugin.CliConnection) ([]pluginModels.ServiceBinding, error) {
-	bindingsResp, err := self.getFromCfApi("/v2/service_bindings", cliConnection)
-	if err != nil {
-		return nil, fmt.Errorf("Unable to call service bindings endpoint: %s", err)
+	var allBindings []pluginModels.ServiceBinding
+	nextUrl := "/v2/service_bindings"
+
+	for nextUrl != "" {
+		bindingsResp, err := self.getFromCfApi(nextUrl, cliConnection)
+		if err != nil {
+			return nil, fmt.Errorf("Unable to call service bindings endpoint: %s", err)
+		}
+
+		var bindings []pluginModels.ServiceBinding
+		nextUrl, bindings, err = deserializeBindings(bindingsResp)
+		if err != nil {
+			return nil, fmt.Errorf("Unable to deserialize service bindings: %s", err)
+		}
+
+		allBindings = append(allBindings, bindings...)
 	}
 
-	return deserializeBindings(bindingsResp)
+	return allBindings, nil
 }
 
-func deserializeBindings(bindingResponse []byte) ([]pluginModels.ServiceBinding, error) {
+func deserializeBindings(bindingResponse []byte) (string, []pluginModels.ServiceBinding, error) {
 	paginatedResources := new(resources.PaginatedServiceBindingResources)
 	err := json.Unmarshal(bindingResponse, paginatedResources)
 
 	if err != nil {
-		return nil, fmt.Errorf("Unable to deserialize service bindings: %s", err)
+		return "", nil, fmt.Errorf("Unable to deserialize service bindings: %s", err)
 	}
 
-	return paginatedResources.ToModel()
+	bindings, err := paginatedResources.ToModel()
+	return paginatedResources.NextUrl, bindings, err
 }
 
 func (self *ApiClientImpl) GetStartedApps(cliConnection plugin.CliConnection) ([]sdkModels.GetAppsModel, error) {

cfmysql/api_client_test.go

@@ -25,8 +25,12 @@ var _ = Describe("ApiClient", func() {
 			switch url {
 			case "https://cf.api.url/v2/service_bindings":
 				return test_resources.LoadResource("test_resources/service_bindings.json"), nil
+			case "https://cf.api.url/v2/service_bindings?page=2":
+				return test_resources.LoadResource("test_resources/service_bindings_page2.json"), nil
 			case "https://cf.api.url/v2/service_instances":
 				return test_resources.LoadResource("test_resources/service_instances.json"), nil
+			case "https://cf.api.url/v2/service_instances?page=2":
+				return test_resources.LoadResource("test_resources/service_instances_page2.json"), nil
 			default:
 				return nil, fmt.Errorf("URL not handled in mock: %s", url)
 			}
@@ -83,15 +87,19 @@ var _ = Describe("ApiClient", func() {
 			instances, err := apiClient.GetServiceInstances(cliConnection)
 
 			Expect(err).To(BeNil())
-			Expect(instances).To(HaveLen(4))
+			Expect(instances).To(HaveLen(5))
 
-			Expect(cliConnection.AccessTokenCallCount()).To(Equal(1))
-			Expect(cliConnection.ApiEndpointCallCount()).To(Equal(1))
+			Expect(cliConnection.AccessTokenCallCount()).To(Equal(2))
+			Expect(cliConnection.ApiEndpointCallCount()).To(Equal(2))
 
-			Expect(mockHttp.GetCallCount()).To(Equal(1))
+			Expect(mockHttp.GetCallCount()).To(Equal(2))
 			url, access_token := mockHttp.GetArgsForCall(0)
 			Expect(url).To(Equal("https://cf.api.url/v2/service_instances"))
 			Expect(access_token).To(Equal("bearer my-secret-token"))
+
+			url2, access_token2 := mockHttp.GetArgsForCall(1)
+			Expect(url2).To(Equal("https://cf.api.url/v2/service_instances?page=2"))
+			Expect(access_token2).To(Equal("bearer my-secret-token"))
 		})
 	})
 
@@ -104,17 +112,21 @@ var _ = Describe("ApiClient", func() {
 				bindings, err := apiClient.GetServiceBindings(cliConnection)
 
 				Expect(err).To(BeNil())
-				Expect(bindings).To(HaveLen(5))
+				Expect(bindings).To(HaveLen(6))
 				Expect(bindings[0].Port).To(Equal("3306"))
 				Expect(bindings[3].Port).To(Equal("54321"))
 
-				Expect(cliConnection.AccessTokenCallCount()).To(Equal(1))
-				Expect(cliConnection.ApiEndpointCallCount()).To(Equal(1))
+				Expect(cliConnection.AccessTokenCallCount()).To(Equal(2))
+				Expect(cliConnection.ApiEndpointCallCount()).To(Equal(2))
 
-				Expect(mockHttp.GetCallCount()).To(Equal(1))
+				Expect(mockHttp.GetCallCount()).To(Equal(2))
 				url, access_token := mockHttp.GetArgsForCall(0)
 				Expect(url).To(Equal("https://cf.api.url/v2/service_bindings"))
 				Expect(access_token).To(Equal("bearer my-secret-token"))
+
+				url2, access_token2 := mockHttp.GetArgsForCall(1)
+				Expect(url2).To(Equal("https://cf.api.url/v2/service_bindings?page=2"))
+				Expect(access_token2).To(Equal("bearer my-secret-token"))
 			})
 		})
 	})

cfmysql/plugin.go

@@ -24,7 +24,7 @@ func (self *MysqlPlugin) GetMetadata() plugin.PluginMetadata {
 		Version: plugin.VersionType{
 			Major: 1,
 			Minor: 3,
-			Build: 4,
+			Build: 5,
 		},
 		MinCliVersion: plugin.VersionType{
 			Major: 6,

cfmysql/plugin_test.go

@@ -21,7 +21,7 @@ var _ = Describe("Plugin", func() {
 			Expect(mysqlPlugin.GetMetadata().Version).To(Equal(plugin.VersionType{
 				Major: 1,
 				Minor: 3,
-				Build: 4,
+				Build: 5,
 			}))
 		})
 	})

cfmysql/resources/resources.go

@@ -11,6 +11,7 @@ import (
 
 type PaginatedServiceBindingResources struct {
 	TotalResults int `json:"total_results"`
+	NextUrl      string `json:"next_url"`
 	Resources    []ServiceBindingResource
 }
 
@@ -37,6 +38,7 @@ type MysqlCredentials struct {
 
 type PaginatedServiceInstanceResources struct {
 	TotalResults int `json:"total_results"`
+	NextUrl      string `json:"next_url"`
 	Resources    []ServiceInstanceResource
 }
 

cfmysql/resources/resources_test.go

@@ -21,6 +21,7 @@ var _ = Describe("Resources", func() {
 
 				Expect(err).To(BeNil())
 				Expect(paginatedResources.Resources).To(HaveLen(4))
+				Expect(paginatedResources.NextUrl).To(Equal("/v2/service_instances?page=2"))
 
 				Expect(paginatedResources.Resources[0].Entity.Name).To(Equal("database-a"))
 				Expect(paginatedResources.Resources[0].Metadata.GUID).To(Equal("service-instance-guid-a"))
@@ -86,6 +87,7 @@ var _ = Describe("Resources", func() {
 
 				Expect(err).To(BeNil())
 				Expect(paginatedResources.Resources).To(HaveLen(5))
+				Expect(paginatedResources.NextUrl).To(Equal("/v2/service_bindings?page=2"))
 
 				Expect(paginatedResources.Resources[0].Entity.ServiceInstanceGUID).To(Equal("service-instance-guid-a"))
 				Expect(paginatedResources.Resources[0].Entity.Credentials.Uri).To(Equal("mysql://username-a:[email protected]:3306/dbname-a?reconnect=true"))

cfmysql/test_resources/service_bindings.json

@@ -1,8 +1,8 @@
 {
-  "total_results": 2,
-  "total_pages": 1,
+  "total_results": 6,
+  "total_pages": 2,
   "prev_url": null,
-  "next_url": null,
+  "next_url": "/v2/service_bindings?page=2",
   "resources": [
     {
       "metadata": {

cfmysql/test_resources/service_bindings_page2.json

@@ -0,0 +1,36 @@
+{
+  "total_results": 6,
+  "total_pages": 2,
+  "prev_url": null,
+  "next_url": null,
+  "resources": [
+    {
+      "metadata": {
+        "guid": "guid-service-binding-f",
+        "url": "/v2/service_bindings/guid-service-binding-f",
+        "created_at": "2016-11-15T09:22:15Z",
+        "updated_at": null
+      },
+      "entity": {
+        "app_guid": "app-guid-f",
+        "service_instance_guid": "service-instance-guid-f",
+        "credentials": {
+          "jdbcUrl": "jdbc:mysql://database-f.host/dbname-f?user=username-f&password=password-f",
+          "uri": "mysql://username-f:[email protected]:3306/dbname-f?reconnect=true",
+          "name": "dbname-f",
+          "hostname": "database-f.host",
+          "port": "3306",
+          "username": "username-f",
+          "password": "password-f"
+        },
+        "binding_options": {},
+        "gateway_data": null,
+        "gateway_name": "",
+        "syslog_drain_url": null,
+        "volume_mounts": [],
+        "app_url": "/v2/apps/app-guid-f",
+        "service_instance_url": "/v2/service_instances/service-instance-guid-f"
+      }
+    }
+  ]
+}

cfmysql/test_resources/service_instances.json

@@ -1,8 +1,8 @@
 {
-  "total_results": 4,
-  "total_pages": 1,
+  "total_results": 5,
+  "total_pages": 2,
   "prev_url": null,
-  "next_url": null,
+  "next_url": "/v2/service_instances?page=2",
   "resources": [
     {
       "metadata": {

cfmysql/test_resources/service_instances_page2.json

@@ -0,0 +1,38 @@
+{
+  "total_results": 5,
+  "total_pages": 2,
+  "prev_url": null,
+  "next_url": null,
+  "resources": [
+    {
+      "metadata": {
+        "guid": "service-instance-guid-f",
+        "url": "/v2/service_instances/service-instance-guid-f",
+        "created_at": "2016-11-14T14:56:40Z",
+        "updated_at": null
+      },
+      "entity": {
+        "name": "database-f",
+        "credentials": {},
+        "service_plan_guid": "service-plan-guid",
+        "space_guid": "space-guid",
+        "gateway_data": null,
+        "dashboard_url": "https://dashboard.url/service-instance-guid-f",
+        "type": "managed_service_instance",
+        "last_operation": {
+          "type": "create",
+          "state": "succeeded",
+          "description": "",
+          "updated_at": null,
+          "created_at": "2016-11-14T14:56:41Z"
+        },
+        "tags": [],
+        "space_url": "/v2/spaces/space-guid",
+        "service_plan_url": "/v2/service_plans/service-plan-guid",
+        "service_bindings_url": "/v2/service_instances/service-instance-guid-f/service_bindings",
+        "service_keys_url": "/v2/service_instances/service-instance-guid-f/service_keys",
+        "routes_url": "/v2/service_instances/service-instance-guid-f/routes"
+      }
+    }
+  ]
+}