Skip to content
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

Revert requestparams #1157

Closed
wants to merge 2 commits into from
Closed

Revert requestparams #1157

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
8da2295
revert request parameters commit: (#953)
Sep 24, 2019
1af3207
removed the output test files
Sep 24, 2019
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
6 changes: 0 additions & 6 deletions examples/2016-10-31/function_request_parameters/src/index.js
View file
Open in desktop

This file was deleted.

33 changes: 0 additions & 33 deletions examples/2016-10-31/function_request_parameters/template.yaml
View file
Open in desktop

This file was deleted.

60 changes: 1 addition & 59 deletions samtranslator/model/eventsources/push.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@

CONDITION = 'Condition'

REQUEST_PARAMETER_PROPERTIES = ["Required", "Caching"]


class PushEventSource(ResourceMacro):
"""Base class for push event sources for SAM Functions.
Expand Down Expand Up @@ -451,8 +449,7 @@ class Api(PushEventSource):
'RestApiId': PropertyType(True, is_str()),
'Stage': PropertyType(False, is_str()),
'Auth': PropertyType(False, is_type(dict)),
'RequestModel': PropertyType(False, is_type(dict)),
'RequestParameters': PropertyType(False, is_type(list))
'RequestModel': PropertyType(False, is_type(dict))
}

def resources_to_link(self, resources):
Expand Down Expand Up @@ -666,61 +663,6 @@ def _add_swagger_integration(self, api, function):
editor.add_request_model_to_method(path=self.Path, method_name=self.Method,
request_model=self.RequestModel)

if self.RequestParameters:

default_value = {
'Required': False,
'Caching': False
}

parameters = []
for parameter in self.RequestParameters:

if isinstance(parameter, dict):

parameter_name, parameter_value = next(iter(parameter.items()))

if not re.match('method\.request\.(querystring|path|header)\.', parameter_name):
raise InvalidEventException(
self.relative_id,
"Invalid value for 'RequestParameters' property. Keys must be in the format "
"'method.request.[querystring|path|header].{value}', "
"e.g 'method.request.header.Authorization'.")

if not isinstance(parameter_value, dict) or not all(key in REQUEST_PARAMETER_PROPERTIES
for key in parameter_value.keys()):
raise InvalidEventException(
self.relative_id,
"Invalid value for 'RequestParameters' property. Values must be an object, "
"e.g { Required: true, Caching: false }")

settings = default_value.copy()
settings.update(parameter_value)
settings.update({'Name': parameter_name})

parameters.append(settings)

elif isinstance(parameter, string_types):
if not re.match('method\.request\.(querystring|path|header)\.', parameter):
raise InvalidEventException(
self.relative_id,
"Invalid value for 'RequestParameters' property. Keys must be in the format "
"'method.request.[querystring|path|header].{value}', "
"e.g 'method.request.header.Authorization'.")

settings = default_value.copy()
settings.update({'Name': parameter})

parameters.append(settings)

else:
raise InvalidEventException(
self.relative_id,
"Invalid value for 'RequestParameters' property. Property must be either a string or an object")

editor.add_request_parameters_to_method(path=self.Path, method_name=self.Method,
request_parameters=parameters)

api["DefinitionBody"] = editor.swagger


Expand Down
48 changes: 0 additions & 48 deletions samtranslator/swagger/swagger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ class SwaggerEditor(object):
_X_APIGW_GATEWAY_RESPONSES = 'x-amazon-apigateway-gateway-responses'
_X_APIGW_POLICY = 'x-amazon-apigateway-policy'
_X_ANY_METHOD = 'x-amazon-apigateway-any-method'
_CACHE_KEY_PARAMETERS = 'cacheKeyParameters'
# https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
_ALL_HTTP_METHODS = ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE", "PATCH"]
_POLICY_TYPE_IAM = "Iam"
Expand Down Expand Up @@ -1004,53 +1003,6 @@ def _add_custom_statement(self, custom_statements):
statement.extend(custom_statements)
self.resource_policy['Statement'] = statement

def add_request_parameters_to_method(self, path, method_name, request_parameters):
"""
Add Parameters to Swagger.

:param string path: Path name
:param string method_name: Method name
:param list request_parameters: Dictionary of Parameters
:return:
"""

normalized_method_name = self._normalize_method_name(method_name)
# It is possible that the method could have two definitions in a Fn::If block.
for method_definition in self.get_method_contents(self.get_path(path)[normalized_method_name]):

# If no integration given, then we don't need to process this definition (could be AWS::NoValue)
if not self.method_definition_has_integration(method_definition):
continue

existing_parameters = method_definition.get('parameters', [])

for request_parameter in request_parameters:

parameter_name = request_parameter['Name']
location_name = parameter_name.replace('method.request.', '')
location, name = location_name.split('.')

if location == 'querystring':
location = 'query'

parameter = {
'in': location,
'name': name,
'required': request_parameter['Required'],
'type': 'string'
}

existing_parameters.append(parameter)

if request_parameter['Caching']:

integration = method_definition[self._X_APIGW_INTEGRATION]
cache_parameters = integration.get(self._CACHE_KEY_PARAMETERS, [])
cache_parameters.append(parameter_name)
integration[self._CACHE_KEY_PARAMETERS] = cache_parameters

method_definition['parameters'] = existing_parameters

@property
def swagger(self):
"""
Expand Down
134 changes: 0 additions & 134 deletions tests/swagger/test_swagger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,140 +1237,6 @@ def test_set_method_apikey_handling_apikeyrequired_true(self):
self.assertEqual(expected, self.editor.swagger["paths"][path][method]["security"])


class TestSwaggerEditor_add_request_parameter_to_method(TestCase):

def setUp(self):
self.original_swagger = {
"swagger": "2.0",
"paths": {
"/foo": {
'get': {
'x-amazon-apigateway-integration': {
'test': 'must have integration'
}
}
}
}
}

self.editor = SwaggerEditor(self.original_swagger)

def test_must_add_parameter_to_method_with_required_and_caching_true(self):

parameters = [{
'Name': 'method.request.header.Authorization',
'Required': True,
'Caching': True
}]

self.editor.add_request_parameters_to_method('/foo', 'get', parameters)

expected_parameters = [
{
'in': 'header',
'required': True,
'name': 'Authorization',
'type': 'string'
}
]

method_swagger = self.editor.swagger['paths']['/foo']['get']

self.assertEqual(expected_parameters, method_swagger['parameters'])
self.assertEqual(['method.request.header.Authorization'], method_swagger[_X_INTEGRATION]['cacheKeyParameters'])

def test_must_add_parameter_to_method_with_required_and_caching_false(self):

parameters = [{
'Name': 'method.request.header.Authorization',
'Required': False,
'Caching': False
}]

self.editor.add_request_parameters_to_method('/foo', 'get', parameters)

expected_parameters = [
{
'in': 'header',
'required': False,
'name': 'Authorization',
'type': 'string'
}
]

method_swagger = self.editor.swagger['paths']['/foo']['get']

self.assertEqual(expected_parameters, method_swagger['parameters'])
self.assertNotIn('cacheKeyParameters', method_swagger[_X_INTEGRATION].keys())

def test_must_add_parameter_to_method_with_existing_parameters(self):

original_swagger = {
"swagger": "2.0",
"paths": {
"/foo": {
'get': {
'x-amazon-apigateway-integration': {
'test': 'must have integration'
},
'parameters': [{'test': 'existing parameter'}]
}
}
}
}

editor = SwaggerEditor(original_swagger)

parameters = [{
'Name': 'method.request.header.Authorization',
'Required': False,
'Caching': False
}]

editor.add_request_parameters_to_method('/foo', 'get', parameters)

expected_parameters = [
{
'test': 'existing parameter'
},
{
'in': 'header',
'required': False,
'name': 'Authorization',
'type': 'string'
}
]

method_swagger = editor.swagger['paths']['/foo']['get']

self.assertEqual(expected_parameters, method_swagger['parameters'])
self.assertNotIn('cacheKeyParameters', method_swagger[_X_INTEGRATION].keys())

def test_must_not_add_parameter_to_method_without_integration(self):
original_swagger = {
"swagger": "2.0",
"paths": {
"/foo": {
'get': {}
}
}
}

editor = SwaggerEditor(original_swagger)

parameters = [{
'Name': 'method.request.header.Authorization',
'Required': True,
'Caching': True
}]

editor.add_request_parameters_to_method('/foo', 'get', parameters)

expected = {}

self.assertEqual(expected, editor.swagger['paths']['/foo']['get'])


class TestSwaggerEditor_add_resource_policy(TestCase):
def setUp(self):

Expand Down
Loading