github.com/m3db/m3@v1.5.0/src/dbnode/encoding/proto/corruption_prop_test.go (about)

     1  // +build big
     2  //
     3  // Copyright (c) 2019 Uber Technologies, Inc.
     4  //
     5  // Permission is hereby granted, free of charge, to any person obtaining a copy
     6  // of this software and associated documentation files (the "Software"), to deal
     7  // in the Software without restriction, including without limitation the rights
     8  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     9  // copies of the Software, and to permit persons to whom the Software is
    10  // furnished to do so, subject to the following conditions:
    11  //
    12  // The above copyright notice and this permission notice shall be included in
    13  // all copies or substantial portions of the Software.
    14  //
    15  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    16  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    17  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    18  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    19  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    20  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    21  // THE SOFTWARE.
    22  
    23  package proto
    24  
    25  import (
    26  	"os"
    27  	"testing"
    28  	"time"
    29  
    30  	"github.com/leanovate/gopter"
    31  	"github.com/leanovate/gopter/gen"
    32  	"github.com/leanovate/gopter/prop"
    33  
    34  	"github.com/m3db/m3/src/dbnode/namespace"
    35  	"github.com/m3db/m3/src/dbnode/x/xio"
    36  )
    37  
    38  // TestIteratorHandlesCorruptStreams ensures that the protobuf iterator never panics when reading corrupt streams.
    39  // It determines this by generating many different random bytes streams and ensuring the protobuf iterator can
    40  // attempt to read them without panicing.
    41  func TestIteratorHandlesCorruptStreams(t *testing.T) {
    42  	var (
    43  		parameters = gopter.DefaultTestParameters()
    44  		seed       = time.Now().UnixNano()
    45  		props      = gopter.NewProperties(parameters)
    46  		reporter   = gopter.NewFormatedReporter(true, 160, os.Stdout)
    47  	)
    48  	parameters.MinSuccessfulTests = 1000
    49  	parameters.Rng.Seed(seed)
    50  
    51  	props.Property("Iterator should handle corrupt streams", prop.ForAll(func(input corruptionPropTestInput) (bool, error) {
    52  		r := xio.NewBytesReader64(input.bytes)
    53  		iter := NewIterator(r, namespace.GetTestSchemaDescr(testVLSchema), testEncodingOptions)
    54  		for iter.Next() {
    55  		}
    56  		return true, nil
    57  	}, genIterCorruptionPropTestInput()))
    58  
    59  	if !props.Run(reporter) {
    60  		t.Errorf("failed with initial seed: %d", seed)
    61  	}
    62  }
    63  
    64  func genIterCorruptionPropTestInput() gopter.Gen {
    65  	return gopter.CombineGens(
    66  		gopter.Gen(gen.SliceOfN(1024, gen.UInt8())),
    67  	).Map(func(input []interface{}) corruptionPropTestInput {
    68  		return corruptionPropTestInput{
    69  			bytes: input[0].([]byte),
    70  		}
    71  	})
    72  }
    73  
    74  type corruptionPropTestInput struct {
    75  	bytes []byte
    76  }