github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/test/namespace_extended_opts.go (about)

     1  // Copyright (c) 2020 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package test
    22  
    23  import (
    24  	"errors"
    25  	"fmt"
    26  
    27  	nsproto "github.com/m3db/m3/src/dbnode/generated/proto/namespace"
    28  	"github.com/m3db/m3/src/dbnode/namespace"
    29  	xjson "github.com/m3db/m3/src/x/json"
    30  
    31  	protobuftypes "github.com/gogo/protobuf/types"
    32  )
    33  
    34  // TypeURLPrefix is a type URL prefix for storing in protobuf Any messages.
    35  const TypeURLPrefix = "testm3db.io/"
    36  
    37  type testExtendedOptions struct {
    38  	value string
    39  }
    40  
    41  func (o *testExtendedOptions) Validate() error {
    42  	if o.value == "invalid" {
    43  		return errors.New("invalid ExtendedOptions")
    44  	}
    45  	return nil
    46  }
    47  
    48  func (o *testExtendedOptions) ToProto() (string, *protobuftypes.Struct) {
    49  	extOptsProto := NewTestExtendedOptionsProto(o.value)
    50  	return extOptsProto.Type, extOptsProto.Options
    51  }
    52  
    53  // ConvertToTestExtendedOptions is ExtendedOptsConverter for testExtendedOptions.
    54  func ConvertToTestExtendedOptions(
    55  	opts *protobuftypes.Struct,
    56  ) (namespace.ExtendedOptions, error) {
    57  	value, ok := opts.Fields["value"]
    58  	if !ok {
    59  		return nil, fmt.Errorf("missing field 'value' in %s", opts)
    60  	}
    61  	stringValue := value.GetStringValue()
    62  	if stringValue == "error" {
    63  		return nil, errors.New("test error in converter")
    64  	}
    65  
    66  	return &testExtendedOptions{stringValue}, nil
    67  }
    68  
    69  // NewTestExtendedOptionsProto construct a new protobuf ExtendedOptions message.
    70  func NewTestExtendedOptionsProto(value string) *nsproto.ExtendedOptions {
    71  	options := map[string]*protobuftypes.Value{
    72  		"value": {Kind: &protobuftypes.Value_StringValue{StringValue: value}},
    73  	}
    74  
    75  	return &nsproto.ExtendedOptions{
    76  		Type:    "testExtendedOptions",
    77  		Options: &protobuftypes.Struct{Fields: options},
    78  	}
    79  }
    80  
    81  // NewTestExtendedOptionsJSON returns a json Map for testExtendedOptions.
    82  func NewTestExtendedOptionsJSON(value string) xjson.Map {
    83  	return xjson.Map{
    84  		"type": "testExtendedOptions",
    85  		"options": xjson.Map{
    86  			"value": value,
    87  		},
    88  	}
    89  }