-
Notifications
You must be signed in to change notification settings - Fork 623
/
interface.go
103 lines (81 loc) · 3.79 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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package qldbiface provides an interface to enable mocking the Amazon QLDB 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 qldbiface
import (
"github.com/aws/aws-sdk-go-v2/service/qldb"
)
// ClientAPI provides an interface to enable mocking the
// qldb.Client methods. 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
// // QLDB.
// func myFunc(svc qldbiface.ClientAPI) bool {
// // Make svc.CancelJournalKinesisStream request
// }
//
// func main() {
// cfg, err := external.LoadDefaultAWSConfig()
// if err != nil {
// panic("failed to load config, " + err.Error())
// }
//
// svc := qldb.New(cfg)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockClientClient struct {
// qldbiface.ClientPI
// }
// func (m *mockClientClient) CancelJournalKinesisStream(input *qldb.CancelJournalKinesisStreamInput) (*qldb.CancelJournalKinesisStreamOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockClientClient{}
//
// 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 ClientAPI interface {
CancelJournalKinesisStreamRequest(*qldb.CancelJournalKinesisStreamInput) qldb.CancelJournalKinesisStreamRequest
CreateLedgerRequest(*qldb.CreateLedgerInput) qldb.CreateLedgerRequest
DeleteLedgerRequest(*qldb.DeleteLedgerInput) qldb.DeleteLedgerRequest
DescribeJournalKinesisStreamRequest(*qldb.DescribeJournalKinesisStreamInput) qldb.DescribeJournalKinesisStreamRequest
DescribeJournalS3ExportRequest(*qldb.DescribeJournalS3ExportInput) qldb.DescribeJournalS3ExportRequest
DescribeLedgerRequest(*qldb.DescribeLedgerInput) qldb.DescribeLedgerRequest
ExportJournalToS3Request(*qldb.ExportJournalToS3Input) qldb.ExportJournalToS3Request
GetBlockRequest(*qldb.GetBlockInput) qldb.GetBlockRequest
GetDigestRequest(*qldb.GetDigestInput) qldb.GetDigestRequest
GetRevisionRequest(*qldb.GetRevisionInput) qldb.GetRevisionRequest
ListJournalKinesisStreamsForLedgerRequest(*qldb.ListJournalKinesisStreamsForLedgerInput) qldb.ListJournalKinesisStreamsForLedgerRequest
ListJournalS3ExportsRequest(*qldb.ListJournalS3ExportsInput) qldb.ListJournalS3ExportsRequest
ListJournalS3ExportsForLedgerRequest(*qldb.ListJournalS3ExportsForLedgerInput) qldb.ListJournalS3ExportsForLedgerRequest
ListLedgersRequest(*qldb.ListLedgersInput) qldb.ListLedgersRequest
ListTagsForResourceRequest(*qldb.ListTagsForResourceInput) qldb.ListTagsForResourceRequest
StreamJournalToKinesisRequest(*qldb.StreamJournalToKinesisInput) qldb.StreamJournalToKinesisRequest
TagResourceRequest(*qldb.TagResourceInput) qldb.TagResourceRequest
UntagResourceRequest(*qldb.UntagResourceInput) qldb.UntagResourceRequest
UpdateLedgerRequest(*qldb.UpdateLedgerInput) qldb.UpdateLedgerRequest
}
var _ ClientAPI = (*qldb.Client)(nil)