github.com/gogo/protobuf@v1.3.2/plugin/compare/comparetest.go (about)

     1  // Protocol Buffers for Go with Gadgets
     2  //
     3  // Copyright (c) 2013, The GoGo Authors. All rights reserved.
     4  // http://github.com/gogo/protobuf
     5  //
     6  // Redistribution and use in source and binary forms, with or without
     7  // modification, are permitted provided that the following conditions are
     8  // met:
     9  //
    10  //     * Redistributions of source code must retain the above copyright
    11  // notice, this list of conditions and the following disclaimer.
    12  //     * Redistributions in binary form must reproduce the above
    13  // copyright notice, this list of conditions and the following disclaimer
    14  // in the documentation and/or other materials provided with the
    15  // distribution.
    16  //
    17  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    18  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    19  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    20  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    21  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    22  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    23  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    24  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    25  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    26  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    27  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    28  
    29  package compare
    30  
    31  import (
    32  	"github.com/gogo/protobuf/gogoproto"
    33  	"github.com/gogo/protobuf/plugin/testgen"
    34  	"github.com/gogo/protobuf/protoc-gen-gogo/generator"
    35  )
    36  
    37  type test struct {
    38  	*generator.Generator
    39  }
    40  
    41  func NewTest(g *generator.Generator) testgen.TestPlugin {
    42  	return &test{g}
    43  }
    44  
    45  func (p *test) Generate(imports generator.PluginImports, file *generator.FileDescriptor) bool {
    46  	used := false
    47  	randPkg := imports.NewImport("math/rand")
    48  	timePkg := imports.NewImport("time")
    49  	testingPkg := imports.NewImport("testing")
    50  	protoPkg := imports.NewImport("github.com/gogo/protobuf/proto")
    51  	unsafePkg := imports.NewImport("unsafe")
    52  	if !gogoproto.ImportsGoGoProto(file.FileDescriptorProto) {
    53  		protoPkg = imports.NewImport("github.com/golang/protobuf/proto")
    54  	}
    55  	for _, message := range file.Messages() {
    56  		ccTypeName := generator.CamelCaseSlice(message.TypeName())
    57  		if !gogoproto.HasCompare(file.FileDescriptorProto, message.DescriptorProto) {
    58  			continue
    59  		}
    60  		if message.DescriptorProto.GetOptions().GetMapEntry() {
    61  			continue
    62  		}
    63  
    64  		if gogoproto.HasTestGen(file.FileDescriptorProto, message.DescriptorProto) {
    65  			used = true
    66  			hasUnsafe := gogoproto.IsUnsafeMarshaler(file.FileDescriptorProto, message.DescriptorProto) ||
    67  				gogoproto.IsUnsafeUnmarshaler(file.FileDescriptorProto, message.DescriptorProto)
    68  			p.P(`func Test`, ccTypeName, `Compare(t *`, testingPkg.Use(), `.T) {`)
    69  			p.In()
    70  			if hasUnsafe {
    71  				p.P(`var bigendian uint32 = 0x01020304`)
    72  				p.P(`if *(*byte)(`, unsafePkg.Use(), `.Pointer(&bigendian)) == 1 {`)
    73  				p.In()
    74  				p.P(`t.Skip("unsafe does not work on big endian architectures")`)
    75  				p.Out()
    76  				p.P(`}`)
    77  			}
    78  			p.P(`popr := `, randPkg.Use(), `.New(`, randPkg.Use(), `.NewSource(`, timePkg.Use(), `.Now().UnixNano()))`)
    79  			p.P(`p := NewPopulated`, ccTypeName, `(popr, false)`)
    80  			p.P(`dAtA, err := `, protoPkg.Use(), `.Marshal(p)`)
    81  			p.P(`if err != nil {`)
    82  			p.In()
    83  			p.P(`panic(err)`)
    84  			p.Out()
    85  			p.P(`}`)
    86  			p.P(`msg := &`, ccTypeName, `{}`)
    87  			p.P(`if err := `, protoPkg.Use(), `.Unmarshal(dAtA, msg); err != nil {`)
    88  			p.In()
    89  			p.P(`panic(err)`)
    90  			p.Out()
    91  			p.P(`}`)
    92  			p.P(`if c := p.Compare(msg); c != 0 {`)
    93  			p.In()
    94  			p.P(`t.Fatalf("%#v !Compare %#v, since %d", msg, p, c)`)
    95  			p.Out()
    96  			p.P(`}`)
    97  			p.P(`p2 := NewPopulated`, ccTypeName, `(popr, false)`)
    98  			p.P(`c := p.Compare(p2)`)
    99  			p.P(`c2 := p2.Compare(p)`)
   100  			p.P(`if c != (-1 * c2) {`)
   101  			p.In()
   102  			p.P(`t.Errorf("p.Compare(p2) = %d", c)`)
   103  			p.P(`t.Errorf("p2.Compare(p) = %d", c2)`)
   104  			p.P(`t.Errorf("p = %#v", p)`)
   105  			p.P(`t.Errorf("p2 = %#v", p2)`)
   106  			p.Out()
   107  			p.P(`}`)
   108  			p.Out()
   109  			p.P(`}`)
   110  		}
   111  
   112  	}
   113  	return used
   114  }
   115  
   116  func init() {
   117  	testgen.RegisterTestPlugin(NewTest)
   118  }