Debian Codegraph @

service/kinesisvideowebrtcstorage/kinesisvideowebrtcstorageiface/interface.go

raw
1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
2
3 // Package kinesisvideowebrtcstorageiface provides an interface to enable mocking the Amazon Kinesis Video WebRTC Storage 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 kinesisvideowebrtcstorageiface
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/kinesisvideowebrtcstorage"
15 )
16
17 // KinesisVideoWebRTCStorageAPI provides an interface to enable mocking the
18 // kinesisvideowebrtcstorage.KinesisVideoWebRTCStorage 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 // // Amazon Kinesis Video WebRTC Storage.
28 // func myFunc(svc kinesisvideowebrtcstorageiface.KinesisVideoWebRTCStorageAPI) bool {
29 // // Make svc.JoinStorageSession request
30 // }
31 //
32 // func main() {
33 // sess := session.New()
34 // svc := kinesisvideowebrtcstorage.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 mockKinesisVideoWebRTCStorageClient struct {
43 // kinesisvideowebrtcstorageiface.KinesisVideoWebRTCStorageAPI
44 // }
45 // func (m *mockKinesisVideoWebRTCStorageClient) JoinStorageSession(input *kinesisvideowebrtcstorage.JoinStorageSessionInput) (*kinesisvideowebrtcstorage.JoinStorageSessionOutput, error) {
46 // // mock response/functionality
47 // }
48 //
49 // func TestMyFunc(t *testing.T) {
50 // // Setup Test
51 // mockSvc := &mockKinesisVideoWebRTCStorageClient{}
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 KinesisVideoWebRTCStorageAPI interface {
63 JoinStorageSession(*kinesisvideowebrtcstorage.JoinStorageSessionInput) (*kinesisvideowebrtcstorage.JoinStorageSessionOutput, error)
64 JoinStorageSessionWithContext(aws.Context, *kinesisvideowebrtcstorage.JoinStorageSessionInput, ...request.Option) (*kinesisvideowebrtcstorage.JoinStorageSessionOutput, error)
65 JoinStorageSessionRequest(*kinesisvideowebrtcstorage.JoinStorageSessionInput) (*request.Request, *kinesisvideowebrtcstorage.JoinStorageSessionOutput)
66 }
67
68 var _ KinesisVideoWebRTCStorageAPI = (*kinesisvideowebrtcstorage.KinesisVideoWebRTCStorage)(nil)