aws-sdk-go-v2: github.com/aws/aws-sdk-go-v2/service/athena/athenaiface Index | Files

package athenaiface

import "github.com/aws/aws-sdk-go-v2/service/athena/athenaiface"

Package athenaiface provides an interface to enable mocking the Amazon Athena 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.

Index

Package Files

interface.go

type ClientAPI Uses

type ClientAPI interface {
    BatchGetNamedQueryRequest(*athena.BatchGetNamedQueryInput) athena.BatchGetNamedQueryRequest

    BatchGetQueryExecutionRequest(*athena.BatchGetQueryExecutionInput) athena.BatchGetQueryExecutionRequest

    CreateDataCatalogRequest(*athena.CreateDataCatalogInput) athena.CreateDataCatalogRequest

    CreateNamedQueryRequest(*athena.CreateNamedQueryInput) athena.CreateNamedQueryRequest

    CreateWorkGroupRequest(*athena.CreateWorkGroupInput) athena.CreateWorkGroupRequest

    DeleteDataCatalogRequest(*athena.DeleteDataCatalogInput) athena.DeleteDataCatalogRequest

    DeleteNamedQueryRequest(*athena.DeleteNamedQueryInput) athena.DeleteNamedQueryRequest

    DeleteWorkGroupRequest(*athena.DeleteWorkGroupInput) athena.DeleteWorkGroupRequest

    GetDataCatalogRequest(*athena.GetDataCatalogInput) athena.GetDataCatalogRequest

    GetDatabaseRequest(*athena.GetDatabaseInput) athena.GetDatabaseRequest

    GetNamedQueryRequest(*athena.GetNamedQueryInput) athena.GetNamedQueryRequest

    GetQueryExecutionRequest(*athena.GetQueryExecutionInput) athena.GetQueryExecutionRequest

    GetQueryResultsRequest(*athena.GetQueryResultsInput) athena.GetQueryResultsRequest

    GetTableMetadataRequest(*athena.GetTableMetadataInput) athena.GetTableMetadataRequest

    GetWorkGroupRequest(*athena.GetWorkGroupInput) athena.GetWorkGroupRequest

    ListDataCatalogsRequest(*athena.ListDataCatalogsInput) athena.ListDataCatalogsRequest

    ListDatabasesRequest(*athena.ListDatabasesInput) athena.ListDatabasesRequest

    ListNamedQueriesRequest(*athena.ListNamedQueriesInput) athena.ListNamedQueriesRequest

    ListQueryExecutionsRequest(*athena.ListQueryExecutionsInput) athena.ListQueryExecutionsRequest

    ListTableMetadataRequest(*athena.ListTableMetadataInput) athena.ListTableMetadataRequest

    ListTagsForResourceRequest(*athena.ListTagsForResourceInput) athena.ListTagsForResourceRequest

    ListWorkGroupsRequest(*athena.ListWorkGroupsInput) athena.ListWorkGroupsRequest

    StartQueryExecutionRequest(*athena.StartQueryExecutionInput) athena.StartQueryExecutionRequest

    StopQueryExecutionRequest(*athena.StopQueryExecutionInput) athena.StopQueryExecutionRequest

    TagResourceRequest(*athena.TagResourceInput) athena.TagResourceRequest

    UntagResourceRequest(*athena.UntagResourceInput) athena.UntagResourceRequest

    UpdateDataCatalogRequest(*athena.UpdateDataCatalogInput) athena.UpdateDataCatalogRequest

    UpdateWorkGroupRequest(*athena.UpdateWorkGroupInput) athena.UpdateWorkGroupRequest
}

ClientAPI provides an interface to enable mocking the athena.Client methods. 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
// Amazon Athena.
func myFunc(svc athenaiface.ClientAPI) bool {
    // Make svc.BatchGetNamedQuery request
}

func main() {
    cfg, err := external.LoadDefaultAWSConfig()
    if err != nil {
        panic("failed to load config, " + err.Error())
    }

    svc := athena.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockClientClient struct {
    athenaiface.ClientPI
}
func (m *mockClientClient) BatchGetNamedQuery(input *athena.BatchGetNamedQueryInput) (*athena.BatchGetNamedQueryOutput, error) {
    // mock response/functionality
}

func TestMyFunc(t *testing.T) {
    // Setup Test
    mockSvc := &mockClientClient{}

    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.

Package athenaiface imports 1 packages (graph). Updated 2020-07-24. Refresh now. Tools for package owners.