Pi-Hole/FTL
1
0
Fork 0
mirror of https://github.com/pi-hole/FTL.git synced 2026-07-09 04:03:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add checking of all endpoints defined in FTL but not in the OpenAPI specs and vice versa

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2023-11-02 05:28:07 +01:00
parent 38463dcbc2
commit 5993b66bca
3 changed files with 101 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/api/checkAPI.py
+25 -12
View File
@@ -48,7 +48,7 @@ if __name__ == "__main__":
# Check if endpoints that are in both FTL and OpenAPI specs match
# and have the same response format. Also verify that the examples
# matches the OpenAPI specs.
print("Verifying the individual endpoint properties...")
print("Verifying the individual OpenAPI endpoint properties...")
teleporter = None
for path in openapi.endpoints["get"]:
# We do not check the action endpoints as they'd trigger
@@ -56,19 +56,32 @@ if __name__ == "__main__":
# gravity, stutting down the system, etc.
if path.startswith("/api/action"):
continue
verifyer = ResponseVerifyer(ftl, openapi)
errors = verifyer.verify_endpoint(path)
if verifyer.teleporter_archive is not None:
teleporter = verifyer.teleporter_archive
if len(errors) == 0:
print(" GET " + path + " (" + verifyer.auth_method + " auth): OK")
else:
print(" GET " + path + " (" + verifyer.auth_method + " auth):")
for error in errors:
print(" - " + error)
errs[2] += len(errors)
with ResponseVerifyer(ftl, openapi) as verifyer:
errors = verifyer.verify_endpoint(path)
if verifyer.teleporter_archive is not None:
teleporter = verifyer.teleporter_archive
if len(errors) == 0:
print(" GET " + path + " (" + verifyer.auth_method + " auth): OK")
else:
print(" GET " + path + " (" + verifyer.auth_method + " auth):")
for error in errors:
print(" - " + error)
errs[2] += len(errors)
print("")
# Verify that all the endpoint defined by GET /api/endpoints are documented
# and that there are no undocumented endpoints
print("Verifying the /api/endpoints endpoint...")
verifyer = ResponseVerifyer(ftl, openapi)
errors = verifyer.verify_endpoints()
if len(errors) == 0:
print(" GET /api/endpoints: OK")
else:
print(" Errors:")
for error in errors:
print(" - " + error)
errs[2] += len(errors)
# Verify FTL Teleporter import
print("Verifying FTL Teleporter import...")
verifyer = ResponseVerifyer(ftl, openapi)