Add tests and godebug to compare structs
This commit is contained in:
parent
dbd368adf2
commit
64a5e43394
10 changed files with 865 additions and 9 deletions
8
Godeps/Godeps.json
generated
8
Godeps/Godeps.json
generated
|
@ -233,6 +233,14 @@
|
|||
"ImportPath": "github.com/juju/ratelimit",
|
||||
"Rev": "77ed1c8a01217656d2080ad51981f6e99adaa177"
|
||||
},
|
||||
{
|
||||
"ImportPath": "github.com/kylelemons/godebug/diff",
|
||||
"Rev": "d99083b96f422f8fd5a93bc02040acec769e178f"
|
||||
},
|
||||
{
|
||||
"ImportPath": "github.com/kylelemons/godebug/pretty",
|
||||
"Rev": "d99083b96f422f8fd5a93bc02040acec769e178f"
|
||||
},
|
||||
{
|
||||
"ImportPath": "github.com/mailru/easyjson/buffer",
|
||||
"Rev": "d5b7844b561a7bc640052f1b935f7b800330d7e0"
|
||||
|
|
|
@ -37,10 +37,6 @@ const (
|
|||
|
||||
// ReadConfig obtains the configuration defined by the user merged with the defaults.
|
||||
func ReadConfig(conf *api.ConfigMap) config.Configuration {
|
||||
if len(conf.Data) == 0 {
|
||||
return config.NewDefault()
|
||||
}
|
||||
|
||||
errors := make([]int, 0)
|
||||
skipUrls := make([]string, 0)
|
||||
whitelist := make([]string, 0)
|
||||
|
|
|
@ -17,7 +17,6 @@ limitations under the License.
|
|||
package template
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"github.com/kylelemons/godebug/pretty"
|
||||
|
@ -63,17 +62,19 @@ func TestMergeConfigMapToStruct(t *testing.T) {
|
|||
def.Resolver = h
|
||||
|
||||
to := ReadConfig(conf)
|
||||
if !reflect.DeepEqual(def, to) {
|
||||
t.Errorf("expected %v but retuned %v", def, to)
|
||||
if diff := pretty.Compare(to, def); diff != "" {
|
||||
t.Errorf("unexpected diff: (-got +want)\n%s", diff)
|
||||
}
|
||||
|
||||
def = config.NewDefault()
|
||||
def.Resolver = h
|
||||
to = ReadConfig(&api.ConfigMap{})
|
||||
if !reflect.DeepEqual(def, to) {
|
||||
t.Errorf("expected %v but retuned %v", def, to)
|
||||
if diff := pretty.Compare(to, def); diff != "" {
|
||||
t.Errorf("unexpected diff: (-got +want)\n%s", diff)
|
||||
}
|
||||
|
||||
def = config.NewDefault()
|
||||
def.Resolver = h
|
||||
def.WhitelistSourceRange = []string{"1.1.1.1/32"}
|
||||
to = ReadConfig(&api.ConfigMap{
|
||||
Data: map[string]string{
|
||||
|
|
202
vendor/github.com/kylelemons/godebug/LICENSE
generated
vendored
Normal file
202
vendor/github.com/kylelemons/godebug/LICENSE
generated
vendored
Normal file
|
@ -0,0 +1,202 @@
|
|||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
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.
|
186
vendor/github.com/kylelemons/godebug/diff/diff.go
generated
vendored
Normal file
186
vendor/github.com/kylelemons/godebug/diff/diff.go
generated
vendored
Normal file
|
@ -0,0 +1,186 @@
|
|||
// Copyright 2013 Google Inc. All rights reserved.
|
||||
//
|
||||
// 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 diff implements a linewise diff algorithm.
|
||||
package diff
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Chunk represents a piece of the diff. A chunk will not have both added and
|
||||
// deleted lines. Equal lines are always after any added or deleted lines.
|
||||
// A Chunk may or may not have any lines in it, especially for the first or last
|
||||
// chunk in a computation.
|
||||
type Chunk struct {
|
||||
Added []string
|
||||
Deleted []string
|
||||
Equal []string
|
||||
}
|
||||
|
||||
func (c *Chunk) empty() bool {
|
||||
return len(c.Added) == 0 && len(c.Deleted) == 0 && len(c.Equal) == 0
|
||||
}
|
||||
|
||||
// Diff returns a string containing a line-by-line unified diff of the linewise
|
||||
// changes required to make A into B. Each line is prefixed with '+', '-', or
|
||||
// ' ' to indicate if it should be added, removed, or is correct respectively.
|
||||
func Diff(A, B string) string {
|
||||
aLines := strings.Split(A, "\n")
|
||||
bLines := strings.Split(B, "\n")
|
||||
|
||||
chunks := DiffChunks(aLines, bLines)
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
for _, c := range chunks {
|
||||
for _, line := range c.Added {
|
||||
fmt.Fprintf(buf, "+%s\n", line)
|
||||
}
|
||||
for _, line := range c.Deleted {
|
||||
fmt.Fprintf(buf, "-%s\n", line)
|
||||
}
|
||||
for _, line := range c.Equal {
|
||||
fmt.Fprintf(buf, " %s\n", line)
|
||||
}
|
||||
}
|
||||
return strings.TrimRight(buf.String(), "\n")
|
||||
}
|
||||
|
||||
// DiffChunks uses an O(D(N+M)) shortest-edit-script algorithm
|
||||
// to compute the edits required from A to B and returns the
|
||||
// edit chunks.
|
||||
func DiffChunks(a, b []string) []Chunk {
|
||||
// algorithm: http://www.xmailserver.org/diff2.pdf
|
||||
|
||||
// We'll need these quantities a lot.
|
||||
alen, blen := len(a), len(b) // M, N
|
||||
|
||||
// At most, it will require len(a) deletions and len(b) additions
|
||||
// to transform a into b.
|
||||
maxPath := alen + blen // MAX
|
||||
if maxPath == 0 {
|
||||
// degenerate case: two empty lists are the same
|
||||
return nil
|
||||
}
|
||||
|
||||
// Store the endpoint of the path for diagonals.
|
||||
// We store only the a index, because the b index on any diagonal
|
||||
// (which we know during the loop below) is aidx-diag.
|
||||
// endpoint[maxPath] represents the 0 diagonal.
|
||||
//
|
||||
// Stated differently:
|
||||
// endpoint[d] contains the aidx of a furthest reaching path in diagonal d
|
||||
endpoint := make([]int, 2*maxPath+1) // V
|
||||
|
||||
saved := make([][]int, 0, 8) // Vs
|
||||
save := func() {
|
||||
dup := make([]int, len(endpoint))
|
||||
copy(dup, endpoint)
|
||||
saved = append(saved, dup)
|
||||
}
|
||||
|
||||
var editDistance int // D
|
||||
dLoop:
|
||||
for editDistance = 0; editDistance <= maxPath; editDistance++ {
|
||||
// The 0 diag(onal) represents equality of a and b. Each diagonal to
|
||||
// the left is numbered one lower, to the right is one higher, from
|
||||
// -alen to +blen. Negative diagonals favor differences from a,
|
||||
// positive diagonals favor differences from b. The edit distance to a
|
||||
// diagonal d cannot be shorter than d itself.
|
||||
//
|
||||
// The iterations of this loop cover either odds or evens, but not both,
|
||||
// If odd indices are inputs, even indices are outputs and vice versa.
|
||||
for diag := -editDistance; diag <= editDistance; diag += 2 { // k
|
||||
var aidx int // x
|
||||
switch {
|
||||
case diag == -editDistance:
|
||||
// This is a new diagonal; copy from previous iter
|
||||
aidx = endpoint[maxPath-editDistance+1] + 0
|
||||
case diag == editDistance:
|
||||
// This is a new diagonal; copy from previous iter
|
||||
aidx = endpoint[maxPath+editDistance-1] + 1
|
||||
case endpoint[maxPath+diag+1] > endpoint[maxPath+diag-1]:
|
||||
// diagonal d+1 was farther along, so use that
|
||||
aidx = endpoint[maxPath+diag+1] + 0
|
||||
default:
|
||||
// diagonal d-1 was farther (or the same), so use that
|
||||
aidx = endpoint[maxPath+diag-1] + 1
|
||||
}
|
||||
// On diagonal d, we can compute bidx from aidx.
|
||||
bidx := aidx - diag // y
|
||||
// See how far we can go on this diagonal before we find a difference.
|
||||
for aidx < alen && bidx < blen && a[aidx] == b[bidx] {
|
||||
aidx++
|
||||
bidx++
|
||||
}
|
||||
// Store the end of the current edit chain.
|
||||
endpoint[maxPath+diag] = aidx
|
||||
// If we've found the end of both inputs, we're done!
|
||||
if aidx >= alen && bidx >= blen {
|
||||
save() // save the final path
|
||||
break dLoop
|
||||
}
|
||||
}
|
||||
save() // save the current path
|
||||
}
|
||||
if editDistance == 0 {
|
||||
return nil
|
||||
}
|
||||
chunks := make([]Chunk, editDistance+1)
|
||||
|
||||
x, y := alen, blen
|
||||
for d := editDistance; d > 0; d-- {
|
||||
endpoint := saved[d]
|
||||
diag := x - y
|
||||
insert := diag == -d || (diag != d && endpoint[maxPath+diag-1] < endpoint[maxPath+diag+1])
|
||||
|
||||
x1 := endpoint[maxPath+diag]
|
||||
var x0, xM, kk int
|
||||
if insert {
|
||||
kk = diag + 1
|
||||
x0 = endpoint[maxPath+kk]
|
||||
xM = x0
|
||||
} else {
|
||||
kk = diag - 1
|
||||
x0 = endpoint[maxPath+kk]
|
||||
xM = x0 + 1
|
||||
}
|
||||
y0 := x0 - kk
|
||||
|
||||
var c Chunk
|
||||
if insert {
|
||||
c.Added = b[y0:][:1]
|
||||
} else {
|
||||
c.Deleted = a[x0:][:1]
|
||||
}
|
||||
if xM < x1 {
|
||||
c.Equal = a[xM:][:x1-xM]
|
||||
}
|
||||
|
||||
x, y = x0, y0
|
||||
chunks[d] = c
|
||||
}
|
||||
if x > 0 {
|
||||
chunks[0].Equal = a[:x]
|
||||
}
|
||||
if chunks[0].empty() {
|
||||
chunks = chunks[1:]
|
||||
}
|
||||
if len(chunks) == 0 {
|
||||
return nil
|
||||
}
|
||||
return chunks
|
||||
}
|
5
vendor/github.com/kylelemons/godebug/pretty/.gitignore
generated
vendored
Normal file
5
vendor/github.com/kylelemons/godebug/pretty/.gitignore
generated
vendored
Normal file
|
@ -0,0 +1,5 @@
|
|||
*.test
|
||||
*.bench
|
||||
*.golden
|
||||
*.txt
|
||||
*.prof
|
25
vendor/github.com/kylelemons/godebug/pretty/doc.go
generated
vendored
Normal file
25
vendor/github.com/kylelemons/godebug/pretty/doc.go
generated
vendored
Normal file
|
@ -0,0 +1,25 @@
|
|||
// Copyright 2013 Google Inc. All rights reserved.
|
||||
//
|
||||
// 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 pretty pretty-prints Go structures.
|
||||
//
|
||||
// This package uses reflection to examine a Go value and can
|
||||
// print out in a nice, aligned fashion. It supports three
|
||||
// modes (normal, compact, and extended) for advanced use.
|
||||
//
|
||||
// See the Reflect and Print examples for what the output looks like.
|
||||
package pretty
|
||||
|
||||
// TODO:
|
||||
// - Catch cycles
|
152
vendor/github.com/kylelemons/godebug/pretty/public.go
generated
vendored
Normal file
152
vendor/github.com/kylelemons/godebug/pretty/public.go
generated
vendored
Normal file
|
@ -0,0 +1,152 @@
|
|||
// Copyright 2013 Google Inc. All rights reserved.
|
||||
//
|
||||
// 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 pretty
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"reflect"
|
||||
"time"
|
||||
|
||||
"github.com/kylelemons/godebug/diff"
|
||||
)
|
||||
|
||||
// A Config represents optional configuration parameters for formatting.
|
||||
//
|
||||
// Some options, notably ShortList, dramatically increase the overhead
|
||||
// of pretty-printing a value.
|
||||
type Config struct {
|
||||
// Verbosity options
|
||||
Compact bool // One-line output. Overrides Diffable.
|
||||
Diffable bool // Adds extra newlines for more easily diffable output.
|
||||
|
||||
// Field and value options
|
||||
IncludeUnexported bool // Include unexported fields in output
|
||||
PrintStringers bool // Call String on a fmt.Stringer
|
||||
PrintTextMarshalers bool // Call MarshalText on an encoding.TextMarshaler
|
||||
SkipZeroFields bool // Skip struct fields that have a zero value.
|
||||
|
||||
// Output transforms
|
||||
ShortList int // Maximum character length for short lists if nonzero.
|
||||
|
||||
// Type-specific overrides
|
||||
//
|
||||
// Formatter maps a type to a function that will provide a one-line string
|
||||
// representation of the input value. Conceptually:
|
||||
// Formatter[reflect.TypeOf(v)](v) = "v as a string"
|
||||
//
|
||||
// Note that the first argument need not explicitly match the type, it must
|
||||
// merely be callable with it.
|
||||
//
|
||||
// When processing an input value, if its type exists as a key in Formatter:
|
||||
// 1) If the value is nil, no stringification is performed.
|
||||
// This allows overriding of PrintStringers and PrintTextMarshalers.
|
||||
// 2) The value will be called with the input as its only argument.
|
||||
// The function must return a string as its first return value.
|
||||
//
|
||||
// In addition to func literals, two common values for this will be:
|
||||
// fmt.Sprint (function) func Sprint(...interface{}) string
|
||||
// Type.String (method) func (Type) String() string
|
||||
//
|
||||
// Note that neither of these work if the String method is a pointer
|
||||
// method and the input will be provided as a value. In that case,
|
||||
// use a function that calls .String on the formal value parameter.
|
||||
Formatter map[reflect.Type]interface{}
|
||||
}
|
||||
|
||||
// Default Config objects
|
||||
var (
|
||||
// DefaultFormatter is the default set of overrides for stringification.
|
||||
DefaultFormatter = map[reflect.Type]interface{}{
|
||||
reflect.TypeOf(time.Time{}): fmt.Sprint,
|
||||
reflect.TypeOf(net.IP{}): fmt.Sprint,
|
||||
reflect.TypeOf((*error)(nil)).Elem(): fmt.Sprint,
|
||||
}
|
||||
|
||||
// CompareConfig is the default configuration used for Compare.
|
||||
CompareConfig = &Config{
|
||||
Diffable: true,
|
||||
IncludeUnexported: true,
|
||||
Formatter: DefaultFormatter,
|
||||
}
|
||||
|
||||
// DefaultConfig is the default configuration used for all other top-level functions.
|
||||
DefaultConfig = &Config{
|
||||
Formatter: DefaultFormatter,
|
||||
}
|
||||
)
|
||||
|
||||
func (cfg *Config) fprint(buf *bytes.Buffer, vals ...interface{}) {
|
||||
for i, val := range vals {
|
||||
if i > 0 {
|
||||
buf.WriteByte('\n')
|
||||
}
|
||||
cfg.val2node(reflect.ValueOf(val)).WriteTo(buf, "", cfg)
|
||||
}
|
||||
}
|
||||
|
||||
// Print writes the DefaultConfig representation of the given values to standard output.
|
||||
func Print(vals ...interface{}) {
|
||||
DefaultConfig.Print(vals...)
|
||||
}
|
||||
|
||||
// Print writes the configured presentation of the given values to standard output.
|
||||
func (cfg *Config) Print(vals ...interface{}) {
|
||||
fmt.Println(cfg.Sprint(vals...))
|
||||
}
|
||||
|
||||
// Sprint returns a string representation of the given value according to the DefaultConfig.
|
||||
func Sprint(vals ...interface{}) string {
|
||||
return DefaultConfig.Sprint(vals...)
|
||||
}
|
||||
|
||||
// Sprint returns a string representation of the given value according to cfg.
|
||||
func (cfg *Config) Sprint(vals ...interface{}) string {
|
||||
buf := new(bytes.Buffer)
|
||||
cfg.fprint(buf, vals...)
|
||||
return buf.String()
|
||||
}
|
||||
|
||||
// Fprint writes the representation of the given value to the writer according to the DefaultConfig.
|
||||
func Fprint(w io.Writer, vals ...interface{}) (n int64, err error) {
|
||||
return DefaultConfig.Fprint(w, vals...)
|
||||
}
|
||||
|
||||
// Fprint writes the representation of the given value to the writer according to the cfg.
|
||||
func (cfg *Config) Fprint(w io.Writer, vals ...interface{}) (n int64, err error) {
|
||||
buf := new(bytes.Buffer)
|
||||
cfg.fprint(buf, vals...)
|
||||
return buf.WriteTo(w)
|
||||
}
|
||||
|
||||
// Compare returns a string containing a line-by-line unified diff of the
|
||||
// values in got and want, using the CompareConfig.
|
||||
//
|
||||
// Each line in the output is prefixed with '+', '-', or ' ' to indicate if it
|
||||
// should be added to, removed from, or is correct for the "got" value with
|
||||
// respect to the "want" value.
|
||||
func Compare(got, want interface{}) string {
|
||||
return CompareConfig.Compare(got, want)
|
||||
}
|
||||
|
||||
// Compare returns a string containing a line-by-line unified diff of the
|
||||
// values in got and want according to the cfg.
|
||||
func (cfg *Config) Compare(got, want interface{}) string {
|
||||
diffCfg := *cfg
|
||||
diffCfg.Diffable = true
|
||||
return diff.Diff(cfg.Sprint(got), cfg.Sprint(want))
|
||||
}
|
121
vendor/github.com/kylelemons/godebug/pretty/reflect.go
generated
vendored
Normal file
121
vendor/github.com/kylelemons/godebug/pretty/reflect.go
generated
vendored
Normal file
|
@ -0,0 +1,121 @@
|
|||
// Copyright 2013 Google Inc. All rights reserved.
|
||||
//
|
||||
// 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 pretty
|
||||
|
||||
import (
|
||||
"encoding"
|
||||
"fmt"
|
||||
"reflect"
|
||||
"sort"
|
||||
)
|
||||
|
||||
func isZeroVal(val reflect.Value) bool {
|
||||
if !val.CanInterface() {
|
||||
return false
|
||||
}
|
||||
z := reflect.Zero(val.Type()).Interface()
|
||||
return reflect.DeepEqual(val.Interface(), z)
|
||||
}
|
||||
|
||||
func (c *Config) val2node(val reflect.Value) node {
|
||||
// TODO(kevlar): pointer tracking?
|
||||
|
||||
if !val.IsValid() {
|
||||
return rawVal("nil")
|
||||
}
|
||||
|
||||
if val.CanInterface() {
|
||||
v := val.Interface()
|
||||
if formatter, ok := c.Formatter[val.Type()]; ok {
|
||||
if formatter != nil {
|
||||
res := reflect.ValueOf(formatter).Call([]reflect.Value{val})
|
||||
return rawVal(res[0].Interface().(string))
|
||||
}
|
||||
} else {
|
||||
if s, ok := v.(fmt.Stringer); ok && c.PrintStringers {
|
||||
return stringVal(s.String())
|
||||
}
|
||||
if t, ok := v.(encoding.TextMarshaler); ok && c.PrintTextMarshalers {
|
||||
if raw, err := t.MarshalText(); err == nil { // if NOT an error
|
||||
return stringVal(string(raw))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
switch kind := val.Kind(); kind {
|
||||
case reflect.Ptr, reflect.Interface:
|
||||
if val.IsNil() {
|
||||
return rawVal("nil")
|
||||
}
|
||||
return c.val2node(val.Elem())
|
||||
case reflect.String:
|
||||
return stringVal(val.String())
|
||||
case reflect.Slice, reflect.Array:
|
||||
n := list{}
|
||||
length := val.Len()
|
||||
for i := 0; i < length; i++ {
|
||||
n = append(n, c.val2node(val.Index(i)))
|
||||
}
|
||||
return n
|
||||
case reflect.Map:
|
||||
n := keyvals{}
|
||||
keys := val.MapKeys()
|
||||
for _, key := range keys {
|
||||
// TODO(kevlar): Support arbitrary type keys?
|
||||
n = append(n, keyval{compactString(c.val2node(key)), c.val2node(val.MapIndex(key))})
|
||||
}
|
||||
sort.Sort(n)
|
||||
return n
|
||||
case reflect.Struct:
|
||||
n := keyvals{}
|
||||
typ := val.Type()
|
||||
fields := typ.NumField()
|
||||
for i := 0; i < fields; i++ {
|
||||
sf := typ.Field(i)
|
||||
if !c.IncludeUnexported && sf.PkgPath != "" {
|
||||
continue
|
||||
}
|
||||
field := val.Field(i)
|
||||
if c.SkipZeroFields && isZeroVal(field) {
|
||||
continue
|
||||
}
|
||||
n = append(n, keyval{sf.Name, c.val2node(field)})
|
||||
}
|
||||
return n
|
||||
case reflect.Bool:
|
||||
if val.Bool() {
|
||||
return rawVal("true")
|
||||
}
|
||||
return rawVal("false")
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||
return rawVal(fmt.Sprintf("%d", val.Int()))
|
||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||
return rawVal(fmt.Sprintf("%d", val.Uint()))
|
||||
case reflect.Uintptr:
|
||||
return rawVal(fmt.Sprintf("0x%X", val.Uint()))
|
||||
case reflect.Float32, reflect.Float64:
|
||||
return rawVal(fmt.Sprintf("%v", val.Float()))
|
||||
case reflect.Complex64, reflect.Complex128:
|
||||
return rawVal(fmt.Sprintf("%v", val.Complex()))
|
||||
}
|
||||
|
||||
// Fall back to the default %#v if we can
|
||||
if val.CanInterface() {
|
||||
return rawVal(fmt.Sprintf("%#v", val.Interface()))
|
||||
}
|
||||
|
||||
return rawVal(val.String())
|
||||
}
|
160
vendor/github.com/kylelemons/godebug/pretty/structure.go
generated
vendored
Normal file
160
vendor/github.com/kylelemons/godebug/pretty/structure.go
generated
vendored
Normal file
|
@ -0,0 +1,160 @@
|
|||
// Copyright 2013 Google Inc. All rights reserved.
|
||||
//
|
||||
// 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 pretty
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
type node interface {
|
||||
WriteTo(w *bytes.Buffer, indent string, cfg *Config)
|
||||
}
|
||||
|
||||
func compactString(n node) string {
|
||||
switch k := n.(type) {
|
||||
case stringVal:
|
||||
return string(k)
|
||||
case rawVal:
|
||||
return string(k)
|
||||
}
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
n.WriteTo(buf, "", &Config{Compact: true})
|
||||
return buf.String()
|
||||
}
|
||||
|
||||
type stringVal string
|
||||
|
||||
func (str stringVal) WriteTo(w *bytes.Buffer, indent string, cfg *Config) {
|
||||
w.WriteString(strconv.Quote(string(str)))
|
||||
}
|
||||
|
||||
type rawVal string
|
||||
|
||||
func (r rawVal) WriteTo(w *bytes.Buffer, indent string, cfg *Config) {
|
||||
w.WriteString(string(r))
|
||||
}
|
||||
|
||||
type keyval struct {
|
||||
key string
|
||||
val node
|
||||
}
|
||||
|
||||
type keyvals []keyval
|
||||
|
||||
func (l keyvals) Len() int { return len(l) }
|
||||
func (l keyvals) Swap(i, j int) { l[i], l[j] = l[j], l[i] }
|
||||
func (l keyvals) Less(i, j int) bool { return l[i].key < l[j].key }
|
||||
|
||||
func (l keyvals) WriteTo(w *bytes.Buffer, indent string, cfg *Config) {
|
||||
w.WriteByte('{')
|
||||
|
||||
switch {
|
||||
case cfg.Compact:
|
||||
// All on one line:
|
||||
for i, kv := range l {
|
||||
if i > 0 {
|
||||
w.WriteByte(',')
|
||||
}
|
||||
w.WriteString(kv.key)
|
||||
w.WriteByte(':')
|
||||
kv.val.WriteTo(w, indent, cfg)
|
||||
}
|
||||
case cfg.Diffable:
|
||||
w.WriteByte('\n')
|
||||
inner := indent + " "
|
||||
// Each value gets its own line:
|
||||
for _, kv := range l {
|
||||
w.WriteString(inner)
|
||||
w.WriteString(kv.key)
|
||||
w.WriteString(": ")
|
||||
kv.val.WriteTo(w, inner, cfg)
|
||||
w.WriteString(",\n")
|
||||
}
|
||||
w.WriteString(indent)
|
||||
default:
|
||||
keyWidth := 0
|
||||
for _, kv := range l {
|
||||
if kw := len(kv.key); kw > keyWidth {
|
||||
keyWidth = kw
|
||||
}
|
||||
}
|
||||
alignKey := indent + " "
|
||||
alignValue := strings.Repeat(" ", keyWidth)
|
||||
inner := alignKey + alignValue + " "
|
||||
// First and last line shared with bracket:
|
||||
for i, kv := range l {
|
||||
if i > 0 {
|
||||
w.WriteString(",\n")
|
||||
w.WriteString(alignKey)
|
||||
}
|
||||
w.WriteString(kv.key)
|
||||
w.WriteString(": ")
|
||||
w.WriteString(alignValue[len(kv.key):])
|
||||
kv.val.WriteTo(w, inner, cfg)
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteByte('}')
|
||||
}
|
||||
|
||||
type list []node
|
||||
|
||||
func (l list) WriteTo(w *bytes.Buffer, indent string, cfg *Config) {
|
||||
if max := cfg.ShortList; max > 0 {
|
||||
short := compactString(l)
|
||||
if len(short) <= max {
|
||||
w.WriteString(short)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteByte('[')
|
||||
|
||||
switch {
|
||||
case cfg.Compact:
|
||||
// All on one line:
|
||||
for i, v := range l {
|
||||
if i > 0 {
|
||||
w.WriteByte(',')
|
||||
}
|
||||
v.WriteTo(w, indent, cfg)
|
||||
}
|
||||
case cfg.Diffable:
|
||||
w.WriteByte('\n')
|
||||
inner := indent + " "
|
||||
// Each value gets its own line:
|
||||
for _, v := range l {
|
||||
w.WriteString(inner)
|
||||
v.WriteTo(w, inner, cfg)
|
||||
w.WriteString(",\n")
|
||||
}
|
||||
w.WriteString(indent)
|
||||
default:
|
||||
inner := indent + " "
|
||||
// First and last line shared with bracket:
|
||||
for i, v := range l {
|
||||
if i > 0 {
|
||||
w.WriteString(",\n")
|
||||
w.WriteString(inner)
|
||||
}
|
||||
v.WriteTo(w, inner, cfg)
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteByte(']')
|
||||
}
|
Loading…
Reference in a new issue