Remove test-only methods from grpc package.
Move the test-only methods to a new internal package so as to not pollute the godoc, and to prevent people from using them. (Packages named internal or under internal are private, and enforced by the go tool)
This commit is contained in:
49
internal/internal.go
Normal file
49
internal/internal.go
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2016, Google Inc.
|
||||||
|
* All rights reserved.
|
||||||
|
*
|
||||||
|
* Redistribution and use in source and binary forms, with or without
|
||||||
|
* modification, are permitted provided that the following conditions are
|
||||||
|
* met:
|
||||||
|
*
|
||||||
|
* * Redistributions of source code must retain the above copyright
|
||||||
|
* notice, this list of conditions and the following disclaimer.
|
||||||
|
* * Redistributions in binary form must reproduce the above
|
||||||
|
* copyright notice, this list of conditions and the following disclaimer
|
||||||
|
* in the documentation and/or other materials provided with the
|
||||||
|
* distribution.
|
||||||
|
* * Neither the name of Google Inc. nor the names of its
|
||||||
|
* contributors may be used to endorse or promote products derived from
|
||||||
|
* this software without specific prior written permission.
|
||||||
|
*
|
||||||
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Package internal contains gRPC-internal code for testing, to avoid polluting
|
||||||
|
// the godoc of the top-level grpc package.
|
||||||
|
package internal
|
||||||
|
|
||||||
|
// TestingCloseConns closes all existing transports but keeps
|
||||||
|
// grpcServer.lis accepting new connections.
|
||||||
|
//
|
||||||
|
// The provided grpcServer must be of type *grpc.Server. It is untyped
|
||||||
|
// for circular dependency reasons.
|
||||||
|
var TestingCloseConns func(grpcServer interface{})
|
||||||
|
|
||||||
|
// TestingUseHandlerImpl enables the http.Handler-based server implementation.
|
||||||
|
// It must be called before Serve and requires TLS credentials.
|
||||||
|
//
|
||||||
|
// The provided grpcServer must be of type *grpc.Server. It is untyped
|
||||||
|
// for circular dependency reasons.
|
||||||
|
var TestingUseHandlerImpl func(grpcServer interface{})
|
24
server.go
24
server.go
@ -52,6 +52,7 @@ import (
|
|||||||
"google.golang.org/grpc/codes"
|
"google.golang.org/grpc/codes"
|
||||||
"google.golang.org/grpc/credentials"
|
"google.golang.org/grpc/credentials"
|
||||||
"google.golang.org/grpc/grpclog"
|
"google.golang.org/grpc/grpclog"
|
||||||
|
"google.golang.org/grpc/internal"
|
||||||
"google.golang.org/grpc/metadata"
|
"google.golang.org/grpc/metadata"
|
||||||
"google.golang.org/grpc/transport"
|
"google.golang.org/grpc/transport"
|
||||||
)
|
)
|
||||||
@ -705,10 +706,18 @@ func (s *Server) Stop() {
|
|||||||
s.mu.Unlock()
|
s.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestingCloseConns closes all exiting transports but keeps s.lis accepting new
|
func init() {
|
||||||
// connections.
|
internal.TestingCloseConns = func(arg interface{}) {
|
||||||
// This is only for tests and is subject to removal.
|
arg.(*Server).testingCloseConns()
|
||||||
func (s *Server) TestingCloseConns() {
|
}
|
||||||
|
internal.TestingUseHandlerImpl = func(arg interface{}) {
|
||||||
|
arg.(*Server).opts.useHandlerImpl = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// testingCloseConns closes all existing transports but keeps s.lis
|
||||||
|
// accepting new connections.
|
||||||
|
func (s *Server) testingCloseConns() {
|
||||||
s.mu.Lock()
|
s.mu.Lock()
|
||||||
for c := range s.conns {
|
for c := range s.conns {
|
||||||
c.Close()
|
c.Close()
|
||||||
@ -717,13 +726,6 @@ func (s *Server) TestingCloseConns() {
|
|||||||
s.mu.Unlock()
|
s.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestingUseHandlerImpl enables the http.Handler-based server implementation.
|
|
||||||
// It must be called before Serve and requires TLS credentials.
|
|
||||||
// This is only for tests and is subject to removal.
|
|
||||||
func (s *Server) TestingUseHandlerImpl() {
|
|
||||||
s.opts.useHandlerImpl = true
|
|
||||||
}
|
|
||||||
|
|
||||||
// SendHeader sends header metadata. It may be called at most once from a unary
|
// SendHeader sends header metadata. It may be called at most once from a unary
|
||||||
// RPC handler. The ctx is the RPC handler's Context or one derived from it.
|
// RPC handler. The ctx is the RPC handler's Context or one derived from it.
|
||||||
func SendHeader(ctx context.Context, md metadata.MD) error {
|
func SendHeader(ctx context.Context, md metadata.MD) error {
|
||||||
|
@ -62,6 +62,7 @@ import (
|
|||||||
"google.golang.org/grpc/grpclog"
|
"google.golang.org/grpc/grpclog"
|
||||||
"google.golang.org/grpc/health"
|
"google.golang.org/grpc/health"
|
||||||
healthpb "google.golang.org/grpc/health/grpc_health_v1"
|
healthpb "google.golang.org/grpc/health/grpc_health_v1"
|
||||||
|
"google.golang.org/grpc/internal"
|
||||||
"google.golang.org/grpc/metadata"
|
"google.golang.org/grpc/metadata"
|
||||||
"google.golang.org/grpc/peer"
|
"google.golang.org/grpc/peer"
|
||||||
testpb "google.golang.org/grpc/test/grpc_testing"
|
testpb "google.golang.org/grpc/test/grpc_testing"
|
||||||
@ -484,7 +485,7 @@ func (te *test) startServer() {
|
|||||||
s := grpc.NewServer(sopts...)
|
s := grpc.NewServer(sopts...)
|
||||||
te.srv = s
|
te.srv = s
|
||||||
if e.httpHandler {
|
if e.httpHandler {
|
||||||
s.TestingUseHandlerImpl()
|
internal.TestingUseHandlerImpl(s)
|
||||||
}
|
}
|
||||||
if te.healthServer != nil {
|
if te.healthServer != nil {
|
||||||
healthpb.RegisterHealthServer(s, te.healthServer)
|
healthpb.RegisterHealthServer(s, te.healthServer)
|
||||||
@ -958,7 +959,7 @@ func testRetry(t *testing.T, e env) {
|
|||||||
// The server shuts down the network connection to make a
|
// The server shuts down the network connection to make a
|
||||||
// transport error which will be detected by the client side
|
// transport error which will be detected by the client side
|
||||||
// code.
|
// code.
|
||||||
te.srv.TestingCloseConns()
|
internal.TestingCloseConns(te.srv)
|
||||||
wg.Done()
|
wg.Done()
|
||||||
}()
|
}()
|
||||||
// All these RPCs should succeed eventually.
|
// All these RPCs should succeed eventually.
|
||||||
|
Reference in New Issue
Block a user