mock

Documentation

Overview

Package mock provides mock implementations of the featureflags package's interfaces. Both the hand-written testify-based FeatureFlagManager and the moq-generated FeatureFlagManagerMock live here during the testify → moq migration. New test code should prefer FeatureFlagManagerMock.

Index

• type FeatureFlagManagerMock
  • func (mock *FeatureFlagManagerMock) CanUseFeature(ctx context.Context, feature string, evalCtx featureflags.EvaluationContext) (bool, error)
  • func (mock *FeatureFlagManagerMock) CanUseFeatureCalls() []struct{ ... }
  • func (mock *FeatureFlagManagerMock) Close() error
  • func (mock *FeatureFlagManagerMock) CloseCalls() []struct{}
  • func (mock *FeatureFlagManagerMock) GetFloat64Value(ctx context.Context, feature string, defaultValue float64, ...) (float64, error)
  • func (mock *FeatureFlagManagerMock) GetFloat64ValueCalls() []struct{ ... }
  • func (mock *FeatureFlagManagerMock) GetInt64Value(ctx context.Context, feature string, defaultValue int64, ...) (int64, error)
  • func (mock *FeatureFlagManagerMock) GetInt64ValueCalls() []struct{ ... }
  • func (mock *FeatureFlagManagerMock) GetObjectValue(ctx context.Context, feature string, defaultValue any, ...) (any, error)
  • func (mock *FeatureFlagManagerMock) GetObjectValueCalls() []struct{ ... }
  • func (mock *FeatureFlagManagerMock) GetStringValue(ctx context.Context, feature string, defaultValue string, ...) (string, error)
  • func (mock *FeatureFlagManagerMock) GetStringValueCalls() []struct{ ... }

Types

type FeatureFlagManagerMock

type FeatureFlagManagerMock struct {
	// CanUseFeatureFunc mocks the CanUseFeature method.
	CanUseFeatureFunc func(ctx context.Context, feature string, evalCtx featureflags.EvaluationContext) (bool, error)

	// CloseFunc mocks the Close method.
	CloseFunc func() error

	// GetFloat64ValueFunc mocks the GetFloat64Value method.
	GetFloat64ValueFunc func(ctx context.Context, feature string, defaultValue float64, evalCtx featureflags.EvaluationContext) (float64, error)

	// GetInt64ValueFunc mocks the GetInt64Value method.
	GetInt64ValueFunc func(ctx context.Context, feature string, defaultValue int64, evalCtx featureflags.EvaluationContext) (int64, error)

	// GetObjectValueFunc mocks the GetObjectValue method.
	GetObjectValueFunc func(ctx context.Context, feature string, defaultValue any, evalCtx featureflags.EvaluationContext) (any, error)

	// GetStringValueFunc mocks the GetStringValue method.
	GetStringValueFunc func(ctx context.Context, feature string, defaultValue string, evalCtx featureflags.EvaluationContext) (string, error)
	// contains filtered or unexported fields
}

FeatureFlagManagerMock is a mock implementation of featureflags.FeatureFlagManager.

func TestSomethingThatUsesFeatureFlagManager(t *testing.T) {

	// make and configure a mocked featureflags.FeatureFlagManager
	mockedFeatureFlagManager := &FeatureFlagManagerMock{
		CanUseFeatureFunc: func(ctx context.Context, feature string, evalCtx featureflags.EvaluationContext) (bool, error) {
			panic("mock out the CanUseFeature method")
		},
		CloseFunc: func() error {
			panic("mock out the Close method")
		},
		GetFloat64ValueFunc: func(ctx context.Context, feature string, defaultValue float64, evalCtx featureflags.EvaluationContext) (float64, error) {
			panic("mock out the GetFloat64Value method")
		},
		GetInt64ValueFunc: func(ctx context.Context, feature string, defaultValue int64, evalCtx featureflags.EvaluationContext) (int64, error) {
			panic("mock out the GetInt64Value method")
		},
		GetObjectValueFunc: func(ctx context.Context, feature string, defaultValue any, evalCtx featureflags.EvaluationContext) (any, error) {
			panic("mock out the GetObjectValue method")
		},
		GetStringValueFunc: func(ctx context.Context, feature string, defaultValue string, evalCtx featureflags.EvaluationContext) (string, error) {
			panic("mock out the GetStringValue method")
		},
	}

	// use mockedFeatureFlagManager in code that requires featureflags.FeatureFlagManager
	// and then make assertions.

}

func (*FeatureFlagManagerMock) CanUseFeature

func (mock *FeatureFlagManagerMock) CanUseFeature(ctx context.Context, feature string, evalCtx featureflags.EvaluationContext) (bool, error)

CanUseFeature calls CanUseFeatureFunc.

func (*FeatureFlagManagerMock) CanUseFeatureCalls

func (mock *FeatureFlagManagerMock) CanUseFeatureCalls() []struct {
	Ctx     context.Context
	Feature string
	EvalCtx featureflags.EvaluationContext
}

CanUseFeatureCalls gets all the calls that were made to CanUseFeature. Check the length with:

len(mockedFeatureFlagManager.CanUseFeatureCalls())

func (*FeatureFlagManagerMock) Close

func (mock *FeatureFlagManagerMock) Close() error

Close calls CloseFunc.

func (*FeatureFlagManagerMock) CloseCalls

func (mock *FeatureFlagManagerMock) CloseCalls() []struct {
}

CloseCalls gets all the calls that were made to Close. Check the length with:

len(mockedFeatureFlagManager.CloseCalls())

func (*FeatureFlagManagerMock) GetFloat64Value

func (mock *FeatureFlagManagerMock) GetFloat64Value(ctx context.Context, feature string, defaultValue float64, evalCtx featureflags.EvaluationContext) (float64, error)

GetFloat64Value calls GetFloat64ValueFunc.

func (*FeatureFlagManagerMock) GetFloat64ValueCalls

func (mock *FeatureFlagManagerMock) GetFloat64ValueCalls() []struct {
	Ctx          context.Context
	Feature      string
	DefaultValue float64
	EvalCtx      featureflags.EvaluationContext
}

GetFloat64ValueCalls gets all the calls that were made to GetFloat64Value. Check the length with:

len(mockedFeatureFlagManager.GetFloat64ValueCalls())

func (*FeatureFlagManagerMock) GetInt64Value

func (mock *FeatureFlagManagerMock) GetInt64Value(ctx context.Context, feature string, defaultValue int64, evalCtx featureflags.EvaluationContext) (int64, error)

GetInt64Value calls GetInt64ValueFunc.

func (*FeatureFlagManagerMock) GetInt64ValueCalls

func (mock *FeatureFlagManagerMock) GetInt64ValueCalls() []struct {
	Ctx          context.Context
	Feature      string
	DefaultValue int64
	EvalCtx      featureflags.EvaluationContext
}

GetInt64ValueCalls gets all the calls that were made to GetInt64Value. Check the length with:

len(mockedFeatureFlagManager.GetInt64ValueCalls())

func (*FeatureFlagManagerMock) GetObjectValue

func (mock *FeatureFlagManagerMock) GetObjectValue(ctx context.Context, feature string, defaultValue any, evalCtx featureflags.EvaluationContext) (any, error)

GetObjectValue calls GetObjectValueFunc.

func (*FeatureFlagManagerMock) GetObjectValueCalls

func (mock *FeatureFlagManagerMock) GetObjectValueCalls() []struct {
	Ctx          context.Context
	Feature      string
	DefaultValue any
	EvalCtx      featureflags.EvaluationContext
}

GetObjectValueCalls gets all the calls that were made to GetObjectValue. Check the length with:

len(mockedFeatureFlagManager.GetObjectValueCalls())

func (*FeatureFlagManagerMock) GetStringValue

func (mock *FeatureFlagManagerMock) GetStringValue(ctx context.Context, feature string, defaultValue string, evalCtx featureflags.EvaluationContext) (string, error)

GetStringValue calls GetStringValueFunc.

func (*FeatureFlagManagerMock) GetStringValueCalls

func (mock *FeatureFlagManagerMock) GetStringValueCalls() []struct {
	Ctx          context.Context
	Feature      string
	DefaultValue string
	EvalCtx      featureflags.EvaluationContext
}

GetStringValueCalls gets all the calls that were made to GetStringValue. Check the length with:

len(mockedFeatureFlagManager.GetStringValueCalls())