Skip to content

fix: Relax document version check for authorizers #5477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucashuy merged 2 commits into from
Jul 11, 2023
Merged

fix: Relax document version check for authorizers #5477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cee8398
Relax document version check for authorizers
lucashuy Jul 10, 2023
9fbcfc8
Merge branch 'develop' into relax_doc_version_check
lucashuy Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions samcli/commands/local/lib/swagger/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ def get_authorizers(self, event_type: str = Route.API) -> Dict[str, Authorizer]:
authorizers: Dict[str, Authorizer] = {}

authorizer_dict = {}
document_version = self.swagger.get(SwaggerParser._SWAGGER) or self.swagger.get(SwaggerParser._OPENAPI) or ""
document_version = self._get_document_version()

if document_version.startswith(SwaggerParser._2_X_VERSION):
LOG.debug("Parsing Swagger document using 2.0 specification")
Expand Down Expand Up @@ -240,6 +240,19 @@ def _get_lambda_identity_sources(

return identity_sources

def _get_document_version(self) -> str:
"""
Helper method to fetch the Swagger document version

Returns
-------
str
A string representing a version, blank if not found
"""
document_version = self.swagger.get(SwaggerParser._SWAGGER) or self.swagger.get(SwaggerParser._OPENAPI) or ""

return str(document_version)

def get_default_authorizer(self, event_type: str) -> Union[str, None]:
"""
Parses the body definition to find root level Authorizer definitions
Expand All @@ -254,7 +267,7 @@ def get_default_authorizer(self, event_type: str) -> Union[str, None]:
Union[str, None]
Returns the name of the authorizer, if there is one defined, otherwise None
"""
document_version = self.swagger.get(SwaggerParser._SWAGGER) or self.swagger.get(SwaggerParser._OPENAPI) or ""
document_version = self._get_document_version()
authorizers = self.swagger.get(SwaggerParser._SWAGGER_SECURITY, [])

if not authorizers:
Expand Down
18 changes: 18 additions & 0 deletions tests/unit/commands/local/lib/swagger/test_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1022,3 +1022,21 @@ def test_invalid_identity_source_throws_exception(self):

with self.assertRaises(InvalidSecurityDefinition):
parser._get_lambda_identity_sources(Mock(), "request", Route.API, properties, auth_properties)


class TestGetDocumentVersion(TestCase):
@parameterized.expand(
[
({"swagger": "2.0"}, "2.0"),
({"swagger": 2.0}, "2.0"),
({"openapi": "3.0"}, "3.0"),
({"openapi": 3.0}, "3.0"),
({"not valid": 3.0}, ""),
({}, ""),
]
)
def test_get_document_version(self, swagger_doc, expected_output):
parser = SwaggerParser(Mock(), swagger_doc)
output = parser._get_document_version()

self.assertEqual(output, expected_output)