forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
interface.go
67 lines (62 loc) · 2.46 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
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package mobileanalyticsiface provides an interface to enable mocking the Amazon Mobile Analytics 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 mobileanalyticsiface
import (
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/service/mobileanalytics"
)
// MobileAnalyticsAPI provides an interface to enable mocking the
// mobileanalytics.MobileAnalytics 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 the SDK's request pipeline.
//
// // myFunc uses an SDK service client to make a request to
// // Amazon Mobile Analytics.
// func myFunc(svc mobileanalyticsiface.MobileAnalyticsAPI) bool {
// // Make svc.PutEvents request
// }
//
// func main() {
// sess := session.New()
// svc := mobileanalytics.New(sess)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockMobileAnalyticsClient struct {
// mobileanalyticsiface.MobileAnalyticsAPI
// }
// func (m *mockMobileAnalyticsClient) PutEvents(input *mobileanalytics.PutEventsInput) (*mobileanalytics.PutEventsOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockMobileAnalyticsClient{}
//
// 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 MobileAnalyticsAPI interface {
PutEventsRequest(*mobileanalytics.PutEventsInput) (*request.Request, *mobileanalytics.PutEventsOutput)
PutEvents(*mobileanalytics.PutEventsInput) (*mobileanalytics.PutEventsOutput, error)
}
var _ MobileAnalyticsAPI = (*mobileanalytics.MobileAnalytics)(nil)