Documentation ¶
Overview ¶
Package amplifyiface provides an interface to enable mocking the AWS Amplify service client for testing your code.
It is important to note that this interface will have breaking changes when the service model is updated and adds new API operations, paginators, and waiters.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AmplifyAPI ¶
type AmplifyAPI interface { CreateAppRequest(*amplify.CreateAppInput) amplify.CreateAppRequest CreateBranchRequest(*amplify.CreateBranchInput) amplify.CreateBranchRequest CreateDomainAssociationRequest(*amplify.CreateDomainAssociationInput) amplify.CreateDomainAssociationRequest DeleteAppRequest(*amplify.DeleteAppInput) amplify.DeleteAppRequest DeleteBranchRequest(*amplify.DeleteBranchInput) amplify.DeleteBranchRequest DeleteDomainAssociationRequest(*amplify.DeleteDomainAssociationInput) amplify.DeleteDomainAssociationRequest DeleteJobRequest(*amplify.DeleteJobInput) amplify.DeleteJobRequest GetAppRequest(*amplify.GetAppInput) amplify.GetAppRequest GetBranchRequest(*amplify.GetBranchInput) amplify.GetBranchRequest GetDomainAssociationRequest(*amplify.GetDomainAssociationInput) amplify.GetDomainAssociationRequest GetJobRequest(*amplify.GetJobInput) amplify.GetJobRequest ListAppsRequest(*amplify.ListAppsInput) amplify.ListAppsRequest ListBranchesRequest(*amplify.ListBranchesInput) amplify.ListBranchesRequest ListDomainAssociationsRequest(*amplify.ListDomainAssociationsInput) amplify.ListDomainAssociationsRequest ListJobsRequest(*amplify.ListJobsInput) amplify.ListJobsRequest StartJobRequest(*amplify.StartJobInput) amplify.StartJobRequest StopJobRequest(*amplify.StopJobInput) amplify.StopJobRequest UpdateAppRequest(*amplify.UpdateAppInput) amplify.UpdateAppRequest UpdateBranchRequest(*amplify.UpdateBranchInput) amplify.UpdateBranchRequest UpdateDomainAssociationRequest(*amplify.UpdateDomainAssociationInput) amplify.UpdateDomainAssociationRequest }
AmplifyAPI provides an interface to enable mocking the amplify.Amplify service client's API operation, paginators, and waiters. This make unit testing your code that calls out to the SDK's service client's calls easier.
The best way to use this interface is so the SDK's service client's calls can be stubbed out for unit testing your code with the SDK without needing to inject custom request handlers into the SDK's request pipeline.
// myFunc uses an SDK service client to make a request to // AWS Amplify. func myFunc(svc amplifyiface.AmplifyAPI) bool { // Make svc.CreateApp request } func main() { cfg, err := external.LoadDefaultAWSConfig() if err != nil { panic("failed to load config, " + err.Error()) } svc := amplify.New(cfg) myFunc(svc) }
In your _test.go file:
// Define a mock struct to be used in your unit tests of myFunc. type mockAmplifyClient struct { amplifyiface.AmplifyAPI } func (m *mockAmplifyClient) CreateApp(input *amplify.CreateAppInput) (*amplify.CreateAppOutput, error) { // mock response/functionality } func TestMyFunc(t *testing.T) { // Setup Test mockSvc := &mockAmplifyClient{} myfunc(mockSvc) // Verify myFunc's functionality }
It is important to note that this interface will have breaking changes when the service model is updated and adds new API operations, paginators, and waiters. Its suggested to use the pattern above for testing, or using tooling to generate mocks to satisfy the interfaces.