mirror of
https://github.com/cloudflare/cloudflared.git
synced 2025-07-28 05:29:57 +00:00
TUN-528: Move cloudflared into a separate repo
This commit is contained in:
Areg Harutyunyan
210
vendor/google.golang.org/grpc/metadata/metadata.go
generated
vendored
Normal file
210
vendor/google.golang.org/grpc/metadata/metadata.go
generated
vendored
Normal file
@@ -0,0 +1,210 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2014 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 metadata define the structure of the metadata supported by gRPC library.
|
||||
// Please refer to https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md
|
||||
// for more information about custom-metadata.
|
||||
package metadata // import "google.golang.org/grpc/metadata"
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"golang.org/x/net/context"
|
||||
)
|
||||
|
||||
// DecodeKeyValue returns k, v, nil.
|
||||
//
|
||||
// Deprecated: use k and v directly instead.
|
||||
func DecodeKeyValue(k, v string) (string, string, error) {
|
||||
return k, v, nil
|
||||
}
|
||||
|
||||
// MD is a mapping from metadata keys to values. Users should use the following
|
||||
// two convenience functions New and Pairs to generate MD.
|
||||
type MD map[string][]string
|
||||
|
||||
// New creates an MD from a given key-value map.
|
||||
//
|
||||
// Only the following ASCII characters are allowed in keys:
|
||||
// - digits: 0-9
|
||||
// - uppercase letters: A-Z (normalized to lower)
|
||||
// - lowercase letters: a-z
|
||||
// - special characters: -_.
|
||||
// Uppercase letters are automatically converted to lowercase.
|
||||
//
|
||||
// Keys beginning with "grpc-" are reserved for grpc-internal use only and may
|
||||
// result in errors if set in metadata.
|
||||
func New(m map[string]string) MD {
|
||||
md := MD{}
|
||||
for k, val := range m {
|
||||
key := strings.ToLower(k)
|
||||
md[key] = append(md[key], val)
|
||||
}
|
||||
return md
|
||||
}
|
||||
|
||||
// Pairs returns an MD formed by the mapping of key, value ...
|
||||
// Pairs panics if len(kv) is odd.
|
||||
//
|
||||
// Only the following ASCII characters are allowed in keys:
|
||||
// - digits: 0-9
|
||||
// - uppercase letters: A-Z (normalized to lower)
|
||||
// - lowercase letters: a-z
|
||||
// - special characters: -_.
|
||||
// Uppercase letters are automatically converted to lowercase.
|
||||
//
|
||||
// Keys beginning with "grpc-" are reserved for grpc-internal use only and may
|
||||
// result in errors if set in metadata.
|
||||
func Pairs(kv ...string) MD {
|
||||
if len(kv)%2 == 1 {
|
||||
panic(fmt.Sprintf("metadata: Pairs got the odd number of input pairs for metadata: %d", len(kv)))
|
||||
}
|
||||
md := MD{}
|
||||
var key string
|
||||
for i, s := range kv {
|
||||
if i%2 == 0 {
|
||||
key = strings.ToLower(s)
|
||||
continue
|
||||
}
|
||||
md[key] = append(md[key], s)
|
||||
}
|
||||
return md
|
||||
}
|
||||
|
||||
// Len returns the number of items in md.
|
||||
func (md MD) Len() int {
|
||||
return len(md)
|
||||
}
|
||||
|
||||
// Copy returns a copy of md.
|
||||
func (md MD) Copy() MD {
|
||||
return Join(md)
|
||||
}
|
||||
|
||||
// Get obtains the values for a given key.
|
||||
func (md MD) Get(k string) []string {
|
||||
k = strings.ToLower(k)
|
||||
return md[k]
|
||||
}
|
||||
|
||||
// Set sets the value of a given key with a slice of values.
|
||||
func (md MD) Set(k string, vals ...string) {
|
||||
if len(vals) == 0 {
|
||||
return
|
||||
}
|
||||
k = strings.ToLower(k)
|
||||
md[k] = vals
|
||||
}
|
||||
|
||||
// Append adds the values to key k, not overwriting what was already stored at that key.
|
||||
func (md MD) Append(k string, vals ...string) {
|
||||
if len(vals) == 0 {
|
||||
return
|
||||
}
|
||||
k = strings.ToLower(k)
|
||||
md[k] = append(md[k], vals...)
|
||||
}
|
||||
|
||||
// Join joins any number of mds into a single MD.
|
||||
// The order of values for each key is determined by the order in which
|
||||
// the mds containing those values are presented to Join.
|
||||
func Join(mds ...MD) MD {
|
||||
out := MD{}
|
||||
for _, md := range mds {
|
||||
for k, v := range md {
|
||||
out[k] = append(out[k], v...)
|
||||
}
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
type mdIncomingKey struct{}
|
||||
type mdOutgoingKey struct{}
|
||||
|
||||
// NewIncomingContext creates a new context with incoming md attached.
|
||||
func NewIncomingContext(ctx context.Context, md MD) context.Context {
|
||||
return context.WithValue(ctx, mdIncomingKey{}, md)
|
||||
}
|
||||
|
||||
// NewOutgoingContext creates a new context with outgoing md attached. If used
|
||||
// in conjunction with AppendToOutgoingContext, NewOutgoingContext will
|
||||
// overwrite any previously-appended metadata.
|
||||
func NewOutgoingContext(ctx context.Context, md MD) context.Context {
|
||||
return context.WithValue(ctx, mdOutgoingKey{}, rawMD{md: md})
|
||||
}
|
||||
|
||||
// AppendToOutgoingContext returns a new context with the provided kv merged
|
||||
// with any existing metadata in the context. Please refer to the
|
||||
// documentation of Pairs for a description of kv.
|
||||
func AppendToOutgoingContext(ctx context.Context, kv ...string) context.Context {
|
||||
if len(kv)%2 == 1 {
|
||||
panic(fmt.Sprintf("metadata: AppendToOutgoingContext got an odd number of input pairs for metadata: %d", len(kv)))
|
||||
}
|
||||
md, _ := ctx.Value(mdOutgoingKey{}).(rawMD)
|
||||
added := make([][]string, len(md.added)+1)
|
||||
copy(added, md.added)
|
||||
added[len(added)-1] = make([]string, len(kv))
|
||||
copy(added[len(added)-1], kv)
|
||||
return context.WithValue(ctx, mdOutgoingKey{}, rawMD{md: md.md, added: added})
|
||||
}
|
||||
|
||||
// FromIncomingContext returns the incoming metadata in ctx if it exists. The
|
||||
// returned MD should not be modified. Writing to it may cause races.
|
||||
// Modification should be made to copies of the returned MD.
|
||||
func FromIncomingContext(ctx context.Context) (md MD, ok bool) {
|
||||
md, ok = ctx.Value(mdIncomingKey{}).(MD)
|
||||
return
|
||||
}
|
||||
|
||||
// FromOutgoingContextRaw returns the un-merged, intermediary contents
|
||||
// of rawMD. Remember to perform strings.ToLower on the keys. The returned
|
||||
// MD should not be modified. Writing to it may cause races. Modification
|
||||
// should be made to copies of the returned MD.
|
||||
//
|
||||
// This is intended for gRPC-internal use ONLY.
|
||||
func FromOutgoingContextRaw(ctx context.Context) (MD, [][]string, bool) {
|
||||
raw, ok := ctx.Value(mdOutgoingKey{}).(rawMD)
|
||||
if !ok {
|
||||
return nil, nil, false
|
||||
}
|
||||
|
||||
return raw.md, raw.added, true
|
||||
}
|
||||
|
||||
// FromOutgoingContext returns the outgoing metadata in ctx if it exists. The
|
||||
// returned MD should not be modified. Writing to it may cause races.
|
||||
// Modification should be made to copies of the returned MD.
|
||||
func FromOutgoingContext(ctx context.Context) (MD, bool) {
|
||||
raw, ok := ctx.Value(mdOutgoingKey{}).(rawMD)
|
||||
if !ok {
|
||||
return nil, false
|
||||
}
|
||||
|
||||
mds := make([]MD, 0, len(raw.added)+1)
|
||||
mds = append(mds, raw.md)
|
||||
for _, vv := range raw.added {
|
||||
mds = append(mds, Pairs(vv...))
|
||||
}
|
||||
return Join(mds...), ok
|
||||
}
|
||||
|
||||
type rawMD struct {
|
||||
md MD
|
||||
added [][]string
|
||||
}
|
||||
251
vendor/google.golang.org/grpc/metadata/metadata_test.go
generated
vendored
Normal file
251
vendor/google.golang.org/grpc/metadata/metadata_test.go
generated
vendored
Normal file
@@ -0,0 +1,251 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2014 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 metadata
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"strconv"
|
||||
"testing"
|
||||
|
||||
"golang.org/x/net/context"
|
||||
)
|
||||
|
||||
func TestPairsMD(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
// input
|
||||
kv []string
|
||||
// output
|
||||
md MD
|
||||
}{
|
||||
{[]string{}, MD{}},
|
||||
{[]string{"k1", "v1", "k1", "v2"}, MD{"k1": []string{"v1", "v2"}}},
|
||||
} {
|
||||
md := Pairs(test.kv...)
|
||||
if !reflect.DeepEqual(md, test.md) {
|
||||
t.Fatalf("Pairs(%v) = %v, want %v", test.kv, md, test.md)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestCopy(t *testing.T) {
|
||||
const key, val = "key", "val"
|
||||
orig := Pairs(key, val)
|
||||
copy := orig.Copy()
|
||||
if !reflect.DeepEqual(orig, copy) {
|
||||
t.Errorf("copied value not equal to the original, got %v, want %v", copy, orig)
|
||||
}
|
||||
orig[key][0] = "foo"
|
||||
if v := copy[key][0]; v != val {
|
||||
t.Errorf("change in original should not affect copy, got %q, want %q", v, val)
|
||||
}
|
||||
}
|
||||
|
||||
func TestJoin(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
mds []MD
|
||||
want MD
|
||||
}{
|
||||
{[]MD{}, MD{}},
|
||||
{[]MD{Pairs("foo", "bar")}, Pairs("foo", "bar")},
|
||||
{[]MD{Pairs("foo", "bar"), Pairs("foo", "baz")}, Pairs("foo", "bar", "foo", "baz")},
|
||||
{[]MD{Pairs("foo", "bar"), Pairs("foo", "baz"), Pairs("zip", "zap")}, Pairs("foo", "bar", "foo", "baz", "zip", "zap")},
|
||||
} {
|
||||
md := Join(test.mds...)
|
||||
if !reflect.DeepEqual(md, test.want) {
|
||||
t.Errorf("context's metadata is %v, want %v", md, test.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestGet(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
md MD
|
||||
key string
|
||||
wantVals []string
|
||||
}{
|
||||
{md: Pairs("My-Optional-Header", "42"), key: "My-Optional-Header", wantVals: []string{"42"}},
|
||||
{md: Pairs("Header", "42", "Header", "43", "Header", "44", "other", "1"), key: "HEADER", wantVals: []string{"42", "43", "44"}},
|
||||
{md: Pairs("HEADER", "10"), key: "HEADER", wantVals: []string{"10"}},
|
||||
} {
|
||||
vals := test.md.Get(test.key)
|
||||
if !reflect.DeepEqual(vals, test.wantVals) {
|
||||
t.Errorf("value of metadata %v is %v, want %v", test.key, vals, test.wantVals)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestSet(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
md MD
|
||||
setKey string
|
||||
setVals []string
|
||||
want MD
|
||||
}{
|
||||
{
|
||||
md: Pairs("My-Optional-Header", "42", "other-key", "999"),
|
||||
setKey: "Other-Key",
|
||||
setVals: []string{"1"},
|
||||
want: Pairs("my-optional-header", "42", "other-key", "1"),
|
||||
},
|
||||
{
|
||||
md: Pairs("My-Optional-Header", "42"),
|
||||
setKey: "Other-Key",
|
||||
setVals: []string{"1", "2", "3"},
|
||||
want: Pairs("my-optional-header", "42", "other-key", "1", "other-key", "2", "other-key", "3"),
|
||||
},
|
||||
{
|
||||
md: Pairs("My-Optional-Header", "42"),
|
||||
setKey: "Other-Key",
|
||||
setVals: []string{},
|
||||
want: Pairs("my-optional-header", "42"),
|
||||
},
|
||||
} {
|
||||
test.md.Set(test.setKey, test.setVals...)
|
||||
if !reflect.DeepEqual(test.md, test.want) {
|
||||
t.Errorf("value of metadata is %v, want %v", test.md, test.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestAppend(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
md MD
|
||||
appendKey string
|
||||
appendVals []string
|
||||
want MD
|
||||
}{
|
||||
{
|
||||
md: Pairs("My-Optional-Header", "42"),
|
||||
appendKey: "Other-Key",
|
||||
appendVals: []string{"1"},
|
||||
want: Pairs("my-optional-header", "42", "other-key", "1"),
|
||||
},
|
||||
{
|
||||
md: Pairs("My-Optional-Header", "42"),
|
||||
appendKey: "my-OptIoNal-HeAder",
|
||||
appendVals: []string{"1", "2", "3"},
|
||||
want: Pairs("my-optional-header", "42", "my-optional-header", "1",
|
||||
"my-optional-header", "2", "my-optional-header", "3"),
|
||||
},
|
||||
{
|
||||
md: Pairs("My-Optional-Header", "42"),
|
||||
appendKey: "my-OptIoNal-HeAder",
|
||||
appendVals: []string{},
|
||||
want: Pairs("my-optional-header", "42"),
|
||||
},
|
||||
} {
|
||||
test.md.Append(test.appendKey, test.appendVals...)
|
||||
if !reflect.DeepEqual(test.md, test.want) {
|
||||
t.Errorf("value of metadata is %v, want %v", test.md, test.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestAppendToOutgoingContext(t *testing.T) {
|
||||
// Pre-existing metadata
|
||||
ctx := NewOutgoingContext(context.Background(), Pairs("k1", "v1", "k2", "v2"))
|
||||
ctx = AppendToOutgoingContext(ctx, "k1", "v3")
|
||||
ctx = AppendToOutgoingContext(ctx, "k1", "v4")
|
||||
md, ok := FromOutgoingContext(ctx)
|
||||
if !ok {
|
||||
t.Errorf("Expected MD to exist in ctx, but got none")
|
||||
}
|
||||
want := Pairs("k1", "v1", "k1", "v3", "k1", "v4", "k2", "v2")
|
||||
if !reflect.DeepEqual(md, want) {
|
||||
t.Errorf("context's metadata is %v, want %v", md, want)
|
||||
}
|
||||
|
||||
// No existing metadata
|
||||
ctx = AppendToOutgoingContext(context.Background(), "k1", "v1")
|
||||
md, ok = FromOutgoingContext(ctx)
|
||||
if !ok {
|
||||
t.Errorf("Expected MD to exist in ctx, but got none")
|
||||
}
|
||||
want = Pairs("k1", "v1")
|
||||
if !reflect.DeepEqual(md, want) {
|
||||
t.Errorf("context's metadata is %v, want %v", md, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAppendToOutgoingContext_Repeated(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
for i := 0; i < 100; i = i + 2 {
|
||||
ctx1 := AppendToOutgoingContext(ctx, "k", strconv.Itoa(i))
|
||||
ctx2 := AppendToOutgoingContext(ctx, "k", strconv.Itoa(i+1))
|
||||
|
||||
md1, _ := FromOutgoingContext(ctx1)
|
||||
md2, _ := FromOutgoingContext(ctx2)
|
||||
|
||||
if reflect.DeepEqual(md1, md2) {
|
||||
t.Fatalf("md1, md2 = %v, %v; should not be equal", md1, md2)
|
||||
}
|
||||
|
||||
ctx = ctx1
|
||||
}
|
||||
}
|
||||
|
||||
func TestAppendToOutgoingContext_FromKVSlice(t *testing.T) {
|
||||
const k, v = "a", "b"
|
||||
kv := []string{k, v}
|
||||
ctx := AppendToOutgoingContext(context.Background(), kv...)
|
||||
md, _ := FromOutgoingContext(ctx)
|
||||
if md[k][0] != v {
|
||||
t.Fatalf("md[%q] = %q; want %q", k, md[k], v)
|
||||
}
|
||||
kv[1] = "xxx"
|
||||
md, _ = FromOutgoingContext(ctx)
|
||||
if md[k][0] != v {
|
||||
t.Fatalf("md[%q] = %q; want %q", k, md[k], v)
|
||||
}
|
||||
}
|
||||
|
||||
// Old/slow approach to adding metadata to context
|
||||
func Benchmark_AddingMetadata_ContextManipulationApproach(b *testing.B) {
|
||||
// TODO: Add in N=1-100 tests once Go1.6 support is removed.
|
||||
const num = 10
|
||||
for n := 0; n < b.N; n++ {
|
||||
ctx := context.Background()
|
||||
for i := 0; i < num; i++ {
|
||||
md, _ := FromOutgoingContext(ctx)
|
||||
NewOutgoingContext(ctx, Join(Pairs("k1", "v1", "k2", "v2"), md))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Newer/faster approach to adding metadata to context
|
||||
func BenchmarkAppendToOutgoingContext(b *testing.B) {
|
||||
const num = 10
|
||||
for n := 0; n < b.N; n++ {
|
||||
ctx := context.Background()
|
||||
for i := 0; i < num; i++ {
|
||||
ctx = AppendToOutgoingContext(ctx, "k1", "v1", "k2", "v2")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkFromOutgoingContext(b *testing.B) {
|
||||
ctx := context.Background()
|
||||
ctx = NewOutgoingContext(ctx, MD{"k3": {"v3", "v4"}})
|
||||
ctx = AppendToOutgoingContext(ctx, "k1", "v1", "k2", "v2")
|
||||
|
||||
for n := 0; n < b.N; n++ {
|
||||
FromOutgoingContext(ctx)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user