Python: Add annotations for flask response tests

The fact that we need to add routeSetup and routeHandler annotations is sort of
annoying :|

python/ql/test/experimental/library-tests/frameworks/flask/response_test.py

@@ -5,23 +5,23 @@ from flask import Flask, make_response, jsonify, Response
 app = Flask(__name__)
 
 
-@app.route("/html1")
-def html1():
-    return "<h1>hello</h1>"
+@app.route("/html1")  # $routeSetup="/html1"
+def html1():  # $routeHandler
+    return "<h1>hello</h1>"  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
 
 
-@app.route("/html2")
-def html2():
+@app.route("/html2")  # $routeSetup="/html2"
+def html2():  # $routeHandler
     # note that response saved in a variable intentionally -- we wan the annotations to
     # show that we recognize the response creation, and not the return (hopefully). (and
     # do the same in the following of the file)
-    resp = make_response("<h1>hello</h1>")
+    resp = make_response("<h1>hello</h1>")  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/html3")
-def html3():
-    resp = app.make_response("<h1>hello</h1>")
+@app.route("/html3")  # $routeSetup="/html3"
+def html3():  # $routeHandler
+    resp = app.make_response("<h1>hello</h1>")  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
@@ -29,32 +29,32 @@ def html3():
 # https://flask.palletsprojects.com/en/1.1.x/api/#flask.Flask.make_response
 
 
-@app.route("/html4")
-def html4():
-    resp = Response("<h1>hello</h1>")
+@app.route("/html4")  # $routeSetup="/html4"
+def html4():  # $routeHandler
+    resp = Response("<h1>hello</h1>")  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/html5")
-def html5():
+@app.route("/html5")  # $routeSetup="/html5"
+def html5():  # $routeHandler
     # note: flask.Flask.response_class is set to `flask.Response` by default.
     # it can be overridden, but we don't try to handle that right now.
-    resp = Flask.response_class("<h1>hello</h1>")
+    resp = Flask.response_class("<h1>hello</h1>")  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/html6")
-def html6():
+@app.route("/html6")  # $routeSetup="/html6"
+def html6():  # $routeHandler
     # note: app.response_class (flask.Flask.response_class) is set to `flask.Response` by default.
     # it can be overridden, but we don't try to handle that right now.
-    resp = app.response_class("<h1>hello</h1>")
+    resp = app.response_class("<h1>hello</h1>")  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/jsonify")
-def jsonify_route():
+@app.route("/jsonify")  # $routeSetup="/jsonify"
+def jsonify_route():  # $routeHandler
     data = {"foo": "bar"}
-    response = jsonify(data)
+    response = jsonify(data)  # $f-:HttpResponse $f-:contentType=application/json $f-:statusCode=200 $f-:responseBody=data
     return response
 
 
@@ -63,17 +63,17 @@ def jsonify_route():
 ################################################################################
 
 
-@app.route("/content-type/response-modification1")
-def response_modification1():
-    resp = make_response("<h1>hello</h1>")
-    resp.content_type = "text/plain"
+@app.route("/content-type/response-modification1")  # $routeSetup="/content-type/response-modification1"
+def response_modification1():  # $routeHandler
+    resp = make_response("<h1>hello</h1>")  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
+    resp.content_type = "text/plain"  # $f-:HttpResponse $f-:contentType=text/plain
     return resp
 
 
-@app.route("/content-type/response-modification2")
-def response_modification2():
-    resp = make_response("<h1>hello</h1>")
-    resp.headers["content-type"] = "text/plain"
+@app.route("/content-type/response-modification2")  # $routeSetup="/content-type/response-modification2"
+def response_modification2():  # $routeHandler
+    resp = make_response("<h1>hello</h1>")  # $f-:HttpResponse $f-:contentType=text/html $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
+    resp.headers["content-type"] = "text/plain"  # $f-:HttpResponse $f-:contentType=text/plain
     return resp
 
 
@@ -81,53 +81,57 @@ def response_modification2():
 # see https://werkzeug.palletsprojects.com/en/1.0.x/wrappers/#werkzeug.wrappers.Response
 
 
-@app.route("/content-type/Response1")
-def Response1():
-    resp = Response("<h1>hello</h1>", mimetype="text/plain")
+@app.route("/content-type/Response1")  # $routeSetup="/content-type/Response1"
+def Response1():  # $routeHandler
+    resp = Response("<h1>hello</h1>", mimetype="text/plain")  # $f-:HttpResponse $f-:contentType=text/plain $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/content-type/Response2")
-def Response2():
-    resp = Response("<h1>hello</h1>", content_type="text/plain; charset=utf-8")
+@app.route("/content-type/Response2")  # $routeSetup="/content-type/Response2"
+def Response2():  # $routeHandler
+    resp = Response("<h1>hello</h1>", content_type="text/plain; charset=utf-8")  # $f-:HttpResponse $f-:contentType=text/plain $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/content-type/Response3")
-def Response3():
+@app.route("/content-type/Response3")  # $routeSetup="/content-type/Response3"
+def Response3():  # $routeHandler
     # content_type argument takes priority (and result is text/plain)
-    resp = Response("<h1>hello</h1>", content_type="text/plain; charset=utf-8", mimetype="text/html")
+    resp = Response(
+        "<h1>hello</h1>", content_type="text/plain; charset=utf-8", mimetype="text/html"
+    )  # $f-:HttpResponse $f-:contentType=text/plain $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/content-type/Response4")
-def Response4():
+@app.route("/content-type/Response4")  # $routeSetup="/content-type/Response4"
+def Response4():  # $routeHandler
     # note: capitalization of Content-Type does not matter
-    resp = Response("<h1>hello</h1>", headers={"Content-TYPE": "text/plain"})
+    resp = Response("<h1>hello</h1>", headers={"Content-TYPE": "text/plain"})  # $f-:HttpResponse $f-:contentType=text/plain $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/content-type/Response5")
-def Response5():
+@app.route("/content-type/Response5")  # $routeSetup="/content-type/Response5"
+def Response5():  # $routeHandler
     # content_type argument takes priority (and result is text/plain)
     # note: capitalization of Content-Type does not matter
-    resp = Response("<h1>hello</h1>", headers={"Content-TYPE": "text/html"}, content_type="text/plain; charset=utf-8")
+    resp = Response(
+        "<h1>hello</h1>", headers={"Content-TYPE": "text/html"}, content_type="text/plain; charset=utf-8"
+    )  # $f-:HttpResponse $f-:contentType=text/plain $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/content-type/Flask-response-class")
-def Flask_response_class():
+@app.route("/content-type/Flask-response-class")  # $routeSetup="/content-type/Flask-response-class"
+def Flask_response_class():  # $routeHandler
     # note: flask.Flask.response_class is set to `flask.Response` by default.
     # it can be overridden, but we don't try to handle that right now.
-    resp = Flask.response_class("<h1>hello</h1>", mimetype="text/plain")
+    resp = Flask.response_class("<h1>hello</h1>", mimetype="text/plain")  # $f-:HttpResponse $f-:contentType=text/plain $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 
-@app.route("/content-type/app-response-class")
-def app_response_class():
+@app.route("/content-type/app-response-class")  # $routeSetup="/content-type/app-response-class"
+def app_response_class():  # $routeHandler
     # note: app.response_class (flask.Flask.response_class) is set to `flask.Response` by default.
     # it can be overridden, but we don't try to handle that right now.
-    resp = app.response_class("<h1>hello</h1>", mimetype="text/plain")
+    resp = app.response_class("<h1>hello</h1>", mimetype="text/plain")  # $f-:HttpResponse $f-:contentType=text/plain $f-:statusCode=200 $f-:responseBody="<h1>hello</h1>"
     return resp
 
 # TODO: add tests for setting status code