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.

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

chore: improve logging with additional test coverage #1937

Merged
merged 4 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions internal/proxy/proxy.go
Original file line number Diff line number Diff line change
Expand Up @@ -747,6 +747,14 @@ type socketMount struct {
dialOpts []cloudsqlconn.DialOption
}

func networkType(conf *Config, inst InstanceConnConfig) string {
if (conf.UnixSocket == "" && inst.UnixSocket == "" && inst.UnixSocketPath == "") ||
(inst.Addr != "" || inst.Port != 0) {
return "tcp"
}
return "unix"
}

func (c *Client) newSocketMount(ctx context.Context, conf *Config, pc *portConfig, inst InstanceConnConfig) (*socketMount, error) {
var (
// network is one of "tcp" or "unix"
Expand All @@ -765,8 +773,7 @@ func (c *Client) newSocketMount(ctx context.Context, conf *Config, pc *portConfi
// instance)
// use a TCP listener.
// Otherwise, use a Unix socket.
if (conf.UnixSocket == "" && inst.UnixSocket == "" && inst.UnixSocketPath == "") ||
(inst.Addr != "" || inst.Port != 0) {
if networkType(conf, inst) == "tcp" {
network = "tcp"

a := conf.Addr
Expand All @@ -782,8 +789,9 @@ func (c *Client) newSocketMount(ctx context.Context, conf *Config, pc *portConfi
np = pc.nextPort()
default:
version, err := c.dialer.EngineVersion(ctx, inst.Name)
// Exit if the port is not specified for inactive instance
if err != nil {
c.logger.Errorf("could not resolve version for %q: %v", inst.Name, err)
c.logger.Errorf("[%v] could not resolve instance version: %v", inst.Name, err)
return nil, err
enocom marked this conversation as resolved.
Show resolved Hide resolved
enocom marked this conversation as resolved.
Show resolved Hide resolved
}
np = pc.nextDBPort(version)
Expand All @@ -795,19 +803,21 @@ func (c *Client) newSocketMount(ctx context.Context, conf *Config, pc *portConfi

version, err := c.dialer.EngineVersion(ctx, inst.Name)
if err != nil {
c.logger.Errorf("could not resolve version for %q: %v", inst.Name, err)
c.logger.Errorf("[%v] could not resolve instance version: %v", inst.Name, err)
return nil, err
enocom marked this conversation as resolved.
Show resolved Hide resolved
}

address, err = newUnixSocketMount(inst, conf.UnixSocket, strings.HasPrefix(version, "POSTGRES"))
if err != nil {
c.logger.Errorf("[%v] could not mount unix socket %q: %v", inst.Name, conf.UnixSocket, err)
return nil, err
enocom marked this conversation as resolved.
Show resolved Hide resolved
}
}

lc := net.ListenConfig{KeepAlive: 30 * time.Second}
ln, err := lc.Listen(ctx, network, address)
if err != nil {
c.logger.Errorf("[%v] could not listen to address %v: %v", inst.Name, address, err)
return nil, err
}
// Change file permissions to allow access for user, group, and other.
Expand Down
97 changes: 97 additions & 0 deletions internal/proxy/proxy_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ package proxy_test
import (
"context"
"errors"
"fmt"
"io"
"net"
"os"
Expand Down Expand Up @@ -83,6 +84,8 @@ func (f *fakeDialer) EngineVersion(_ context.Context, inst string) (string, erro
return "MYSQL_8_0", nil
case strings.Contains(inst, "sqlserver"):
return "SQLSERVER_2019_STANDARD", nil
case strings.Contains(inst, "fakeserver"):
return "", fmt.Errorf("non existing server")
default:
return "POSTGRES_14", nil
}
Expand Down Expand Up @@ -306,6 +309,17 @@ func TestClientInitialization(t *testing.T) {
filepath.Join(testUnixSocketPathPg),
},
},
{
desc: "with TCP port for non functional instance",
enocom marked this conversation as resolved.
Show resolved Hide resolved
in: &proxy.Config{
Instances: []proxy.InstanceConnConfig{
{Name: "proj:region:fakeserver", Port: 50000},
},
},
wantTCPAddrs: []string{
"127.0.0.1:50000",
},
},
}

for _, tc := range tcs {
Expand Down Expand Up @@ -711,3 +725,86 @@ func TestRunConnectionCheck(t *testing.T) {
}

}

func TestProxyInitializationWithFailedUnixSocket(t *testing.T) {
ctx := context.Background()
testDir, _ := createTempDir(t)
testUnixSocketPath := path.Join(testDir, "db")

tcs := []struct {
desc string
in *proxy.Config
}{
{
desc: "with unix socket for non functional instance",
in: &proxy.Config{
Instances: []proxy.InstanceConnConfig{
{
Name: "proj:region:fakeserver",
UnixSocketPath: testUnixSocketPath,
},
},
},
},
{
desc: "without TCP port or unix socket for non functional instance",
in: &proxy.Config{
Instances: []proxy.InstanceConnConfig{
{Name: "proj:region:fakeserver"},
},
},
},
}
for _, tc := range tcs {
t.Run(tc.desc, func(t *testing.T) {
_, err := proxy.NewClient(ctx, &fakeDialer{}, testLogger, tc.in)
if err == nil {
t.Fatalf("want non nil error, got = %v", err)
}
})
}
}

func TestProxyMultiInstances(t *testing.T) {
ctx := context.Background()
testDir, _ := createTempDir(t)
testUnixSocketPath := path.Join(testDir, "db")

tcs := []struct {
desc string
in *proxy.Config
wantSuccess bool
}{
{
desc: "with tcp socket and unix for non functional instance",
in: &proxy.Config{
Instances: []proxy.InstanceConnConfig{
{
Name: "proj:region:fakeserver",
UnixSocketPath: testUnixSocketPath,
},
{Name: mysql, Port: 3306},
},
},
wantSuccess: false,
},
{
desc: "with two tcp socket instances and conflicting ports",
in: &proxy.Config{
Instances: []proxy.InstanceConnConfig{
{Name: "proj:region:fakeserver", Port: 60000},
{Name: mysql, Port: 60000},
},
},
wantSuccess: false,
},
}
for _, tc := range tcs {
t.Run(tc.desc, func(t *testing.T) {
_, err := proxy.NewClient(ctx, &fakeDialer{}, testLogger, tc.in)
if tc.wantSuccess != (err == nil) {
Copy link
Member

Choose a reason for hiding this comment

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

Could this be:

if tc.wantSuccess && err != nil {
// ...
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the proposed change, if tc.wantSuccess is false (we want NewClient() to fail), the branch will not be executed regardless what the err is. This will miss reporting the failing case when err is nil and we want NewClient() to fail.

t.Fatalf("want return = %v, got = %v", tc.wantSuccess, err == nil)
}
})
}
}
Loading