Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions core/src/main/java/de/bwaldvogel/mongo/MongoVersion.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ default String toVersionString() {
return Utils.join(getVersionArray(), ".");
}

default String toMajorMinorVersionString() {
return Utils.join(getVersionArray().subList(0, 2), ".");
}

int getWireVersion();

}
Comment thread
bwaldvogel marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
Expand All @@ -24,11 +25,13 @@
import de.bwaldvogel.mongo.ServerVersion;
import de.bwaldvogel.mongo.bson.Document;
import de.bwaldvogel.mongo.exception.ErrorCode;
import de.bwaldvogel.mongo.exception.InvalidOptionsException;
import de.bwaldvogel.mongo.exception.MongoServerError;
import de.bwaldvogel.mongo.exception.MongoServerException;
import de.bwaldvogel.mongo.exception.NamespaceExistsException;
import de.bwaldvogel.mongo.exception.NoReplicationEnabledException;
import de.bwaldvogel.mongo.exception.NoSuchCommandException;
import de.bwaldvogel.mongo.exception.TypeMismatchException;
import de.bwaldvogel.mongo.oplog.CollectionBackedOplog;
import de.bwaldvogel.mongo.oplog.NoopOplog;
import de.bwaldvogel.mongo.oplog.Oplog;
Expand Down Expand Up @@ -163,6 +166,7 @@ private Document handleAdminCommand(DatabaseCommand command, Document query) {
case CONNECTION_STATUS -> handleConnectionStatus();
case HOST_INFO -> handleHostInfo();
case GET_CMD_LINE_OPTS -> handleGetCmdLineOpts();
case GET_PARAMETER -> handleGetParameter(query);
case END_SESSIONS -> {
log.debug("endSessions on admin database");
yield successResponse();
Expand Down Expand Up @@ -241,6 +245,65 @@ private Document handleGetCmdLineOpts() {
return response;
}

private Document handleGetParameter(Document query) {
Object value = query.get("getParameter");
boolean getAllParameters = "*".equals(value);
boolean showDetails = false;
if (value instanceof Document options) {
getAllParameters = getGetParameterOption(options, "allParameters");
showDetails = getGetParameterOption(options, "showDetails");
}

Document response = new Document();
// like a real server, names that are not a known parameter are ignored
for (Map.Entry<String, ServerParameter> entry : getAllServerParameters().entrySet()) {
String name = entry.getKey();
if (getAllParameters || query.containsKey(name)) {
ServerParameter parameter = entry.getValue();
response.put(name, showDetails ? parameter.toDetails() : parameter.value());
}
}
if (response.isEmpty()) {
throw new InvalidOptionsException("no option found to get");
}
Utils.markOkay(response);
return response;
}

// like a real server, numbers are accepted as a boolean as well
private static boolean getGetParameterOption(Document options, String name) {
Object value = options.get(name);
if (value != null && !(value instanceof Boolean) && !(value instanceof Number)) {
throw new TypeMismatchException("BSON field 'getParameter." + name + "' is the wrong type '"
+ Utils.describeType(value) + "', expected types '[bool, long, int, decimal, double']");
}
return Utils.isTrue(value);
}

private record ServerParameter(Object value, boolean settableAtRuntime, boolean settableAtStartup) {
private Document toDetails() {
return new Document("value", value)
.append("settableAtRuntime", Boolean.valueOf(settableAtRuntime))
.append("settableAtStartup", Boolean.valueOf(settableAtStartup));
}
}

private Map<String, ServerParameter> getAllServerParameters() {
Map<String, ServerParameter> parameters = new LinkedHashMap<>();
parameters.put("featureCompatibilityVersion",
new ServerParameter(new Document("version", version.toMajorMinorVersionString()), false, false));
parameters.put("quiet", new ServerParameter(Boolean.FALSE, true, true));
parameters.put("logLevel", new ServerParameter(Integer.valueOf(0), true, true));
parameters.put("notablescan", new ServerParameter(Boolean.FALSE, true, true));
parameters.put("maxIndexBuildMemoryUsageMegabytes", new ServerParameter(Integer.valueOf(200), true, true));
parameters.put("enableLocalhostAuthBypass", new ServerParameter(Boolean.TRUE, false, true));
// the values a default mongod reports; this server does not implement authentication
parameters.put("authenticationMechanisms",
new ServerParameter(List.of("MONGODB-X509", "SCRAM-SHA-1", "SCRAM-SHA-256"), false, true));
parameters.put("clusterAuthMode", new ServerParameter("undefined", true, false));
return parameters;
}

@VisibleForExternalBackends
protected Set<String> listDatabaseNames() {
return databases.keySet();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ public enum Command {
DB_STATS("dbStats"),
GET_CMD_LINE_OPTS("getCmdLineOpts"),
GET_LOG("getLog"),
GET_PARAMETER("getParameter"),
HOST_INFO("hostInfo"),
PING("ping"),
SERVER_STATUS("serverStatus"),
Expand Down
7 changes: 7 additions & 0 deletions core/src/test/java/de/bwaldvogel/mongo/ServerVersionTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,11 @@ void testToVersionString() throws Exception {
assertThat(ServerVersion.MONGO_9_0.toVersionString()).isEqualTo("9.0.0");
}

@Test
void testToMajorMinorVersionString() throws Exception {
assertThat(ServerVersion.MONGO_3_6.toMajorMinorVersionString()).isEqualTo("3.6");
assertThat(ServerVersion.MONGO_7_0.toMajorMinorVersionString()).isEqualTo("7.0");
assertThat(ServerVersion.MONGO_8_0.toMajorMinorVersionString()).isEqualTo("8.0");
}

}
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
package de.bwaldvogel.mongo.backend;

import static de.bwaldvogel.mongo.TestUtils.json;
import static de.bwaldvogel.mongo.backend.AbstractMongoBackend.ADMIN_DB_NAME;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;

import java.util.List;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import de.bwaldvogel.mongo.MongoBackend;
import de.bwaldvogel.mongo.MongoDatabase;
import de.bwaldvogel.mongo.ServerVersion;
import de.bwaldvogel.mongo.bson.Document;
import de.bwaldvogel.mongo.exception.InvalidOptionsException;
import de.bwaldvogel.mongo.exception.TypeMismatchException;

class AbstractMongoBackendTest {

Expand Down Expand Up @@ -65,4 +72,109 @@ void testMongoDatabaseHandleCommand() {
assertThat(response.get("message")).isEqualTo("fakeResponse");
}

@Test
void testGetParameter() {
Document response = getParameter(json("getParameter: 1, featureCompatibilityVersion: 1"));
assertThat(response).isEqualTo(json("featureCompatibilityVersion: {version: '7.0'}, ok: 1.0"));
}

@Test
void testGetParameter_multipleParameters() {
Document response = getParameter(json("getParameter: 1, quiet: 1, logLevel: 1"));
assertThat(response).isEqualTo(json("quiet: false, logLevel: 0, ok: 1.0"));
}

@Test
void testGetParameter_ignoresUnknownParameters() {
Document response = getParameter(json("getParameter: 1, notablescan: 1, unknownParameter: 1"));
assertThat(response).isEqualTo(json("notablescan: false, ok: 1.0"));
}

@Test
void testGetParameter_featureCompatibilityVersionFollowsServerVersion() {
backend.version(ServerVersion.MONGO_8_0);
Document response = getParameter(json("getParameter: 1, featureCompatibilityVersion: 1"));
assertThat(response.get("featureCompatibilityVersion")).isEqualTo(json("version: '8.0'"));
}

@Test
void testGetParameter_showDetails() {
Document response = getParameter(json("getParameter: {showDetails: true}, enableLocalhostAuthBypass: 1"));
assertThat(response).isEqualTo(json("enableLocalhostAuthBypass:"
+ " {value: true, settableAtRuntime: false, settableAtStartup: true}, ok: 1.0"));
}

@Test
void testGetParameter_allParametersWithStar() {
Document response = getParameter(json("getParameter: '*'"));
assertThat(response.keySet()).containsExactly(
"featureCompatibilityVersion",
"quiet",
"logLevel",
"notablescan",
"maxIndexBuildMemoryUsageMegabytes",
"enableLocalhostAuthBypass",
"authenticationMechanisms",
"clusterAuthMode",
"ok");
assertThat(response.get("maxIndexBuildMemoryUsageMegabytes")).isEqualTo(200);
assertThat(response.get("authenticationMechanisms"))
.isEqualTo(List.of("MONGODB-X509", "SCRAM-SHA-1", "SCRAM-SHA-256"));
assertThat(response.get("clusterAuthMode")).isEqualTo("undefined");
}

@Test
void testGetParameter_allParametersWithDetails() {
Document response = getParameter(json("getParameter: {allParameters: true, showDetails: true}"));
assertThat(response).hasSize(9);
assertThat(response.get("quiet")).isEqualTo(json("value: false, settableAtRuntime: true, settableAtStartup: true"));
assertThat(response.get("clusterAuthMode"))
.isEqualTo(json("value: 'undefined', settableAtRuntime: true, settableAtStartup: false"));
}

@Test
void testGetParameter_allParametersFalse() {
Document response = getParameter(json("getParameter: {allParameters: false}, logLevel: 1"));
assertThat(response).isEqualTo(json("logLevel: 0, ok: 1.0"));
}

@Test
void testGetParameter_noKnownParameter() {
assertThatExceptionOfType(InvalidOptionsException.class)
.isThrownBy(() -> getParameter(json("getParameter: 1, unknownParameter: 1")))
.withMessage("[Error 72] no option found to get");

assertThatExceptionOfType(InvalidOptionsException.class)
.isThrownBy(() -> getParameter(json("getParameter: 1")))
.withMessage("[Error 72] no option found to get");
}

@Test
void testGetParameter_numericOptions() {
assertThat(getParameter(json("getParameter: {showDetails: 1}, logLevel: 1")))
.isEqualTo(json("logLevel: {value: 0, settableAtRuntime: true, settableAtStartup: true}, ok: 1.0"));
assertThat(getParameter(json("getParameter: {showDetails: 0}, logLevel: 1")))
.isEqualTo(json("logLevel: 0, ok: 1.0"));
assertThat(getParameter(json("getParameter: {allParameters: 1.0}"))).hasSize(9);
assertThat(getParameter(json("getParameter: {allParameters: null}, logLevel: 1")))
.isEqualTo(json("logLevel: 0, ok: 1.0"));
}

@Test
void testGetParameter_nonBooleanOptions() {
assertThatExceptionOfType(TypeMismatchException.class)
.isThrownBy(() -> getParameter(json("getParameter: {allParameters: 'true'}")))
.withMessage("[Error 14] BSON field 'getParameter.allParameters' is the wrong type 'string',"
+ " expected types '[bool, long, int, decimal, double']");

assertThatExceptionOfType(TypeMismatchException.class)
.isThrownBy(() -> getParameter(json("getParameter: {showDetails: 'yes'}, logLevel: 1")))
.withMessage("[Error 14] BSON field 'getParameter.showDetails' is the wrong type 'string',"
+ " expected types '[bool, long, int, decimal, double']");
}

private Document getParameter(Document query) {
return backend.handleCommand(ADMIN_DB_NAME, DatabaseCommand.of(Command.GET_PARAMETER), query);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,92 @@ void testGetLogWhichDoesNotExist() {
.withMessageStartingWith("Command execution failed on MongoDB server with error 96 (OperationFailed): 'No log named 'illegal''");
}

@Test
void testGetParameter() {
assertThat(runCommand(json("getParameter: 1, featureCompatibilityVersion: 1")))
.isEqualTo(json("featureCompatibilityVersion: {version: '7.0'}, ok: 1.0"));

assertThat(runCommand(json("getParameter: 1, quiet: 1, logLevel: 1")))
.isEqualTo(json("quiet: false, logLevel: 0, ok: 1.0"));

assertThat(runCommand(json("getParameter: {allParameters: false}, logLevel: 1")))
.isEqualTo(json("logLevel: 0, ok: 1.0"));
}

@Test
void testGetParameterIgnoresUnknownParameters() {
assertThat(runCommand(json("getParameter: 1, notablescan: 1, unknownParameter: 1")))
.isEqualTo(json("notablescan: false, ok: 1.0"));
}

@Test
void testGetParameterWithDetails() {
assertThat(runCommand(json("getParameter: {showDetails: true}, enableLocalhostAuthBypass: 1")))
.isEqualTo(json("enableLocalhostAuthBypass: {value: true, settableAtRuntime: false, settableAtStartup: true}, ok: 1.0"));
}

@Test
void testGetAllParameters() {
Document allParameters = runCommand(json("getParameter: {allParameters: true, showDetails: true}"));
assertThat(allParameters.getDouble("ok")).isEqualTo(1.0);
assertThat(allParameters.get("featureCompatibilityVersion"))
.isEqualTo(json("value: {version: '7.0'}, settableAtRuntime: false, settableAtStartup: false"));
assertThat(allParameters.get("quiet"))
.isEqualTo(json("value: false, settableAtRuntime: true, settableAtStartup: true"));
assertThat(allParameters.get("logLevel"))
.isEqualTo(json("value: 0, settableAtRuntime: true, settableAtStartup: true"));
assertThat(allParameters.get("notablescan"))
.isEqualTo(json("value: false, settableAtRuntime: true, settableAtStartup: true"));
assertThat(allParameters.get("maxIndexBuildMemoryUsageMegabytes"))
.isEqualTo(json("value: 200, settableAtRuntime: true, settableAtStartup: true"));
assertThat(allParameters.get("enableLocalhostAuthBypass"))
.isEqualTo(json("value: true, settableAtRuntime: false, settableAtStartup: true"));
assertThat(allParameters.get("authenticationMechanisms"))
.isEqualTo(json("value: ['MONGODB-X509', 'SCRAM-SHA-1', 'SCRAM-SHA-256'], settableAtRuntime: false, settableAtStartup: true"));
assertThat(allParameters.get("clusterAuthMode"))
.isEqualTo(json("value: 'undefined', settableAtRuntime: true, settableAtStartup: false"));

Document allParametersWithStar = runCommand(json("getParameter: '*'"));
assertThat(allParametersWithStar.getDouble("ok")).isEqualTo(1.0);
assertThat(allParametersWithStar.get("featureCompatibilityVersion")).isEqualTo(json("version: '7.0'"));
assertThat(allParametersWithStar.get("clusterAuthMode")).isEqualTo("undefined");
}

@Test
void testGetParameterWithNumericOptions() {
assertThat(runCommand(json("getParameter: {showDetails: 1}, logLevel: 1")))
.isEqualTo(json("logLevel: {value: 0, settableAtRuntime: true, settableAtStartup: true}, ok: 1.0"));
assertThat(runCommand(json("getParameter: {showDetails: 0}, logLevel: 1")))
.isEqualTo(json("logLevel: 0, ok: 1.0"));
assertThat(runCommand(json("getParameter: {allParameters: 1}")).get("clusterAuthMode")).isEqualTo("undefined");
assertThat(runCommand(json("getParameter: {allParameters: null}, logLevel: 1")))
.isEqualTo(json("logLevel: 0, ok: 1.0"));
}

@Test
void testGetParameterWithNonBooleanOptions() {
assertThatExceptionOfType(MongoCommandException.class)
.isThrownBy(() -> runCommand(json("getParameter: {allParameters: 'true'}")))
.withMessageStartingWith("Command execution failed on MongoDB server with error 14 (TypeMismatch):"
+ " 'BSON field 'getParameter.allParameters' is the wrong type 'string', expected types '[bool, long, int, decimal, double']'");

assertThatExceptionOfType(MongoCommandException.class)
.isThrownBy(() -> runCommand(json("getParameter: {showDetails: 'yes'}, logLevel: 1")))
.withMessageStartingWith("Command execution failed on MongoDB server with error 14 (TypeMismatch):"
+ " 'BSON field 'getParameter.showDetails' is the wrong type 'string', expected types '[bool, long, int, decimal, double']'");
}

@Test
void testGetParameterWithoutKnownParameter() {
assertThatExceptionOfType(MongoCommandException.class)
.isThrownBy(() -> runCommand(json("getParameter: 1, unknownParameter: 1")))
.withMessageStartingWith("Command execution failed on MongoDB server with error 72 (InvalidOptions): 'no option found to get'");

assertThatExceptionOfType(MongoCommandException.class)
.isThrownBy(() -> runCommand(json("getParameter: 1")))
.withMessageStartingWith("Command execution failed on MongoDB server with error 72 (InvalidOptions): 'no option found to get'");
}

@Test
void testCompoundDateIdUpserts() {
Document query = json("_id: {$lt: {n: 'a', t: 10}, $gte: {n: 'a', t: 1}}");
Expand Down
Loading