/*
* Copyright (c) 2008-2016 MongoDB, Inc.
*
* 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.mongodb;
import com.mongodb.async.AsyncBatchCursor;
import com.mongodb.async.FutureResultCallback;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.binding.AsyncClusterBinding;
import com.mongodb.binding.AsyncConnectionSource;
import com.mongodb.binding.AsyncReadWriteBinding;
import com.mongodb.binding.AsyncSingleConnectionBinding;
import com.mongodb.binding.ClusterBinding;
import com.mongodb.binding.ReadWriteBinding;
import com.mongodb.binding.SingleConnectionBinding;
import com.mongodb.connection.AsyncConnection;
import com.mongodb.connection.AsynchronousSocketChannelStreamFactory;
import com.mongodb.connection.Cluster;
import com.mongodb.connection.ClusterDescription;
import com.mongodb.connection.ClusterSettings;
import com.mongodb.connection.ClusterType;
import com.mongodb.connection.ConnectionPoolSettings;
import com.mongodb.connection.DefaultClusterFactory;
import com.mongodb.connection.ServerDescription;
import com.mongodb.connection.ServerSettings;
import com.mongodb.connection.ServerVersion;
import com.mongodb.connection.SocketSettings;
import com.mongodb.connection.SocketStreamFactory;
import com.mongodb.connection.SslSettings;
import com.mongodb.connection.StreamFactory;
import com.mongodb.connection.netty.NettyStreamFactory;
import com.mongodb.management.JMXConnectionPoolListener;
import com.mongodb.operation.AsyncReadOperation;
import com.mongodb.operation.AsyncWriteOperation;
import com.mongodb.operation.BatchCursor;
import com.mongodb.operation.CommandWriteOperation;
import com.mongodb.operation.DropDatabaseOperation;
import com.mongodb.operation.ReadOperation;
import com.mongodb.operation.WriteOperation;
import org.bson.BsonDocument;
import org.bson.BsonDocumentWrapper;
import org.bson.BsonInt32;
import org.bson.Document;
import org.bson.codecs.BsonDocumentCodec;
import org.bson.codecs.DocumentCodec;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import static com.mongodb.connection.ClusterConnectionMode.MULTIPLE;
import static com.mongodb.connection.ClusterType.REPLICA_SET;
import static com.mongodb.connection.ClusterType.SHARDED;
import static com.mongodb.connection.ClusterType.STANDALONE;
import static java.lang.Thread.sleep;
import static java.util.Arrays.asList;
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assume.assumeThat;
/**
* Helper class for the acceptance tests. Used primarily by DatabaseTestCase and FunctionalSpecification. This fixture allows Test
* super-classes to share functionality whilst minimising duplication.
*/
public final class ClusterFixture {
public static final String DEFAULT_URI = "mongodb://localhost:27017";
public static final String MONGODB_URI_SYSTEM_PROPERTY_NAME = "org.mongodb.test.uri";
private static final String DEFAULT_DATABASE_NAME = "JavaDriverTest";
public static final long TIMEOUT = 60L;
private static ConnectionString connectionString;
private static Cluster cluster;
private static Cluster asyncCluster;
static {
String mongoURIProperty = System.getProperty(MONGODB_URI_SYSTEM_PROPERTY_NAME);
String mongoURIString = mongoURIProperty == null || mongoURIProperty.isEmpty()
? DEFAULT_URI : mongoURIProperty;
connectionString = new ConnectionString(mongoURIString);
Runtime.getRuntime().addShutdownHook(new ShutdownHook());
}
private ClusterFixture() {
}
public static String getDefaultDatabaseName() {
return DEFAULT_DATABASE_NAME;
}
public static boolean clusterIsType(final ClusterType clusterType) {
return getCluster().getDescription().getType() == clusterType;
}
@SuppressWarnings("deprecation")
public static ServerVersion getServerVersion() {
return getCluster().getDescription().getAny().get(0).getVersion();
}
public static boolean serverVersionAtLeast(final List<Integer> versionArray) {
return getConnectedServerVersion().compareTo(new ServerVersion(versionArray)) >= 0;
}
public static boolean serverVersionAtLeast(final int majorVersion, final int minorVersion) {
return serverVersionAtLeast(asList(majorVersion, minorVersion, 0));
}
public static boolean serverVersionLessThan(final String versionString) {
return getConnectedServerVersion().compareTo(new ServerVersion(getVersionList(versionString).subList(0, 3))) < 0;
}
public static boolean serverVersionGreaterThan(final String versionString) {
return getConnectedServerVersion().compareTo(new ServerVersion(getVersionList(versionString).subList(0, 3))) > 0;
}
private static List<Integer> getVersionList(final String versionString) {
List<Integer> versionList = new ArrayList<Integer>();
for (String s : versionString.split("\\.")) {
versionList.add(Integer.valueOf(s));
}
while (versionList.size() < 3) {
versionList.add(0);
}
return versionList;
}
public static Document getBuildInfo() {
return new CommandWriteOperation<Document>("admin", new BsonDocument("buildInfo", new BsonInt32(1)), new DocumentCodec())
.execute(getBinding());
}
public static Document getServerStatus() {
return new CommandWriteOperation<Document>("admin", new BsonDocument("serverStatus", new BsonInt32(1)), new DocumentCodec())
.execute(getBinding());
}
@SuppressWarnings("unchecked")
public static boolean isEnterpriseServer() {
Document buildInfo = getBuildInfo();
List<String> modules = Collections.emptyList();
if (buildInfo.containsKey("modules")) {
modules = (List<String>) buildInfo.get("modules");
}
return modules.contains("enterprise");
}
public static boolean supportsFsync() {
Document serverStatus = getServerStatus();
Document storageEngine = (Document) serverStatus.get("storageEngine");
return storageEngine != null && !storageEngine.get("name").equals("inMemory");
}
@SuppressWarnings("deprecation")
public static ServerVersion getConnectedServerVersion() {
ClusterDescription clusterDescription = getCluster().getDescription();
int retries = 0;
while (clusterDescription.getAny().isEmpty() && retries <= 3) {
try {
Thread.sleep(1000);
retries++;
} catch (InterruptedException e) {
throw new RuntimeException("Interrupted", e);
}
clusterDescription = getCluster().getDescription();
}
if (clusterDescription.getAny().isEmpty()) {
throw new RuntimeException("There are no servers available in " + clusterDescription);
}
return clusterDescription.getAny().get(0).getVersion();
}
public static boolean isNotAtLeastJava7() {
return javaVersionStartsWith("1.6");
}
public static boolean isNotAtLeastJava8() {
return isNotAtLeastJava7() || javaVersionStartsWith("1.7");
}
private static boolean javaVersionStartsWith(final String versionPrefix) {
return System.getProperty("java.version").startsWith(versionPrefix + ".");
}
static class ShutdownHook extends Thread {
@Override
public void run() {
if (cluster != null) {
new DropDatabaseOperation(getDefaultDatabaseName(), WriteConcern.ACKNOWLEDGED).execute(getBinding());
cluster.close();
}
}
}
public static synchronized ConnectionString getConnectionString() {
return connectionString;
}
public static ReadWriteBinding getBinding() {
return getBinding(getCluster());
}
public static ReadWriteBinding getBinding(final ReadPreference readPreference) {
return getBinding(getCluster(), readPreference);
}
public static ReadWriteBinding getBinding(final Cluster cluster) {
return getBinding(cluster, ReadPreference.primary());
}
private static ReadWriteBinding getBinding(final Cluster cluster, final ReadPreference readPreference) {
return new ClusterBinding(cluster, readPreference);
}
public static SingleConnectionBinding getSingleConnectionBinding() {
return new SingleConnectionBinding(getCluster(), ReadPreference.primary());
}
public static AsyncSingleConnectionBinding getAsyncSingleConnectionBinding() {
return getAsyncSingleConnectionBinding(getAsyncCluster());
}
public static AsyncSingleConnectionBinding getAsyncSingleConnectionBinding(final Cluster cluster) {
return new AsyncSingleConnectionBinding(cluster, 20, SECONDS);
}
public static AsyncReadWriteBinding getAsyncBinding() {
return getAsyncBinding(getAsyncCluster());
}
public static AsyncReadWriteBinding getAsyncBinding(final ReadPreference readPreference) {
return getAsyncBinding(getAsyncCluster(), readPreference);
}
public static AsyncReadWriteBinding getAsyncBinding(final Cluster cluster) {
return getAsyncBinding(cluster, ReadPreference.primary());
}
public static AsyncReadWriteBinding getAsyncBinding(final Cluster cluster, final ReadPreference readPreference) {
return new AsyncClusterBinding(cluster, readPreference);
}
public static synchronized Cluster getCluster() {
if (cluster == null) {
cluster = createCluster(new SocketStreamFactory(getSocketSettings(), getSslSettings()));
}
return cluster;
}
public static synchronized Cluster getAsyncCluster() {
if (asyncCluster == null) {
asyncCluster = createCluster(getAsyncStreamFactory());
}
return asyncCluster;
}
public static Cluster createCluster(final StreamFactory streamFactory) {
return new DefaultClusterFactory().create(ClusterSettings.builder().applyConnectionString(getConnectionString()).build(),
ServerSettings.builder().build(),
ConnectionPoolSettings.builder().applyConnectionString(getConnectionString()).build(),
streamFactory,
new SocketStreamFactory(SocketSettings.builder().build(), getSslSettings()),
getConnectionString().getCredentialList(), null, new JMXConnectionPoolListener(), null);
}
public static StreamFactory getAsyncStreamFactory() {
String streamType = System.getProperty("org.mongodb.async.type", "nio2");
if (streamType.equals("netty") || getSslSettings().isEnabled()) {
return new NettyStreamFactory(getSocketSettings(), getSslSettings());
} else if (streamType.equals("nio2")) {
return new AsynchronousSocketChannelStreamFactory(getSocketSettings(), getSslSettings());
} else {
throw new IllegalArgumentException("Unsupported stream type " + streamType);
}
}
private static SocketSettings getSocketSettings() {
return SocketSettings.builder().applyConnectionString(getConnectionString()).build();
}
public static SslSettings getSslSettings() {
SslSettings.Builder builder = SslSettings.builder().applyConnectionString(getConnectionString());
if (System.getProperty("java.version").startsWith("1.6.")) {
builder.invalidHostNameAllowed(true);
}
return builder.build();
}
@SuppressWarnings("deprecation")
public static ServerAddress getPrimary() throws InterruptedException {
List<ServerDescription> serverDescriptions = getCluster().getDescription().getPrimaries();
while (serverDescriptions.isEmpty()) {
sleep(100);
serverDescriptions = getCluster().getDescription().getPrimaries();
}
return serverDescriptions.get(0).getAddress();
}
public static List<MongoCredential> getCredentialList() {
return getConnectionString().getCredentialList();
}
public static boolean isDiscoverableReplicaSet() {
return getCluster().getDescription().getType() == REPLICA_SET
&& getCluster().getDescription().getConnectionMode() == MULTIPLE;
}
public static boolean isSharded() {
return getCluster().getDescription().getType() == SHARDED;
}
public static boolean isStandalone() {
return getCluster().getDescription().getType() == STANDALONE;
}
public static boolean isAuthenticated() {
return !getConnectionString().getCredentialList().isEmpty();
}
public static void enableMaxTimeFailPoint() {
assumeThat(isSharded(), is(false));
new CommandWriteOperation<BsonDocument>("admin",
new BsonDocumentWrapper<Document>(new Document("configureFailPoint", "maxTimeAlwaysTimeOut")
.append("mode", "alwaysOn"),
new DocumentCodec()),
new BsonDocumentCodec())
.execute(getBinding());
}
public static void disableMaxTimeFailPoint() {
assumeThat(isSharded(), is(false));
if (serverVersionAtLeast(2, 6) && !isSharded()) {
new CommandWriteOperation<BsonDocument>("admin",
new BsonDocumentWrapper<Document>(new Document("configureFailPoint",
"maxTimeAlwaysTimeOut")
.append("mode", "off"),
new DocumentCodec()),
new BsonDocumentCodec())
.execute(getBinding());
}
}
public static <T> T executeSync(final WriteOperation<T> op) throws Throwable {
return executeSync(op, getBinding());
}
public static <T> T executeSync(final WriteOperation<T> op, final ReadWriteBinding binding) throws Throwable {
return op.execute(binding);
}
public static <T> T executeSync(final ReadOperation<T> op) throws Throwable {
return executeSync(op, getBinding());
}
public static <T> T executeSync(final ReadOperation<T> op, final ReadWriteBinding binding) throws Throwable {
return op.execute(binding);
}
public static <T> T executeAsync(final AsyncWriteOperation<T> op) throws Throwable {
return executeAsync(op, getAsyncBinding());
}
public static <T> T executeAsync(final AsyncWriteOperation<T> op, final AsyncReadWriteBinding binding) throws Throwable {
final FutureResultCallback<T> futureResultCallback = new FutureResultCallback<T>();
op.executeAsync(binding, futureResultCallback);
return futureResultCallback.get(TIMEOUT, SECONDS);
}
public static <T> T executeAsync(final AsyncReadOperation<T> op) throws Throwable {
return executeAsync(op, getAsyncBinding());
}
public static <T> T executeAsync(final AsyncReadOperation<T> op, final AsyncReadWriteBinding binding) throws Throwable {
final FutureResultCallback<T> futureResultCallback = new FutureResultCallback<T>();
op.executeAsync(binding, futureResultCallback);
return futureResultCallback.get(TIMEOUT, SECONDS);
}
public static <T> void loopCursor(final List<AsyncBatchCursor<T>> batchCursors, final Block<T> block) throws Throwable {
List<FutureResultCallback<Void>> futures = new ArrayList<FutureResultCallback<Void>>();
for (AsyncBatchCursor<T> batchCursor : batchCursors) {
FutureResultCallback<Void> futureResultCallback = new FutureResultCallback<Void>();
futures.add(futureResultCallback);
loopCursor(batchCursor, block, futureResultCallback);
}
for (int i = 0; i < batchCursors.size(); i++) {
futures.get(i).get(TIMEOUT, SECONDS);
}
}
public static <T> void loopCursor(final AsyncReadOperation<AsyncBatchCursor<T>> op, final Block<T> block) throws Throwable {
final FutureResultCallback<Void> futureResultCallback = new FutureResultCallback<Void>();
loopCursor(executeAsync(op), block, futureResultCallback);
futureResultCallback.get(TIMEOUT, SECONDS);
}
public static <T> void loopCursor(final AsyncBatchCursor<T> batchCursor, final Block<T> block,
final SingleResultCallback<Void> callback) {
batchCursor.next(new SingleResultCallback<List<T>>() {
@Override
public void onResult(final List<T> results, final Throwable t) {
if (t != null || results == null) {
batchCursor.close();
callback.onResult(null, t);
} else {
try {
for (T result : results) {
block.apply(result);
}
loopCursor(batchCursor, block, callback);
} catch (Throwable tr) {
batchCursor.close();
callback.onResult(null, tr);
}
}
}
});
}
public static <T> List<T> collectCursorResults(final AsyncBatchCursor<T> batchCursor) throws Throwable {
final List<T> results = new ArrayList<T>();
FutureResultCallback<Void> futureResultCallback = new FutureResultCallback<Void>();
loopCursor(batchCursor, new Block<T>() {
@Override
public void apply(final T t) {
results.add(t);
}
}, futureResultCallback);
futureResultCallback.get(TIMEOUT, SECONDS);
return results;
}
public static <T> List<T> collectCursorResults(final BatchCursor<T> batchCursor) throws Throwable {
List<T> results = new ArrayList<T>();
while (batchCursor.hasNext()) {
results.addAll(batchCursor.next());
}
return results;
}
public static AsyncConnectionSource getWriteConnectionSource(final AsyncReadWriteBinding binding) throws Throwable {
final FutureResultCallback<AsyncConnectionSource> futureResultCallback = new FutureResultCallback<AsyncConnectionSource>();
binding.getWriteConnectionSource(futureResultCallback);
return futureResultCallback.get(TIMEOUT, SECONDS);
}
public static AsyncConnectionSource getReadConnectionSource(final AsyncReadWriteBinding binding) throws Throwable {
final FutureResultCallback<AsyncConnectionSource> futureResultCallback = new FutureResultCallback<AsyncConnectionSource>();
binding.getReadConnectionSource(futureResultCallback);
return futureResultCallback.get(TIMEOUT, SECONDS);
}
public static AsyncConnection getConnection(final AsyncConnectionSource source) throws Throwable {
final FutureResultCallback<AsyncConnection> futureResultCallback = new FutureResultCallback<AsyncConnection>();
source.getConnection(futureResultCallback);
return futureResultCallback.get(TIMEOUT, SECONDS);
}
}