-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
interface.go
72 lines (67 loc) · 3.24 KB
/
interface.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package workmailmessageflowiface provides an interface to enable mocking the Amazon WorkMail Message Flow 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.
package workmailmessageflowiface
import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/service/workmailmessageflow"
)
// WorkMailMessageFlowAPI provides an interface to enable mocking the
// workmailmessageflow.WorkMailMessageFlow 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 WorkMail Message Flow.
// func myFunc(svc workmailmessageflowiface.WorkMailMessageFlowAPI) bool {
// // Make svc.GetRawMessageContent request
// }
//
// func main() {
// sess := session.New()
// svc := workmailmessageflow.New(sess)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockWorkMailMessageFlowClient struct {
// workmailmessageflowiface.WorkMailMessageFlowAPI
// }
// func (m *mockWorkMailMessageFlowClient) GetRawMessageContent(input *workmailmessageflow.GetRawMessageContentInput) (*workmailmessageflow.GetRawMessageContentOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockWorkMailMessageFlowClient{}
//
// 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.
type WorkMailMessageFlowAPI interface {
GetRawMessageContent(*workmailmessageflow.GetRawMessageContentInput) (*workmailmessageflow.GetRawMessageContentOutput, error)
GetRawMessageContentWithContext(aws.Context, *workmailmessageflow.GetRawMessageContentInput, ...request.Option) (*workmailmessageflow.GetRawMessageContentOutput, error)
GetRawMessageContentRequest(*workmailmessageflow.GetRawMessageContentInput) (*request.Request, *workmailmessageflow.GetRawMessageContentOutput)
PutRawMessageContent(*workmailmessageflow.PutRawMessageContentInput) (*workmailmessageflow.PutRawMessageContentOutput, error)
PutRawMessageContentWithContext(aws.Context, *workmailmessageflow.PutRawMessageContentInput, ...request.Option) (*workmailmessageflow.PutRawMessageContentOutput, error)
PutRawMessageContentRequest(*workmailmessageflow.PutRawMessageContentInput) (*request.Request, *workmailmessageflow.PutRawMessageContentOutput)
}
var _ WorkMailMessageFlowAPI = (*workmailmessageflow.WorkMailMessageFlow)(nil)