Merge pull request cloudant#443 from cloudant/support-legacy-creds-with-iam

Added support for IAM API key in bluemix method

Author: emlaver

CHANGES.md

@@ -7,6 +7,7 @@
 - [NEW] Add `ComplexKey.addHighSentinel()` to allow matching of all values as part of a complex key
  range.
 - [NEW] Support IAM authentication in replication documents.
+- [IMPROVED] Added support for IAM API key in the client builder `bluemix` method.
 - [IMPROVED] When making view requests (including `_all_docs`), set `keys` in the `POST` body rather
  than in `GET` query parameters. This is because a large number of keys could previously exceed the
  maximum URL length, causing errors.

Jenkinsfile

@@ -27,9 +27,10 @@ def runTests(testEnv, isServiceTests) {
 
  //Set up the environment and run the tests
  withEnv(testEnv) {
- withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: env.CREDS_ID, usernameVariable: 'DB_USER', passwordVariable: 'DB_PASSWORD']]) {
+ withCredentials([usernamePassword(credentialsId: 'clientlibs-test', usernameVariable: 'DB_USER', passwordVariable: 'DB_PASSWORD'),
+ string(credentialsId: 'clientlibs-test-iam', variable: 'DB_IAM_API_KEY')]) {
  try {
- sh './gradlew -Dtest.couch.username=$DB_USER -Dtest.couch.password=$DB_PASSWORD -Dtest.couch.host=$DB_HOST -Dtest.couch.port=$DB_PORT -Dtest.couch.http=$DB_HTTP $GRADLE_TARGET'
+ sh './gradlew -Dtest.couch.username=$DB_USER -Dtest.couch.password=$DB_PASSWORD -Dtest.couch.host=$DB_HOST -Dtest.couch.port=$DB_PORT -Dtest.couch.http=$DB_HTTP -Dtest.couch.iam.api.key=$DB_IAM_API_KEY $GRADLE_TARGET'
  } finally {
  junit '**/build/test-results/**/*.xml'
  }

cloudant-client/src/main/java/com/cloudant/client/api/ClientBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2015, 2017 IBM Corp. All rights reserved.
+ * Copyright © 2015, 2018 IBM Corp. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at
@@ -180,12 +180,8 @@ public class ClientBuilder {
  */
  public static ClientBuilder account(String account) {
  logger.config("Account: " + account);
- try {
- URL url = new URL(String.format("https://%s.cloudant.com", account));
- return ClientBuilder.url(url);
- } catch (MalformedURLException e) {
- throw new IllegalArgumentException("Could not generate url from account name.", e);
- }
+ return ClientBuilder.url(
+ convertStringToURL(String.format("https://%s.cloudant.com", account)));
  }
 
  /**
@@ -229,17 +225,13 @@ private ClientBuilder(URL url) {
  String urlPath = url.getPath().trim();
  urlPath = urlPath.endsWith("/") ? urlPath.substring(0, urlPath.length() - 1) : urlPath;
 
- try {
- // Reconstruct URL without user credentials
- this.url = new URL(urlProtocol
- + "://"
- + urlHost
- + ":"
- + urlPort
- + urlPath);
- } catch (MalformedURLException e) {
- throw new RuntimeException(e);
- }
+ // Reconstruct URL without user credentials
+ this.url = convertStringToURL(urlProtocol
+ + "://"
+ + urlHost
+ + ":"
+ + urlPort
+ + urlPath);
  }
 
 
@@ -748,11 +740,7 @@ public static ClientBuilder bluemix(String vcapServices, String serviceName, Str
  if (instanceName == null) {
  if (cloudantServices.size() == 1) {
  CloudFoundryService cloudantService = cloudantServices.get(0);
- if (cloudantService.credentials == null || cloudantService.credentials.url == null) {
- throw new IllegalArgumentException(
- "The Cloudant service instance information was invalid.");
- }
- return ClientBuilder.url(cloudantService.credentials.url);
+ return vcapClientBuilder(cloudantService);
  } else {
  throw new IllegalArgumentException("Multiple Cloudant service instances present. " +
  "A service instance name must be specified.");
@@ -761,11 +749,7 @@ public static ClientBuilder bluemix(String vcapServices, String serviceName, Str
 
  for (CloudFoundryService cloudantService : cloudantServices) {
  if (instanceName.equals(cloudantService.name)) {
- if (cloudantService.credentials == null || cloudantService.credentials.url == null) {
- throw new IllegalArgumentException(
- "The Cloudant service instance information was invalid.");
- }
- return ClientBuilder.url(cloudantService.credentials.url);
+ return vcapClientBuilder(cloudantService);
  }
  }
 
@@ -774,6 +758,30 @@ public static ClientBuilder bluemix(String vcapServices, String serviceName, Str
  );
  }
 
+ private static ClientBuilder vcapClientBuilder(CloudFoundryService cloudantService) {
+ // Create client with IAM if the API key exists
+ if (cloudantService.credentials != null
+ && cloudantService.credentials.host != null) {
+ URL vcapUrl = convertStringToURL(
+ String.format("https://%s", cloudantService.credentials.host));
+ ClientBuilder clientBuilder = ClientBuilder.url(vcapUrl);
+ if (cloudantService.credentials.apikey != null) {
+ return clientBuilder.iamApiKey(cloudantService.credentials.apikey);
+ } else if (cloudantService.credentials.username != null
+ && cloudantService.credentials.password != null) {
+ return clientBuilder.username(cloudantService.credentials.username)
+ .password(cloudantService.credentials.password);
+ } else {
+ throw new IllegalArgumentException(
+ "The Cloudant service instance is missing the IAM API key, " +
+ "or both the username and password credential properties.");
+ }
+ } else {
+ throw new IllegalArgumentException(
+ "The Cloudant service instance information was invalid.");
+ }
+ }
+
  /**
  * Sets the
  * <a href="https://console.bluemix.net/docs/services/Cloudant/guides/iam.html#ibm-cloud-identity-and-access-management"
@@ -787,4 +795,11 @@ public ClientBuilder iamApiKey(String iamApiKey) {
  return this;
  }
 
+ private static URL convertStringToURL(String urlAsString) {
+ try {
+ return new URL(urlAsString);
+ } catch (MalformedURLException e) {
+ throw new RuntimeException(e);
+ }
+ }
 }

cloudant-client/src/main/java/com/cloudant/client/internal/util/CloudFoundryService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 IBM Corp. All rights reserved.
+ * Copyright © 2016, 2018 IBM Corp. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at
@@ -14,6 +14,8 @@
 
 package com.cloudant.client.internal.util;
 
+import com.google.gson.annotations.SerializedName;
+
 import java.net.URL;
 
 
@@ -24,6 +26,13 @@ public class CloudFoundryService {
 
  public static class CloudFoundryServiceCredentials {
 
- public URL url;
+ @SerializedName("apikey")
+ public String apikey;
+ @SerializedName("host")
+ public String host;
+ @SerializedName("username")
+ public String username;
+ @SerializedName("password")
+ public String password;
  }
 }