Documentation
¶
Overview ¶
Package appstreamiface provides an interface to enable mocking the Amazon AppStream 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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientAPI ¶ added in v0.9.0
type ClientAPI interface {
AssociateFleetRequest(*appstream.AssociateFleetInput) appstream.AssociateFleetRequest
BatchAssociateUserStackRequest(*appstream.BatchAssociateUserStackInput) appstream.BatchAssociateUserStackRequest
BatchDisassociateUserStackRequest(*appstream.BatchDisassociateUserStackInput) appstream.BatchDisassociateUserStackRequest
CopyImageRequest(*appstream.CopyImageInput) appstream.CopyImageRequest
CreateDirectoryConfigRequest(*appstream.CreateDirectoryConfigInput) appstream.CreateDirectoryConfigRequest
CreateFleetRequest(*appstream.CreateFleetInput) appstream.CreateFleetRequest
CreateImageBuilderRequest(*appstream.CreateImageBuilderInput) appstream.CreateImageBuilderRequest
CreateImageBuilderStreamingURLRequest(*appstream.CreateImageBuilderStreamingURLInput) appstream.CreateImageBuilderStreamingURLRequest
CreateStackRequest(*appstream.CreateStackInput) appstream.CreateStackRequest
CreateStreamingURLRequest(*appstream.CreateStreamingURLInput) appstream.CreateStreamingURLRequest
CreateUsageReportSubscriptionRequest(*appstream.CreateUsageReportSubscriptionInput) appstream.CreateUsageReportSubscriptionRequest
CreateUserRequest(*appstream.CreateUserInput) appstream.CreateUserRequest
DeleteDirectoryConfigRequest(*appstream.DeleteDirectoryConfigInput) appstream.DeleteDirectoryConfigRequest
DeleteFleetRequest(*appstream.DeleteFleetInput) appstream.DeleteFleetRequest
DeleteImageRequest(*appstream.DeleteImageInput) appstream.DeleteImageRequest
DeleteImageBuilderRequest(*appstream.DeleteImageBuilderInput) appstream.DeleteImageBuilderRequest
DeleteImagePermissionsRequest(*appstream.DeleteImagePermissionsInput) appstream.DeleteImagePermissionsRequest
DeleteStackRequest(*appstream.DeleteStackInput) appstream.DeleteStackRequest
DeleteUsageReportSubscriptionRequest(*appstream.DeleteUsageReportSubscriptionInput) appstream.DeleteUsageReportSubscriptionRequest
DeleteUserRequest(*appstream.DeleteUserInput) appstream.DeleteUserRequest
DescribeDirectoryConfigsRequest(*appstream.DescribeDirectoryConfigsInput) appstream.DescribeDirectoryConfigsRequest
DescribeFleetsRequest(*appstream.DescribeFleetsInput) appstream.DescribeFleetsRequest
DescribeImageBuildersRequest(*appstream.DescribeImageBuildersInput) appstream.DescribeImageBuildersRequest
DescribeImagePermissionsRequest(*appstream.DescribeImagePermissionsInput) appstream.DescribeImagePermissionsRequest
DescribeImagesRequest(*appstream.DescribeImagesInput) appstream.DescribeImagesRequest
DescribeSessionsRequest(*appstream.DescribeSessionsInput) appstream.DescribeSessionsRequest
DescribeStacksRequest(*appstream.DescribeStacksInput) appstream.DescribeStacksRequest
DescribeUsageReportSubscriptionsRequest(*appstream.DescribeUsageReportSubscriptionsInput) appstream.DescribeUsageReportSubscriptionsRequest
DescribeUserStackAssociationsRequest(*appstream.DescribeUserStackAssociationsInput) appstream.DescribeUserStackAssociationsRequest
DescribeUsersRequest(*appstream.DescribeUsersInput) appstream.DescribeUsersRequest
DisableUserRequest(*appstream.DisableUserInput) appstream.DisableUserRequest
DisassociateFleetRequest(*appstream.DisassociateFleetInput) appstream.DisassociateFleetRequest
EnableUserRequest(*appstream.EnableUserInput) appstream.EnableUserRequest
ExpireSessionRequest(*appstream.ExpireSessionInput) appstream.ExpireSessionRequest
ListAssociatedFleetsRequest(*appstream.ListAssociatedFleetsInput) appstream.ListAssociatedFleetsRequest
ListAssociatedStacksRequest(*appstream.ListAssociatedStacksInput) appstream.ListAssociatedStacksRequest
ListTagsForResourceRequest(*appstream.ListTagsForResourceInput) appstream.ListTagsForResourceRequest
StartFleetRequest(*appstream.StartFleetInput) appstream.StartFleetRequest
StartImageBuilderRequest(*appstream.StartImageBuilderInput) appstream.StartImageBuilderRequest
StopFleetRequest(*appstream.StopFleetInput) appstream.StopFleetRequest
StopImageBuilderRequest(*appstream.StopImageBuilderInput) appstream.StopImageBuilderRequest
TagResourceRequest(*appstream.TagResourceInput) appstream.TagResourceRequest
UntagResourceRequest(*appstream.UntagResourceInput) appstream.UntagResourceRequest
UpdateDirectoryConfigRequest(*appstream.UpdateDirectoryConfigInput) appstream.UpdateDirectoryConfigRequest
UpdateFleetRequest(*appstream.UpdateFleetInput) appstream.UpdateFleetRequest
UpdateImagePermissionsRequest(*appstream.UpdateImagePermissionsInput) appstream.UpdateImagePermissionsRequest
UpdateStackRequest(*appstream.UpdateStackInput) appstream.UpdateStackRequest
WaitUntilFleetStarted(context.Context, *appstream.DescribeFleetsInput, ...aws.WaiterOption) error
WaitUntilFleetStopped(context.Context, *appstream.DescribeFleetsInput, ...aws.WaiterOption) error
}
ClientAPI provides an interface to enable mocking the appstream.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 AppStream.
func myFunc(svc appstreamiface.ClientAPI) bool {
// Make svc.AssociateFleet request
}
func main() {
cfg, err := external.LoadDefaultAWSConfig()
if err != nil {
panic("failed to load config, " + err.Error())
}
svc := appstream.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 {
appstreamiface.ClientPI
}
func (m *mockClientClient) AssociateFleet(input *appstream.AssociateFleetInput) (*appstream.AssociateFleetOutput, 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.
Source Files
Click to show internal directories.
Click to hide internal directories.