go.temporal.io/server@v1.23.0/common/testing/temporalapi/public_methods.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2022 Temporal Technologies Inc.  All rights reserved.
     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 temporalapi
    24  
    25  import (
    26  	"reflect"
    27  	"regexp"
    28  )
    29  
    30  var publicMethodRgx = regexp.MustCompile("^[A-Z]")
    31  
    32  // WalkExportedMethods calls the provided callback on each method declared as public on the
    33  // specified object.
    34  // This prevents the `mustEmbedUnimplementedFooBarBaz` method required by the GRPC v2
    35  // gateway from polluting our tests.
    36  func WalkExportedMethods(obj any, cb func(reflect.Method)) {
    37  	v := reflect.ValueOf(obj)
    38  	if !v.IsValid() {
    39  		return
    40  	}
    41  
    42  	t := v.Type()
    43  	if t.Kind() == reflect.Pointer {
    44  		t = t.Elem()
    45  	}
    46  	for i := 0; i < t.NumMethod(); i++ {
    47  		if publicMethodRgx.MatchString(t.Method(i).Name) {
    48  			cb(t.Method(i))
    49  		}
    50  	}
    51  }