Skip to content

Commit

Permalink
APIGateway: fix strict filtering for API keys (#8220)
Browse files Browse the repository at this point in the history
  • Loading branch information
bentsku authored Oct 10, 2024
1 parent 84cac7a commit d184a3f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
12 changes: 10 additions & 2 deletions moto/apigateway/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -2151,7 +2151,11 @@ def create_api_key(self, payload: Dict[str, Any]) -> ApiKey:
return key

def get_api_keys(self, name: Optional[str] = None) -> List[ApiKey]:
return [key for key in self.keys.values() if not name or name == key.name]
return [
key
for key in self.keys.values()
if not name or (key.name and key.name.startswith(name))
]

def get_api_key(self, api_key_id: str) -> ApiKey:
if api_key_id not in self.keys:
Expand Down Expand Up @@ -2230,7 +2234,11 @@ def get_usage_plan_keys(

plan_keys = self.usage_plan_keys[usage_plan_id].values()
if name:
return [key for key in plan_keys if not name or key.name == name]
return [
key
for key in plan_keys
if not name or (key.name and key.name.startswith(name))
]
return list(plan_keys)

def get_usage_plan_key(self, usage_plan_id: str, key_id: str) -> UsagePlanKey:
Expand Down
11 changes: 11 additions & 0 deletions tests/test_apigateway/test_apigateway.py
Original file line number Diff line number Diff line change
Expand Up @@ -1555,9 +1555,17 @@ def test_get_api_keys():
keys = client.get_api_keys(nameQuery="TESTKEY2")["items"]
assert [key["name"] for key in keys] == ["TESTKEY2"]

# assert that passing only a prefix works
keys = client.get_api_keys(nameQuery="TESTKEY")["items"]
assert [key["name"] for key in keys] == ["TESTKEY1", "TESTKEY2"]

keys = client.get_api_keys(nameQuery="TESTKEY3")["items"]
assert keys == []

# assert that suffix of a name does not work
keys = client.get_api_keys(nameQuery="KEY2")["items"]
assert keys == []


@mock_aws
def test_create_api_key():
Expand Down Expand Up @@ -1791,6 +1799,9 @@ def test_usage_plan_keys():
# Query By Name
plans = client.get_usage_plan_keys(usagePlanId=usage_plan_id, nameQuery=key_name)
assert len(plans["items"]) == 1
# test using only a prefix
plans = client.get_usage_plan_keys(usagePlanId=usage_plan_id, nameQuery="test-")
assert len(plans["items"]) == 1
plans = client.get_usage_plan_keys(usagePlanId=usage_plan_id, nameQuery="unknown")
assert len(plans["items"]) == 0

Expand Down

0 comments on commit d184a3f

Please sign in to comment.