[VOL-5567] Upgrade protos and remove deprecated dependencies
Change-Id: I699f46a8f3f6140431d7e813b6ae48f3db55f45c
Signed-off-by: bseeniva <balaji.seenivasan@radisys.com>
diff --git a/vendor/go.uber.org/mock/gomock/controller.go b/vendor/go.uber.org/mock/gomock/controller.go
new file mode 100644
index 0000000..674c329
--- /dev/null
+++ b/vendor/go.uber.org/mock/gomock/controller.go
@@ -0,0 +1,326 @@
+// Copyright 2010 Google Inc.
+//
+// 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 gomock
+
+import (
+ "context"
+ "fmt"
+ "reflect"
+ "runtime"
+ "sync"
+)
+
+// A TestReporter is something that can be used to report test failures. It
+// is satisfied by the standard library's *testing.T.
+type TestReporter interface {
+ Errorf(format string, args ...any)
+ Fatalf(format string, args ...any)
+}
+
+// TestHelper is a TestReporter that has the Helper method. It is satisfied
+// by the standard library's *testing.T.
+type TestHelper interface {
+ TestReporter
+ Helper()
+}
+
+// cleanuper is used to check if TestHelper also has the `Cleanup` method. A
+// common pattern is to pass in a `*testing.T` to
+// `NewController(t TestReporter)`. In Go 1.14+, `*testing.T` has a cleanup
+// method. This can be utilized to call `Finish()` so the caller of this library
+// does not have to.
+type cleanuper interface {
+ Cleanup(func())
+}
+
+// A Controller represents the top-level control of a mock ecosystem. It
+// defines the scope and lifetime of mock objects, as well as their
+// expectations. It is safe to call Controller's methods from multiple
+// goroutines. Each test should create a new Controller.
+//
+// func TestFoo(t *testing.T) {
+// ctrl := gomock.NewController(t)
+// // ..
+// }
+//
+// func TestBar(t *testing.T) {
+// t.Run("Sub-Test-1", st) {
+// ctrl := gomock.NewController(st)
+// // ..
+// })
+// t.Run("Sub-Test-2", st) {
+// ctrl := gomock.NewController(st)
+// // ..
+// })
+// })
+type Controller struct {
+ // T should only be called within a generated mock. It is not intended to
+ // be used in user code and may be changed in future versions. T is the
+ // TestReporter passed in when creating the Controller via NewController.
+ // If the TestReporter does not implement a TestHelper it will be wrapped
+ // with a nopTestHelper.
+ T TestHelper
+ mu sync.Mutex
+ expectedCalls *callSet
+ finished bool
+}
+
+// NewController returns a new Controller. It is the preferred way to create a Controller.
+//
+// Passing [*testing.T] registers cleanup function to automatically call [Controller.Finish]
+// when the test and all its subtests complete.
+func NewController(t TestReporter, opts ...ControllerOption) *Controller {
+ h, ok := t.(TestHelper)
+ if !ok {
+ h = &nopTestHelper{t}
+ }
+ ctrl := &Controller{
+ T: h,
+ expectedCalls: newCallSet(),
+ }
+ for _, opt := range opts {
+ opt.apply(ctrl)
+ }
+ if c, ok := isCleanuper(ctrl.T); ok {
+ c.Cleanup(func() {
+ ctrl.T.Helper()
+ ctrl.finish(true, nil)
+ })
+ }
+
+ return ctrl
+}
+
+// ControllerOption configures how a Controller should behave.
+type ControllerOption interface {
+ apply(*Controller)
+}
+
+type overridableExpectationsOption struct{}
+
+// WithOverridableExpectations allows for overridable call expectations
+// i.e., subsequent call expectations override existing call expectations
+func WithOverridableExpectations() overridableExpectationsOption {
+ return overridableExpectationsOption{}
+}
+
+func (o overridableExpectationsOption) apply(ctrl *Controller) {
+ ctrl.expectedCalls = newOverridableCallSet()
+}
+
+type cancelReporter struct {
+ t TestHelper
+ cancel func()
+}
+
+func (r *cancelReporter) Errorf(format string, args ...any) {
+ r.t.Errorf(format, args...)
+}
+
+func (r *cancelReporter) Fatalf(format string, args ...any) {
+ defer r.cancel()
+ r.t.Fatalf(format, args...)
+}
+
+func (r *cancelReporter) Helper() {
+ r.t.Helper()
+}
+
+// WithContext returns a new Controller and a Context, which is cancelled on any
+// fatal failure.
+func WithContext(ctx context.Context, t TestReporter) (*Controller, context.Context) {
+ h, ok := t.(TestHelper)
+ if !ok {
+ h = &nopTestHelper{t: t}
+ }
+
+ ctx, cancel := context.WithCancel(ctx)
+ return NewController(&cancelReporter{t: h, cancel: cancel}), ctx
+}
+
+type nopTestHelper struct {
+ t TestReporter
+}
+
+func (h *nopTestHelper) Errorf(format string, args ...any) {
+ h.t.Errorf(format, args...)
+}
+
+func (h *nopTestHelper) Fatalf(format string, args ...any) {
+ h.t.Fatalf(format, args...)
+}
+
+func (h nopTestHelper) Helper() {}
+
+// RecordCall is called by a mock. It should not be called by user code.
+func (ctrl *Controller) RecordCall(receiver any, method string, args ...any) *Call {
+ ctrl.T.Helper()
+
+ recv := reflect.ValueOf(receiver)
+ for i := 0; i < recv.Type().NumMethod(); i++ {
+ if recv.Type().Method(i).Name == method {
+ return ctrl.RecordCallWithMethodType(receiver, method, recv.Method(i).Type(), args...)
+ }
+ }
+ ctrl.T.Fatalf("gomock: failed finding method %s on %T", method, receiver)
+ panic("unreachable")
+}
+
+// RecordCallWithMethodType is called by a mock. It should not be called by user code.
+func (ctrl *Controller) RecordCallWithMethodType(receiver any, method string, methodType reflect.Type, args ...any) *Call {
+ ctrl.T.Helper()
+
+ call := newCall(ctrl.T, receiver, method, methodType, args...)
+
+ ctrl.mu.Lock()
+ defer ctrl.mu.Unlock()
+ ctrl.expectedCalls.Add(call)
+
+ return call
+}
+
+// Call is called by a mock. It should not be called by user code.
+func (ctrl *Controller) Call(receiver any, method string, args ...any) []any {
+ ctrl.T.Helper()
+
+ // Nest this code so we can use defer to make sure the lock is released.
+ actions := func() []func([]any) []any {
+ ctrl.T.Helper()
+ ctrl.mu.Lock()
+ defer ctrl.mu.Unlock()
+
+ expected, err := ctrl.expectedCalls.FindMatch(receiver, method, args)
+ if err != nil {
+ // callerInfo's skip should be updated if the number of calls between the user's test
+ // and this line changes, i.e. this code is wrapped in another anonymous function.
+ // 0 is us, 1 is controller.Call(), 2 is the generated mock, and 3 is the user's test.
+ origin := callerInfo(3)
+ stringArgs := make([]string, len(args))
+ for i, arg := range args {
+ stringArgs[i] = getString(arg)
+ }
+ ctrl.T.Fatalf("Unexpected call to %T.%v(%v) at %s because: %s", receiver, method, stringArgs, origin, err)
+ }
+
+ // Two things happen here:
+ // * the matching call no longer needs to check prerequisite calls,
+ // * and the prerequisite calls are no longer expected, so remove them.
+ preReqCalls := expected.dropPrereqs()
+ for _, preReqCall := range preReqCalls {
+ ctrl.expectedCalls.Remove(preReqCall)
+ }
+
+ actions := expected.call()
+ if expected.exhausted() {
+ ctrl.expectedCalls.Remove(expected)
+ }
+ return actions
+ }()
+
+ var rets []any
+ for _, action := range actions {
+ if r := action(args); r != nil {
+ rets = r
+ }
+ }
+
+ return rets
+}
+
+// Finish checks to see if all the methods that were expected to be called were called.
+// It is not idempotent and therefore can only be invoked once.
+//
+// Note: If you pass a *testing.T into [NewController], you no longer
+// need to call ctrl.Finish() in your test methods.
+func (ctrl *Controller) Finish() {
+ // If we're currently panicking, probably because this is a deferred call.
+ // This must be recovered in the deferred function.
+ err := recover()
+ ctrl.finish(false, err)
+}
+
+// Satisfied returns whether all expected calls bound to this Controller have been satisfied.
+// Calling Finish is then guaranteed to not fail due to missing calls.
+func (ctrl *Controller) Satisfied() bool {
+ ctrl.mu.Lock()
+ defer ctrl.mu.Unlock()
+ return ctrl.expectedCalls.Satisfied()
+}
+
+func (ctrl *Controller) finish(cleanup bool, panicErr any) {
+ ctrl.T.Helper()
+
+ ctrl.mu.Lock()
+ defer ctrl.mu.Unlock()
+
+ if ctrl.finished {
+ if _, ok := isCleanuper(ctrl.T); !ok {
+ ctrl.T.Fatalf("Controller.Finish was called more than once. It has to be called exactly once.")
+ }
+ return
+ }
+ ctrl.finished = true
+
+ // Short-circuit, pass through the panic.
+ if panicErr != nil {
+ panic(panicErr)
+ }
+
+ // Check that all remaining expected calls are satisfied.
+ failures := ctrl.expectedCalls.Failures()
+ for _, call := range failures {
+ ctrl.T.Errorf("missing call(s) to %v", call)
+ }
+ if len(failures) != 0 {
+ if !cleanup {
+ ctrl.T.Fatalf("aborting test due to missing call(s)")
+ return
+ }
+ ctrl.T.Errorf("aborting test due to missing call(s)")
+ }
+}
+
+// callerInfo returns the file:line of the call site. skip is the number
+// of stack frames to skip when reporting. 0 is callerInfo's call site.
+func callerInfo(skip int) string {
+ if _, file, line, ok := runtime.Caller(skip + 1); ok {
+ return fmt.Sprintf("%s:%d", file, line)
+ }
+ return "unknown file"
+}
+
+// isCleanuper checks it if t's base TestReporter has a Cleanup method.
+func isCleanuper(t TestReporter) (cleanuper, bool) {
+ tr := unwrapTestReporter(t)
+ c, ok := tr.(cleanuper)
+ return c, ok
+}
+
+// unwrapTestReporter unwraps TestReporter to the base implementation.
+func unwrapTestReporter(t TestReporter) TestReporter {
+ tr := t
+ switch nt := t.(type) {
+ case *cancelReporter:
+ tr = nt.t
+ if h, check := tr.(*nopTestHelper); check {
+ tr = h.t
+ }
+ case *nopTestHelper:
+ tr = nt.t
+ default:
+ // not wrapped
+ }
+ return tr
+}