-
Notifications
You must be signed in to change notification settings - Fork 6
Add a utility to create a SSH tunnel for the database #1237
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.
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
Open
arteymix
wants to merge
1
commit into
development
Choose a base branch
from
feature-ssh-tunnel-for-dev
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
80 changes: 80 additions & 0 deletions
80
gemma-core/src/main/java/ubic/gemma/persistence/util/LocalSshTunnel.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| package ubic.gemma.persistence.util; | ||
|
|
||
| import lombok.Setter; | ||
| import lombok.extern.apachecommons.CommonsLog; | ||
| import org.apache.commons.io.IOUtils; | ||
| import org.apache.commons.lang3.ArrayUtils; | ||
| import org.springframework.context.SmartLifecycle; | ||
| import org.springframework.util.Assert; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| /** | ||
| * Establishes a local SSH tunnel. | ||
| * @author poirigui | ||
| */ | ||
| @CommonsLog | ||
| @Setter | ||
| public class LocalSshTunnel implements SmartLifecycle { | ||
|
|
||
| private String host; | ||
| @Nullable | ||
| private Integer port; | ||
|
|
||
| // for the tunnel | ||
| private int localPort; | ||
| private String remoteHost; | ||
| private int remotePort; | ||
|
|
||
| private boolean autoStart = false; | ||
|
|
||
| private Process tunnelProcess; | ||
|
|
||
| @Override | ||
| public void start() { | ||
| Assert.isTrue( host != null && localPort > 0 && remoteHost != null && remotePort > 0 ); | ||
| try { | ||
| String[] args = new String[] { "ssh", "-L", localPort + ":" + remoteHost + ":" + remotePort, host }; | ||
| if ( port != null ) { | ||
| args = ArrayUtils.addAll( args, "-p", String.valueOf( port ) ); | ||
| } | ||
| tunnelProcess = Runtime.getRuntime().exec( args ); | ||
| // quickly check if the process exited | ||
| if ( tunnelProcess.waitFor( 100, TimeUnit.MILLISECONDS ) ) { | ||
| throw new RuntimeException( IOUtils.toString( tunnelProcess.getErrorStream(), StandardCharsets.UTF_8 ) ); | ||
| } | ||
| } catch ( IOException | InterruptedException e ) { | ||
| throw new RuntimeException( e ); | ||
| } | ||
| log.info( String.format( "Established a SSH tunnel to %s%s: %d -> %s:%d.", | ||
| host, port != null ? ":" + port : "", localPort, remoteHost, remotePort ) ); | ||
| } | ||
|
|
||
| @Override | ||
| public void stop() { | ||
| tunnelProcess.destroy(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isRunning() { | ||
| return tunnelProcess != null && tunnelProcess.isAlive(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isAutoStartup() { | ||
| return autoStart; | ||
| } | ||
|
|
||
| @Override | ||
| public void stop( Runnable callback ) { | ||
| stop(); | ||
| } | ||
|
|
||
| @Override | ||
| public int getPhase() { | ||
| return 0; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add the -N option so that no shell is opened.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also need a log file for the stdout/stderr. We can take inspiration from the internal static asset server.