mediaconvertiface

Documentation

Overview

Package mediaconvertiface provides an interface to enable mocking the AWS Elemental MediaConvert 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

• type MediaConvertAPI

Types

type MediaConvertAPI

type MediaConvertAPI interface {
	CancelJobRequest(*mediaconvert.CancelJobInput) mediaconvert.CancelJobRequest

	CreateJobRequest(*mediaconvert.CreateJobInput) mediaconvert.CreateJobRequest

	CreateJobTemplateRequest(*mediaconvert.CreateJobTemplateInput) mediaconvert.CreateJobTemplateRequest

	CreatePresetRequest(*mediaconvert.CreatePresetInput) mediaconvert.CreatePresetRequest

	CreateQueueRequest(*mediaconvert.CreateQueueInput) mediaconvert.CreateQueueRequest

	DeleteJobTemplateRequest(*mediaconvert.DeleteJobTemplateInput) mediaconvert.DeleteJobTemplateRequest

	DeletePresetRequest(*mediaconvert.DeletePresetInput) mediaconvert.DeletePresetRequest

	DeleteQueueRequest(*mediaconvert.DeleteQueueInput) mediaconvert.DeleteQueueRequest

	DescribeEndpointsRequest(*mediaconvert.DescribeEndpointsInput) mediaconvert.DescribeEndpointsRequest

	GetJobRequest(*mediaconvert.GetJobInput) mediaconvert.GetJobRequest

	GetJobTemplateRequest(*mediaconvert.GetJobTemplateInput) mediaconvert.GetJobTemplateRequest

	GetPresetRequest(*mediaconvert.GetPresetInput) mediaconvert.GetPresetRequest

	GetQueueRequest(*mediaconvert.GetQueueInput) mediaconvert.GetQueueRequest

	ListJobTemplatesRequest(*mediaconvert.ListJobTemplatesInput) mediaconvert.ListJobTemplatesRequest

	ListJobsRequest(*mediaconvert.ListJobsInput) mediaconvert.ListJobsRequest

	ListPresetsRequest(*mediaconvert.ListPresetsInput) mediaconvert.ListPresetsRequest

	ListQueuesRequest(*mediaconvert.ListQueuesInput) mediaconvert.ListQueuesRequest

	UpdateJobTemplateRequest(*mediaconvert.UpdateJobTemplateInput) mediaconvert.UpdateJobTemplateRequest

	UpdatePresetRequest(*mediaconvert.UpdatePresetInput) mediaconvert.UpdatePresetRequest

	UpdateQueueRequest(*mediaconvert.UpdateQueueInput) mediaconvert.UpdateQueueRequest
}

MediaConvertAPI provides an interface to enable mocking the mediaconvert.MediaConvert 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
// AWS Elemental MediaConvert.
func myFunc(svc mediaconvertiface.MediaConvertAPI) bool {
    // Make svc.CancelJob request
}

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

    svc := mediaconvert.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockMediaConvertClient struct {
    mediaconvertiface.MediaConvertAPI
}
func (m *mockMediaConvertClient) CancelJob(input *mediaconvert.CancelJobInput) (*mediaconvert.CancelJobOutput, error) {
    // mock response/functionality
}

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

    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.