Skip to content

Commit fae706a

Browse files
rjrudinrjrudin
committed
Cleanup of unit test plumbing
Did the following: 1. Renamed "adminClient" to "restAdminClient" so I stop thinking that "admin client" refers to an "admin client" (that represents most of the changes here) 2. Reduced the number of overloaded "makeNewClient" methods in Common.java No functional changes here.
1 parent b5c39c0 commit fae706a

33 files changed

+111
-131
lines changed

‎marklogic-client-api/src/test/java/com/marklogic/client/test/AlertingTest.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,20 @@ public class AlertingTest {
5252
private static QueryOptionsManager queryOptionsManager;
5353
private static QueryManager queryManager;
5454
private static TransformExtensionsManager transformManager;
55-
private static DatabaseClient adminClient = Common.connectAdmin();
55+
private static DatabaseClient restAdminClient = Common.connectRestAdmin();
5656
private static final String RULE_NAME_WRITE_RULE_AS_TEST = "writeRuleAsTest";
5757

5858
@AfterAll
5959
public static void teardown()
6060
throws ForbiddenUserException, FailedRequestException, ResourceNotFoundException
6161
{
62-
XMLDocumentManager docMgr = adminClient.newXMLDocumentManager();
62+
XMLDocumentManager docMgr = restAdminClient.newXMLDocumentManager();
6363
docMgr.delete("/alert/first.xml");
6464
docMgr.delete("/alert/second.xml");
6565
docMgr.delete("/alert/third.xml");
6666
teardownMatchRules();
6767

68-
transformManager = adminClient.newServerConfigManager().newTransformExtensionsManager();
68+
transformManager = restAdminClient.newServerConfigManager().newTransformExtensionsManager();
6969
transformManager.deleteTransform("ruleTransform");
7070
}
7171

@@ -76,19 +76,19 @@ public static void setup()
7676
XMLUnit.setIgnoreWhitespace(true);
7777

7878

79-
queryOptionsManager = adminClient.newServerConfigManager()
79+
queryOptionsManager = restAdminClient.newServerConfigManager()
8080
.newQueryOptionsManager();
8181
File options = new File("src/test/resources/alerting-options.xml");
8282
queryOptionsManager.writeOptions("alerts", new FileHandle(options));
8383

84-
queryManager = adminClient.newQueryManager();
84+
queryManager = restAdminClient.newQueryManager();
8585

86-
transformManager = adminClient.newServerConfigManager().newTransformExtensionsManager();
86+
transformManager = restAdminClient.newServerConfigManager().newTransformExtensionsManager();
8787

8888
File ruleTransform = new File("src/test/resources/rule-transform.xqy");
8989
transformManager.writeXQueryTransform("ruleTransform", new FileHandle(ruleTransform));
9090

91-
adminClient.newServerConfigManager().setServerRequestLogging(true);
91+
restAdminClient.newServerConfigManager().setServerRequestLogging(true);
9292
Common.connect();
9393

9494
// write three files for alert tests.

‎marklogic-client-api/src/test/java/com/marklogic/client/test/BitemporalFeaturesTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ public class BitemporalFeaturesTest {
6363

6464
@BeforeAll
6565
public static void beforeClass() {
66-
Common.connectAdmin();
67-
docMgr = Common.adminClient.newXMLDocumentManager();
68-
queryMgr = Common.adminClient.newQueryManager();
66+
Common.connectRestAdmin();
67+
docMgr = Common.restAdminClient.newXMLDocumentManager();
68+
queryMgr = Common.restAdminClient.newQueryManager();
6969
}
7070

7171
@AfterAll
@@ -102,7 +102,7 @@ public void testBitemporalDocument() {
102102
docMgr.write(docId2, temporalDocument2, null, handle2, null, null, temporalCollection);
103103
StringHandle handle3 = new StringHandle(doc3).withFormat(Format.XML);
104104
docMgr.write(docId3, temporalDocument1, null, handle3, null, null, temporalCollection);
105-
QueryManager queryMgr = Common.adminClient.newQueryManager();
105+
QueryManager queryMgr = Common.restAdminClient.newQueryManager();
106106
queryMgr.setPageLength(1000);
107107
QueryDefinition query = queryMgr.newStringDefinition();
108108
query.setCollections(temporalDocument1);
@@ -149,7 +149,7 @@ public void testBitemporalDocumentBulk() {
149149
writeSet.add(prefix + "_D.xml", new StringHandle(doc4).withFormat(Format.XML), temporalDocument4);
150150
docMgr.write(writeSet, null, null, temporalCollection);
151151
writeSet = docMgr.newWriteSet();
152-
QueryManager queryMgr = Common.adminClient.newQueryManager();
152+
QueryManager queryMgr = Common.restAdminClient.newQueryManager();
153153
queryMgr.setPageLength(1000);
154154
QueryDefinition query = queryMgr.newStringDefinition();
155155
query.setCollections(temporalDocument1);
@@ -234,7 +234,7 @@ public void testProtectWipe() throws DatatypeConfigurationException {
234234
Common.waitFor(1500);
235235

236236
docMgr.wipe(logicalID, temporalCollection);
237-
QueryManager queryMgr = Common.adminClient.newQueryManager();
237+
QueryManager queryMgr = Common.restAdminClient.newQueryManager();
238238
queryMgr.setPageLength(1000);
239239
QueryDefinition query = queryMgr.newStringDefinition();
240240
query.setCollections(logicalID);

‎marklogic-client-api/src/test/java/com/marklogic/client/test/BulkReadWriteTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,8 @@ public void testE_TextLoad() {
303303

304304
@Test
305305
public void testF_TextLoadWithTransform() throws IOException {
306-
DatabaseClient adminClient = Common.connectAdmin();
307-
adminClient.newServerConfigManager().newTransformExtensionsManager().writeXQueryTransformAs(
306+
DatabaseClient restAdminClient = Common.connectRestAdmin();
307+
restAdminClient.newServerConfigManager().newTransformExtensionsManager().writeXQueryTransformAs(
308308
TransformExtensionsTest.XQUERY_NAME,
309309
TransformExtensionsTest.makeXQueryMetadata(),
310310
Common.testFileToString(TransformExtensionsTest.XQUERY_FILE)

‎marklogic-client-api/src/test/java/com/marklogic/client/test/Common.java‎

Lines changed: 14 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ public X509Certificate[] getAcceptedIssuers() {
8282
};
8383

8484
public static DatabaseClient client;
85-
public static DatabaseClient adminClient;
85+
public static DatabaseClient restAdminClient;
8686
public static DatabaseClient serverAdminClient;
8787
public static DatabaseClient evalClient;
8888
public static DatabaseClient readOnlyClient;
@@ -92,10 +92,10 @@ public static DatabaseClient connect() {
9292
client = newClient();
9393
return client;
9494
}
95-
public static DatabaseClient connectAdmin() {
96-
if (adminClient == null)
97-
adminClient = newAdminClient();
98-
return adminClient;
95+
public static DatabaseClient connectRestAdmin() {
96+
if (restAdminClient == null)
97+
restAdminClient = newRestAdminClient();
98+
return restAdminClient;
9999
}
100100
public static DatabaseClient connectServerAdmin() {
101101
if (serverAdminClient == null)
@@ -108,18 +108,19 @@ public static DatabaseClient connectEval() {
108108
return evalClient;
109109
}
110110
public static DatabaseClient connectReadOnly() {
111-
if (readOnlyClient == null)
112-
readOnlyClient = newReadOnlyClient();
111+
if (readOnlyClient == null) {
112+
readOnlyClient = makeNewClient(Common.HOST, Common.PORT, newSecurityContext(Common.READ_ONLY_USER, Common.READ_ONLY_PASS));
113+
}
113114
return readOnlyClient;
114115
}
115116
public static DatabaseClient newClient() {
116117
return newClient(null);
117118
}
118119
public static DatabaseClient newClient(String databaseName) {
119-
return newClientAsUser(Common.USER, databaseName);
120+
return makeNewClient(Common.HOST, Common.PORT, databaseName, newSecurityContext(Common.USER, Common.PASS), null);
120121
}
121122
public static DatabaseClient newClientAsUser(String username) {
122-
return newClientAsUser(username, null);
123+
return makeNewClient(Common.HOST, Common.PORT, null, newSecurityContext(username, Common.PASS), null);
123124
}
124125

125126
public static DatabaseClientFactory.SecurityContext newSecurityContext(String username, String password) {
@@ -129,21 +130,8 @@ public static DatabaseClientFactory.SecurityContext newSecurityContext(String us
129130
return new DatabaseClientFactory.DigestAuthContext(username, password);
130131
}
131132

132-
public static DatabaseClient newClientAsUser(String username, String databaseName) {
133-
return makeNewClient(Common.HOST, Common.PORT, databaseName, newSecurityContext(username, Common.PASS));
134-
}
135-
136133
public static DatabaseClient makeNewClient(String host, int port, DatabaseClientFactory.SecurityContext securityContext) {
137-
return makeNewClient(host, port, null, securityContext);
138-
}
139-
140-
public static DatabaseClient makeNewClient(String host, int port, String database, DatabaseClientFactory.SecurityContext securityContext) {
141-
return makeNewClient(host, port, database, securityContext, CONNECTION_TYPE);
142-
}
143-
144-
public static DatabaseClient makeNewClient(String host, int port, DatabaseClientFactory.SecurityContext securityContext,
145-
DatabaseClient.ConnectionType connectionType) {
146-
return makeNewClient(host, port, null, securityContext, connectionType);
134+
return makeNewClient(host, port, null, securityContext, null);
147135
}
148136

149137
/**
@@ -157,12 +145,9 @@ public static DatabaseClient makeNewClient(String host, int port, String databas
157145
return DatabaseClientFactory.newClient(host, port, BASE_PATH, database, securityContext, connectionType);
158146
}
159147

160-
public static DatabaseClient newAdminClient() {
161-
return newAdminClient(null);
162-
}
163-
public static DatabaseClient newAdminClient(String databaseName) {
164-
return makeNewClient(Common.HOST, Common.PORT, databaseName,
165-
newSecurityContext(Common.REST_ADMIN_USER, Common.REST_ADMIN_PASS), CONNECTION_TYPE);
148+
public static DatabaseClient newRestAdminClient() {
149+
return makeNewClient(Common.HOST, Common.PORT, null,
150+
newSecurityContext(Common.REST_ADMIN_USER, Common.REST_ADMIN_PASS), CONNECTION_TYPE);
166151
}
167152
public static DatabaseClient newServerAdminClient() {
168153
return newServerAdminClient(null);
@@ -178,10 +163,6 @@ public static DatabaseClient newEvalClient(String databaseName) {
178163
return makeNewClient(Common.HOST, Common.PORT, databaseName,
179164
newSecurityContext(Common.EVAL_USER, Common.EVAL_PASS), CONNECTION_TYPE);
180165
}
181-
public static DatabaseClient newReadOnlyClient() {
182-
return makeNewClient(Common.HOST, Common.PORT,
183-
newSecurityContext(Common.READ_ONLY_USER, Common.READ_ONLY_PASS), CONNECTION_TYPE);
184-
}
185166

186167
public static MarkLogicVersion getMarkLogicVersion() {
187168
String version = newServerAdminClient().newServerEval().javascript("xdmp.version()").evalAs(String.class);

‎marklogic-client-api/src/test/java/com/marklogic/client/test/ConditionalDocumentTest.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,13 @@
3939
import static org.junit.jupiter.api.Assertions.*;
4040

4141
public class ConditionalDocumentTest {
42-
static DatabaseClient adminClient = Common.connectAdmin();
4342
static ServerConfigurationManager serverConfig;
4443

4544
@BeforeAll
4645
public static void beforeClass()
4746
throws FailedRequestException, ForbiddenUserException, ResourceNotFoundException, ResourceNotResendableException
4847
{
49-
serverConfig = adminClient.newServerConfigManager();
48+
serverConfig = Common.connectRestAdmin().newServerConfigManager();
5049
serverConfig.readConfiguration();
5150
serverConfig.setUpdatePolicy(UpdatePolicy.VERSION_REQUIRED);
5251
serverConfig.writeConfiguration();

‎marklogic-client-api/src/test/java/com/marklogic/client/test/DatabaseClientTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class DatabaseClientTest {
3434
@BeforeAll
3535
public static void beforeClass() {
3636
Common.connect();
37-
Common.connectAdmin();
37+
Common.connectRestAdmin();
3838
}
3939
@AfterAll
4040
public static void afterClass() {
@@ -102,7 +102,7 @@ public void testNewServerEvaluationCall() {
102102

103103
@Test
104104
public void testNewQueryOptionsManager() {
105-
QueryOptionsManager mgr = Common.adminClient.newServerConfigManager().newQueryOptionsManager();
105+
QueryOptionsManager mgr = Common.restAdminClient.newServerConfigManager().newQueryOptionsManager();
106106
assertNotNull( mgr);
107107
}
108108

‎marklogic-client-api/src/test/java/com/marklogic/client/test/EvalTest.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@
5858
public class EvalTest {
5959
private static GregorianCalendar septFirst = new GregorianCalendar(TimeZone.getTimeZone("CET"));
6060
private static ExtensionLibrariesManager libMgr;
61-
private static DatabaseClient adminClient = Common.connectAdmin();
61+
private static DatabaseClient restAdminClient = Common.connectRestAdmin();
6262

6363
@BeforeAll
6464
public static void beforeClass() {
65-
libMgr = adminClient.newServerConfigManager().newExtensionLibrariesManager();
65+
libMgr = restAdminClient.newServerConfigManager().newExtensionLibrariesManager();
6666
Common.connectEval();
6767

6868
septFirst.set(2014, Calendar.SEPTEMBER, 1, 0, 0, 0);
@@ -450,7 +450,7 @@ public void test_171() throws Exception {
450450
@Test
451451
public void test_582_need_privilege() throws Exception{
452452
try {
453-
assertEquals("hello", adminClient.newServerEval()
453+
assertEquals("hello", restAdminClient.newServerEval()
454454
.xquery("'hello'").eval().next().getString());
455455
fail("a FailedRequestException should have been thrown since rest_admin doesn't have eval privileges");
456456
} catch (FailedRequestException fre) {

‎marklogic-client-api/src/test/java/com/marklogic/client/test/ExtensionLibrariesTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ public class ExtensionLibrariesTest {
3636
public void testXQueryModuleCRUD()
3737
throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException {
3838

39-
Common.connectAdmin();
39+
Common.connectRestAdmin();
4040
// get a manager
41-
ExtensionLibrariesManager libsMgr = Common.adminClient
41+
ExtensionLibrariesManager libsMgr = Common.restAdminClient
4242
.newServerConfigManager().newExtensionLibrariesManager();
4343

4444
// write XQuery file to the modules database
@@ -85,10 +85,10 @@ public void testXQueryModuleCRUD()
8585

8686
@Test
8787
public void testXQueryModuleCRUDXmlFileNegative() {
88-
Common.connectAdmin();
88+
Common.connectRestAdmin();
8989

9090
// get a manager
91-
ExtensionLibrariesManager libsMgr = Common.adminClient.newServerConfigManager().newExtensionLibrariesManager();
91+
ExtensionLibrariesManager libsMgr = Common.restAdminClient.newServerConfigManager().newExtensionLibrariesManager();
9292

9393
String libraryPath = "/foo/my/path/to/my/module.xqy";
9494
FileHandle f = new FileHandle(new File("test-complete/src/test/java/com/marklogic/client/functionaltest/data/all_well.xml")).withFormat(Format.XML);

‎marklogic-client-api/src/test/java/com/marklogic/client/test/FailedRequestTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ public class FailedRequestTest {
3838
public void testFailedRequest()
3939
throws FailedRequestException, ForbiddenUserException, ResourceNotFoundException, ResourceNotResendableException, XMLStreamException
4040
{
41-
Common.connectAdmin();
42-
QueryOptionsManager mgr = Common.adminClient.newServerConfigManager()
41+
Common.connectRestAdmin();
42+
QueryOptionsManager mgr = Common.restAdminClient.newServerConfigManager()
4343
.newQueryOptionsManager();
4444

4545
try {
@@ -52,9 +52,9 @@ public void testFailedRequest()
5252
assertEquals(403, e.getServerStatusCode());
5353
assertEquals("Forbidden", e.getServerStatus());
5454
}
55-
mgr = Common.adminClient.newServerConfigManager().newQueryOptionsManager();
55+
mgr = Common.restAdminClient.newServerConfigManager().newQueryOptionsManager();
5656

57-
Common.adminClient.newServerConfigManager().setQueryOptionValidation(true);
57+
Common.restAdminClient.newServerConfigManager().setQueryOptionValidation(true);
5858

5959
Common.propertyWait();
6060

‎marklogic-client-api/src/test/java/com/marklogic/client/test/GeospatialRegionQueriesTest.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ public static void teardown() {
4646
private static void deleteEnvironment() {
4747
XMLDocumentManager docMgr = Common.client.newXMLDocumentManager();
4848
docMgr.delete("usa.xml", "cuba.xml", "mexico.xml", "p1.xml", "p2.xml","newpolygon.xml");
49-
Common.adminClient.newServerConfigManager().setQueryValidation(false);
49+
Common.restAdminClient.newServerConfigManager().setQueryValidation(false);
5050

5151
Common.propertyWait();
5252
}
5353

5454
@BeforeAll
5555
public static void setup() {
5656
Common.connect();
57-
Common.connectAdmin();
57+
Common.connectRestAdmin();
5858
try {
5959
buildEnvironment();
6060
} catch (ParserConfigurationException e) {
@@ -142,7 +142,7 @@ private static void buildEnvironment() throws ParserConfigurationException {
142142
writeset.add("p2.xml", new DOMHandle().with(domDocument));
143143

144144
docMgr.write(writeset);
145-
Common.adminClient.newServerConfigManager().setQueryValidation(true);
145+
Common.restAdminClient.newServerConfigManager().setQueryValidation(true);
146146

147147
Common.propertyWait();
148148
}
@@ -201,7 +201,7 @@ public void testGeospatialRegionDoubleQuery() {
201201
+ "</options>";
202202
StringHandle writeHandle = new StringHandle(options);
203203

204-
QueryOptionsManager optionsMgr = Common.adminClient.newServerConfigManager().newQueryOptionsManager();
204+
QueryOptionsManager optionsMgr = Common.restAdminClient.newServerConfigManager().newQueryOptionsManager();
205205
optionsMgr.writeOptions("geodoubleoptions", writeHandle);
206206

207207
QueryManager queryMgr = Common.client.newQueryManager();
@@ -307,7 +307,7 @@ public void testGeospatialRegionQueryOptionsConstraint() {
307307
// create a handle to send the query options
308308
StringHandle writeHandle = new StringHandle(options);
309309

310-
QueryOptionsManager optionsMgr = Common.adminClient.newServerConfigManager().newQueryOptionsManager();
310+
QueryOptionsManager optionsMgr = Common.restAdminClient.newServerConfigManager().newQueryOptionsManager();
311311
optionsMgr.writeOptions("geooptions", writeHandle);
312312

313313
QueryManager queryMgr = Common.client.newQueryManager();

0 commit comments

Comments
 (0)