Documentation ¶
Overview ¶
Package pinpointemailiface provides an interface to enable mocking the Amazon Pinpoint Email Service 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 PinpointEmailAPI ¶
type PinpointEmailAPI interface { CreateConfigurationSetRequest(*pinpointemail.CreateConfigurationSetInput) pinpointemail.CreateConfigurationSetRequest CreateConfigurationSetEventDestinationRequest(*pinpointemail.CreateConfigurationSetEventDestinationInput) pinpointemail.CreateConfigurationSetEventDestinationRequest CreateDedicatedIpPoolRequest(*pinpointemail.CreateDedicatedIpPoolInput) pinpointemail.CreateDedicatedIpPoolRequest CreateDeliverabilityTestReportRequest(*pinpointemail.CreateDeliverabilityTestReportInput) pinpointemail.CreateDeliverabilityTestReportRequest CreateEmailIdentityRequest(*pinpointemail.CreateEmailIdentityInput) pinpointemail.CreateEmailIdentityRequest DeleteConfigurationSetRequest(*pinpointemail.DeleteConfigurationSetInput) pinpointemail.DeleteConfigurationSetRequest DeleteConfigurationSetEventDestinationRequest(*pinpointemail.DeleteConfigurationSetEventDestinationInput) pinpointemail.DeleteConfigurationSetEventDestinationRequest DeleteDedicatedIpPoolRequest(*pinpointemail.DeleteDedicatedIpPoolInput) pinpointemail.DeleteDedicatedIpPoolRequest DeleteEmailIdentityRequest(*pinpointemail.DeleteEmailIdentityInput) pinpointemail.DeleteEmailIdentityRequest GetAccountRequest(*pinpointemail.GetAccountInput) pinpointemail.GetAccountRequest GetBlacklistReportsRequest(*pinpointemail.GetBlacklistReportsInput) pinpointemail.GetBlacklistReportsRequest GetConfigurationSetRequest(*pinpointemail.GetConfigurationSetInput) pinpointemail.GetConfigurationSetRequest GetConfigurationSetEventDestinationsRequest(*pinpointemail.GetConfigurationSetEventDestinationsInput) pinpointemail.GetConfigurationSetEventDestinationsRequest GetDedicatedIpRequest(*pinpointemail.GetDedicatedIpInput) pinpointemail.GetDedicatedIpRequest GetDedicatedIpsRequest(*pinpointemail.GetDedicatedIpsInput) pinpointemail.GetDedicatedIpsRequest GetDeliverabilityDashboardOptionsRequest(*pinpointemail.GetDeliverabilityDashboardOptionsInput) pinpointemail.GetDeliverabilityDashboardOptionsRequest GetDeliverabilityTestReportRequest(*pinpointemail.GetDeliverabilityTestReportInput) pinpointemail.GetDeliverabilityTestReportRequest GetDomainStatisticsReportRequest(*pinpointemail.GetDomainStatisticsReportInput) pinpointemail.GetDomainStatisticsReportRequest GetEmailIdentityRequest(*pinpointemail.GetEmailIdentityInput) pinpointemail.GetEmailIdentityRequest ListConfigurationSetsRequest(*pinpointemail.ListConfigurationSetsInput) pinpointemail.ListConfigurationSetsRequest ListDedicatedIpPoolsRequest(*pinpointemail.ListDedicatedIpPoolsInput) pinpointemail.ListDedicatedIpPoolsRequest ListDeliverabilityTestReportsRequest(*pinpointemail.ListDeliverabilityTestReportsInput) pinpointemail.ListDeliverabilityTestReportsRequest ListEmailIdentitiesRequest(*pinpointemail.ListEmailIdentitiesInput) pinpointemail.ListEmailIdentitiesRequest ListTagsForResourceRequest(*pinpointemail.ListTagsForResourceInput) pinpointemail.ListTagsForResourceRequest PutAccountDedicatedIpWarmupAttributesRequest(*pinpointemail.PutAccountDedicatedIpWarmupAttributesInput) pinpointemail.PutAccountDedicatedIpWarmupAttributesRequest PutAccountSendingAttributesRequest(*pinpointemail.PutAccountSendingAttributesInput) pinpointemail.PutAccountSendingAttributesRequest PutConfigurationSetDeliveryOptionsRequest(*pinpointemail.PutConfigurationSetDeliveryOptionsInput) pinpointemail.PutConfigurationSetDeliveryOptionsRequest PutConfigurationSetReputationOptionsRequest(*pinpointemail.PutConfigurationSetReputationOptionsInput) pinpointemail.PutConfigurationSetReputationOptionsRequest PutConfigurationSetSendingOptionsRequest(*pinpointemail.PutConfigurationSetSendingOptionsInput) pinpointemail.PutConfigurationSetSendingOptionsRequest PutConfigurationSetTrackingOptionsRequest(*pinpointemail.PutConfigurationSetTrackingOptionsInput) pinpointemail.PutConfigurationSetTrackingOptionsRequest PutDedicatedIpInPoolRequest(*pinpointemail.PutDedicatedIpInPoolInput) pinpointemail.PutDedicatedIpInPoolRequest PutDedicatedIpWarmupAttributesRequest(*pinpointemail.PutDedicatedIpWarmupAttributesInput) pinpointemail.PutDedicatedIpWarmupAttributesRequest PutDeliverabilityDashboardOptionRequest(*pinpointemail.PutDeliverabilityDashboardOptionInput) pinpointemail.PutDeliverabilityDashboardOptionRequest PutEmailIdentityDkimAttributesRequest(*pinpointemail.PutEmailIdentityDkimAttributesInput) pinpointemail.PutEmailIdentityDkimAttributesRequest PutEmailIdentityFeedbackAttributesRequest(*pinpointemail.PutEmailIdentityFeedbackAttributesInput) pinpointemail.PutEmailIdentityFeedbackAttributesRequest PutEmailIdentityMailFromAttributesRequest(*pinpointemail.PutEmailIdentityMailFromAttributesInput) pinpointemail.PutEmailIdentityMailFromAttributesRequest SendEmailRequest(*pinpointemail.SendEmailInput) pinpointemail.SendEmailRequest TagResourceRequest(*pinpointemail.TagResourceInput) pinpointemail.TagResourceRequest UntagResourceRequest(*pinpointemail.UntagResourceInput) pinpointemail.UntagResourceRequest UpdateConfigurationSetEventDestinationRequest(*pinpointemail.UpdateConfigurationSetEventDestinationInput) pinpointemail.UpdateConfigurationSetEventDestinationRequest }
PinpointEmailAPI provides an interface to enable mocking the pinpointemail.PinpointEmail 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 // Amazon Pinpoint Email Service. func myFunc(svc pinpointemailiface.PinpointEmailAPI) bool { // Make svc.CreateConfigurationSet request } func main() { cfg, err := external.LoadDefaultAWSConfig() if err != nil { panic("failed to load config, " + err.Error()) } svc := pinpointemail.New(cfg) myFunc(svc) }
In your _test.go file:
// Define a mock struct to be used in your unit tests of myFunc. type mockPinpointEmailClient struct { pinpointemailiface.PinpointEmailAPI } func (m *mockPinpointEmailClient) CreateConfigurationSet(input *pinpointemail.CreateConfigurationSetInput) (*pinpointemail.CreateConfigurationSetOutput, error) { // mock response/functionality } func TestMyFunc(t *testing.T) { // Setup Test mockSvc := &mockPinpointEmailClient{} 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.