feat(mongo): Add MongoDB connection support for Boundary CLI PORT (#6069)

* feat(mongo): add mongo for boundary cli

* Fix: remove changes added by mistake during testing

* feat(enos): install MongoDB client (mongosh) in e2e Docker test runtime

* Remove explicit Boundary DB/server startup from target_tcp_connect_mongo_test.go

* Add a full stop and trigger CI

* feat: add mongosh support to boundary connect mongo

* feat: add mongosh support to boundary connect mongo

* feat: add auth-source flag for MongoDB connect command

- Add -auth-source flag with default value 'admin' for root users
- Add BOUNDARY_CONNECT_MONGO_AUTH_SOURCE environment variable support
- Update documentation with new flag and correct mongosh default
- Improve MongoDB test with explicit auth-source parameter
- Fix Docker configuration formatting for better readability

This ensures MongoDB root users authenticate against the admin database
by default while allowing flexibility for custom authentication databases.

* test(e2e): Fixed false positive in Mongo connect test; use UriNetwork and container hostname

* make gen

* fix: Removed unnecessary variable containerName from the MongoDB E2E test

* feat(connect/mongo): Build URI compatible with mongosh and set default authSource

* feat(connect/mongo): use mongosh flags following PostgreSQL pattern

* remove 'connection string' from auth-source usage text

* Update internal/cmd/commands/connect/mongo.go

Co-authored-by: Bharath Gajjala <120367134+bgajjala8@users.noreply.github.com>

* remove 'connection string' from auth-source usage text

* refacotr: replace authSource flag with authenticationDatabase

---------

Co-authored-by: Enbiya <100806254+enbiyagoral@users.noreply.github.com>
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
This commit is contained in:
authored and GitHub committed 2025-10-09 11:13:47 -05:00
1 parent b006c47887
commit 4078838f56
10 files changed
+435 -10

No files matched your search

+51
View File
@@ -360,6 +360,57 @@ func StartMysql(t testing.TB, pool *dockertest.Pool, network *dockertest.Network
}
}
// StartMongo starts a MongoDB database in a docker container.
// Returns information about the container
func StartMongo(t testing.TB, pool *dockertest.Pool, network *dockertest.Network, repository, tag string) *Container {
t.Log("Starting MongoDB database...")
c, err := LoadConfig()
require.NoError(t, err)
err = pool.Client.PullImage(docker.PullImageOptions{
Repository: fmt.Sprintf("%s/%s", c.DockerMirror, repository),
Tag: tag,
}, docker.AuthConfiguration{})
require.NoError(t, err)
networkAlias := "e2emongo"
mongoDb := "e2eboundarydb"
mongoUser := "e2eboundary"
mongoPassword := "e2eboundary"
resource, err := pool.RunWithOptions(&dockertest.RunOptions{
Repository: fmt.Sprintf("%s/%s", c.DockerMirror, repository),
Tag: tag,
Env: []string{
"MONGO_INITDB_ROOT_USERNAME=" + mongoUser,
"MONGO_INITDB_ROOT_PASSWORD=" + mongoPassword,
"MONGO_INITDB_DATABASE=" + mongoDb,
},
ExposedPorts: []string{"27017/tcp"},
Name: networkAlias,
Networks: []*dockertest.Network{network},
})
require.NoError(t, err)
return &Container{
Resource: resource,
UriLocalhost: fmt.Sprintf(
"mongodb://%s:%s@%s/%s?authSource=admin",
mongoUser,
mongoPassword,
resource.GetHostPort("27017/tcp"),
mongoDb,
),
UriNetwork: fmt.Sprintf(
"mongodb://%s:%s@%s:27017/%s?authSource=admin",
mongoUser,
mongoPassword,
networkAlias,
mongoDb,
),
}
}
// StartCassandra starts a Cassandra database in a docker container.
// Returns information about the container
func StartCassandra(t testing.TB, pool *dockertest.Pool, network *dockertest.Network, repository, tag string) *Container {
@@ -0,0 +1,134 @@
// 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"
)
// TestCliTcpTargetConnectMongo uses the boundary cli to connect to a
// target using `connect mongo`
func TestCliTcpTargetConnectMongo(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.StartMongo(t, pool, &network[0], "mongo", "7.0")
require.NotNil(t, c, "MongoDB container should not be nil")
t.Cleanup(func() {
if err := pool.Purge(c.Resource); err != nil {
t.Logf("Failed to purge MongoDB container: %v", err)
}
})
u, err := url.Parse(c.UriNetwork)
require.NoError(t, err, "Failed to parse MongoDB URL")
user, hostname, port, db := u.User.Username(), u.Hostname(), u.Port(), u.Path[1:]
pw, pwSet := u.User.Password()
t.Logf("MongoDB info: user=%s, db=%s, host=%s, port=%s, password-set:%t",
user, db, hostname, port, pwSet)
err = pool.Retry(func() error {
cmd := exec.CommandContext(ctx, "docker", "exec", hostname,
"mongosh", "-u", user, "-p", pw, "--authenticationDatabase", "admin",
"--eval", "db.runCommand('ping')")
return cmd.Run()
})
require.NoError(t, err, "MongoDB 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", "mongo",
"-target-id", targetId,
"-dbname", db,
"-authentication-database", "admin",
)
f, err := pty.Start(cmd)
require.NoError(t, err)
t.Cleanup(func() {
err := f.Close()
require.NoError(t, err)
})
_, err = f.Write([]byte("db.runCommand('ping')\n"))
require.NoError(t, err)
_, err = f.Write([]byte("db.getName()\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("MongoDB session output: %s", output)
require.Contains(t, output, `ok:`, "MongoDB ping command should succeed")
require.Contains(t, output, `1`, "MongoDB ping should return ok: 1")
require.Contains(t, output, db, "Database name should appear in the session")
require.NotContains(t, output, "MongoServerSelectionError", "Should not have connection errors")
t.Log("Successfully connected to MongoDB target")
}