Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mysql source: handle ssh timeout exception #20593

Merged
merged 14 commits into from Jan 25, 2023
Merged

Mysql source: handle ssh timeout exception #20593

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ea44cca
Ssh wrapped source: mark ssh timeout exception as config error.
sashaNeshcheret Dec 16, 2022
f1faddb
Ssh wrapped source: move to single catch block
sashaNeshcheret Dec 16, 2022
e9071cb
Ssh wrapped source: code format
sashaNeshcheret Dec 19, 2022
541e16c
Merge branch 'master' into omneshcheret/609-mysql-source-handle-ssh-t…
sashaNeshcheret Dec 19, 2022
4a446fd
Source postgres: update display message
sashaNeshcheret Jan 18, 2023
a03281d
Merge remote-tracking branch 'origin/omneshcheret/609-mysql-source-ha…
sashaNeshcheret Jan 18, 2023
c765ba8
Merge branch 'master' into omneshcheret/609-mysql-source-handle-ssh-t…
sashaNeshcheret Jan 18, 2023
81a44cf
Merge branch 'master' into omneshcheret/609-mysql-source-handle-ssh-t…
sashaNeshcheret Jan 24, 2023
fce9274
Source mysql: format
sashaNeshcheret Jan 24, 2023
0538340
Merge remote-tracking branch 'origin/omneshcheret/609-mysql-source-ha…
sashaNeshcheret Jan 24, 2023
6831a3a
Merge remote-tracking branch 'origin/master' into omneshcheret/609-my…
sashaNeshcheret Jan 24, 2023
763cc38
Source mysql: bump versions
sashaNeshcheret Jan 24, 2023
b9ff5f2
auto-bump connector version
octavia-squidington-iii Jan 24, 2023
b9459d0
Merge branch 'master' into omneshcheret/609-mysql-source-handle-ssh-t…
sashaNeshcheret Jan 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 9 additions & 1 deletion ...ntegrations/bases/base-java/src/main/java/io/airbyte/integrations/base/ssh/SshTunnel.java
View file
Open in desktop
Expand Up @@ -22,9 +22,11 @@
import java.time.Duration;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import org.apache.sshd.client.SshClient;
import org.apache.sshd.client.keyverifier.AcceptAllServerKeyVerifier;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.common.SshException;
import org.apache.sshd.common.util.net.SshdSocketAddress;
import org.apache.sshd.common.util.security.SecurityUtils;
import org.apache.sshd.core.CoreModuleProperties;
Expand Down Expand Up @@ -364,7 +366,13 @@ ClientSession openTunnel(final SshClient client) {
remoteServiceHost, remoteServicePort, address.toInetSocketAddress()));
return session;
} catch (final IOException | GeneralSecurityException e) {
throw new RuntimeException(e);
if (e instanceof SshException && e.getMessage()
.toLowerCase(Locale.ROOT)
.contains("failed to get operation result within specified timeout")) {
throw new ConfigErrorException(e.getMessage(), e);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the expected message should be something like:
"Timed out while opening a SSH Tunnel. Please double check the given SSH configurations and try again."

} else {
throw new RuntimeException(e);
}
}
}

Expand Down
2 changes: 1 addition & 1 deletion ...tegrations/io/airbyte/integration_tests/sources/AbstractSshMySqlSourceAcceptanceTest.java
View file
Open in desktop
Expand Up @@ -28,7 +28,7 @@ public abstract class AbstractSshMySqlSourceAcceptanceTest extends SourceAccepta
private static final String STREAM_NAME = "id_and_name";
private static final String STREAM_NAME2 = "starships";

private JsonNode config;
protected static JsonNode config;

public abstract Path getConfigFilePath();

Expand Down
40 changes: 40 additions & 0 deletions ...tegrations/io/airbyte/integration_tests/sources/SshPasswordMySqlSourceAcceptanceTest.java
View file
Open in desktop
Expand Up @@ -4,10 +4,22 @@

package io.airbyte.integrations.io.airbyte.integration_tests.sources;

import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import io.airbyte.commons.exceptions.ConfigErrorException;
import io.airbyte.commons.features.EnvVariableFeatureFlags;
import io.airbyte.integrations.base.Source;
import io.airbyte.integrations.base.ssh.SshBastionContainer;
import io.airbyte.integrations.base.ssh.SshTunnel;
import io.airbyte.integrations.source.mysql.MySqlSource;
import io.airbyte.integrations.standardtest.source.TestDestinationEnv;
import java.nio.file.Path;
import java.util.List;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.testcontainers.containers.MySQLContainer;
import org.testcontainers.containers.Network;
import uk.org.webcompere.systemstubs.environment.EnvironmentVariables;
import uk.org.webcompere.systemstubs.jupiter.SystemStub;
import uk.org.webcompere.systemstubs.jupiter.SystemStubsExtension;
Expand All @@ -29,4 +41,32 @@ public Path getConfigFilePath() {
return Path.of("secrets/ssh-pwd-repl-config.json");
}

@Test
public void sshTimeoutExceptionMarkAsConfigErrorTest() throws Exception {
SshBastionContainer bastion = new SshBastionContainer();
final Network network = Network.newNetwork();
// set up env
MySQLContainer<?> db = startTestContainers(bastion, network);
config = bastion.getTunnelConfig(SshTunnel.TunnelMethod.SSH_PASSWORD_AUTH, bastion.getBasicDbConfigBuider(db, List.of("public")));
bastion.stopAndClose();
Source sshWrappedSource = MySqlSource.sshWrappedSource();
Exception exception = assertThrows(ConfigErrorException.class, () -> sshWrappedSource.discover(config));

String expectedMessage = "Failed to get operation result within specified timeout";
String actualMessage = exception.getMessage();

assertTrue(actualMessage.contains(expectedMessage));
}

private MySQLContainer startTestContainers(SshBastionContainer bastion, Network network) {
bastion.initAndStartBastion(network);
return initAndStartJdbcContainer(network);
}

private MySQLContainer initAndStartJdbcContainer(Network network) {
MySQLContainer<?> db = new MySQLContainer<>("mysql:8.0").withNetwork(network);
db.start();
return db;
}

}