plugintestutils

type EqualityCheckValues struct {
	Expected any
	Actual   any
}

type LinkChangeStagingTestCase[
	ResourceAServiceConfig any,
	ResourceAService any,
	ResourceBServiceConfig any,
	ResourceBService any,
] struct {
	// The name of the test case used for errors and debugging.
	Name string
	// ServiceFactoryA is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context
	// for the first resource (resource A).
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	//
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for AWS services
	// and the `Service` type parameter could be a `lambda.Service` interface that implements
	// API methods for the AWS Lambda service.
	// The `ServiceConfigStore` type parameter would be an optional store
	ServiceFactoryA pluginutils.ServiceFactory[ResourceAServiceConfig, ResourceAService]
	// ServiceFactoryB is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context
	// for the second resource (resource B).
	//
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for
	// AWS services and the `Service` type parameter could be a `lambda.Service`
	// interface that implements API methods for the AWS Lambda service.
	ServiceFactoryB pluginutils.ServiceFactory[ResourceBServiceConfig, ResourceBService]
	// ConfigStoreA is a store that generates service-specific configuration
	// for the service factory to create an instance of the service
	// for the first resource (resource A).
	// This could be something like a cache for `*aws.Config` for AWS services
	// based on a session ID.
	// This is only needed if your service factory requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStoreA pluginutils.ServiceConfigStore[ResourceAServiceConfig]
	// ConfigStoreB is a store that generates service-specific configuration
	// for the service factory to create an instance of the service
	// for the second resource (resource B).
	ConfigStoreB pluginutils.ServiceConfigStore[ResourceBServiceConfig]
	// Input for the link stage changing operation.
	Input *provider.LinkStageChangesInput
	// Expected output from the link stage changing operation.
	ExpectedOutput *provider.LinkStageChangesOutput
	// If true, the test case expects an error to be returned.
	ExpectError bool
	// The expected error message if an error is expected.
	// This doesn't have to be an exact match, the error message
	// just needs to contain the provided string.
	ExpectedErrorMessage string
}

type LinkUpdateIntermediaryResourcesTestCase[
	ResourceAServiceConfig any,
	ResourceAService any,
	ResourceBServiceConfig any,
	ResourceBService any,
] struct {
	// The name of the test case used for errors and debugging.
	Name string
	// ServiceFactoryA is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context
	// for the first resource (resource A).
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	//
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for AWS services
	// and the `Service` type parameter could be a `lambda.Service` interface that implements
	// API methods for the AWS Lambda service.
	// The `ServiceConfigStore` type parameter would be an optional store
	ServiceFactoryA pluginutils.ServiceFactory[ResourceAServiceConfig, ResourceAService]
	// ServiceFactoryB is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context
	// for the second resource (resource B).
	//
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for
	// AWS services and the `Service` type parameter could be a `lambda.Service`
	// interface that implements API methods for the AWS Lambda service.
	ServiceFactoryB pluginutils.ServiceFactory[ResourceBServiceConfig, ResourceBService]
	// ConfigStoreA is a store that generates service-specific configuration
	// for the service factory to create an instance of the service
	// for the first resource (resource A).
	// This could be something like a cache for `*aws.Config` for AWS services
	// based on a session ID.
	// This is only needed if the service factory for resource A requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStoreA pluginutils.ServiceConfigStore[ResourceAServiceConfig]
	// ConfigStoreB is a store that generates service-specific configuration
	// for the service factory to create an instance of the service
	// for the second resource (resource B).
	// This is only needed if the service factory for resource B requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStoreB pluginutils.ServiceConfigStore[ResourceBServiceConfig]
	// IntermediariesServiceMockCalls is a mock calls tracker that is expected to be embedded
	// into a mock implementation of the service interface for carrying out
	// the update operation via the provider service APIs for intermediary resources.
	//
	// This is optional and only needs to be set if the test case
	// uses mocks instead of a real service.
	IntermediariesServiceMockCalls *MockCalls
	// Input for the link intermediary resources update operation.
	Input *provider.LinkUpdateIntermediaryResourcesInput
	// Expected output from the link intermediary resources update operation.
	ExpectedOutput *provider.LinkUpdateIntermediaryResourcesOutput
	// ExpectedOutputMatcher is a function that takes the actual output
	// from the `UpdateIntermediaryResources` method and returns a prepared actual
	// value along with the expected value to be used in an equality check.
	ExpectedOutputMatcher func(
		actual *provider.LinkUpdateIntermediaryResourcesOutput,
	) (EqualityCheckValues, error)
	// ExtraAssertions is an optional function that is called after the output of
	// the operation successfully matches the expected output or matcher.
	// This is useful for adding additional assertions, such as checking
	// the persisted state of intermediary resources in the upstream service
	// for integration tests.
	ExtraAssertions func(
		ctx context.Context,
		suite *suite.Suite,
		output *provider.LinkUpdateIntermediaryResourcesOutput,
	)
	// UpdateActionsCalled is a mapping of method name to the
	// expected second argument for the method.
	// When the value is a slice of any, it is expected that the method
	// is called multiple times with different arguments in the provided order.
	// This will usually be something like a `*Input` or `*Request` struct
	// that service library functions take after a context argument.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `IntermediariesServiceMockCalls` is set).
	UpdateActionsCalled map[string]any
	// UpdateActionsNotCalled is a list of method names
	// that are not expected to be called as a part
	// of the update operation.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `IntermediariesServiceMockCalls` is set).
	UpdateActionsNotCalled []string
	// If true, the test case expects an error to be returned.
	ExpectError bool
	// The expected error message if an error is expected.
	// This doesn't have to be an exact match, the error message
	// just needs to contain the provided string.
	ExpectedErrorMessage string
	// Cleanup is a function that is called after the test case has run.
	// This is used to clean up intermediary resources that were created for the link test case.
	// This is useful for integration tests with real services where the resource
	// needs to be cleaned up after the test case has run regardless of whether
	// the test case passes or fails.
	Cleanup func(
		ctx context.Context,
		failed bool,
		output *provider.LinkUpdateIntermediaryResourcesOutput,
	) error
}

type LinkUpdateResource string

type LinkUpdateResourceTestCase[
	ResourceAServiceConfig any,
	ResourceAService any,
	ResourceBServiceConfig any,
	ResourceBService any,
] struct {
	// The name of the test case used for errors and debugging.
	Name string
	// ServiceFactoryA is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context
	// for the first resource (resource A).
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	//
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for AWS services
	// and the `Service` type parameter could be a `lambda.Service` interface that implements
	// API methods for the AWS Lambda service.
	// The `ServiceConfigStore` type parameter would be an optional store
	ServiceFactoryA pluginutils.ServiceFactory[ResourceAServiceConfig, ResourceAService]
	// ServiceFactoryB is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context
	// for the second resource (resource B).
	//
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for
	// AWS services and the `Service` type parameter could be a `lambda.Service`
	// interface that implements API methods for the AWS Lambda service.
	ServiceFactoryB pluginutils.ServiceFactory[ResourceBServiceConfig, ResourceBService]
	// ConfigStoreA is a store that generates service-specific configuration
	// for the service factory to create an instance of the service
	// for the first resource (resource A).
	// This could be something like a cache for `*aws.Config` for AWS services
	// based on a session ID.
	// This is only needed if the service factory for resource A requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStoreA pluginutils.ServiceConfigStore[ResourceAServiceConfig]
	// ConfigStoreB is a store that generates service-specific configuration
	// for the service factory to create an instance of the service
	// for the second resource (resource B).
	// This is only needed if the service factory for resource B requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStoreB pluginutils.ServiceConfigStore[ResourceBServiceConfig]
	// CurrentServiceMockCalls is a mock calls tracker that is expected to be embedded
	// into a mock implementation of the service interface for carrying out
	// the update operation via the provider service APIs for the resource
	// under test.
	//
	// This is optional and only needs to be set if the test case
	// uses mocks instead of a real service.
	CurrentServiceMockCalls *MockCalls
	// Input for the link resource update operation.
	Input *provider.LinkUpdateResourceInput
	// Expected output from the link resource update operation.
	ExpectedOutput *provider.LinkUpdateResourceOutput
	// ExpectedOutputMatcher is a function that takes the actual output
	// from the `UpdateResource(A|B)` method and returns a prepared actual
	// value along with the expected value to be used in an equality check.
	ExpectedOutputMatcher func(
		actual *provider.LinkUpdateResourceOutput,
	) (EqualityCheckValues, error)
	// ExtraAssertions is an optional function that is called after the output of
	// the operation successfully matches the expected output or matcher.
	// This is useful for adding additional assertions, such as checking
	// the persisted state of the resource in the upstream service for integration tests.
	ExtraAssertions func(
		ctx context.Context,
		suite *suite.Suite,
		output *provider.LinkUpdateResourceOutput,
	)
	// Resource defines the resource in the link relationship that should be updated.
	Resource LinkUpdateResource
	// UpdateActionsCalled is a mapping of method name to the
	// expected second argument for the method.
	// When the value is a slice of any, it is expected that the method
	// is called multiple times with different arguments in the provided order.
	// This will usually be something like a `*Input` or `*Request` struct
	// that service library functions take after a context argument.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `CurrentServiceMockCalls` is set).
	UpdateActionsCalled map[string]any
	// UpdateActionsNotCalled is a list of method names
	// that are not expected to be called as a part
	// of the update operation.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `CurrentServiceMockCalls` is set).
	UpdateActionsNotCalled []string
	// If true, the test case expects an error to be returned.
	ExpectError bool
	// The expected error message if an error is expected.
	// This doesn't have to be an exact match, the error message
	// just needs to contain the provided string.
	ExpectedErrorMessage string
	// Cleanup is a function that is called after the test case has run.
	// This is used to clean up resources that were created for the link test case.
	// This is useful for integration tests with real services where the resource
	// needs to be cleaned up after the test case has run regardless of whether
	// the test case passes or fails.
	Cleanup func(ctx context.Context, failed bool, output *provider.LinkUpdateResourceOutput) error
}

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

type ResourceDeployTestCase[ServiceConfig any, Service any] struct {
	// Name is the name of the test case that will be used when running a test suite.
	Name string
	// ServiceFactory is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context.
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	//
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for AWS services
	// and the `Service` type parameter could be a `lambda.Service` interface that implements
	// API methods for the AWS Lambda service.
	// The `ServiceConfigStore` type parameter would be an optional store
	ServiceFactory pluginutils.ServiceFactory[ServiceConfig, Service]
	// ServiceMockCalls is a mock calls tracker that is expected to be embedded
	// into a mock implementation of the service interface for carrying out
	// the save operation via the provider service APIs.
	//
	// This is optional and only needs to be set if the test case
	// uses mocks instead of a real service.
	ServiceMockCalls *MockCalls
	// ConfigStore is a store that generates service-specific configuration
	// for the service factory to create an instance of the service.
	// This could be something like a cache for `*aws.Config` for AWS services
	// based on a session ID.
	// This is only needed if your service factory requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStore pluginutils.ServiceConfigStore[ServiceConfig]
	// Input is passed into the `Deploy` method of the resource implementation.
	Input *provider.ResourceDeployInput
	// SaveActionsCalled is a mapping of method name to the
	// expected second argument for the method.
	// When the value is a slice of any, it is expected that the method
	// is called multiple times with different arguments in the provided order.
	// This will usually be something like a `*Input` or `*Request` struct
	// that service library functions take after a context argument.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `ServiceMockCalls` is set).
	SaveActionsCalled map[string]any
	// SaveActionsNotCalled is a list of method names
	// that are not expected to be called as a part
	// of the save operation.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `ServiceMockCalls` is set).
	SaveActionsNotCalled []string
	// ExpectedOutput is the expected output from the `Deploy` method.
	ExpectedOutput *provider.ResourceDeployOutput
	// ExpectedOutputMatcher is a function that takes the actual output
	// from the `Deploy` method and returns a prepared actual
	// value along with the expected value to be used in an equality check.
	ExpectedOutputMatcher func(
		actual *provider.ResourceDeployOutput,
	) (EqualityCheckValues, error)
	// ExtraAssertions is an optional function that is called after the output of
	// the operation successfully matches the expected output or matcher.
	// This is useful for adding additional assertions, such as checking
	// the persisted state of the resource in the upstream service for integration tests.
	ExtraAssertions func(
		ctx context.Context,
		suite *suite.Suite,
		output *provider.ResourceDeployOutput,
	)
	// ExpectError indicates whether the test case expects an error
	// to be returned from the `Deploy` method.
	ExpectError bool
	// Cleanup is a function that is called after the test case has run.
	// This is used to clean up any resources that were created during the test case.
	// This is useful for integration tests with real services where the resource
	// needs to be cleaned up after the test case has run regardless of whether
	// the test case passes or fails.
	Cleanup func(ctx context.Context, output *provider.ResourceDeployOutput) error
}

type ResourceDestroyTestCase[ServiceConfig any, Service any] struct {
	// Name is the name of the test case that will be used when running a test suite.
	Name string
	// ServiceFactory is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context.
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	//
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for AWS services
	// and the `Service` type parameter could be a `lambda.Service` interface that implements
	// API methods for the AWS Lambda service.
	// The `ServiceConfigStore` type parameter would be an optional store
	ServiceFactory pluginutils.ServiceFactory[ServiceConfig, Service]
	// ServiceMockCalls is a mock calls tracker that is expected to be embedded
	// into a mock implementation of the service interface for carrying out
	// the destroy operation via the provider service APIs.
	//
	// This is optional and only needs to be set if the test case
	// uses mocks instead of a real service.
	ServiceMockCalls *MockCalls
	// ConfigStore is a store that generates service-specific configuration
	// for the service factory to create an instance of the service.
	// This could be something like a cache for `*aws.Config` for AWS services
	// based on a session ID.
	// This is only needed if your service factory requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStore pluginutils.ServiceConfigStore[ServiceConfig]
	// Input is passed into the `Destroy` method of the resource implementation.
	Input *provider.ResourceDestroyInput
	// DestroyActionsCalled is a mapping of method name to the
	// expected second argument for the method.
	// When the value is a slice of any, it is expected that the method
	// is called multiple times with different arguments in the provided order.
	// This will usually be something like a `*Input` or `*Request` struct
	// that service library functions take after a context argument.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `ServiceMockCalls` is set).
	DestroyActionsCalled map[string]any
	// SaveActionsNotCalled is a list of method names
	// that are not expected to be called as a part
	// of the save operation.
	//
	// This should only be set if the case uses mocks instead of a real service
	// (i.e. when `ServiceMockCalls` is set).
	DestroyActionsNotCalled []string
	// ExpectError indicates whether the test case expects an error
	// to be returned from the `Destroy` method.
	ExpectError bool
}

type ResourceGetExternalStateTestCase[ServiceConfig any, Service any] struct {
	// Name is the name of the test case that will be used when running a test suite.
	Name string
	// ServiceFactory is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context.
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	//
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for AWS services
	// and the `Service` type parameter could be a `lambda.Service` interface that implements
	// API methods for the AWS Lambda service.
	// The `ServiceConfigStore` type parameter would be an optional store
	ServiceFactory pluginutils.ServiceFactory[ServiceConfig, Service]
	// ConfigStore is a store that generates service-specific configuration
	// for the service factory to create an instance of the service.
	// This could be something like a cache for `*aws.Config` for AWS services
	// based on a session ID.
	// This is only needed if your service factory requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStore pluginutils.ServiceConfigStore[ServiceConfig]
	// Input is the input passed into the `GetExternalState` method.
	Input *provider.ResourceGetExternalStateInput
	// ExpectedOutput is the expected output from the `GetExternalState` method.
	ExpectedOutput *provider.ResourceGetExternalStateOutput
	// ExpectedOutputMatcher is a function that takes the actual output
	// from the `GetExternalState` method and returns a prepared actual
	// value along with the expected value to be used in an equality check.
	ExpectedOutputMatcher func(
		actual *provider.ResourceGetExternalStateOutput,
	) (EqualityCheckValues, error)
	// CheckTags should be set to true if the subject resource holds tags
	// as an array of key-value pair objects.
	// The default behaviour is to not check tags.
	CheckTags bool
	// TagsFieldName is the name of the field in the resource spec state
	// that holds the tags as an array of key-value pair objects.
	// This field is used only if CheckTags is `true`.
	// The default value is "tags".
	TagsFieldName string
	// TagObjectFieldNames is used to specify the field names for keys and values
	// for tags in the resource spec state.
	// The default field names are "key" and "value", this will only
	// be used if CheckTags is `true`.
	TagObjectFieldNames *TagFieldNames
	// ExpectError indicates whether the test case expects an error
	// to be returned from the `GetExternalState` method.
	ExpectError bool
}

type ResourceHasStabilisedTestCase[ServiceConfig any, Service any] struct {
	// Name is the name of the test case that will be used when running a test suite.
	Name string
	// ServiceFactory is a function that creates an instance of the service
	// using the provided service-specific configuration and a provider context.
	// serviceConfig can be nil for services that do not take a specific configuration
	// to create client instances.
	//
	// For example the `ServiceConfig` type parameter would be `*aws.Config` for AWS services
	// and the `Service` type parameter could be a `lambda.Service` interface that implements
	// API methods for the AWS Lambda service.
	// The `ServiceConfigStore` type parameter would be an optional store
	ServiceFactory pluginutils.ServiceFactory[ServiceConfig, Service]
	// ConfigStore is a store that generates service-specific configuration
	// for the service factory to create an instance of the service.
	// This could be something like a cache for `*aws.Config` for AWS services
	// based on a session ID.
	// This is only needed if your service factory requires a specific
	// configuration struct to be able to create an instance of the service.
	ConfigStore pluginutils.ServiceConfigStore[ServiceConfig]
	// Input is the input passed into the `HasStabilised` method.
	Input *provider.ResourceHasStabilisedInput
	// ExpectedOutput is the expected output from the `HasStabilised` method.
	ExpectedOutput *provider.ResourceHasStabilisedOutput
	// ExpectedOutputMatcher is a function that takes the actual output
	// from the `HasStabilised` method and returns a prepared actual
	// value along with the expected value to be used in an equality check.
	ExpectedOutputMatcher func(
		actual *provider.ResourceHasStabilisedOutput,
	) (EqualityCheckValues, error)
	// ExpectError indicates whether the test case expects an error
	// to be returned from the `GetExternalState` method.
	ExpectError bool
}

type TagFieldNames struct {
	KeyFieldName   string
	ValueFieldName string
}