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
grpc: restrict status codes from control plane (gRFC A54) #5653
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,234 @@ | ||
| /* | ||
| * | ||
| * Copyright 2022 gRPC authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package test | ||
|
|
||
| import ( | ||
| "context" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/balancer" | ||
| "google.golang.org/grpc/balancer/base" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/connectivity" | ||
| "google.golang.org/grpc/internal/balancer/stub" | ||
| iresolver "google.golang.org/grpc/internal/resolver" | ||
| "google.golang.org/grpc/internal/stubserver" | ||
| "google.golang.org/grpc/resolver" | ||
| "google.golang.org/grpc/resolver/manual" | ||
| "google.golang.org/grpc/status" | ||
| testpb "google.golang.org/grpc/test/grpc_testing" | ||
| ) | ||
|
|
||
| func (s) TestConfigSelectorStatusCodes(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| csErr error | ||
| want error | ||
| }{{ | ||
| name: "legal status code", | ||
| csErr: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| want: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| }, { | ||
| name: "illegal status code", | ||
| csErr: status.Errorf(codes.NotFound, "this error is bad"), | ||
| want: status.Errorf(codes.Internal, "this error is bad"), | ||
| }} | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| ss := &stubserver.StubServer{ | ||
| EmptyCallF: func(ctx context.Context, in *testpb.Empty) (*testpb.Empty, error) { | ||
| return &testpb.Empty{}, nil | ||
| }, | ||
| } | ||
| ss.R = manual.NewBuilderWithScheme("confSel") | ||
|
|
||
| if err := ss.Start(nil); err != nil { | ||
| t.Fatalf("Error starting endpoint server: %v", err) | ||
| } | ||
| defer ss.Stop() | ||
|
|
||
| state := iresolver.SetConfigSelector(resolver.State{ | ||
| Addresses: []resolver.Address{{Addr: ss.Address}}, | ||
| ServiceConfig: parseServiceConfig(t, ss.R, "{}"), | ||
| }, funcConfigSelector{ | ||
| f: func(i iresolver.RPCInfo) (*iresolver.RPCConfig, error) { | ||
| return nil, tc.csErr | ||
| }, | ||
| }) | ||
| ss.R.UpdateState(state) // Blocks until config selector is applied | ||
|
|
||
| ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
| defer cancel() | ||
| if _, err := ss.Client.EmptyCall(ctx, &testpb.Empty{}); status.Code(err) != status.Code(tc.want) || !strings.Contains(err.Error(), status.Convert(tc.want).Message()) { | ||
| t.Fatalf("client.EmptyCall(_, _) = _, %v; want _, %v", err, tc.want) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func (s) TestPickerStatusCodes(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| pickerErr error | ||
| want error | ||
| }{{ | ||
| name: "legal status code", | ||
| pickerErr: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| want: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| }, { | ||
| name: "illegal status code", | ||
| pickerErr: status.Errorf(codes.NotFound, "this error is bad"), | ||
| want: status.Errorf(codes.Internal, "this error is bad"), | ||
| }} | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| ss := &stubserver.StubServer{ | ||
| EmptyCallF: func(ctx context.Context, in *testpb.Empty) (*testpb.Empty, error) { | ||
| return &testpb.Empty{}, nil | ||
| }, | ||
| } | ||
|
|
||
| if err := ss.Start(nil); err != nil { | ||
| t.Fatalf("Error starting endpoint server: %v", err) | ||
| } | ||
| defer ss.Stop() | ||
|
|
||
| // Create a stub balancer that creates a picker that always returns | ||
| // an error. | ||
| sbf := stub.BalancerFuncs{ | ||
| UpdateClientConnState: func(d *stub.BalancerData, _ balancer.ClientConnState) error { | ||
| d.ClientConn.UpdateState(balancer.State{ | ||
| ConnectivityState: connectivity.TransientFailure, | ||
| Picker: base.NewErrPicker(tc.pickerErr), | ||
| }) | ||
| return nil | ||
| }, | ||
| } | ||
| stub.Register("testPickerStatusCodesBalancer", sbf) | ||
|
|
||
| ss.NewServiceConfig(`{"loadBalancingConfig": [{"testPickerStatusCodesBalancer":{}}] }`) | ||
|
|
||
| // Make calls until pickerErr is received. | ||
| ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
| defer cancel() | ||
|
|
||
| var lastErr error | ||
| for ctx.Err() == nil { | ||
| if _, lastErr = ss.Client.EmptyCall(ctx, &testpb.Empty{}); status.Code(lastErr) == status.Code(tc.want) && strings.Contains(lastErr.Error(), status.Convert(tc.want).Message()) { | ||
| // Success! | ||
| return | ||
| } | ||
| time.Sleep(time.Millisecond) | ||
| } | ||
|
|
||
| t.Fatalf("client.EmptyCall(_, _) = _, %v; want _, %v", lastErr, tc.want) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func (s) TestCallCredsFromDialOptionsStatusCodes(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| credsErr error | ||
| want error | ||
| }{{ | ||
| name: "legal status code", | ||
| credsErr: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| want: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| }, { | ||
| name: "illegal status code", | ||
| credsErr: status.Errorf(codes.NotFound, "this error is bad"), | ||
| want: status.Errorf(codes.Internal, "this error is bad"), | ||
| }} | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| ss := &stubserver.StubServer{ | ||
| EmptyCallF: func(ctx context.Context, in *testpb.Empty) (*testpb.Empty, error) { | ||
| return &testpb.Empty{}, nil | ||
| }, | ||
| } | ||
|
|
||
| errChan := make(chan error, 1) | ||
| creds := &testPerRPCCredentials{errChan: errChan} | ||
|
|
||
| if err := ss.Start(nil, grpc.WithPerRPCCredentials(creds)); err != nil { | ||
| t.Fatalf("Error starting endpoint server: %v", err) | ||
| } | ||
| defer ss.Stop() | ||
|
|
||
| ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
| defer cancel() | ||
|
|
||
| errChan <- tc.credsErr | ||
|
|
||
| if _, err := ss.Client.EmptyCall(ctx, &testpb.Empty{}); status.Code(err) != status.Code(tc.want) || !strings.Contains(err.Error(), status.Convert(tc.want).Message()) { | ||
| t.Fatalf("client.EmptyCall(_, _) = _, %v; want _, %v", err, tc.want) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func (s) TestCallCredsFromCallOptionsStatusCodes(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| credsErr error | ||
| want error | ||
| }{{ | ||
| name: "legal status code", | ||
| credsErr: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| want: status.Errorf(codes.Unavailable, "this error is fine"), | ||
| }, { | ||
| name: "illegal status code", | ||
| credsErr: status.Errorf(codes.NotFound, "this error is bad"), | ||
| want: status.Errorf(codes.Internal, "this error is bad"), | ||
| }} | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| ss := &stubserver.StubServer{ | ||
| EmptyCallF: func(ctx context.Context, in *testpb.Empty) (*testpb.Empty, error) { | ||
| return &testpb.Empty{}, nil | ||
| }, | ||
| } | ||
|
|
||
| errChan := make(chan error, 1) | ||
| creds := &testPerRPCCredentials{errChan: errChan} | ||
|
|
||
| if err := ss.Start(nil); err != nil { | ||
| t.Fatalf("Error starting endpoint server: %v", err) | ||
| } | ||
| defer ss.Stop() | ||
|
|
||
| ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
| defer cancel() | ||
|
|
||
| errChan <- tc.credsErr | ||
|
|
||
| if _, err := ss.Client.EmptyCall(ctx, &testpb.Empty{}, grpc.PerRPCCredentials(creds)); status.Code(err) != status.Code(tc.want) || !strings.Contains(err.Error(), status.Convert(tc.want).Message()) { | ||
| t.Fatalf("client.EmptyCall(_, _) = _, %v; want _, %v", err, tc.want) | ||
| } | ||
| }) | ||
| } | ||
| } |
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.
I'm a little concerned that we have to do this in multiple places. How can we guarantee that we haven't missed a place (in this PR), or that we don't miss one in the future when we are adding something.
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.
A54 specifies the places that should be covered, and this PR should cover all of them. I've also reached out to Eric about whether other plugins (e.g. compressors and encoders) should be considered.