Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

openapi: Use standardized URL format in validator test. 

Now that the URL format has been standardized as {var_name},
we can finally clean up the validator test.
This commit is contained in:
Hemanth V. Alluri 2019-07-11 22:35:48 +05:30 committed by Tim Abbott
parent ffd2bccd4e
commit 644fba495b
1 changed files with 16 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
zerver/tests/test_openapi.py
View File

@ -291,42 +291,25 @@ class OpenAPIArgumentsTest(ZulipTestCase):
self.assertTrue(regex_pattern.startswith("^")) self.assertTrue(regex_pattern.startswith("^"))
self.assertTrue(regex_pattern.endswith("$")) self.assertTrue(regex_pattern.endswith("$"))
url_pattern = '/' + regex_pattern[1:][:-1] url_pattern = '/' + regex_pattern[1:][:-1]
# Deal with the conversion of named capturing groups: url_pattern = re.sub(r"\(\?P<(\w+)>[^/]+\)", r"{\1}", url_pattern)
# Two possible ways to denote variables in urls exist.
# {var_name} and <var_name>. So we need to consider both.
url_patterns = [re.sub(r"\(\?P<(\w+)>[^/]+\)", r"<\1>", url_pattern),
re.sub(r"\(\?P<(\w+)>[^/]+\)", r"{\1}", url_pattern)]
if any([url_patterns[0] in self.pending_endpoints, if url_pattern in self.pending_endpoints:
url_patterns[1] in self.pending_endpoints]):
continue continue
if "intentionally_undocumented" in tags: if "intentionally_undocumented" in tags:
error = AssertionError("We found some OpenAPI \
documentation for %s %s, so maybe we shouldn't mark it as intentionally \
undocumented in the urls." % (method, url_patterns[0] + " or " + url_patterns[1]))
try: try:
get_openapi_parameters(url_patterns[0], method) get_openapi_parameters(url_pattern, method)
raise error # nocoverage raise AssertionError("We found some OpenAPI \
documentation for %s %s, so maybe we shouldn't mark it as intentionally \
undocumented in the urls." % (method, url_pattern)) # nocoverage
except KeyError: except KeyError:
pass continue
try:
get_openapi_parameters(url_patterns[1], method)
raise error # nocoverage
except KeyError:
pass
continue # nocoverage # although, this *is* covered.
try: try:
openapi_parameters = get_openapi_parameters(url_patterns[0], method) openapi_parameters = get_openapi_parameters(url_pattern, method)
except Exception: # nocoverage except Exception: # nocoverage
try: raise AssertionError("Could not find OpenAPI docs for %s %s" %
openapi_parameters = get_openapi_parameters(url_patterns[1], method) (method, url_pattern))
except Exception: # nocoverage
raise AssertionError("Could not find OpenAPI docs for %s %s" %
(method, url_patterns[0] + " or " + url_patterns[1]))
# We now have everything we need to understand the # We now have everything we need to understand the
# function as defined in our urls.py: # function as defined in our urls.py:
@ -353,24 +336,19 @@ undocumented in the urls." % (method, url_patterns[0] + " or " + url_patterns[1]
if len(openapi_parameter_names - accepted_arguments) > 0: if len(openapi_parameter_names - accepted_arguments) > 0:
print("Undocumented parameters for", print("Undocumented parameters for",
url_patterns[0] + " or " + url_patterns[1], url_pattern, method, function)
method, function)
print(" +", openapi_parameter_names) print(" +", openapi_parameter_names)
print(" -", accepted_arguments) print(" -", accepted_arguments)
assert(any([url_patterns[0] in self.buggy_documentation_endpoints, assert(url_pattern in self.buggy_documentation_endpoints)
url_patterns[1] in self.buggy_documentation_endpoints]))
elif len(accepted_arguments - openapi_parameter_names) > 0: elif len(accepted_arguments - openapi_parameter_names) > 0:
print("Documented invalid parameters for", print("Documented invalid parameters for",
url_patterns[0] + " or " + url_patterns[1], url_pattern, method, function)
method, function)
print(" -", openapi_parameter_names) print(" -", openapi_parameter_names)
print(" +", accepted_arguments) print(" +", accepted_arguments)
assert(any([url_patterns[0] in self.buggy_documentation_endpoints, assert(url_pattern in self.buggy_documentation_endpoints)
url_patterns[1] in self.buggy_documentation_endpoints]))
else: else:
self.assertEqual(openapi_parameter_names, accepted_arguments) self.assertEqual(openapi_parameter_names, accepted_arguments)
self.checked_endpoints.add(url_patterns[0]) self.checked_endpoints.add(url_pattern)
self.checked_endpoints.add(url_patterns[1])
openapi_paths = set(get_openapi_paths()) openapi_paths = set(get_openapi_paths())
undocumented_paths = openapi_paths - self.checked_endpoints undocumented_paths = openapi_paths - self.checked_endpoints