github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/integration/resources/common.go (about)

     1  // Copyright (c) 2021  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 resources
    22  
    23  import (
    24  	"time"
    25  
    26  	"github.com/cenkalti/backoff/v3"
    27  	"go.uber.org/zap"
    28  )
    29  
    30  const (
    31  	retryMaxInterval = 5 * time.Second
    32  	retryMaxTime     = 1 * time.Minute
    33  )
    34  
    35  // Retry is a function for retrying an operation in integration tests.
    36  // Exponentially backs off between retries with a max wait of 5 seconds
    37  // Waits up to a minute total for an operation to complete.
    38  func Retry(op func() error) error {
    39  	return RetryWithMaxTime(op, retryMaxTime)
    40  }
    41  
    42  // RetryWithMaxTime is a function for retrying an operation in integration tests.
    43  // Exponentially backs off between retries with a max wait of 5 seconds
    44  // Waits up to the max time provided to complete.
    45  func RetryWithMaxTime(op func() error, maxTime time.Duration) error {
    46  	bo := backoff.NewExponentialBackOff()
    47  	bo.MaxInterval = retryMaxInterval
    48  	bo.MaxElapsedTime = maxTime
    49  	return backoff.Retry(op, bo)
    50  }
    51  
    52  // NewLogger creates a new development zap logger without stacktraces
    53  // to cut down on verbosity.
    54  func NewLogger() (*zap.Logger, error) {
    55  	logCfg := zap.NewDevelopmentConfig()
    56  	logCfg.DisableStacktrace = true
    57  
    58  	return logCfg.Build()
    59  }