support instances_retrievable and bindings_retrievable (supporting webui forms for params + osb client guid lookup)

[gberche-orange]

Expected behavior

• As an application developer (implicitly using osb-cmdb),
• in order to update services supporting arbitrary params and json schemas and have previously set data displayed in web ui or in cf cli v8 (see Improving cf service UX in V8)
• I need osb-cmdb to implement the fetch endpoint for service instance and service bindings.

As an osb-client,

• in order to check whether a service instance exists associated with a given id
• in order to check whether a given id was already used
• I need the OSB instances_retrievable feature to be implemented

Observed behavior

Osb-cmdb and SCAB does not currently implement the fetch endpoints.

As a workaround, OSB client can be given a read-only access to the osb-cmdb to discover existing backing service guids. (duplicate of #23)

Affected release

Reproduced on version 0.2

[gberche-orange]

Status as of V1.6.0 for instances_retrievable feature

• Acceptance test checking get endpoint with params is available at

  osb-cmdb/spring-cloud-app-broker-acceptance-tests/src/test/java/org/springframework/cloud/appbroker/acceptance/CreateInstanceCustomParamAcceptanceTest.java

  Lines 66 to 78 in 9f6e52c

  	void deployAppsAndCreateServiceKeysOnBindService() {
  	// given a brokered service instance is created with some params
  	Map<String, Object> parameters = Collections.singletonMap("a-key", "a-value");
  	createServiceInstance(brokeredServiceInstanceName(), parameters);
  	// then the brokered service instance is indeed successfully created
  	ServiceInstance brokeredServiceInstance = getServiceInstance(brokeredServiceInstanceName());
  	assertThat(brokeredServiceInstance.getStatus()).isEqualTo("succeeded");
  	//And the brokered service instance returns the same params provisionned
  	Map<String, Object> brokeredServiceInstanceParams = getServiceInstanceParams(brokeredServiceInstance.getId());
  	assertThat(brokeredServiceInstanceParams).containsAllEntriesOf(parameters);
  	//And a custom param propagates metadata to brokered service
  	assertCustomParams(brokeredServiceInstanceParams);
  	}

  but faking the service catalog instances_retrievable field

  osb-cmdb/spring-cloud-app-broker-acceptance-tests/src/test/java/org/springframework/cloud/appbroker/acceptance/CloudFoundryAcceptanceTest.java

  Line 219 in bd8c963

  "spring.cloud.openservicebroker.catalog.services[0].instances_retrievable=true",

• hideMetadataCustomParamInGetServiceInstanceEndpoint default value is true (false opt in is supported for supporting acceptance tests)
• Dynamic catalog includes mapping instances_retrievable field

  osb-cmdb/osb-cmdb/src/main/java/com/orange/oss/osbcmdb/catalog/ServiceDefinitionMapper.java

  Lines 62 to 63 in ffbda22

  	.bindingsRetrievable(safeBoolean(entity.getBindingsRetrievable()))
  	.instancesRetrievable(safeBoolean(entity.getInstancesRetrievable()))

• Missing unit test for dynamic catalog instances_retrievable property

Paas-templates osb smoke tests are missing call to "cf curl /v3/service_instances/:guid/parameters", see https://www.pivotaltracker.com/story/show/178213858 for smoke test scenario

[gberche-orange]

Steps from V1.6.0 for binding_retrievable feature

Decision on whether to migrate to v3 CAPI api to support async service bindings

• V3 service binding is not yet supported in cf-java-client

  • https://github.com/cloudfoundry/cf-java-client/blob/96f068a61ccff1b60d5a3c068587420da431720a/cloudfoundry-client-reactor/src/main/java/org/cloudfoundry/reactor/client/v3/servicebindings/ReactorServiceBindingsV3.java#L52-L55 uses service_bindings path
  • http://v3-apidocs.cloudfoundry.org/version/3.108.0/index.html#create-a-service-credential-binding expects POST /v3/service_credential_bindings

• V2 async service bindings does not exist.

• check prereq support in spring-cloud-service-broker

  • https://github.com/spring-cloud/spring-cloud-open-service-broker/blob/main/spring-cloud-open-service-broker-core/src/main/java/org/springframework/cloud/servicebroker/model/binding/GetServiceInstanceBindingRequest.java

• Implement GET /v2/service_instances/:instance_id/service_bindings/:binding_id by returning the current service key using v2 CC api support in cf-java-client

• Add acceptance test

[gberche-orange]

Suggested alternative to implementing and testing async service binding is to wrap the CF CLI, thanks @o-orand

[gberche-orange]

Async service binding is now available in https://github.com/cloudfoundry/cf-java-client/releases/tag/v5.9.0.RELEASE thanks to cloudfoundry/cf-java-client#1158