Merge pull request #523 from cloudant/new-test-server

Update test server config

Author: ricellis

Jenkinsfile

@@ -27,9 +27,15 @@ def runTests(testEnv, isServiceTests) {
 
         //Set up the environment and run the tests
         withEnv(testEnv) {
-            withCredentials([(env.CREDS_ID.contains('iam')) ? string(credentialsId: env.CREDS_ID, variable: 'IAM_API_KEY') : usernamePassword(credentialsId: env.CREDS_ID, usernameVariable: 'DB_USER', passwordVariable: 'DB_PASSWORD')]) {
+            withCredentials([(env.CREDS_ID.contains('Iam')) ? string(credentialsId: env.CREDS_ID, variable: 'IAM_API_KEY') : usernamePassword(credentialsId: env.CREDS_ID, usernameVariable: 'DB_USER', passwordVariable: 'DB_PASSWORD')]) {
                 try {
-                    sh "./gradlew ${(env.DB_USER?.trim()) ? '-Dtest.server.user=$DB_USER -Dtest.server.password=$DB_PASSWORD' : ''} -Dtest.server.host=\$DB_HOST -Dtest.server.port=\$DB_PORT -Dtest.server.protocol=\$DB_HTTP \$GRADLE_TARGET"
+                    sh "./gradlew \
+                    ${(env.DB_USER?.trim()) ? '-Dtest.server.user=$DB_USER -Dtest.server.password=$DB_PASSWORD' : ''} \
+                    -Dtest.server.host=\$DB_HOST \
+                    -Dtest.server.port=\$DB_PORT \
+                    -Dtest.server.protocol=\$DB_HTTP \
+                    -Dtest.replication.source.url=\$SDKS_TEST_SERVER_URL \
+                    \$GRADLE_TARGET"
                 } finally {
                     junit '**/build/test-results/**/*.xml'
                 }
@@ -49,8 +55,8 @@ stage('Build') {
 
 stage('QA') {
     // Define the matrix environments
-    def CLOUDANT_ENV = ['DB_HTTP=https', 'DB_HOST=clientlibs-test.cloudant.com', 'DB_PORT=443', 'DB_IGNORE_COMPACTION=true', 'CREDS_ID=clientlibs-test']
-    def CLOUDANT_IAM_ENV = ['DB_HTTP=https', 'DB_HOST=clientlibs-test.cloudant.com', 'DB_PORT=443', 'DB_IGNORE_COMPACTION=true', 'CREDS_ID=clientlibs-test-iam']
+    def CLOUDANT_ENV = ['DB_HTTP=https', "DB_HOST=${SDKS_TEST_SERVER_HOST}", 'DB_PORT=443', 'DB_IGNORE_COMPACTION=true', 'CREDS_ID=testServerLegacy']
+    def CLOUDANT_IAM_ENV = ['DB_HTTP=https', "DB_HOST=${SDKS_TEST_SERVER_HOST}", 'DB_PORT=443', 'DB_IGNORE_COMPACTION=true', 'CREDS_ID=testServerIamApiKey', "TEST_IAM_TOKEN_URL=${SDKS_TEST_IAM_URL}"]
     def COUCH1_6_ENV = ['DB_HTTP=http', 'DB_HOST=cloudantsync002.bristol-victoria.uk.ibm.com', 'DB_PORT=5984', 'DB_IGNORE_COMPACTION=false', 'CREDS_ID=couchdb']
     def COUCH2_0_ENV = ['DB_HTTP=http', 'DB_HOST=cloudantsync002.bristol-victoria.uk.ibm.com', 'DB_PORT=5985', 'DB_IGNORE_COMPACTION=true', 'CREDS_ID=couchdb']
     def CLOUDANT_LOCAL_ENV = ['DB_HTTP=http', 'DB_HOST=cloudantsync002.bristol-victoria.uk.ibm.com', 'DB_PORT=8081', 'DB_IGNORE_COMPACTION=true', 'CREDS_ID=couchdb']

cloudant-client/build.gradle

@@ -53,6 +53,17 @@ tasks.withType(Test) {
         }
         jvmArgs "-javaagent:${jMockit}"
     }
+    // Special environment variables for integration tests
+    [SERVER_URL:'test.server.url',
+     SERVER_USER:'test.server.user',
+     SERVER_PASSWORD:'test.server.password',
+     TEST_REPLICATION_SOURCE_URL:'test.replication.source.url',
+     TEST_IAM_TOKEN_URL:'com.cloudant.client.iamserver'].each { k,v ->
+        def e = System.getenv(k)
+        if (e) {
+            systemProperty v, e
+        }
+    }
 }
 
 // Run tests which are compatible with all versions of Couch or
@@ -91,16 +102,6 @@ task cloudantServiceTest(type: Test) {
 }
 
 task integrationTest(type: Test) {
-    // Special environment variables for integration tests
-    [SERVER_URL:'test.server.url',
-     SERVER_USER:'test.server.user',
-     SERVER_PASSWORD:'test.server.password',
-     TEST_REPLICATION_SOURCE_URL:'test.replication.source.url'].each { k,v ->
-        def e = System.getenv(k)
-        if (e) {
-            systemProperty v, e
-        }
-    }
     // Run all tests that need a running DB and those for Cloudant, but not unit tests
     useJUnitPlatform {
         includeEngines 'junit-jupiter'

cloudant-client/src/test/java/com/cloudant/tests/CloudFoundryServiceTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016, 2020 IBM Corp. All rights reserved.
+ * Copyright © 2016, 2021 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,7 +14,6 @@
 
 package com.cloudant.tests;
 
-import static com.cloudant.http.internal.interceptors.IamCookieInterceptor.IAM_TOKEN_SERVER_URL_PROPERTY_KEY;
 import static com.cloudant.tests.util.MockWebServerResources.IAM_API_KEY;
 import static com.cloudant.tests.util.MockWebServerResources.IAM_TOKEN;
 import static com.cloudant.tests.util.MockWebServerResources.OK_IAM_COOKIE;
@@ -23,6 +22,7 @@
 
 import com.cloudant.client.api.ClientBuilder;
 import com.cloudant.client.api.CloudantClient;
+import com.cloudant.tests.extensions.MockIamWebServerExtension;
 import com.cloudant.tests.extensions.MockWebServerExtension;
 import com.cloudant.tests.util.HttpFactoryParameterizedTest;
 import com.cloudant.tests.util.MockWebServerResources;
@@ -57,7 +57,7 @@ public class CloudFoundryServiceTest {
     public MockWebServerExtension mockWebServerExt = new MockWebServerExtension();
 
     @RegisterExtension
-    public MockWebServerExtension mockIamServerExt = new MockWebServerExtension();
+    public MockWebServerExtension mockIamServerExt = new MockIamWebServerExtension();
 
     public MockWebServer server;
     public MockWebServer mockIamServer;
@@ -74,14 +74,6 @@ public void beforeEach() {
         mockServerHostPort = String.format("%s:%s/", server.getHostName(), server.getPort());
         //setup mock IAM server
         mockIamServer = mockIamServerExt.get();
-        // Override the default IAM token server with our test mock server
-        System.setProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY, mockIamServer.url(iamTokenEndpoint)
-                .toString());
-    }
-
-    @AfterEach
-    public void clearIAMMock() {
-        System.clearProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY);
     }
 
     private static class VCAPGenerator {
@@ -98,7 +90,7 @@ private static class VCAPGenerator {
             cloudantServices = new ArrayList<HashMap<String, Object>>();
             vcap.put(serviceName, cloudantServices);
         }
-        
+
         private void addService(String name, String username, String password,
                                 String host, String apikey) {
             HashMap<String, Object> cloudantService = new HashMap<String, Object>();

cloudant-client/src/test/java/com/cloudant/tests/CloudantClientHelper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2015, 2019 IBM Corp. All rights reserved.
+ * Copyright © 2015, 2021 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
@@ -36,12 +36,13 @@ public abstract class CloudantClientHelper {
     static final String SERVER_USER;
     static final String SERVER_PASSWORD;
     static final String SERVER_HOST;
+    //some tests need access to the URL
+    static final URL SERVER_URL;
 
     private static final CloudantClient CLIENT_INSTANCE;
 
     private static final String SERVER_PORT;
     private static final String SERVER_PROTOCOL;
-    private static final URL SERVER_URL;
 
     static {
 

cloudant-client/src/test/java/com/cloudant/tests/CloudantClientTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2015, 2019 IBM Corp. All rights reserved.
+ * Copyright © 2015, 2021 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
@@ -500,7 +500,7 @@ public void testBasicAuth() throws IOException {
                 new BasicAuthInterceptor(CloudantClientHelper.SERVER_USER
                         + ":" + CloudantClientHelper.SERVER_PASSWORD);
 
-        CloudantClient client = ClientBuilder.account(CloudantClientHelper.SERVER_USER)
+        CloudantClient client = ClientBuilder.url(CloudantClientHelper.SERVER_URL)
                 .interceptors(interceptor).build();
 
         // Test passes if there are no exceptions

cloudant-client/src/test/java/com/cloudant/tests/HttpIamTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2017, 2019 IBM Corp. All rights reserved.
+ * Copyright © 2017, 2021 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,7 +14,6 @@
 
 package com.cloudant.tests;
 
-import static com.cloudant.http.internal.interceptors.IamCookieInterceptor.IAM_TOKEN_SERVER_URL_PROPERTY_KEY;
 import static com.cloudant.tests.HttpTest.takeN;
 import static com.cloudant.tests.util.MockWebServerResources.EXPECTED_OK_COOKIE;
 import static com.cloudant.tests.util.MockWebServerResources.EXPECTED_OK_COOKIE_2;
@@ -40,6 +39,7 @@
 import com.cloudant.client.org.lightcouch.CouchDbException;
 import com.cloudant.http.Http;
 import com.cloudant.http.interceptors.Replay429Interceptor;
+import com.cloudant.tests.extensions.MockIamWebServerExtension;
 import com.cloudant.tests.extensions.MockWebServerExtension;
 import com.cloudant.tests.util.MockWebServerResources;
 
@@ -64,7 +64,7 @@ public class HttpIamTest {
     public MockWebServerExtension mockWebServerExt = new MockWebServerExtension();
 
     @RegisterExtension
-    public MockWebServerExtension mockIamServerExt = new MockWebServerExtension();
+    public MockWebServerExtension mockIamServerExt = new MockIamWebServerExtension();
 
     public MockWebServer mockWebServer;
     public MockWebServer mockIamServer;
@@ -76,14 +76,6 @@ public class HttpIamTest {
     public void setIAMMockEndpoint() {
         mockWebServer = mockWebServerExt.get();
         mockIamServer = mockIamServerExt.get();
-        // Override the default IAM token server with our test mock server
-        System.setProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY, mockIamServer.url(iamTokenEndpoint)
-                .toString());
-    }
-
-    @AfterEach
-    public void clearIAMMock() {
-        System.clearProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY);
     }
 
     /**

cloudant-client/src/test/java/com/cloudant/tests/SessionInterceptorExpiryTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2017, 2018 IBM Corp. All rights reserved.
+ * Copyright © 2017, 2021 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,7 +14,6 @@
 
 package com.cloudant.tests;
 
-import static com.cloudant.http.internal.interceptors.IamCookieInterceptor.IAM_TOKEN_SERVER_URL_PROPERTY_KEY;
 import static com.cloudant.tests.util.MockWebServerResources.iamTokenEndpoint;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -30,6 +29,7 @@
 import com.cloudant.http.internal.interceptors.CookieInterceptor;
 import com.cloudant.http.internal.interceptors.IamCookieInterceptor;
 import com.cloudant.http.internal.ok.OkHttpClientHttpUrlConnectionFactory;
+import com.cloudant.tests.extensions.MockIamWebServerExtension;
 import com.cloudant.tests.extensions.MockWebServerExtension;
 import com.cloudant.tests.util.HttpFactoryParameterizedTest;
 import com.cloudant.tests.util.MockWebServerResources;
@@ -120,7 +120,7 @@ public Object resolveParameter(ParameterContext parameterContext,
     public MockWebServerExtension mockWebServerExt = new MockWebServerExtension();
     public MockWebServer mockWebServer;
     @RegisterExtension
-    public MockWebServerExtension mockIamServerExt = new MockWebServerExtension();
+    public MockWebServerExtension mockIamServerExt = new MockIamWebServerExtension();
     public MockWebServer mockIamServer;
 
     private HttpConnectionRequestInterceptor rqInterceptor;
@@ -139,9 +139,6 @@ public void setupSessionInterceptor(boolean okUsable, String sessionPath) {
             rpInterceptor = ci;
         } else if (sessionPath.equals("/_iam_session")) {
             // Set the endpoint value before each test
-            // Override the default IAM token server with our test mock server
-            System.setProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY, mockIamServer.url(iamTokenEndpoint)
-                    .toString());
             IamCookieInterceptor ici = new IamCookieInterceptor("apikey", baseUrl);
             rqInterceptor = ici;
             rpInterceptor = ici;
@@ -150,11 +147,6 @@ public void setupSessionInterceptor(boolean okUsable, String sessionPath) {
         }
     }
 
-    @AfterEach
-    public void clearIAMMock() {
-        System.clearProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY);
-    }
-
     private void queueResponses(boolean okUsable,
                                 String sessionPath,
                                 Long cookieLifetimeSeconds,

cloudant-client/src/test/java/com/cloudant/tests/extensions/MockIamWebServerExtension.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright © 2021 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
+ *
+ * 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.cloudant.tests.extensions;
+
+import static com.cloudant.http.internal.interceptors.IamCookieInterceptor.IAM_TOKEN_SERVER_URL_PROPERTY_KEY;
+import static com.cloudant.tests.util.MockWebServerResources.iamTokenEndpoint;
+
+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.BeforeEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import okhttp3.mockwebserver.MockWebServer;
+
+public class MockIamWebServerExtension extends MockWebServerExtension {
+
+    // Immutably store the real token server
+    private final String tokenServer = System.getProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY);
+
+    // NB beforeEach/afterEach emulate before and after in the actual mock, because we can't call
+    // these directly as they are marked as protected
+
+    @Override
+    public synchronized void beforeEach(ExtensionContext context) throws Exception {
+        super.beforeEach(context);
+        // Override the token server property
+        System.setProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY, this.get().url(iamTokenEndpoint)
+                .toString());
+    }
+
+    @Override
+    public synchronized void afterEach(ExtensionContext context) throws Exception {
+        if (tokenServer != null) {
+          // Restore the original token server
+          System.setProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY, tokenServer);
+        } else {
+          // Clear the temporary token server
+          System.clearProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY);
+        }
+        super.afterEach(context);
+    }
+
+}

cloudant-client/src/test/java/com/cloudant/tests/extensions/MockWebServerExtension.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2018 IBM Corp. All rights reserved.
+ * Copyright © 2018, 2021 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
@@ -24,9 +24,6 @@ public class MockWebServerExtension implements BeforeEachCallback, AfterEachCall
     private MockWebServer mockWebServer;
     private boolean started = false;
 
-    public MockWebServerExtension() {
-    }
-
     public MockWebServer get() {
         return this.mockWebServer;
     }