github.com/aavshr/aws-sdk-go@v1.41.3/service/apigatewaymanagementapi/apigatewaymanagementapiiface/interface.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package apigatewaymanagementapiiface provides an interface to enable mocking the AmazonApiGatewayManagementApi 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 apigatewaymanagementapiiface
    10  
    11  import (
    12  	"github.com/aavshr/aws-sdk-go/aws"
    13  	"github.com/aavshr/aws-sdk-go/aws/request"
    14  	"github.com/aavshr/aws-sdk-go/service/apigatewaymanagementapi"
    15  )
    16  
    17  // ApiGatewayManagementApiAPI provides an interface to enable mocking the
    18  // apigatewaymanagementapi.ApiGatewayManagementApi 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  //    // AmazonApiGatewayManagementApi.
    28  //    func myFunc(svc apigatewaymanagementapiiface.ApiGatewayManagementApiAPI) bool {
    29  //        // Make svc.DeleteConnection request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := apigatewaymanagementapi.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 mockApiGatewayManagementApiClient struct {
    43  //        apigatewaymanagementapiiface.ApiGatewayManagementApiAPI
    44  //    }
    45  //    func (m *mockApiGatewayManagementApiClient) DeleteConnection(input *apigatewaymanagementapi.DeleteConnectionInput) (*apigatewaymanagementapi.DeleteConnectionOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockApiGatewayManagementApiClient{}
    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 ApiGatewayManagementApiAPI interface {
    63  	DeleteConnection(*apigatewaymanagementapi.DeleteConnectionInput) (*apigatewaymanagementapi.DeleteConnectionOutput, error)
    64  	DeleteConnectionWithContext(aws.Context, *apigatewaymanagementapi.DeleteConnectionInput, ...request.Option) (*apigatewaymanagementapi.DeleteConnectionOutput, error)
    65  	DeleteConnectionRequest(*apigatewaymanagementapi.DeleteConnectionInput) (*request.Request, *apigatewaymanagementapi.DeleteConnectionOutput)
    66  
    67  	GetConnection(*apigatewaymanagementapi.GetConnectionInput) (*apigatewaymanagementapi.GetConnectionOutput, error)
    68  	GetConnectionWithContext(aws.Context, *apigatewaymanagementapi.GetConnectionInput, ...request.Option) (*apigatewaymanagementapi.GetConnectionOutput, error)
    69  	GetConnectionRequest(*apigatewaymanagementapi.GetConnectionInput) (*request.Request, *apigatewaymanagementapi.GetConnectionOutput)
    70  
    71  	PostToConnection(*apigatewaymanagementapi.PostToConnectionInput) (*apigatewaymanagementapi.PostToConnectionOutput, error)
    72  	PostToConnectionWithContext(aws.Context, *apigatewaymanagementapi.PostToConnectionInput, ...request.Option) (*apigatewaymanagementapi.PostToConnectionOutput, error)
    73  	PostToConnectionRequest(*apigatewaymanagementapi.PostToConnectionInput) (*request.Request, *apigatewaymanagementapi.PostToConnectionOutput)
    74  }
    75  
    76  var _ ApiGatewayManagementApiAPI = (*apigatewaymanagementapi.ApiGatewayManagementApi)(nil)