fix(config): fix ssh connection through the config file (#273)

* fix(config): add missing fig struct tags

* test(config): add missing ssh test assertions

* docs: update docs to show example of the new fixes

Author: danvergara

.dblab.yaml

@@ -34,6 +34,32 @@ database:
     db: "msdb"
     password: "5@klkbN#ABC"
     user: "SA"
+  - name: "ssh-tunnel"
+    host: "localhost"
+    port: 5432
+    db: "users"
+    password: "password"
+    user: "postgres"
+    schema: "public"
+    driver: "postgres"
+    ssh-host: "example.com"
+    ssh-port: 22
+    ssh-user: "ssh-user"
+    ssh-pass: "password"
+  - name: "realistic-ssh-example"
+    host: "rds-endpoint.region.rds.amazonaws.com"
+    port: 5432
+    db: "database_name"
+    user: "db_user"
+    password: "password"
+    schema: "schema_name"
+    driver: "postgres"
+    ssl: "require"
+    ssh-host: "bastion.host.ip"
+    ssh-port: 22
+    ssh-user: "ec2-user"
+    ssh-key-file: "/path/to/ssh/key.pem"
+    ssh-key-pass: "hiuwiewnc092"
 limit: 50
 keybindings:
   run-query: 'Ctrl-Space'

README.md

@@ -82,7 +82,7 @@ curl https://raw.githubusercontent.com/danvergara/dblab/master/scripts/install_u
 ## Help
 
 ```
-dblab is a terminal UI based interactive database client for Postgres, MySQL and SQLite3.
+dblab is a terminal UI based interactive database client
 
 Usage:
   dblab [flags]
@@ -320,6 +320,20 @@ database:
     ssh-port: 22
     ssh-user: "ssh-user"
     ssh-pass: "password"
+  - name: "realistic-ssh-example"
+    host: "rds-endpoint.region.rds.amazonaws.com"
+    port: 5432
+    db: "database_name"
+    user: "db_user"
+    password: "password"
+    schema: "schema_name"
+    driver: "postgres"
+    ssl: "require"
+    ssh-host: "bastion.host.ip"
+    ssh-port: 22
+    ssh-user: "ec2-user"
+    ssh-key-file: "/path/to/ssh/key.pem"
+    ssh-key-pass: "hiuwiewnc092"
 # should be greater than 0, otherwise the app will error out
 limit: 50
 keybindings:

cmd/root.go

@@ -58,7 +58,7 @@ func NewRootCmd() *cobra.Command {
 	return &cobra.Command{
 		Use:   "dblab",
 		Short: "Interactive database client",
-		Long:  `dblab is a terminal UI based interactive database client for Postgres and MySQL.`,
+		Long:  `dblab is a terminal UI based interactive database client`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			var opts command.Options
 			var err error

docs/usage.md

@@ -338,6 +338,20 @@ database:
     ssh-port: 22
     ssh-user: "ssh-user"
     ssh-pass: "password"
+  - name: "realistic-ssh-example"
+    host: "rds-endpoint.region.rds.amazonaws.com"
+    port: 5432
+    db: "database_name"
+    user: "db_user"
+    password: "password"
+    schema: "schema_name"
+    driver: "postgres"
+    ssl: "require"
+    ssh-host: "bastion.host.ip"
+    ssh-port: 22
+    ssh-user: "ec2-user"
+    ssh-key-file: "/path/to/ssh/key.pem"
+    ssh-key-pass: "hiuwiewnc092"
 # should be greater than 0, otherwise the app will error out
 limit: 50
 keybindings:

pkg/config/.dblab.yaml

@@ -48,6 +48,20 @@ database:
     ssh-port: 22
     ssh-user: "ssh-user"
     ssh-pass: "password"
+  - name: "realistic-ssh-example"
+    host: "rds-endpoint.region.rds.amazonaws.com"
+    port: 5432
+    db: "database_name"
+    user: "db_user"
+    password: "password"
+    schema: "schema_name"
+    driver: "postgres"
+    ssl: "require"
+    ssh-host: "bastion.host.ip"
+    ssh-port: 22
+    ssh-user: "ec2-user"
+    ssh-key-file: "/path/to/ssh/key.pem"
+    ssh-key-pass: "hiuwiewnc092"
 limit: 50
 keybindings:
   run-query: 'Ctrl-Space'

pkg/config/config.go

@@ -46,12 +46,12 @@ type Database struct {
 	Schema   string
 
 	// SSH Tunnel.
-	SSHHost          string
-	SSHPort          string
-	SSHUser          string
-	SSHPass          string
-	SSHKeyFile       string
-	SSHKeyPassphrase string
+	SSHHost          string `fig:"ssh-host"`
+	SSHPort          string `fig:"ssh-port"`
+	SSHUser          string `fig:"ssh-user"`
+	SSHPass          string `fig:"ssh-pass"`
+	SSHKeyFile       string `fig:"ssh-key-file"`
+	SSHKeyPassphrase string `fig:"ssh-key-pass"`
 
 	// SSL connection params.
 	SSL string `default:"disable"`

pkg/config/config_test.go

@@ -31,6 +31,8 @@ func TestInit(t *testing.T) {
 		sshPort     string
 		sshUser     string
 		sshPass     string
+		sshKeyFile  string
+		sshKeyPass  string
 	}
 	var tests = []struct {
 		name  string
@@ -102,6 +104,26 @@ func TestInit(t *testing.T) {
 				limit:   50,
 			},
 		},
+		{
+			name:  "realistic example",
+			input: "realistic-ssh-example",
+			want: want{
+				host:       "rds-endpoint.region.rds.amazonaws.com",
+				port:       "5432",
+				dbname:     "database_name",
+				user:       "db_user",
+				pass:       "password",
+				driver:     "postgres",
+				schema:     "schema_name",
+				ssl:        "require",
+				sshHost:    "bastion.host.ip",
+				sshPort:    "22",
+				sshUser:    "ec2-user",
+				sshKeyFile: "/path/to/ssh/key.pem",
+				sshKeyPass: "hiuwiewnc092",
+				limit:      50,
+			},
+		},
 		{
 			name:  "oracle",
 			input: "oracle",
@@ -139,6 +161,14 @@ func TestInit(t *testing.T) {
 			assert.Equal(t, tt.want.sslkey, opts.SSLKey)
 			assert.Equal(t, tt.want.sslpassword, opts.SSLPassword)
 			assert.Equal(t, tt.want.sslrootcert, opts.SSLRootcert)
+
+			// SSH validations.
+			assert.Equal(t, tt.want.sshHost, opts.SSHHost)
+			assert.Equal(t, tt.want.sshPort, opts.SSHPort)
+			assert.Equal(t, tt.want.sshUser, opts.SSHUser)
+			assert.Equal(t, tt.want.sshPass, opts.SSHPass)
+			assert.Equal(t, tt.want.sshPass, opts.SSHPass)
+			assert.Equal(t, tt.want.sshKeyFile, opts.SSHKeyFile)
 		})
 	}
 }