utils

Documentation

Index

• Variables
• func Base64Encode(data string) string
• func CreateMockEmptyGetResponse() func(ctx context.Context, url string) ([]byte, error)
• func CreateMockGetResponse(response string, err error) func(ctx context.Context, url string) ([]byte, error)
• func GetDefaultConfigDirectory() (string, error)
• func GetTimestamp() int64
• func IntSliceToStringSlice(in []int) (out []string)
• func IsAbsoluteURL(rawURL string) bool
• func IsExitStatusCode(exitCode int, err error) bool
• func IsValidLicenseKeyFormat(licenseKey string) bool
• func IsValidUserAPIKeyFormat(key string) bool
• func LogIfError(err error)
• func LogIfFatal(err error)
• func MakeRange(min, max int) []int
• func MinOf(vars ...int) int
• func Obfuscate(input string) string
• func StdinExists() bool
• func StringInSlice(str string, slice []string) bool
• func StructToMap(item interface{}, fields []string) map[string]interface{}
• type HTTPClient
  • func (c *HTTPClient) Do(req *http.Request) (*http.Response, error)
  • func (c *HTTPClient) Get(ctx context.Context, url string) ([]byte, error)
  • func (c *HTTPClient) Post(ctx context.Context, url string, requestBody []byte) ([]byte, error)
• type HTTPClientInterface
  • func NewHTTPClient(apiKey string) HTTPClientInterface
• type MockHTTPClient
  • func NewMockHTTPClient(mockDoFunc MockHTTPDoFunc) *MockHTTPClient
  • func (c *MockHTTPClient) Do(req *http.Request) (*http.Response, error)
  • func (c *MockHTTPClient) Get(ctx context.Context, url string) ([]byte, error)
• type MockHTTPDoFunc
  • func CreateMockHTTPDoFunc(mockResponse string, statusCode int, err error) MockHTTPDoFunc
• type NRDBClient
• type Retry
  • func NewRetry(maxRetries int, retryDelayMs int, retryFunc func() error) *Retry
  • func (r *Retry) ExecWithRetries(ctx context.Context) *RetryContext
• type RetryContext
  • func (c *RetryContext) MostRecentError() error
• type StructToMapCallback

Variables

var Command = &cobra.Command{
	Use:   "utils",
	Short: "Various utility methods",
}

Command represents the utils command.

var (
	SignalCtx = getSignalContext()
)

Functions

func Base64Encode

func Base64Encode(data string) string

Base64Encode base 64 encodes a string.

func CreateMockEmptyGetResponse

func CreateMockEmptyGetResponse() func(ctx context.Context, url string) ([]byte, error)

func CreateMockGetResponse

func CreateMockGetResponse(response string, err error) func(ctx context.Context, url string) ([]byte, error)

func GetDefaultConfigDirectory

func GetDefaultConfigDirectory() (string, error)

GetDefaultConfigDirectory returns the full path to the .newrelic directory within the user's home directory.

func GetTimestamp

func GetTimestamp() int64

GetTimestamp returns the current epoch timestamp in seconds.

func IntSliceToStringSlice

func IntSliceToStringSlice(in []int) (out []string)

func IsAbsoluteURL

func IsAbsoluteURL(rawURL string) bool

func IsExitStatusCode

func IsExitStatusCode(exitCode int, err error) bool

func IsValidLicenseKeyFormat

func IsValidLicenseKeyFormat(licenseKey string) bool

Returns true if the given license key is valid. A valid license key is 40 characters in length, ends with "NRAL", and has a hexadecimal prefix.

func IsValidUserAPIKeyFormat

func IsValidUserAPIKeyFormat(key string) bool

func LogIfError

func LogIfError(err error)

LogIfError wraps the err nil check to cleanup the code. Logs at Error level

func LogIfFatal

func LogIfFatal(err error)

LogIfFatal wraps the err nil check to cleanup the code. Logs at Fatal level

func MakeRange

func MakeRange(min, max int) []int

MakeRange generates a slice of sequential integers.

func MinOf

func MinOf(vars ...int) int

MinOf returns the minimum int value provided.

func Obfuscate

func Obfuscate(input string) string

Obfuscate receives a string, and replaces everything after the first 8 characters with an asterisk before returning the result.

func StdinExists

func StdinExists() bool

Standard way to check for stdin in most environments (https://stackoverflow.com/questions/22563616/determine-if-stdin-has-data-with-go)

func StringInSlice

func StringInSlice(str string, slice []string) bool

func StructToMap

func StructToMap(item interface{}, fields []string) map[string]interface{}

Types

type HTTPClient

type HTTPClient struct {
	// contains filtered or unexported fields
}

func (*HTTPClient) Do

func (c *HTTPClient) Do(req *http.Request) (*http.Response, error)

func (*HTTPClient) Get

func (c *HTTPClient) Get(ctx context.Context, url string) ([]byte, error)

func (*HTTPClient) Post

func (c *HTTPClient) Post(ctx context.Context, url string, requestBody []byte) ([]byte, error)

type HTTPClientInterface

type HTTPClientInterface interface {
	Get(ctx context.Context, url string) ([]byte, error)
	Post(ctx context.Context, url string, requestBody []byte) ([]byte, error)
	Do(req *http.Request) (*http.Response, error)
}

func NewHTTPClient

func NewHTTPClient(apiKey string) HTTPClientInterface

type MockHTTPClient

type MockHTTPClient struct {
	GetCallCount int
	MockDoFunc   MockHTTPDoFunc
}

func NewMockHTTPClient

func NewMockHTTPClient(mockDoFunc MockHTTPDoFunc) *MockHTTPClient

func (*MockHTTPClient) Do

func (c *MockHTTPClient) Do(req *http.Request) (*http.Response, error)

func (*MockHTTPClient) Get

func (c *MockHTTPClient) Get(ctx context.Context, url string) ([]byte, error)

type MockHTTPDoFunc

type MockHTTPDoFunc func(req *http.Request) (*http.Response, error)

func CreateMockHTTPDoFunc

func CreateMockHTTPDoFunc(mockResponse string, statusCode int, err error) MockHTTPDoFunc

CreateMockHTTPDoFunc is a helper function to create mock responses for the MockHTTPClient. In short, it simulates the http.Client.Do() method.

type NRDBClient

type NRDBClient interface {
	QueryWithContext(context.Context, int, nrdb.NRQL) (*nrdb.NRDBResultContainer, error)
}

type Retry

type Retry struct {
	MaxRetries int

	RetryFunc func() error
	// contains filtered or unexported fields
}

func NewRetry

func NewRetry(maxRetries int, retryDelayMs int, retryFunc func() error) *Retry

func (*Retry) ExecWithRetries

func (r *Retry) ExecWithRetries(ctx context.Context) *RetryContext

type RetryContext

type RetryContext struct {
	RetryCount int
	Errors     []error
	Success    bool
	Canceled   bool
}

func (*RetryContext) MostRecentError

func (c *RetryContext) MostRecentError() error

type StructToMapCallback

type StructToMapCallback func(item interface{}, fields []string) map[string]interface{}