go.uber.org/yarpc@v1.72.1/x/yarpctest/core.go (about)

     1  // Copyright (c) 2022 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 yarpctest
    22  
    23  import (
    24  	"fmt"
    25  	"testing"
    26  
    27  	"github.com/stretchr/testify/assert"
    28  	"go.uber.org/multierr"
    29  	"go.uber.org/yarpc/x/yarpctest/api"
    30  )
    31  
    32  // Action is the interface for applying actions (Requests) in tests.
    33  type Action api.Action
    34  
    35  // Lifecycle is the interface for creating/starting/stopping lifecycles
    36  // (Services) in tests.
    37  type Lifecycle api.Lifecycle
    38  
    39  // Lifecycles is a wrapper around a list of Lifecycle definitions.
    40  func Lifecycles(l ...api.Lifecycle) api.Lifecycle {
    41  	return lifecycles(l)
    42  }
    43  
    44  type lifecycles []api.Lifecycle
    45  
    46  // Start the lifecycles. If there are any errors, stop any started lifecycles
    47  // and fail the test.
    48  func (ls lifecycles) Start(t testing.TB) error {
    49  	startedLifecycles := make(lifecycles, 0, len(ls))
    50  	for _, l := range ls {
    51  		err := l.Start(t)
    52  		if !assert.NoError(t, err) {
    53  			// Cleanup started lifecycles (this could fail)
    54  			return multierr.Append(err, startedLifecycles.Stop(t))
    55  		}
    56  		startedLifecycles = append(startedLifecycles, l)
    57  	}
    58  	return nil
    59  }
    60  
    61  // Stop the lifecycles. Record all errors. If any lifecycle failed to stop
    62  // fail the test.
    63  func (ls lifecycles) Stop(t testing.TB) error {
    64  	var err error
    65  	for _, l := range ls {
    66  		err = multierr.Append(err, l.Stop(t))
    67  	}
    68  	assert.NoError(t, err)
    69  	return err
    70  }
    71  
    72  // Actions will wrap a list of actions in a sequential executor.
    73  func Actions(actions ...api.Action) api.Action {
    74  	return multi(actions)
    75  }
    76  
    77  type multi []api.Action
    78  
    79  func (m multi) Run(t testing.TB) {
    80  	for i, req := range m {
    81  		api.Run(fmt.Sprintf("Action #%d", i), t, req.Run)
    82  	}
    83  }