forked from aws/aws-sdk-go-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
interface.go
100 lines (80 loc) · 3.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package snowballiface provides an interface to enable mocking the Amazon Import/Export Snowball 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 snowballiface
import (
"github.com/aws/aws-sdk-go-v2/service/snowball"
)
// SnowballAPI provides an interface to enable mocking the
// snowball.Snowball 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 Import/Export Snowball.
// func myFunc(svc snowballiface.SnowballAPI) bool {
// // Make svc.CancelCluster request
// }
//
// func main() {
// cfg, err := external.LoadDefaultAWSConfig()
// if err != nil {
// panic("failed to load config, " + err.Error())
// }
//
// svc := snowball.New(cfg)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockSnowballClient struct {
// snowballiface.SnowballAPI
// }
// func (m *mockSnowballClient) CancelCluster(input *snowball.CancelClusterInput) (*snowball.CancelClusterOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockSnowballClient{}
//
// 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 SnowballAPI interface {
CancelClusterRequest(*snowball.CancelClusterInput) snowball.CancelClusterRequest
CancelJobRequest(*snowball.CancelJobInput) snowball.CancelJobRequest
CreateAddressRequest(*snowball.CreateAddressInput) snowball.CreateAddressRequest
CreateClusterRequest(*snowball.CreateClusterInput) snowball.CreateClusterRequest
CreateJobRequest(*snowball.CreateJobInput) snowball.CreateJobRequest
DescribeAddressRequest(*snowball.DescribeAddressInput) snowball.DescribeAddressRequest
DescribeAddressesRequest(*snowball.DescribeAddressesInput) snowball.DescribeAddressesRequest
DescribeClusterRequest(*snowball.DescribeClusterInput) snowball.DescribeClusterRequest
DescribeJobRequest(*snowball.DescribeJobInput) snowball.DescribeJobRequest
GetJobManifestRequest(*snowball.GetJobManifestInput) snowball.GetJobManifestRequest
GetJobUnlockCodeRequest(*snowball.GetJobUnlockCodeInput) snowball.GetJobUnlockCodeRequest
GetSnowballUsageRequest(*snowball.GetSnowballUsageInput) snowball.GetSnowballUsageRequest
ListClusterJobsRequest(*snowball.ListClusterJobsInput) snowball.ListClusterJobsRequest
ListClustersRequest(*snowball.ListClustersInput) snowball.ListClustersRequest
ListJobsRequest(*snowball.ListJobsInput) snowball.ListJobsRequest
UpdateClusterRequest(*snowball.UpdateClusterInput) snowball.UpdateClusterRequest
UpdateJobRequest(*snowball.UpdateJobInput) snowball.UpdateJobRequest
}
var _ SnowballAPI = (*snowball.Snowball)(nil)