File: builder_test.go

package info (click to toggle)
golang-google-grpc 1.38.0%2Breally1.33.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 7,168 kB
  • sloc: sh: 724; makefile: 76
file content (182 lines) | stat: -rw-r--r-- 6,234 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
// +build go1.13

/*
 *
 * Copyright 2020 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 meshca

import (
	"context"
	"fmt"
	"testing"

	"github.com/golang/protobuf/proto"

	"google.golang.org/grpc"
	"google.golang.org/grpc/connectivity"
	"google.golang.org/grpc/credentials/tls/certprovider"
	configpb "google.golang.org/grpc/credentials/tls/certprovider/meshca/internal/meshca_experimental"
	"google.golang.org/grpc/internal/testutils"
)

func overrideHTTPFuncs() func() {
	// Directly override the functions which are used to read the zone and
	// audience instead of overriding the http.Client.
	origReadZone := readZoneFunc
	readZoneFunc = func(httpDoer) string { return "test-zone" }
	origReadAudience := readAudienceFunc
	readAudienceFunc = func(httpDoer) string { return "test-audience" }
	return func() {
		readZoneFunc = origReadZone
		readAudienceFunc = origReadAudience
	}
}

func (s) TestBuildSameConfig(t *testing.T) {
	defer overrideHTTPFuncs()()

	// We will attempt to create `cnt` number of providers. So we create a
	// channel of the same size here, even though we expect only one ClientConn
	// to be pushed into this channel. This makes sure that even if more than
	// one ClientConn ends up being created, the Build() call does not block.
	const cnt = 5
	ccChan := testutils.NewChannelWithSize(cnt)

	// Override the dial func to dial a dummy MeshCA endpoint, and also push the
	// returned ClientConn on a channel to be inspected by the test.
	origDialFunc := grpcDialFunc
	grpcDialFunc = func(string, ...grpc.DialOption) (*grpc.ClientConn, error) {
		cc, err := grpc.Dial("dummy-meshca-endpoint", grpc.WithInsecure())
		ccChan.Send(cc)
		return cc, err
	}
	defer func() { grpcDialFunc = origDialFunc }()

	// Parse a good config to generate a stable config which will be passed to
	// invocations of Build().
	inputConfig := makeJSONConfig(t, goodConfigFullySpecified)
	builder := newPluginBuilder()
	stableConfig, err := builder.ParseConfig(inputConfig)
	if err != nil {
		t.Fatalf("builder.ParseConfig(%q) failed: %v", inputConfig, err)
	}

	// Create multiple providers with the same config. All these providers must
	// end up sharing the same ClientConn.
	providers := []certprovider.Provider{}
	for i := 0; i < cnt; i++ {
		p := builder.Build(stableConfig, certprovider.Options{})
		if p == nil {
			t.Fatalf("builder.Build(%s) failed: %v", string(stableConfig.Canonical()), err)
		}
		providers = append(providers, p)
	}

	// Make sure only one ClientConn is created.
	ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
	defer cancel()
	val, err := ccChan.Receive(ctx)
	if err != nil {
		t.Fatalf("Failed to create ClientConn: %v", err)
	}
	testCC := val.(*grpc.ClientConn)

	// Attempt to read the second ClientConn should timeout.
	ctx, cancel = context.WithTimeout(context.Background(), defaultTestShortTimeout)
	defer cancel()
	if _, err := ccChan.Receive(ctx); err != context.DeadlineExceeded {
		t.Fatal("Builder created more than one ClientConn")
	}

	for _, p := range providers {
		p.Close()
	}

	for {
		state := testCC.GetState()
		if state == connectivity.Shutdown {
			break
		}
		ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
		defer cancel()
		if !testCC.WaitForStateChange(ctx, state) {
			t.Fatalf("timeout waiting for clientConn state to change from %s", state)
		}
	}
}

func (s) TestBuildDifferentConfig(t *testing.T) {
	defer overrideHTTPFuncs()()

	// We will attempt to create two providers with different configs. So we
	// expect two ClientConns to be pushed on to this channel.
	const cnt = 2
	ccChan := testutils.NewChannelWithSize(cnt)

	// Override the dial func to dial a dummy MeshCA endpoint, and also push the
	// returned ClientConn on a channel to be inspected by the test.
	origDialFunc := grpcDialFunc
	grpcDialFunc = func(string, ...grpc.DialOption) (*grpc.ClientConn, error) {
		cc, err := grpc.Dial("dummy-meshca-endpoint", grpc.WithInsecure())
		ccChan.Send(cc)
		return cc, err
	}
	defer func() { grpcDialFunc = origDialFunc }()

	builder := newPluginBuilder()
	providers := []certprovider.Provider{}
	for i := 0; i < cnt; i++ {
		// Copy the good test config and modify the serverURI to make sure that
		// a new provider is created for the config.
		cfg := proto.Clone(goodConfigFullySpecified).(*configpb.GoogleMeshCaConfig)
		cfg.Server.GrpcServices[0].GetGoogleGrpc().TargetUri = fmt.Sprintf("test-mesh-ca:%d", i)
		inputConfig := makeJSONConfig(t, cfg)
		stableConfig, err := builder.ParseConfig(inputConfig)
		if err != nil {
			t.Fatalf("builder.ParseConfig(%q) failed: %v", inputConfig, err)
		}

		p := builder.Build(stableConfig, certprovider.Options{})
		if p == nil {
			t.Fatalf("builder.Build(%s) failed: %v", string(stableConfig.Canonical()), err)
		}
		providers = append(providers, p)
	}

	// Make sure two ClientConns are created.
	ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
	defer cancel()
	for i := 0; i < cnt; i++ {
		if _, err := ccChan.Receive(ctx); err != nil {
			t.Fatalf("Failed to create ClientConn: %v", err)
		}
	}

	// Close the first provider, and attempt to read key material from the
	// second provider. The call to read key material should timeout, but it
	// should not return certprovider.errProviderClosed.
	providers[0].Close()
	ctx, cancel = context.WithTimeout(context.Background(), defaultTestShortTimeout)
	defer cancel()
	if _, err := providers[1].KeyMaterial(ctx); err != context.DeadlineExceeded {
		t.Fatalf("provider.KeyMaterial(ctx) = %v, want contextDeadlineExceeded", err)
	}

	// Close the second provider to make sure that the leakchecker is happy.
	providers[1].Close()
}