cloudcontrol

Implementation details for API cloudcontrol

Coverage Overview


AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
CancelResourceRequest
CreateResource
DeleteResource
GetResource✔️pro✔️✔️✔️Show Tests
GetResourceRequestStatus
ListResourceRequests
ListResources✔️pro✔️✔️✔️Show Tests
UpdateResource

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


GetResource

Parameters: Identifier, TypeName
  • LocalStack Pro
    • test_read_security_group LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_securitygroup.py::test_read_security_group HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_subnet LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_subnet.py::test_read_subnet HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_vpc LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_vpc.py::test_read_vpc HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_key LocalStack Pro: tests/aws/services/cloudcontrol/services/test_kms/test_cloudcontrol_kms_key.py::test_read_key HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_lambda_layer LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_read_lambda_layer HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_layers_dict_identifier LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_read_layers_dict_identifier HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_secrets_basic LocalStack Pro: tests/aws/services/cloudcontrol/services/test_secretsmanager/test_cloudcontrol_secrets.py::test_read_secrets_basic HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_secrets_with_binary LocalStack Pro: tests/aws/services/cloudcontrol/services/test_secretsmanager/test_cloudcontrol_secrets.py::test_read_secrets_with_binary HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_secrets_with_string LocalStack Pro: tests/aws/services/cloudcontrol/services/test_secretsmanager/test_cloudcontrol_secrets.py::test_read_secrets_with_string HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_ssm_parameter[SecureString-Really secret] LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ssm/test_ssm_parameter.py::test_read_ssm_parameter[SecureString-Really secret] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_ssm_parameter[String-SuperSecret] LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ssm/test_ssm_parameter.py::test_read_ssm_parameter[String-SuperSecret] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_ssm_parameter[StringList-super,secret] LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ssm/test_ssm_parameter.py::test_read_ssm_parameter[StringList-super,secret] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_ssm_parameter_dict_identifier LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ssm/test_ssm_parameter.py::test_read_ssm_parameter_dict_identifier HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_with_account_and_region LocalStack Pro: tests/aws/services/cloudcontrol/test_cloudcontrol_apl.py::TestCloudControlApiCredentials::test_with_account_and_region HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_visit_all LocalStack Pro: tests/integration/replicator/core/test_visitor.py::test_visit_all HTTP Status Code: 200 AWS validated
    • test_visit_parameter_type LocalStack Pro: tests/integration/replicator/core/test_visitor.py::test_visit_parameter_type HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_subnets_replication LocalStack Pro: tests/integration/replicator/services/ec2/test_subnets_replication.py::test_subnets_replication HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_replicate_vpc LocalStack Pro: tests/integration/replicator/services/ec2/test_vpc_replication.py::test_replicate_vpc HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_successful_replication LocalStack Pro: tests/integration/replicator/services/kms/test_kms_replication.py::TestKmsSecretReplication::test_successful_replication HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_secrets_replication_kms LocalStack Pro: tests/integration/replicator/services/secretsmanager/test_secrets_replication.py::TestSecretsReplication::test_secrets_replication_kms HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_secrets_replication_no_kms LocalStack Pro: tests/integration/replicator/services/secretsmanager/test_secrets_replication.py::TestSecretsReplication::test_secrets_replication_no_kms HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_successful_replication LocalStack Pro: tests/integration/replicator/services/ssm/test_ssm_replication.py::TestSsmParameterReplication::test_successful_replication HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_read_security_group_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_securitygroup.py::test_read_security_group_not_found HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_read_subnet_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_subnet.py::test_read_subnet_not_found HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_read_vpc_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_vpc.py::test_read_vpc_not_found HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_read_key_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_kms/test_cloudcontrol_kms_key.py::test_read_key_not_found HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_read_lambda_layer LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_read_lambda_layer HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_read_lambda_layer LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_read_lambda_layer HTTP Status Code: 400 (InvalidRequestException) AWS validated Snapshot Tested
    • test_read_layer_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_read_layer_not_found HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_read_secret_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_secretsmanager/test_cloudcontrol_secrets.py::test_read_secret_not_found HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_read_ssm_parameter_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ssm/test_ssm_parameter.py::test_read_ssm_parameter_not_found HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_with_account_and_region LocalStack Pro: tests/aws/services/cloudcontrol/test_cloudcontrol_apl.py::TestCloudControlApiCredentials::test_with_account_and_region HTTP Status Code: 400 (ResourceNotFoundException) AWS validated Snapshot Tested
    • test_resource_unavailable LocalStack Pro: tests/integration/replicator/services/ssm/test_ssm_replication.py::TestSsmParameterReplication::test_resource_unavailable HTTP Status Code: 400 (ResourceNotFoundException) AWS validated
    • test_read_layer_not_found LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_read_layer_not_found HTTP Status Code: 500 (HandlerInternalFailureException) AWS validated Snapshot Tested

ListResources

Parameters: ResourceModel, TypeName
  • LocalStack Pro
    • test_list_layer_version LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_list_layer_version HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: TypeName
  • LocalStack Pro
    • test_list_security_groups LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_securitygroup.py::test_list_security_groups HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_subnets LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_subnet.py::test_list_subnets HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_vpc LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ec2/test_cloudcontrol_vpc.py::test_list_vpc HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_keys LocalStack Pro: tests/aws/services/cloudcontrol/services/test_kms/test_cloudcontrol_kms_key.py::test_list_keys HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_secret LocalStack Pro: tests/aws/services/cloudcontrol/services/test_secretsmanager/test_cloudcontrol_secrets.py::test_list_secret HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_list_ssm_parameter LocalStack Pro: tests/aws/services/cloudcontrol/services/test_ssm/test_ssm_parameter.py::test_list_ssm_parameter HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_with_account_and_region LocalStack Pro: tests/aws/services/cloudcontrol/test_cloudcontrol_apl.py::TestCloudControlApiCredentials::test_with_account_and_region HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_visit_all LocalStack Pro: tests/integration/replicator/core/test_visitor.py::test_visit_all HTTP Status Code: 200 AWS validated
    • test_filter_by_service LocalStack Pro: tests/integration/services/internal/resources/test_resources.py::TestResourcesEndpoint::test_filter_by_service HTTP Status Code: 200
    • test_get_global_resource LocalStack Pro: tests/integration/services/internal/resources/test_resources.py::TestResourcesEndpoint::test_get_global_resource HTTP Status Code: 200
    • test_get_resource LocalStack Pro: tests/integration/services/internal/resources/test_resources.py::TestResourcesEndpoint::test_get_resource HTTP Status Code: 200
    • test_list_layer_version LocalStack Pro: tests/aws/services/cloudcontrol/services/test_lambda_/test_cloudcontrol_lambda_layer.py::test_list_layer_version HTTP Status Code: 400 (InvalidRequestException) AWS validated Snapshot Tested
    • test_get_global_resource LocalStack Pro: tests/integration/services/internal/resources/test_resources.py::TestResourcesEndpoint::test_get_global_resource HTTP Status Code: 400 (InvalidRequestException)
    • test_get_resource LocalStack Pro: tests/integration/services/internal/resources/test_resources.py::TestResourcesEndpoint::test_get_resource HTTP Status Code: 400 (InvalidRequestException)

Last modified November 25, 2024: Update Parity Coverage Docs (#1581) (f33406e58)