forked from aws/aws-sdk-go-v2
/
interface.go
106 lines (83 loc) · 3.69 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package sqsiface provides an interface to enable mocking the Amazon Simple Queue 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.
package sqsiface
import (
"github.com/aws/aws-sdk-go-v2/service/sqs"
)
// SQSAPI provides an interface to enable mocking the
// sqs.SQS 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 Simple Queue Service.
// func myFunc(svc sqsiface.SQSAPI) bool {
// // Make svc.AddPermission request
// }
//
// func main() {
// cfg, err := external.LoadDefaultAWSConfig()
// if err != nil {
// panic("failed to load config, " + err.Error())
// }
//
// svc := sqs.New(cfg)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockSQSClient struct {
// sqsiface.SQSAPI
// }
// func (m *mockSQSClient) AddPermission(input *sqs.AddPermissionInput) (*sqs.AddPermissionOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockSQSClient{}
//
// 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 SQSAPI interface {
AddPermissionRequest(*sqs.AddPermissionInput) sqs.AddPermissionRequest
ChangeMessageVisibilityRequest(*sqs.ChangeMessageVisibilityInput) sqs.ChangeMessageVisibilityRequest
ChangeMessageVisibilityBatchRequest(*sqs.ChangeMessageVisibilityBatchInput) sqs.ChangeMessageVisibilityBatchRequest
CreateQueueRequest(*sqs.CreateQueueInput) sqs.CreateQueueRequest
DeleteMessageRequest(*sqs.DeleteMessageInput) sqs.DeleteMessageRequest
DeleteMessageBatchRequest(*sqs.DeleteMessageBatchInput) sqs.DeleteMessageBatchRequest
DeleteQueueRequest(*sqs.DeleteQueueInput) sqs.DeleteQueueRequest
GetQueueAttributesRequest(*sqs.GetQueueAttributesInput) sqs.GetQueueAttributesRequest
GetQueueUrlRequest(*sqs.GetQueueUrlInput) sqs.GetQueueUrlRequest
ListDeadLetterSourceQueuesRequest(*sqs.ListDeadLetterSourceQueuesInput) sqs.ListDeadLetterSourceQueuesRequest
ListQueueTagsRequest(*sqs.ListQueueTagsInput) sqs.ListQueueTagsRequest
ListQueuesRequest(*sqs.ListQueuesInput) sqs.ListQueuesRequest
PurgeQueueRequest(*sqs.PurgeQueueInput) sqs.PurgeQueueRequest
ReceiveMessageRequest(*sqs.ReceiveMessageInput) sqs.ReceiveMessageRequest
RemovePermissionRequest(*sqs.RemovePermissionInput) sqs.RemovePermissionRequest
SendMessageRequest(*sqs.SendMessageInput) sqs.SendMessageRequest
SendMessageBatchRequest(*sqs.SendMessageBatchInput) sqs.SendMessageBatchRequest
SetQueueAttributesRequest(*sqs.SetQueueAttributesInput) sqs.SetQueueAttributesRequest
TagQueueRequest(*sqs.TagQueueInput) sqs.TagQueueRequest
UntagQueueRequest(*sqs.UntagQueueInput) sqs.UntagQueueRequest
}
var _ SQSAPI = (*sqs.SQS)(nil)