test: improve test code coverage (#162)

Author: padamstx

src/main/java/com/ibm/cloud/sdk/core/service/BaseService.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2015, 2021.
+ * (C) Copyright IBM Corp. 2015, 2022.
  *
  * 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
@@ -36,6 +36,7 @@
 import com.ibm.cloud.sdk.core.service.exception.ForbiddenException;
 import com.ibm.cloud.sdk.core.service.exception.InternalServerErrorException;
 import com.ibm.cloud.sdk.core.service.exception.InvalidServiceResponseException;
+import com.ibm.cloud.sdk.core.service.exception.NotAcceptableException;
 import com.ibm.cloud.sdk.core.service.exception.NotFoundException;
 import com.ibm.cloud.sdk.core.service.exception.RequestTooLargeException;
 import com.ibm.cloud.sdk.core.service.exception.ServiceResponseException;
@@ -439,6 +440,14 @@ public void setEndPoint(final String endPoint) {
     this.setServiceUrl(endPoint);
   }
 
+  /**
+   * Returns the set of default headers current set on this BaseService instance.
+   * @return the Headers object containing the default headers.
+   */
+  public Headers getDefaultHeaders() {
+    return defaultHeaders;
+  }
+
   /**
    * Set the default headers to be used on every HTTP request.
    *
@@ -526,7 +535,7 @@ protected <T> T processServiceCall(final ResponseConverter<T> converter, final R
       case HttpStatus.NOT_FOUND: // HTTP 404
         throw new NotFoundException(response);
       case HttpStatus.NOT_ACCEPTABLE: // HTTP 406
-        throw new ForbiddenException(response);
+        throw new NotAcceptableException(response);
       case HttpStatus.CONFLICT: // HTTP 409
         throw new ConflictException(response);
       case HttpStatus.REQUEST_TOO_LONG: // HTTP 413

src/main/java/com/ibm/cloud/sdk/core/service/exception/NotAcceptableException.java

@@ -0,0 +1,41 @@
+/**
+ * (C) Copyright IBM Corp. 2022.
+ *
+ * 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
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.ibm.cloud.sdk.core.service.exception;
+
+import com.ibm.cloud.sdk.core.http.HttpStatus;
+
+import okhttp3.Response;
+
+/**
+ * 406 Not Acceptable (HTTP/1.0 - RFC 1945).
+ */
+public class NotAcceptableException extends ServiceResponseException {
+
+  /**
+   * The Constant serialVersionUID.
+   */
+  private static final long serialVersionUID = 1L;
+
+  /**
+   * Instantiates a new Forbidden Exception.
+   *
+   * @param response the HTTP response
+   */
+  public NotAcceptableException(Response response) {
+    super(HttpStatus.NOT_ACCEPTABLE, response);
+    if (this.getMessage() == null) {
+      this.setMessage("Not Acceptable: Service cannot produce a response.");
+    }
+  }
+}

src/main/java/com/ibm/cloud/sdk/core/util/CredentialUtils.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2015, 2019.
+ * (C) Copyright IBM Corp. 2015, 2022.
  *
  * 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
@@ -143,6 +143,12 @@ public static Map<String, List<VcapService>> getVcapServicesObj() {
 
     // Retrieve the environment variable's value.
     String vcapValue = EnvironmentUtils.getenv(VCAP_SERVICES);
+
+    // If no env var, then look for a system property (helps in testing).
+    if (StringUtils.isEmpty(vcapValue)) {
+      vcapValue = System.getProperty(VCAP_SERVICES);
+    }
+
     if (StringUtils.isNotEmpty(vcapValue)) {
       Gson gson = GsonSingleton.getGson();
       // Parse it into a map of VcapService lists keyed by service name.

src/test/java/com/ibm/cloud/sdk/core/security/VpcInstanceAuthenticatorTest.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2021.
+ * (C) Copyright IBM Corp. 2022.
  *
  * 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
@@ -111,6 +111,9 @@ public void testBuilderDefaultConfig() {
     assertNull(authenticator.getURL());
     assertNull(authenticator.getIamProfileCrn());
     assertNull(authenticator.getIamProfileId());
+
+    VpcInstanceAuthenticator auth2 = authenticator.newBuilder().build();
+    assertNotNull(auth2);
   }
 
   @Test

src/test/java/com/ibm/cloud/sdk/core/test/TestUtils.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2015, 2019.
+ * (C) Copyright IBM Corp. 2015, 2022.
  *
  * 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
@@ -43,6 +43,9 @@ public final class TestUtils {
   /** The Constant PUT. */
   public static final String PUT = "PUT";
 
+  /** The Constant PATCH. */
+  public static final String PATCH = "PATCH";
+
   /**
    * Private constructor.
    */

src/test/java/com/ibm/cloud/sdk/core/test/http/HttpClientSingletonTest.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2021.
+ * (C) Copyright IBM Corp. 2022.
  *
  * 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
@@ -13,21 +13,23 @@
 
 package com.ibm.cloud.sdk.core.test.http;
 
-import com.ibm.cloud.sdk.core.http.HttpClientSingleton;
-import com.ibm.cloud.sdk.core.http.HttpConfigOptions;
-import okhttp3.ConnectionSpec;
-import okhttp3.OkHttpClient;
-import okhttp3.TlsVersion;
-import org.testng.annotations.Ignore;
-import org.testng.annotations.Test;
+import static org.testng.Assert.assertTrue;
 
 import java.io.IOException;
-import java.util.Arrays;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
+
 import javax.net.ssl.SSLSocket;
 
-import static org.testng.Assert.assertTrue;
+import org.testng.annotations.Test;
+
+import com.ibm.cloud.sdk.core.http.HttpClientSingleton;
+import com.ibm.cloud.sdk.core.http.HttpConfigOptions;
+
+import okhttp3.ConnectionSpec;
+import okhttp3.OkHttpClient;
+import okhttp3.TlsVersion;
 
 /**
  * Unit tests for the HttpClientSingleton object.

src/test/java/com/ibm/cloud/sdk/core/test/http/HttpConfigTest.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2015, 2019.
+ * (C) Copyright IBM Corp. 2015, 2022.
  *
  * 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
@@ -13,26 +13,34 @@
 
 package com.ibm.cloud.sdk.core.test.http;
 
-import okhttp3.Authenticator;
-import okhttp3.Request;
-import okhttp3.Response;
-import okhttp3.Route;
-import org.testng.annotations.Test;
-
-import com.ibm.cloud.sdk.core.http.HttpConfigOptions;
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNotNull;
+import static org.testng.Assert.assertNull;
+import static org.testng.Assert.assertTrue;
 
-import javax.annotation.Nullable;
 import java.io.IOException;
 import java.net.InetSocketAddress;
 import java.net.Proxy;
 
-import static org.testng.Assert.assertEquals;
-import static org.testng.Assert.assertNull;
-import static org.testng.Assert.assertTrue;
+import javax.annotation.Nullable;
+
+import org.testng.annotations.Test;
+
+import com.ibm.cloud.sdk.core.http.HttpClientSingleton;
+import com.ibm.cloud.sdk.core.http.HttpConfigOptions;
+import com.ibm.cloud.sdk.core.util.HttpLogging;
+
+import okhttp3.Authenticator;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import okhttp3.Route;
+import okhttp3.logging.HttpLoggingInterceptor;
 
 /**
  * Unit tests for the HttpConfigOptions object.
  */
+@SuppressWarnings("deprecation")
 public class HttpConfigTest {
 
   @Test
@@ -58,5 +66,23 @@ public Request authenticate(@Nullable Route route, Response response) throws IOE
     assertNull(configOptions.getGzipCompression());
     assertEquals(proxy, configOptions.getProxy());
     assertEquals(HttpConfigOptions.LoggingLevel.HEADERS, configOptions.getLoggingLevel());
+
+    OkHttpClient client = HttpClientSingleton.getInstance().configureClient(configOptions);
+    assertNotNull(client);
+
+    // Call configureClient to cover some additional statements.
+    client = HttpClientSingleton.getInstance().configureClient(configOptions);
+    assertNotNull(client);
+
+    client = HttpClientSingleton.getInstance().configureClient(null);
+    assertNotNull(client);
+  }
+
+
+  @Test
+  public void testHttpLogging() {
+    HttpLoggingInterceptor interceptor = HttpLogging.getLoggingInterceptor();
+    assertNotNull(interceptor);
   }
+
 }

src/test/java/com/ibm/cloud/sdk/core/test/security/AuthenticatorBaseTest.java

@@ -0,0 +1,39 @@
+/**
+ * (C) Copyright IBM Corp. 2022.
+ *
+ * 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
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.ibm.cloud.sdk.core.test.security;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNull;
+import static org.testng.Assert.assertTrue;
+
+import org.testng.annotations.Test;
+
+import com.ibm.cloud.sdk.core.security.AuthenticatorBase;
+
+public class AuthenticatorBaseTest {
+
+  @Test
+  public void testConstructBasicAuthHeader() {
+    assertTrue(AuthenticatorBase.constructBasicAuthHeader("user", "password").startsWith("Basic "));
+    assertNull(AuthenticatorBase.constructBasicAuthHeader(null, null));
+    assertNull(AuthenticatorBase.constructBasicAuthHeader("", ""));
+  }
+
+  @Test
+  public void testConstructBearerAuthHeader() {
+    assertEquals("Bearer token", AuthenticatorBase.constructBearerTokenAuthHeader("token"));
+    assertNull( AuthenticatorBase.constructBearerTokenAuthHeader(null));
+    assertNull( AuthenticatorBase.constructBearerTokenAuthHeader(""));
+  }
+}

src/test/java/com/ibm/cloud/sdk/core/test/security/BasicAuthenticatorTest.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2015, 2021.
+ * (C) Copyright IBM Corp. 2015, 2022.
  *
  * 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
@@ -36,7 +36,10 @@ public void testSuccess() {
     String username = "good-username";
     String password = "good-password";
 
-    BasicAuthenticator auth = new BasicAuthenticator(username, password);
+    BasicAuthenticator auth = new BasicAuthenticator.Builder()
+        .username(username)
+        .password(password)
+        .build();
     assertEquals(Authenticator.AUTHTYPE_BASIC, auth.authenticationType());
     assertEquals(username, auth.getUsername());
     assertEquals(password, auth.getPassword());
@@ -64,6 +67,9 @@ public void testBuilderSuccess() {
     assertNotNull(auth);
     assertEquals(auth.getUsername(), "good-user");
     assertEquals(auth.getPassword(), "good-password");
+
+    BasicAuthenticator auth2 = auth.newBuilder().build();
+    assertNotNull(auth2);
   }
 
   @Test(expectedExceptions = IllegalArgumentException.class)

src/test/java/com/ibm/cloud/sdk/core/test/security/BearerTokenAuthenticatorTest.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2015, 2021.
+ * (C) Copyright IBM Corp. 2015, 2022.
  *
  * 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
@@ -96,20 +96,31 @@ public void testConfigEmptyAccessToken() {
     BearerTokenAuthenticator.fromConfiguration(props);
   }
 
+  @Test
   public void testCtorCorrectConfig() {
     BearerTokenAuthenticator authenticator = new BearerTokenAuthenticator("my-access-token");
     assertEquals(Authenticator.AUTHTYPE_BEARER_TOKEN, authenticator.authenticationType());
     assertEquals("my-access-token", authenticator.getBearerToken());
   }
 
-  public void testConfigCorrectConfig() {
+  @Test
+  public void testConfigCorrectConfig1() {
     Map<String, String> props = new HashMap<>();
     props.put(Authenticator.PROPNAME_BEARER_TOKEN, "my-access-token");
     BearerTokenAuthenticator authenticator = BearerTokenAuthenticator.fromConfiguration(props);
     assertEquals(Authenticator.AUTHTYPE_BEARER_TOKEN, authenticator.authenticationType());
     assertEquals("my-access-token", authenticator.getBearerToken());
   }
 
+  @Test
+  public void testConfigCorrectConfig2() {
+    Map<String, String> props = new HashMap<>();
+    props.put(Authenticator.PROPNAME_BEARER_TOKEN, "my-access-token");
+    BearerTokenAuthenticator authenticator = new BearerTokenAuthenticator(props);
+    assertEquals(Authenticator.AUTHTYPE_BEARER_TOKEN, authenticator.authenticationType());
+    assertEquals("my-access-token", authenticator.getBearerToken());
+  }
+
   @Test
   public void testSingleAuthHeader() {
     Map<String, String> props = new HashMap<>();