mirror of https://github.com/hashicorp/boundary
feat: add MySQL command support PORT (#5891)
* feat: add MySQL command support * Fix MySQL connection according to review feedback * Update internal/cmd/commands/connect/mysql.go Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update internal/cmd/commands/connect/mysql.go Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update internal/cmd/commands/connect/mysql.go Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * feat: add MySQL support to boundary connect * docs: add MySQL to navigation menu Fixes content check error by adding mysql.mdx to docs navigation. MySQL page now appears in Commands > connect section alongside postgres. * Update testing/internal/e2e/tests/base_plus/target_tcp_connect_mysql_test.go Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * test: add containerized MySQL connection test for target functionality * Remove MySQL environment variables from e2e test config * test: move MySQL e2e test from base_plus to base folder * Fix MySQL test to support both MySQL and MariaDB clients * Fix MySQL test to support both MySQL and MariaDB clients * lint cleanup * adding error checks * Make gen * Test case testing * Reverting bad comment * cleaning up extra test file * Add Mysql to runner (#5893) * Adding back correct test file * Removing base plus test file * Removing base plus test file * Revert "Removing base plus test file" This reverts commitpull/5912/headace9cb3e90. * forcing enos docker network name * Revert "forcing enos docker network name" This reverts commit631bdb4a0e. * changing hosts to looks for sql container * fix container name * Adjusting for e2e tests and a bit of cleanup * missed a commented string * Bgajjala mysql e2etest v2 (#5900) * Using Env Vars rather than parsing uri * Comments fix * spacing * Update testing/internal/e2e/tests/base/target_tcp_connect_mysql_test.go * Spacing * Update internal/cmd/commands/connect/mysql.go * adding error checks * Make gen * Update testing/internal/e2e/tests/base/target_tcp_connect_mysql_test.go * Update internal/cmd/commands/connect/mysql.go * Make gen * derving target port from uri * nit * updating test to use url strings * nit: spacing * nit: code organization * nit: code organization Co-authored-by: Enbiya Göral --------- Co-authored-by: Enbiya <menbiyagoral@gmail.com> Co-authored-by: Enbiya Göral <100806254+enbiyagoral@users.noreply.github.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> Co-authored-by: Ryan Derr <54389874+RyanDerr@users.noreply.github.com>
Bharath Gajjala
8 months ago
committed by
GitHub
parent
ca899f4fff
commit
8b8fb28228
@ -0,0 +1,120 @@
|
||||
// Copyright (c) HashiCorp, Inc.
|
||||
// SPDX-License-Identifier: BUSL-1.1
|
||||
|
||||
package connect
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/hashicorp/boundary/api/proxy"
|
||||
"github.com/hashicorp/boundary/internal/cmd/base"
|
||||
"github.com/posener/complete"
|
||||
)
|
||||
|
||||
const (
|
||||
mysqlSynopsis = "Authorize a session against a target and invoke a MySQL client to connect"
|
||||
)
|
||||
|
||||
func mysqlOptions(c *Command, set *base.FlagSets) {
|
||||
f := set.NewFlagSet("MySQL Options")
|
||||
|
||||
f.StringVar(&base.StringVar{
|
||||
Name: "style",
|
||||
Target: &c.flagMySQLStyle,
|
||||
EnvVar: "BOUNDARY_CONNECT_MYSQL_STYLE",
|
||||
Completion: complete.PredictSet("mysql"),
|
||||
Default: "mysql",
|
||||
Usage: `Specifies how the CLI will attempt to invoke a MySQL client. This will also set a suitable default for -exec if a value was not specified. Currently-understood values are "mysql".`,
|
||||
})
|
||||
|
||||
f.StringVar(&base.StringVar{
|
||||
Name: "username",
|
||||
Target: &c.flagUsername,
|
||||
EnvVar: "BOUNDARY_CONNECT_USERNAME",
|
||||
Completion: complete.PredictNothing,
|
||||
Usage: `Specifies the username to pass through to the client. May be overridden by credentials sourced from a credential store.`,
|
||||
})
|
||||
|
||||
f.StringVar(&base.StringVar{
|
||||
Name: "dbname",
|
||||
Target: &c.flagDbname,
|
||||
EnvVar: "BOUNDARY_CONNECT_DBNAME",
|
||||
Completion: complete.PredictNothing,
|
||||
Usage: `Specifies the database name to pass through to the client.`,
|
||||
})
|
||||
}
|
||||
|
||||
type mysqlFlags struct {
|
||||
flagMySQLStyle string
|
||||
}
|
||||
|
||||
func (m *mysqlFlags) defaultExec() string {
|
||||
return strings.ToLower(m.flagMySQLStyle)
|
||||
}
|
||||
|
||||
func (m *mysqlFlags) buildArgs(c *Command, port, ip, _ string, creds proxy.Credentials) (args, envs []string, retCreds proxy.Credentials, retErr error) {
|
||||
var username, password string
|
||||
|
||||
retCreds = creds
|
||||
if len(retCreds.UsernamePassword) > 0 {
|
||||
// Mark credential as consumed so it is not printed to user
|
||||
retCreds.UsernamePassword[0].Consumed = true
|
||||
|
||||
// For now just grab the first username password credential brokered
|
||||
username = retCreds.UsernamePassword[0].Username
|
||||
password = retCreds.UsernamePassword[0].Password
|
||||
}
|
||||
|
||||
switch m.flagMySQLStyle {
|
||||
case "mysql":
|
||||
// Handle password first - defaults-file must be the first argument
|
||||
if password != "" {
|
||||
passfile, err := os.CreateTemp("", "*")
|
||||
if err != nil {
|
||||
return nil, nil, proxy.Credentials{}, fmt.Errorf("Error saving MySQL password to tmp file: %w", err)
|
||||
}
|
||||
c.cleanupFuncs = append(c.cleanupFuncs, func() error {
|
||||
if err := os.Remove(passfile.Name()); err != nil {
|
||||
return fmt.Errorf("Error removing temporary password file; consider removing %s manually: %w", passfile.Name(), err)
|
||||
}
|
||||
return nil
|
||||
})
|
||||
_, err = passfile.Write([]byte("[client]\npassword=" + password))
|
||||
if err != nil {
|
||||
_ = passfile.Close()
|
||||
return nil, nil, proxy.Credentials{}, fmt.Errorf("Error writing password file to %s: %w", passfile.Name(), err)
|
||||
}
|
||||
if err := passfile.Close(); err != nil {
|
||||
return nil, nil, proxy.Credentials{}, fmt.Errorf("Error closing password file after writing to %s: %w", passfile.Name(), err)
|
||||
}
|
||||
// --defaults-file must be the first argument
|
||||
args = append([]string{"--defaults-file=" + passfile.Name()}, args...)
|
||||
|
||||
if c.flagDbname == "" {
|
||||
c.UI.Warn("Credentials are being brokered but no -dbname parameter provided. mysql may misinterpret another parameter as the database name.")
|
||||
}
|
||||
} else {
|
||||
// If no password provided, add -p to prompt for password
|
||||
args = append(args, "-p")
|
||||
}
|
||||
|
||||
if port != "" {
|
||||
args = append(args, "-P", port)
|
||||
}
|
||||
args = append(args, "-h", ip)
|
||||
|
||||
if c.flagDbname != "" {
|
||||
args = append(args, "-D", c.flagDbname)
|
||||
}
|
||||
|
||||
switch {
|
||||
case username != "":
|
||||
args = append(args, "-u", username)
|
||||
case c.flagUsername != "":
|
||||
args = append(args, "-u", c.flagUsername)
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
@ -0,0 +1,127 @@
|
||||
// Copyright (c) HashiCorp, Inc.
|
||||
// SPDX-License-Identifier: BUSL-1.1
|
||||
|
||||
package base_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"io"
|
||||
"net/url"
|
||||
"os/exec"
|
||||
"testing"
|
||||
|
||||
"github.com/creack/pty"
|
||||
"github.com/hashicorp/boundary/internal/target"
|
||||
"github.com/hashicorp/boundary/testing/internal/e2e"
|
||||
"github.com/hashicorp/boundary/testing/internal/e2e/boundary"
|
||||
"github.com/hashicorp/boundary/testing/internal/e2e/infra"
|
||||
"github.com/ory/dockertest/v3"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestCliTcpTargetConnectMysql uses the boundary cli to connect to a
|
||||
// target using `connect mysql`
|
||||
func TestCliTcpTargetConnectMysql(t *testing.T) {
|
||||
e2e.MaybeSkipTest(t)
|
||||
ctx := context.Background()
|
||||
|
||||
pool, err := dockertest.NewPool("")
|
||||
require.NoError(t, err)
|
||||
|
||||
// e2e_cluster network is created by the e2e infra setup
|
||||
network, err := pool.NetworksByName("e2e_cluster")
|
||||
require.NoError(t, err, "Failed to get e2e_cluster network")
|
||||
|
||||
c := infra.StartMysql(t, pool, &network[0], "mysql", "8.0")
|
||||
require.NotNil(t, c, "MySQL container should not be nil")
|
||||
t.Cleanup(func() {
|
||||
if err := pool.Purge(c.Resource); err != nil {
|
||||
t.Logf("Failed to purge MySQL container: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
u, err := url.Parse(c.UriNetwork)
|
||||
require.NoError(t, err, "Failed to parse MySQL URL")
|
||||
|
||||
user, hostname, port, db := u.User.Username(), u.Hostname(), u.Port(), u.Path[1:]
|
||||
pw, pwSet := u.User.Password()
|
||||
t.Logf("MySQL info: user=%s, db=%s, host=%s, port=%s, password-set:%t",
|
||||
user, db, hostname, port, pwSet)
|
||||
|
||||
// Wait for MySQL to be ready
|
||||
err = pool.Retry(func() error {
|
||||
return exec.CommandContext(ctx, "docker", "exec", hostname,
|
||||
"mysql", "-u"+user, "-p"+pw, "-e", "SELECT 1").Run()
|
||||
})
|
||||
require.NoError(t, err, "MySQL container failed to start")
|
||||
|
||||
boundary.AuthenticateAdminCli(t, ctx)
|
||||
|
||||
orgId, err := boundary.CreateOrgCli(t, ctx)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() {
|
||||
ctx := context.Background()
|
||||
boundary.AuthenticateAdminCli(t, ctx)
|
||||
output := e2e.RunCommand(ctx, "boundary", e2e.WithArgs("scopes", "delete", "-id", orgId))
|
||||
require.NoError(t, output.Err, string(output.Stderr))
|
||||
})
|
||||
|
||||
projectId, err := boundary.CreateProjectCli(t, ctx, orgId)
|
||||
require.NoError(t, err)
|
||||
|
||||
targetId, err := boundary.CreateTargetCli(
|
||||
t,
|
||||
ctx,
|
||||
projectId,
|
||||
port,
|
||||
target.WithAddress(hostname),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
storeId, err := boundary.CreateCredentialStoreStaticCli(t, ctx, projectId)
|
||||
require.NoError(t, err)
|
||||
|
||||
credentialId, err := boundary.CreateStaticCredentialPasswordCli(
|
||||
t,
|
||||
ctx,
|
||||
storeId,
|
||||
user,
|
||||
pw,
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = boundary.AddBrokeredCredentialSourceToTargetCli(t, ctx, targetId, credentialId)
|
||||
require.NoError(t, err)
|
||||
|
||||
cmd := exec.CommandContext(ctx,
|
||||
"boundary",
|
||||
"connect", "mysql",
|
||||
"-target-id", targetId,
|
||||
"-dbname", db,
|
||||
)
|
||||
f, err := pty.Start(cmd)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() {
|
||||
err := f.Close()
|
||||
require.NoError(t, err)
|
||||
})
|
||||
|
||||
_, err = f.Write([]byte("SHOW TABLES;\n"))
|
||||
require.NoError(t, err)
|
||||
_, err = f.Write([]byte("SELECT DATABASE();\n"))
|
||||
require.NoError(t, err)
|
||||
_, err = f.Write([]byte("EXIT;\n"))
|
||||
require.NoError(t, err)
|
||||
_, err = f.Write([]byte{4})
|
||||
require.NoError(t, err)
|
||||
|
||||
var buf bytes.Buffer
|
||||
_, _ = io.Copy(&buf, f)
|
||||
|
||||
output := buf.String()
|
||||
t.Logf("MySQL session output: %s", output)
|
||||
|
||||
require.Contains(t, output, "| "+db+" |", "Session did not return expected database query result")
|
||||
t.Log("Successfully connected to MySQL target")
|
||||
}
|
||||
@ -0,0 +1,74 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: connect mysql - Command
|
||||
description: >-
|
||||
The "connect mysql" command performs a target authorization or consumes an existing authorization token, and then launches a proxied MySQL connection.
|
||||
---
|
||||
|
||||
# connect mysql
|
||||
|
||||
Command: `boundary connect mysql`
|
||||
|
||||
The `connect mysql` command authorizes a session against a target and invokes a MySQL client for the connection.
|
||||
The command fills in the local address and port.
|
||||
|
||||
@include 'cmd-connect-env-vars.mdx'
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
The following example shows how to connect to a target with the ID `ttcp_eTcMueUYv` using a MySQL helper:
|
||||
|
||||
```shell-session
|
||||
$ boundary connect mysql -target-id=ttcp_eTcZMueUYv \
|
||||
-dbname=northwind \
|
||||
-username=superuser \
|
||||
-format=table
|
||||
```
|
||||
|
||||
When prompted, you must enter the password for the user, "superuser":
|
||||
|
||||
<CodeBlockConfig hideClipboard>
|
||||
|
||||
```plaintext
|
||||
Enter password:
|
||||
Welcome to the MySQL monitor. Commands end with ; or \g.
|
||||
Your MySQL connection id is 8
|
||||
Server version: 8.0.30 MySQL Community Server - GPL
|
||||
|
||||
Copyright (c) 2000, 2022, Oracle and/or its affiliates.
|
||||
|
||||
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
|
||||
|
||||
mysql>
|
||||
```
|
||||
|
||||
</CodeBlockConfig>
|
||||
|
||||
## Usage
|
||||
|
||||
<CodeBlockConfig hideClipboard>
|
||||
|
||||
```shell-session
|
||||
$ boundary connect mysql [options] [args]
|
||||
```
|
||||
|
||||
</CodeBlockConfig>
|
||||
|
||||
@include 'cmd-connect-command-options.mdx'
|
||||
|
||||
### MySQL options:
|
||||
|
||||
- `-dbname` `(string: "")` - The database name you want to pass through to the client.
|
||||
You can also specify the database name using the **BOUNDARY_CONNECT_DBNAME** environment variable.
|
||||
|
||||
- `-style` `(string: "")` - How the CLI attempts to invoke a MySQL client.
|
||||
This value also sets a suitable default for `-exec`, if you did not specify a value.
|
||||
The default and currently-understood value is `mysql`.
|
||||
You can also specify how the CLI attempts to invoke a MySQL client using the **BOUNDARY_CONNECT_MYSQL_STYLE** environment variable.
|
||||
|
||||
- `-username` `(string: "")` - The username you want to pass through to the client.
|
||||
This value may be overridden by credentials sourced from a credential store.
|
||||
You can also specfiy a username using the **BOUNDARY_CONNECT_USERNAME** environment variable.
|
||||
|
||||
@include 'cmd-option-note.mdx'
|
||||
Loading…
Reference in new issue