Resource Groups

Implementation details for API resource-groups

Coverage Overview

Resource Groups is supported by LocalStack in the community image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
CreateGroup✔️community✔️✔️✔️✔️✔️Show Tests
DeleteGroup✔️community✔️✔️✔️✔️✔️Show Tests
GetAccountSettings
GetGroup✔️community✔️✔️✔️✔️✔️Show Tests
GetGroupConfiguration✔️community✔️✔️
GetGroupQuery✔️community✔️✔️
GetTags✔️✔️
GroupResources
ListGroupResources
ListGroups✔️community✔️✔️✔️✔️Show Tests
PutGroupConfiguration✔️community✔️
SearchResources
Tag✔️
UngroupResources
Untag✔️
UpdateAccountSettings
UpdateGroup✔️community✔️
UpdateGroupQuery✔️community✔️

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


CreateGroup

Parameters: Description, Name
  • LocalStack Community
    • test_sub_in_lambda_function_name LocalStack Community: tests/aws/services/cloudformation/resources/test_legacy.py::TestCloudFormation::test_sub_in_lambda_function_name HTTP Status Code: 200
Parameters: Description, Name, ResourceQuery, Tags
  • LocalStack Community
    • test_create_group LocalStack Community: tests/aws/services/resource_groups/test_resource_groups.py::TestResourceGroups::test_create_group HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteGroup

Parameters: GroupName
  • LocalStack Community
    • test_sub_in_lambda_function_name LocalStack Community: tests/aws/services/cloudformation/resources/test_legacy.py::TestCloudFormation::test_sub_in_lambda_function_name HTTP Status Code: 200
    • test_create_group LocalStack Community: tests/aws/services/resource_groups/test_resource_groups.py::TestResourceGroups::test_create_group HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_create_group LocalStack Community: tests/aws/services/resource_groups/test_resource_groups.py::TestResourceGroups::test_create_group HTTP Status Code: 500 (InternalError) AWS validated Snapshot Tested

GetGroup

Parameters: GroupName
  • LocalStack Community
    • test_create_group LocalStack Community: tests/aws/services/resource_groups/test_resource_groups.py::TestResourceGroups::test_create_group HTTP Status Code: 200 AWS validated Snapshot Tested

ListGroups

Parameters: - (without any parameters)
  • LocalStack Community
    • test_sub_in_lambda_function_name LocalStack Community: tests/aws/services/cloudformation/resources/test_legacy.py::TestCloudFormation::test_sub_in_lambda_function_name HTTP Status Code: 200
    • test_create_group LocalStack Community: tests/aws/services/resource_groups/test_resource_groups.py::TestResourceGroups::test_create_group HTTP Status Code: 200 AWS validated Snapshot Tested

Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)