Documentation
¶
Overview ¶
Package rekognitioniface provides an interface to enable mocking the Amazon Rekognition 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 {
CompareFacesRequest(*rekognition.CompareFacesInput) rekognition.CompareFacesRequest
CreateCollectionRequest(*rekognition.CreateCollectionInput) rekognition.CreateCollectionRequest
CreateProjectRequest(*rekognition.CreateProjectInput) rekognition.CreateProjectRequest
CreateProjectVersionRequest(*rekognition.CreateProjectVersionInput) rekognition.CreateProjectVersionRequest
CreateStreamProcessorRequest(*rekognition.CreateStreamProcessorInput) rekognition.CreateStreamProcessorRequest
DeleteCollectionRequest(*rekognition.DeleteCollectionInput) rekognition.DeleteCollectionRequest
DeleteFacesRequest(*rekognition.DeleteFacesInput) rekognition.DeleteFacesRequest
DeleteProjectRequest(*rekognition.DeleteProjectInput) rekognition.DeleteProjectRequest
DeleteProjectVersionRequest(*rekognition.DeleteProjectVersionInput) rekognition.DeleteProjectVersionRequest
DeleteStreamProcessorRequest(*rekognition.DeleteStreamProcessorInput) rekognition.DeleteStreamProcessorRequest
DescribeCollectionRequest(*rekognition.DescribeCollectionInput) rekognition.DescribeCollectionRequest
DescribeProjectVersionsRequest(*rekognition.DescribeProjectVersionsInput) rekognition.DescribeProjectVersionsRequest
DescribeProjectsRequest(*rekognition.DescribeProjectsInput) rekognition.DescribeProjectsRequest
DescribeStreamProcessorRequest(*rekognition.DescribeStreamProcessorInput) rekognition.DescribeStreamProcessorRequest
DetectCustomLabelsRequest(*rekognition.DetectCustomLabelsInput) rekognition.DetectCustomLabelsRequest
DetectFacesRequest(*rekognition.DetectFacesInput) rekognition.DetectFacesRequest
DetectLabelsRequest(*rekognition.DetectLabelsInput) rekognition.DetectLabelsRequest
DetectModerationLabelsRequest(*rekognition.DetectModerationLabelsInput) rekognition.DetectModerationLabelsRequest
DetectTextRequest(*rekognition.DetectTextInput) rekognition.DetectTextRequest
GetCelebrityInfoRequest(*rekognition.GetCelebrityInfoInput) rekognition.GetCelebrityInfoRequest
GetCelebrityRecognitionRequest(*rekognition.GetCelebrityRecognitionInput) rekognition.GetCelebrityRecognitionRequest
GetContentModerationRequest(*rekognition.GetContentModerationInput) rekognition.GetContentModerationRequest
GetFaceDetectionRequest(*rekognition.GetFaceDetectionInput) rekognition.GetFaceDetectionRequest
GetFaceSearchRequest(*rekognition.GetFaceSearchInput) rekognition.GetFaceSearchRequest
GetLabelDetectionRequest(*rekognition.GetLabelDetectionInput) rekognition.GetLabelDetectionRequest
GetPersonTrackingRequest(*rekognition.GetPersonTrackingInput) rekognition.GetPersonTrackingRequest
GetSegmentDetectionRequest(*rekognition.GetSegmentDetectionInput) rekognition.GetSegmentDetectionRequest
GetTextDetectionRequest(*rekognition.GetTextDetectionInput) rekognition.GetTextDetectionRequest
IndexFacesRequest(*rekognition.IndexFacesInput) rekognition.IndexFacesRequest
ListCollectionsRequest(*rekognition.ListCollectionsInput) rekognition.ListCollectionsRequest
ListFacesRequest(*rekognition.ListFacesInput) rekognition.ListFacesRequest
ListStreamProcessorsRequest(*rekognition.ListStreamProcessorsInput) rekognition.ListStreamProcessorsRequest
RecognizeCelebritiesRequest(*rekognition.RecognizeCelebritiesInput) rekognition.RecognizeCelebritiesRequest
SearchFacesRequest(*rekognition.SearchFacesInput) rekognition.SearchFacesRequest
SearchFacesByImageRequest(*rekognition.SearchFacesByImageInput) rekognition.SearchFacesByImageRequest
StartCelebrityRecognitionRequest(*rekognition.StartCelebrityRecognitionInput) rekognition.StartCelebrityRecognitionRequest
StartContentModerationRequest(*rekognition.StartContentModerationInput) rekognition.StartContentModerationRequest
StartFaceDetectionRequest(*rekognition.StartFaceDetectionInput) rekognition.StartFaceDetectionRequest
StartFaceSearchRequest(*rekognition.StartFaceSearchInput) rekognition.StartFaceSearchRequest
StartLabelDetectionRequest(*rekognition.StartLabelDetectionInput) rekognition.StartLabelDetectionRequest
StartPersonTrackingRequest(*rekognition.StartPersonTrackingInput) rekognition.StartPersonTrackingRequest
StartProjectVersionRequest(*rekognition.StartProjectVersionInput) rekognition.StartProjectVersionRequest
StartSegmentDetectionRequest(*rekognition.StartSegmentDetectionInput) rekognition.StartSegmentDetectionRequest
StartStreamProcessorRequest(*rekognition.StartStreamProcessorInput) rekognition.StartStreamProcessorRequest
StartTextDetectionRequest(*rekognition.StartTextDetectionInput) rekognition.StartTextDetectionRequest
StopProjectVersionRequest(*rekognition.StopProjectVersionInput) rekognition.StopProjectVersionRequest
StopStreamProcessorRequest(*rekognition.StopStreamProcessorInput) rekognition.StopStreamProcessorRequest
WaitUntilProjectVersionRunning(context.Context, *rekognition.DescribeProjectVersionsInput, ...aws.WaiterOption) error
WaitUntilProjectVersionTrainingCompleted(context.Context, *rekognition.DescribeProjectVersionsInput, ...aws.WaiterOption) error
}
ClientAPI provides an interface to enable mocking the rekognition.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 Rekognition.
func myFunc(svc rekognitioniface.ClientAPI) bool {
// Make svc.CompareFaces request
}
func main() {
cfg, err := external.LoadDefaultAWSConfig()
if err != nil {
panic("failed to load config, " + err.Error())
}
svc := rekognition.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 {
rekognitioniface.ClientPI
}
func (m *mockClientClient) CompareFaces(input *rekognition.CompareFacesInput) (*rekognition.CompareFacesOutput, 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.