Documentation
¶
Overview ¶
Package kmsiface provides an interface to enable mocking the AWS Key Management Service 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 {
CancelKeyDeletionRequest(*kms.CancelKeyDeletionInput) kms.CancelKeyDeletionRequest
ConnectCustomKeyStoreRequest(*kms.ConnectCustomKeyStoreInput) kms.ConnectCustomKeyStoreRequest
CreateAliasRequest(*kms.CreateAliasInput) kms.CreateAliasRequest
CreateCustomKeyStoreRequest(*kms.CreateCustomKeyStoreInput) kms.CreateCustomKeyStoreRequest
CreateGrantRequest(*kms.CreateGrantInput) kms.CreateGrantRequest
CreateKeyRequest(*kms.CreateKeyInput) kms.CreateKeyRequest
DecryptRequest(*kms.DecryptInput) kms.DecryptRequest
DeleteAliasRequest(*kms.DeleteAliasInput) kms.DeleteAliasRequest
DeleteCustomKeyStoreRequest(*kms.DeleteCustomKeyStoreInput) kms.DeleteCustomKeyStoreRequest
DeleteImportedKeyMaterialRequest(*kms.DeleteImportedKeyMaterialInput) kms.DeleteImportedKeyMaterialRequest
DescribeCustomKeyStoresRequest(*kms.DescribeCustomKeyStoresInput) kms.DescribeCustomKeyStoresRequest
DescribeKeyRequest(*kms.DescribeKeyInput) kms.DescribeKeyRequest
DisableKeyRequest(*kms.DisableKeyInput) kms.DisableKeyRequest
DisableKeyRotationRequest(*kms.DisableKeyRotationInput) kms.DisableKeyRotationRequest
DisconnectCustomKeyStoreRequest(*kms.DisconnectCustomKeyStoreInput) kms.DisconnectCustomKeyStoreRequest
EnableKeyRequest(*kms.EnableKeyInput) kms.EnableKeyRequest
EnableKeyRotationRequest(*kms.EnableKeyRotationInput) kms.EnableKeyRotationRequest
EncryptRequest(*kms.EncryptInput) kms.EncryptRequest
GenerateDataKeyRequest(*kms.GenerateDataKeyInput) kms.GenerateDataKeyRequest
GenerateDataKeyWithoutPlaintextRequest(*kms.GenerateDataKeyWithoutPlaintextInput) kms.GenerateDataKeyWithoutPlaintextRequest
GenerateRandomRequest(*kms.GenerateRandomInput) kms.GenerateRandomRequest
GetKeyPolicyRequest(*kms.GetKeyPolicyInput) kms.GetKeyPolicyRequest
GetKeyRotationStatusRequest(*kms.GetKeyRotationStatusInput) kms.GetKeyRotationStatusRequest
GetParametersForImportRequest(*kms.GetParametersForImportInput) kms.GetParametersForImportRequest
ImportKeyMaterialRequest(*kms.ImportKeyMaterialInput) kms.ImportKeyMaterialRequest
ListAliasesRequest(*kms.ListAliasesInput) kms.ListAliasesRequest
ListGrantsRequest(*kms.ListGrantsInput) kms.ListGrantsRequest
ListKeyPoliciesRequest(*kms.ListKeyPoliciesInput) kms.ListKeyPoliciesRequest
ListKeysRequest(*kms.ListKeysInput) kms.ListKeysRequest
ListResourceTagsRequest(*kms.ListResourceTagsInput) kms.ListResourceTagsRequest
ListRetirableGrantsRequest(*kms.ListRetirableGrantsInput) kms.ListRetirableGrantsRequest
PutKeyPolicyRequest(*kms.PutKeyPolicyInput) kms.PutKeyPolicyRequest
ReEncryptRequest(*kms.ReEncryptInput) kms.ReEncryptRequest
RetireGrantRequest(*kms.RetireGrantInput) kms.RetireGrantRequest
RevokeGrantRequest(*kms.RevokeGrantInput) kms.RevokeGrantRequest
ScheduleKeyDeletionRequest(*kms.ScheduleKeyDeletionInput) kms.ScheduleKeyDeletionRequest
TagResourceRequest(*kms.TagResourceInput) kms.TagResourceRequest
UntagResourceRequest(*kms.UntagResourceInput) kms.UntagResourceRequest
UpdateAliasRequest(*kms.UpdateAliasInput) kms.UpdateAliasRequest
UpdateCustomKeyStoreRequest(*kms.UpdateCustomKeyStoreInput) kms.UpdateCustomKeyStoreRequest
UpdateKeyDescriptionRequest(*kms.UpdateKeyDescriptionInput) kms.UpdateKeyDescriptionRequest
}
ClientAPI provides an interface to enable mocking the kms.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
// KMS.
func myFunc(svc kmsiface.ClientAPI) bool {
// Make svc.CancelKeyDeletion request
}
func main() {
cfg, err := external.LoadDefaultAWSConfig()
if err != nil {
panic("failed to load config, " + err.Error())
}
svc := kms.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 {
kmsiface.ClientPI
}
func (m *mockClientClient) CancelKeyDeletion(input *kms.CancelKeyDeletionInput) (*kms.CancelKeyDeletionOutput, 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