codeguruprofileriface

type ClientAPI ¶

type ClientAPI interface {
	AddNotificationChannelsRequest(*codeguruprofiler.AddNotificationChannelsInput) codeguruprofiler.AddNotificationChannelsRequest

	BatchGetFrameMetricDataRequest(*codeguruprofiler.BatchGetFrameMetricDataInput) codeguruprofiler.BatchGetFrameMetricDataRequest

	ConfigureAgentRequest(*codeguruprofiler.ConfigureAgentInput) codeguruprofiler.ConfigureAgentRequest

	CreateProfilingGroupRequest(*codeguruprofiler.CreateProfilingGroupInput) codeguruprofiler.CreateProfilingGroupRequest

	DeleteProfilingGroupRequest(*codeguruprofiler.DeleteProfilingGroupInput) codeguruprofiler.DeleteProfilingGroupRequest

	DescribeProfilingGroupRequest(*codeguruprofiler.DescribeProfilingGroupInput) codeguruprofiler.DescribeProfilingGroupRequest

	GetFindingsReportAccountSummaryRequest(*codeguruprofiler.GetFindingsReportAccountSummaryInput) codeguruprofiler.GetFindingsReportAccountSummaryRequest

	GetNotificationConfigurationRequest(*codeguruprofiler.GetNotificationConfigurationInput) codeguruprofiler.GetNotificationConfigurationRequest

	GetPolicyRequest(*codeguruprofiler.GetPolicyInput) codeguruprofiler.GetPolicyRequest

	GetProfileRequest(*codeguruprofiler.GetProfileInput) codeguruprofiler.GetProfileRequest

	GetRecommendationsRequest(*codeguruprofiler.GetRecommendationsInput) codeguruprofiler.GetRecommendationsRequest

	ListFindingsReportsRequest(*codeguruprofiler.ListFindingsReportsInput) codeguruprofiler.ListFindingsReportsRequest

	ListProfileTimesRequest(*codeguruprofiler.ListProfileTimesInput) codeguruprofiler.ListProfileTimesRequest

	ListProfilingGroupsRequest(*codeguruprofiler.ListProfilingGroupsInput) codeguruprofiler.ListProfilingGroupsRequest

	ListTagsForResourceRequest(*codeguruprofiler.ListTagsForResourceInput) codeguruprofiler.ListTagsForResourceRequest

	PostAgentProfileRequest(*codeguruprofiler.PostAgentProfileInput) codeguruprofiler.PostAgentProfileRequest

	PutPermissionRequest(*codeguruprofiler.PutPermissionInput) codeguruprofiler.PutPermissionRequest

	RemoveNotificationChannelRequest(*codeguruprofiler.RemoveNotificationChannelInput) codeguruprofiler.RemoveNotificationChannelRequest

	RemovePermissionRequest(*codeguruprofiler.RemovePermissionInput) codeguruprofiler.RemovePermissionRequest

	SubmitFeedbackRequest(*codeguruprofiler.SubmitFeedbackInput) codeguruprofiler.SubmitFeedbackRequest

	TagResourceRequest(*codeguruprofiler.TagResourceInput) codeguruprofiler.TagResourceRequest

	UntagResourceRequest(*codeguruprofiler.UntagResourceInput) codeguruprofiler.UntagResourceRequest

	UpdateProfilingGroupRequest(*codeguruprofiler.UpdateProfilingGroupInput) codeguruprofiler.UpdateProfilingGroupRequest
}

ClientAPI provides an interface to enable mocking the codeguruprofiler.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 CodeGuru Profiler.
func myFunc(svc codeguruprofileriface.ClientAPI) bool {
    // Make svc.AddNotificationChannels request
}

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

    svc := codeguruprofiler.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 {
    codeguruprofileriface.ClientPI
}
func (m *mockClientClient) AddNotificationChannels(input *codeguruprofiler.AddNotificationChannelsInput) (*codeguruprofiler.AddNotificationChannelsOutput, 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.