forked from aws/aws-sdk-go-v2
/
interface.go
119 lines (91 loc) · 4.62 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
107
108
109
110
111
112
113
114
115
116
117
118
119
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package kinesisiface provides an interface to enable mocking the Amazon Kinesis 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 kinesisiface
import (
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/kinesis"
)
// KinesisAPI provides an interface to enable mocking the
// kinesis.Kinesis 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 Kinesis.
// func myFunc(svc kinesisiface.KinesisAPI) bool {
// // Make svc.AddTagsToStream request
// }
//
// func main() {
// cfg, err := external.LoadDefaultAWSConfig()
// if err != nil {
// panic("failed to load config, " + err.Error())
// }
//
// svc := kinesis.New(cfg)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockKinesisClient struct {
// kinesisiface.KinesisAPI
// }
// func (m *mockKinesisClient) AddTagsToStream(input *kinesis.AddTagsToStreamInput) (*kinesis.AddTagsToStreamOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockKinesisClient{}
//
// 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 KinesisAPI interface {
AddTagsToStreamRequest(*kinesis.AddTagsToStreamInput) kinesis.AddTagsToStreamRequest
CreateStreamRequest(*kinesis.CreateStreamInput) kinesis.CreateStreamRequest
DecreaseStreamRetentionPeriodRequest(*kinesis.DecreaseStreamRetentionPeriodInput) kinesis.DecreaseStreamRetentionPeriodRequest
DeleteStreamRequest(*kinesis.DeleteStreamInput) kinesis.DeleteStreamRequest
DescribeLimitsRequest(*kinesis.DescribeLimitsInput) kinesis.DescribeLimitsRequest
DescribeStreamRequest(*kinesis.DescribeStreamInput) kinesis.DescribeStreamRequest
DescribeStreamSummaryRequest(*kinesis.DescribeStreamSummaryInput) kinesis.DescribeStreamSummaryRequest
DisableEnhancedMonitoringRequest(*kinesis.DisableEnhancedMonitoringInput) kinesis.DisableEnhancedMonitoringRequest
EnableEnhancedMonitoringRequest(*kinesis.EnableEnhancedMonitoringInput) kinesis.EnableEnhancedMonitoringRequest
GetRecordsRequest(*kinesis.GetRecordsInput) kinesis.GetRecordsRequest
GetShardIteratorRequest(*kinesis.GetShardIteratorInput) kinesis.GetShardIteratorRequest
IncreaseStreamRetentionPeriodRequest(*kinesis.IncreaseStreamRetentionPeriodInput) kinesis.IncreaseStreamRetentionPeriodRequest
ListShardsRequest(*kinesis.ListShardsInput) kinesis.ListShardsRequest
ListStreamsRequest(*kinesis.ListStreamsInput) kinesis.ListStreamsRequest
ListTagsForStreamRequest(*kinesis.ListTagsForStreamInput) kinesis.ListTagsForStreamRequest
MergeShardsRequest(*kinesis.MergeShardsInput) kinesis.MergeShardsRequest
PutRecordRequest(*kinesis.PutRecordInput) kinesis.PutRecordRequest
PutRecordsRequest(*kinesis.PutRecordsInput) kinesis.PutRecordsRequest
RemoveTagsFromStreamRequest(*kinesis.RemoveTagsFromStreamInput) kinesis.RemoveTagsFromStreamRequest
SplitShardRequest(*kinesis.SplitShardInput) kinesis.SplitShardRequest
StartStreamEncryptionRequest(*kinesis.StartStreamEncryptionInput) kinesis.StartStreamEncryptionRequest
StopStreamEncryptionRequest(*kinesis.StopStreamEncryptionInput) kinesis.StopStreamEncryptionRequest
UpdateShardCountRequest(*kinesis.UpdateShardCountInput) kinesis.UpdateShardCountRequest
WaitUntilStreamExists(*kinesis.DescribeStreamInput) error
WaitUntilStreamExistsWithContext(aws.Context, *kinesis.DescribeStreamInput, ...aws.WaiterOption) error
WaitUntilStreamNotExists(*kinesis.DescribeStreamInput) error
WaitUntilStreamNotExistsWithContext(aws.Context, *kinesis.DescribeStreamInput, ...aws.WaiterOption) error
}
var _ KinesisAPI = (*kinesis.Kinesis)(nil)