Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

fix: showing invalid credentials message on MongoDB test datasource if there is an unauthorized error (#11124)

Browse Source 
* fix: if test datasource gets Unauthorized accessing admin database
It will try to access the default database.

* fix: fix broken test

* fix: cleanup unused imports

* test: make test more readable with better comments
This commit is contained in:
Mojtaba 2022-02-16 12:03:13 +03:30 committed by GitHub
parent 4c81347128
commit 497dd1a21b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
app/server/appsmith-plugins/mongoPlugin/src/main/java/com/external/plugins/MongoPlugin.java vendored
View File

@ -40,12 +40,14 @@ import org.json.JSONArray;
import org.json.JSONObject;
import org.pf4j.Extension;
import org.pf4j.PluginWrapper;
import org.reactivestreams.Publisher;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.core.scheduler.Scheduler;
import reactor.core.scheduler.Schedulers;
import reactor.util.function.Tuple2;
import java.math.BigDecimal;
import java.math.BigInteger;
@ -61,6 +63,8 @@ import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeoutException;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
@ -870,29 +874,25 @@ public class MongoPlugin extends BasePlugin {
@Override
public Mono<DatasourceTestResult> testDatasource(DatasourceConfiguration datasourceConfiguration) {
final Consumer<Tuple2<MongoClient, Document>> closeClient = tuple -> tuple.getT1().close();
Function<TimeoutException, Throwable> timeoutExceptionThrowableFunction = error -> new AppsmithPluginException(
AppsmithPluginError.PLUGIN_DATASOURCE_TIMEOUT_ERROR,
"Connection timed out. Please check if the datasource configuration fields have " +
"been filled correctly."
);
return datasourceCreate(datasourceConfiguration)
.flatMap(mongoClient -> {
return Mono.zip(Mono.just(mongoClient),
Mono.from(mongoClient.getDatabase("admin").runCommand(new Document(
"listDatabases", 1))));
})
.doOnSuccess(tuple -> {
MongoClient mongoClient = tuple.getT1();
Publisher<Document> result = mongoClient.getDatabase("admin").runCommand(new Document(
"listDatabases", 1));
if (mongoClient != null) {
mongoClient.close();
}
return Mono.zip(Mono.just(mongoClient), Mono.from(result));
})
.doOnSuccess(closeClient)
.then(Mono.just(new DatasourceTestResult()))
.timeout(Duration.ofSeconds(TEST_DATASOURCE_TIMEOUT_SECONDS))
.onErrorMap(
TimeoutException.class,
error -> new AppsmithPluginException(
AppsmithPluginError.PLUGIN_DATASOURCE_TIMEOUT_ERROR,
"Connection timed out. Please check if the datasource configuration fields have " +
"been filled correctly."
)
)
.onErrorMap(TimeoutException.class, timeoutExceptionThrowableFunction)
.onErrorResume(error -> {
/**
* 1. Return OK response on "Unauthorized" exception.
@ -902,7 +902,23 @@ public class MongoPlugin extends BasePlugin {
*/
if (error instanceof MongoCommandException &&
((MongoCommandException) error).getErrorCodeName().equals("Unauthorized")) {
return Mono.just(new DatasourceTestResult());
return datasourceCreate(datasourceConfiguration)
.flatMap(mongoClient -> {
if (datasourceConfiguration.getConnection() != null && datasourceConfiguration.getConnection().getDefaultDatabaseName() != null) {
final String defaultDatabaseName = datasourceConfiguration.getConnection().getDefaultDatabaseName();
Publisher<Document> result = mongoClient.getDatabase(defaultDatabaseName).runCommand(new Document(
"listCollections", 1).append("nameOnly", TRUE));
return Mono.zip(Mono.just(mongoClient), Mono.from(result));
}
return Mono.error(new AppsmithPluginException(
AppsmithPluginError.PLUGIN_DATASOURCE_TEST_GENERIC_ERROR,
"Not enough information to test the Datasource. " +
"Please provide the default database name."));
}).doOnSuccess(closeClient).then(Mono.just(new DatasourceTestResult()))
.timeout(Duration.ofSeconds(TEST_DATASOURCE_TIMEOUT_SECONDS))
.onErrorMap(TimeoutException.class, timeoutExceptionThrowableFunction)
.onErrorResume(err -> Mono.just(new DatasourceTestResult(mongoErrorUtils.getReadableError(err))));
}
return Mono.just(new DatasourceTestResult(mongoErrorUtils.getReadableError(error)));

14
app/server/appsmith-plugins/mongoPlugin/src/test/java/com/external/plugins/MongoPluginTest.java vendored
View File

@ -31,7 +31,6 @@ import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Test;
import org.springframework.data.mongodb.core.query.Query;
import org.testcontainers.containers.GenericContainer;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
@ -79,8 +78,6 @@ import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.when;
import static org.springframework.data.mongodb.core.query.Criteria.where;
import static org.springframework.data.mongodb.core.query.Query.query;
/**
* Unit tests for MongoPlugin
@ -190,11 +187,10 @@ public class MongoPluginTest {
}
/*
* 1. Test that when a query is attempted to run on mongodb but refused because of lack of authorization, then
* also, it indicates a successful connection establishment.
* 1. Test that when a query is attempted to run on mongodb but refused because of lack of authorization.
*/
@Test
public void testDatasourceWithUnauthorizedException() throws NoSuchFieldException {
public void testDatasourceWithUnauthorizedException() {
/*
* 1. Create mock exception of type: MongoCommandException.
* - mock method getErrorCodeName() to return String "Unauthorized".
@ -202,6 +198,8 @@ public class MongoPluginTest {
MongoCommandException mockMongoCommandException = mock(MongoCommandException.class);
when(mockMongoCommandException.getErrorCodeName()).thenReturn("Unauthorized");
when(mockMongoCommandException.getMessage()).thenReturn("Mock Unauthorized Exception");
when(mockMongoCommandException.getErrorMessage()).thenReturn("Mock error : Expected 'something' , but got something else.\n" +
"Doc = [{find mockAction} {filter mockFilter} {limit 10} {$db mockDB} ...]");
/*
* 1. Spy MongoPluginExecutor class.
@ -216,13 +214,13 @@ public class MongoPluginTest {
doReturn(Mono.error(mockMongoCommandException)).when(spyMongoPluginExecutor).datasourceCreate(any());
/*
* 1. Test that MongoCommandException with error code "Unauthorized" is caught and no error is reported.
* 1. Test that MongoCommandException with error code "Unauthorized" is not successful because of invalid credentials.
*/
DatasourceConfiguration dsConfig = createDatasourceConfiguration();
StepVerifier
.create(spyMongoPluginExecutor.testDatasource(dsConfig))
.assertNext(datasourceTestResult -> {
assertTrue(datasourceTestResult.isSuccess());
assertFalse(datasourceTestResult.isSuccess());
})
.verifyComplete();
}