[configtls] [config/configgrpc] Use configtls.NewDefaultClientConfig(), configtls.NewDefaultConfig() and configtls.NewDefaultServerConfig() #11638
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -102,11 +102,10 @@ func TestDefaultGrpcClientSettings(t *testing.T) { | |
| tt, err := componenttest.SetupTelemetry(componentID) | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) }) | ||
| clientConfig := configtls.NewDefaultClientConfig() | ||
| clientConfig.Insecure = true | ||
| gcs := &ClientConfig{ | ||
|
There was a problem hiding this comment. In most/all of these first cases, wouldn't you want to use the NewDefaultClientConfig at the outer level, rather than only on the inner TLSSetting? There was a problem hiding this comment.
Thanks for taking a look! This suggested change should be done for all the test cases or only the initial ones? PR includes changes only to migrate to new configtls.NewDefaultClientConfig(). If the community is okay, I am willing to create an issue to track this and create separate PR addressing this. Please share your thoughts. There was a problem hiding this comment. Please ignore my comment if it doesn't match the requirements. I just thought it odd that we'd use one and not the other. I'm new here. :) |
||
| TLSSetting: clientConfig, | ||
| } | ||
| opts, err := gcs.getGrpcDialOptions(context.Background(), componenttest.NewNopHost(), tt.TelemetrySettings(), []ToClientConnOption{}) | ||
| require.NoError(t, err) | ||
|
|
@@ -117,11 +116,10 @@ func TestGrpcClientExtraOption(t *testing.T) { | |
| tt, err := componenttest.SetupTelemetry(componentID) | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) }) | ||
| clientConfig := configtls.NewDefaultClientConfig() | ||
| clientConfig.Insecure = true | ||
| gcs := &ClientConfig{ | ||
| TLSSetting: clientConfig, | ||
| } | ||
| extraOpt := grpc.WithUserAgent("test-agent") | ||
| opts, err := gcs.getGrpcDialOptions( | ||
|
|
@@ -139,7 +137,8 @@ func TestAllGrpcClientSettings(t *testing.T) { | |
| tt, err := componenttest.SetupTelemetry(componentID) | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) }) | ||
| clientConfig := configtls.NewDefaultClientConfig() | ||
| clientConfig.Insecure = false | ||
|
|
||
| tests := []struct { | ||
| settings ClientConfig | ||
| name string | ||
|
|
@@ -153,9 +152,7 @@ func TestAllGrpcClientSettings(t *testing.T) { | |
| }, | ||
| Endpoint: "localhost:1234", | ||
| Compression: configcompression.TypeGzip, | ||
| TLSSetting: clientConfig, | ||
| Keepalive: &KeepaliveClientConfig{ | ||
| Time: time.Second, | ||
| Timeout: time.Second, | ||
|
|
@@ -182,9 +179,7 @@ func TestAllGrpcClientSettings(t *testing.T) { | |
| }, | ||
| Endpoint: "localhost:1234", | ||
| Compression: configcompression.TypeSnappy, | ||
| TLSSetting: clientConfig, | ||
| Keepalive: &KeepaliveClientConfig{ | ||
| Time: time.Second, | ||
| Timeout: time.Second, | ||
|
|
@@ -211,9 +206,7 @@ func TestAllGrpcClientSettings(t *testing.T) { | |
| }, | ||
| Endpoint: "localhost:1234", | ||
| Compression: configcompression.TypeZstd, | ||
| TLSSetting: clientConfig, | ||
| Keepalive: &KeepaliveClientConfig{ | ||
| Time: time.Second, | ||
| Timeout: time.Second, | ||
|
|
@@ -375,15 +368,15 @@ func TestGrpcServerAuthSettings(t *testing.T) { | |
| } | ||
|
|
||
| func TestGrpcClientConfigInvalidBalancer(t *testing.T) { | ||
| clientConfig := configtls.NewDefaultClientConfig() | ||
| clientConfig.Insecure = false | ||
|
There was a problem hiding this comment. Insecure is false by default |
||
| settings := ClientConfig{ | ||
| Headers: map[string]configopaque.String{ | ||
| "test": "test", | ||
| }, | ||
| Endpoint: "localhost:1234", | ||
| Compression: "gzip", | ||
| TLSSetting: clientConfig, | ||
| Keepalive: &KeepaliveClientConfig{ | ||
| Time: time.Second, | ||
| Timeout: time.Second, | ||
|
|
@@ -398,6 +391,15 @@ func TestGrpcClientConfigInvalidBalancer(t *testing.T) { | |
| } | ||
|
|
||
| func TestGRPCClientSettingsError(t *testing.T) { | ||
| clientConfigCADoesntExist := configtls.NewDefaultClientConfig() | ||
| clientConfigCADoesntExist.Config = configtls.Config{ | ||
| CAFile: "/doesnt/exist", | ||
| } | ||
| clientConfigCADoesntExist.Insecure = false | ||
| clientConfigCADoesntExist.ServerName = "" | ||
|
|
||
| clientConfigWithInsecure := configtls.NewDefaultClientConfig() | ||
| clientConfigWithInsecure.Insecure = true | ||
| tests := []struct { | ||
| settings ClientConfig | ||
| err string | ||
|
|
@@ -409,14 +411,8 @@ func TestGRPCClientSettingsError(t *testing.T) { | |
| Headers: nil, | ||
| Endpoint: "", | ||
| Compression: "", | ||
| TLSSetting: clientConfigCADoesntExist, | ||
| Keepalive: nil, | ||
| }, | ||
| }, | ||
| { | ||
|
|
@@ -425,14 +421,8 @@ func TestGRPCClientSettingsError(t *testing.T) { | |
| Headers: nil, | ||
| Endpoint: "", | ||
| Compression: "", | ||
| TLSSetting: clientConfigCADoesntExist, | ||
| Keepalive: nil, | ||
| }, | ||
| }, | ||
| { | ||
|
|
@@ -454,32 +444,26 @@ func TestGRPCClientSettingsError(t *testing.T) { | |
| { | ||
| err: "unsupported compression type \"zlib\"", | ||
| settings: ClientConfig{ | ||
| Endpoint: "localhost:1234", | ||
| TLSSetting: clientConfigWithInsecure, | ||
| Compression: "zlib", | ||
| }, | ||
| host: &mockHost{}, | ||
| }, | ||
| { | ||
| err: "unsupported compression type \"deflate\"", | ||
| settings: ClientConfig{ | ||
| Endpoint: "localhost:1234", | ||
| TLSSetting: clientConfigWithInsecure, | ||
| Compression: "deflate", | ||
| }, | ||
| host: &mockHost{}, | ||
| }, | ||
| { | ||
| err: "unsupported compression type \"bad\"", | ||
| settings: ClientConfig{ | ||
| Endpoint: "localhost:1234", | ||
| TLSSetting: clientConfigWithInsecure, | ||
| Compression: "bad", | ||
| }, | ||
| host: &mockHost{}, | ||
|
|
@@ -504,7 +488,7 @@ func TestUseSecure(t *testing.T) { | |
| Headers: nil, | ||
| Endpoint: "", | ||
| Compression: "", | ||
| TLSSetting: configtls.NewDefaultClientConfig(), | ||
| Keepalive: nil, | ||
| } | ||
| dialOpts, err := gcs.getGrpcDialOptions(context.Background(), componenttest.NewNopHost(), tt.TelemetrySettings(), []ToClientConnOption{}) | ||
|
|
@@ -632,6 +616,22 @@ func TestHttpReception(t *testing.T) { | |
| require.NoError(t, err) | ||
| t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) }) | ||
|
|
||
| clientConfigWithInsecure := configtls.NewDefaultClientConfig() | ||
| clientConfigWithInsecure.Insecure = true | ||
|
|
||
| clientConfigWithCAFile := configtls.NewDefaultClientConfig() | ||
| clientConfigWithCAFile.Config = configtls.Config{ | ||
| CAFile: filepath.Join("testdata", "ca.crt"), | ||
| } | ||
| clientConfigWithCAFile.ServerName = "localhost" | ||
|
|
||
| clientConfigWithCertAndKeyFile := configtls.NewDefaultClientConfig() | ||
| clientConfigWithCertAndKeyFile.Config = configtls.Config{ | ||
| CAFile: filepath.Join("testdata", "ca.crt"), | ||
| CertFile: filepath.Join("testdata", "client.crt"), | ||
| KeyFile: filepath.Join("testdata", "client.key"), | ||
| } | ||
| clientConfigWithCertAndKeyFile.ServerName = "localhost" | ||
| tests := []struct { | ||
| name string | ||
| tlsServerCreds *configtls.ServerConfig | ||
|
|
@@ -641,9 +641,7 @@ func TestHttpReception(t *testing.T) { | |
| { | ||
| name: "noTLS", | ||
| tlsServerCreds: nil, | ||
| tlsClientCreds: &clientConfigWithInsecure, | ||
| }, | ||
| { | ||
| name: "TLS", | ||
|
|
@@ -654,12 +652,7 @@ func TestHttpReception(t *testing.T) { | |
| KeyFile: filepath.Join("testdata", "server.key"), | ||
| }, | ||
| }, | ||
| tlsClientCreds: &clientConfigWithCAFile, | ||
| }, | ||
| { | ||
| name: "NoServerCertificates", | ||
|
|
@@ -668,13 +661,8 @@ func TestHttpReception(t *testing.T) { | |
| CAFile: filepath.Join("testdata", "ca.crt"), | ||
| }, | ||
| }, | ||
| tlsClientCreds: &clientConfigWithCAFile, | ||
| hasError: true, | ||
| }, | ||
| { | ||
| name: "mTLS", | ||
|
|
@@ -686,14 +674,7 @@ func TestHttpReception(t *testing.T) { | |
| }, | ||
| ClientCAFile: filepath.Join("testdata", "ca.crt"), | ||
| }, | ||
| tlsClientCreds: &clientConfigWithCertAndKeyFile, | ||
| }, | ||
| { | ||
| name: "NoClientCertificate", | ||
|
|
@@ -705,13 +686,8 @@ func TestHttpReception(t *testing.T) { | |
| }, | ||
| ClientCAFile: filepath.Join("testdata", "ca.crt"), | ||
| }, | ||
| tlsClientCreds: &clientConfigWithCAFile, | ||
| hasError: true, | ||
| }, | ||
| { | ||
| name: "WrongClientCA", | ||
|
|
@@ -723,15 +699,8 @@ func TestHttpReception(t *testing.T) { | |
| }, | ||
| ClientCAFile: filepath.Join("testdata", "server.crt"), | ||
| }, | ||
| tlsClientCreds: &clientConfigWithCertAndKeyFile, | ||
| hasError: true, | ||
| }, | ||
| } | ||
| // prepare | ||
|
|
@@ -801,12 +770,11 @@ func TestReceiveOnUnixDomainSocket(t *testing.T) { | |
| go func() { | ||
| _ = srv.Serve(ln) | ||
| }() | ||
| clientConfig := configtls.NewDefaultClientConfig() | ||
| clientConfig.Insecure = true | ||
| gcs := &ClientConfig{ | ||
| Endpoint: "unix://" + ln.Addr().String(), | ||
| TLSSetting: clientConfig, | ||
| } | ||
| grpcClientConn, errClient := gcs.ToClientConn(context.Background(), componenttest.NewNopHost(), tt.TelemetrySettings()) | ||
| require.NoError(t, errClient) | ||
|
|
@@ -979,7 +947,8 @@ func TestClientInfoInterceptors(t *testing.T) { | |
| t.Run(tt.name, func(t *testing.T) { | ||
| mock := &grpcTraceServer{} | ||
| var l net.Listener | ||
| clientConfig := configtls.NewDefaultClientConfig() | ||
| clientConfig.Insecure = true | ||
| // prepare the server | ||
| { | ||
| gss := &ServerConfig{ | ||
|
|
@@ -1005,10 +974,8 @@ func TestClientInfoInterceptors(t *testing.T) { | |
| // prepare the client and execute a RPC | ||
| { | ||
| gcs := &ClientConfig{ | ||
| Endpoint: l.Addr().String(), | ||
| TLSSetting: clientConfig, | ||
| } | ||
|
|
||
| tel, err := componenttest.SetupTelemetry(componentID) | ||
|
|
||
Oops, something went wrong.
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.
nit: The term "clientConfig" is highly overloaded in this context, I wonder if it would be better to rename this local "tlsSettings" or something similar.