Debian Codegraph @

service/ssooidc/ssooidciface/interface.go

raw
1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
2
3 // Package ssooidciface provides an interface to enable mocking the AWS SSO OIDC service client
4 // for testing your code.
5 //
6 // It is important to note that this interface will have breaking changes
7 // when the service model is updated and adds new API operations, paginators,
8 // and waiters.
9 package ssooidciface
10
11 import (
12 "github.com/aws/aws-sdk-go/aws"
13 "github.com/aws/aws-sdk-go/aws/request"
14 "github.com/aws/aws-sdk-go/service/ssooidc"
15 )
16
17 // SSOOIDCAPI provides an interface to enable mocking the
18 // ssooidc.SSOOIDC service client's API operation,
19 // paginators, and waiters. This make unit testing your code that calls out
20 // to the SDK's service client's calls easier.
21 //
22 // The best way to use this interface is so the SDK's service client's calls
23 // can be stubbed out for unit testing your code with the SDK without needing
24 // to inject custom request handlers into the SDK's request pipeline.
25 //
26 // // myFunc uses an SDK service client to make a request to
27 // // AWS SSO OIDC.
28 // func myFunc(svc ssooidciface.SSOOIDCAPI) bool {
29 // // Make svc.CreateToken request
30 // }
31 //
32 // func main() {
33 // sess := session.New()
34 // svc := ssooidc.New(sess)
35 //
36 // myFunc(svc)
37 // }
38 //
39 // In your _test.go file:
40 //
41 // // Define a mock struct to be used in your unit tests of myFunc.
42 // type mockSSOOIDCClient struct {
43 // ssooidciface.SSOOIDCAPI
44 // }
45 // func (m *mockSSOOIDCClient) CreateToken(input *ssooidc.CreateTokenInput) (*ssooidc.CreateTokenOutput, error) {
46 // // mock response/functionality
47 // }
48 //
49 // func TestMyFunc(t *testing.T) {
50 // // Setup Test
51 // mockSvc := &mockSSOOIDCClient{}
52 //
53 // myfunc(mockSvc)
54 //
55 // // Verify myFunc's functionality
56 // }
57 //
58 // It is important to note that this interface will have breaking changes
59 // when the service model is updated and adds new API operations, paginators,
60 // and waiters. Its suggested to use the pattern above for testing, or using
61 // tooling to generate mocks to satisfy the interfaces.
62 type SSOOIDCAPI interface {
63 CreateToken(*ssooidc.CreateTokenInput) (*ssooidc.CreateTokenOutput, error)
64 CreateTokenWithContext(aws.Context, *ssooidc.CreateTokenInput, ...request.Option) (*ssooidc.CreateTokenOutput, error)
65 CreateTokenRequest(*ssooidc.CreateTokenInput) (*request.Request, *ssooidc.CreateTokenOutput)
66
67 CreateTokenWithIAM(*ssooidc.CreateTokenWithIAMInput) (*ssooidc.CreateTokenWithIAMOutput, error)
68 CreateTokenWithIAMWithContext(aws.Context, *ssooidc.CreateTokenWithIAMInput, ...request.Option) (*ssooidc.CreateTokenWithIAMOutput, error)
69 CreateTokenWithIAMRequest(*ssooidc.CreateTokenWithIAMInput) (*request.Request, *ssooidc.CreateTokenWithIAMOutput)
70
71 RegisterClient(*ssooidc.RegisterClientInput) (*ssooidc.RegisterClientOutput, error)
72 RegisterClientWithContext(aws.Context, *ssooidc.RegisterClientInput, ...request.Option) (*ssooidc.RegisterClientOutput, error)
73 RegisterClientRequest(*ssooidc.RegisterClientInput) (*request.Request, *ssooidc.RegisterClientOutput)
74
75 StartDeviceAuthorization(*ssooidc.StartDeviceAuthorizationInput) (*ssooidc.StartDeviceAuthorizationOutput, error)
76 StartDeviceAuthorizationWithContext(aws.Context, *ssooidc.StartDeviceAuthorizationInput, ...request.Option) (*ssooidc.StartDeviceAuthorizationOutput, error)
77 StartDeviceAuthorizationRequest(*ssooidc.StartDeviceAuthorizationInput) (*request.Request, *ssooidc.StartDeviceAuthorizationOutput)
78 }
79
80 var _ SSOOIDCAPI = (*ssooidc.SSOOIDC)(nil)