forked from aws/aws-sdk-go-v2
/
interface.go
90 lines (75 loc) · 3.2 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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package fmsiface provides an interface to enable mocking the Firewall Management 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 fmsiface
import (
"github.com/aws/aws-sdk-go-v2/service/fms"
)
// FMSAPI provides an interface to enable mocking the
// fms.FMS 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
// // Firewall Management Service.
// func myFunc(svc fmsiface.FMSAPI) bool {
// // Make svc.AssociateAdminAccount request
// }
//
// func main() {
// cfg, err := external.LoadDefaultAWSConfig()
// if err != nil {
// panic("failed to load config, " + err.Error())
// }
//
// svc := fms.New(cfg)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockFMSClient struct {
// fmsiface.FMSAPI
// }
// func (m *mockFMSClient) AssociateAdminAccount(input *fms.AssociateAdminAccountInput) (*fms.AssociateAdminAccountOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockFMSClient{}
//
// 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 FMSAPI interface {
AssociateAdminAccountRequest(*fms.AssociateAdminAccountInput) fms.AssociateAdminAccountRequest
DeleteNotificationChannelRequest(*fms.DeleteNotificationChannelInput) fms.DeleteNotificationChannelRequest
DeletePolicyRequest(*fms.DeletePolicyInput) fms.DeletePolicyRequest
DisassociateAdminAccountRequest(*fms.DisassociateAdminAccountInput) fms.DisassociateAdminAccountRequest
GetAdminAccountRequest(*fms.GetAdminAccountInput) fms.GetAdminAccountRequest
GetComplianceDetailRequest(*fms.GetComplianceDetailInput) fms.GetComplianceDetailRequest
GetNotificationChannelRequest(*fms.GetNotificationChannelInput) fms.GetNotificationChannelRequest
GetPolicyRequest(*fms.GetPolicyInput) fms.GetPolicyRequest
ListComplianceStatusRequest(*fms.ListComplianceStatusInput) fms.ListComplianceStatusRequest
ListPoliciesRequest(*fms.ListPoliciesInput) fms.ListPoliciesRequest
PutNotificationChannelRequest(*fms.PutNotificationChannelInput) fms.PutNotificationChannelRequest
PutPolicyRequest(*fms.PutPolicyInput) fms.PutPolicyRequest
}
var _ FMSAPI = (*fms.FMS)(nil)