Update flask tests and enable flaskmaster (#1163)

* Update flask tests and enable flaskmaster

* Remove use of egg for flaskmaster

* import separately instead of using extra

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: lrafeei

tests/framework_flask/_test_blueprints.py

@@ -13,70 +13,82 @@
 # limitations under the License.
 
 import webtest
-
-from flask import Flask
-from flask import Blueprint
-from werkzeug.routing import Rule
-
 from conftest import is_flask_v2 as nested_blueprint_support
+from conftest import is_not_flask_v2_3 as before_app_first_request_support
+from flask import Blueprint, Flask
+from werkzeug.routing import Rule
 
 # Blueprints are only available in 0.7.0 onwards.
 
-blueprint = Blueprint('blueprint', __name__)
+blueprint = Blueprint("blueprint", __name__)
 
 application = Flask(__name__)
 
-@blueprint.route('/index')
+
+@blueprint.route("/index")
 def index_page():
-    return 'BLUEPRINT INDEX RESPONSE'
+    return "BLUEPRINT INDEX RESPONSE"
 
-@blueprint.endpoint('endpoint')
+
+@blueprint.endpoint("endpoint")
 def endpoint_page():
-    return 'BLUEPRINT ENDPOINT RESPONSE'
+    return "BLUEPRINT ENDPOINT RESPONSE"
+
+
+# < Flask v2.3.0
+if before_app_first_request_support:
+
+    @blueprint.before_app_first_request
+    def before_app_first_request():
+        pass
 
-@blueprint.before_app_first_request
-def before_app_first_request():
-    pass
 
 @blueprint.before_request
 def before_request():
     pass
 
+
 @blueprint.before_app_request
 def before_app_request():
     pass
 
+
 @blueprint.after_request
 def after_request(response):
     return response
 
+
 @blueprint.after_app_request
 def after_app_request(response):
     return response
 
+
 @blueprint.teardown_request
 def teardown_request(exc):
     pass
 
+
 @blueprint.teardown_app_request
 def teardown_app_request(exc):
     pass
 
+
 # Support for nested blueprints was added in Flask 2.0
 if nested_blueprint_support:
-    parent = Blueprint('parent', __name__, url_prefix='/parent')
-    child = Blueprint('child', __name__, url_prefix='/child')
+    parent = Blueprint("parent", __name__, url_prefix="/parent")
+    child = Blueprint("child", __name__, url_prefix="/child")
 
     parent.register_blueprint(child)
 
-    @child.route('/nested')
+    @child.route("/nested")
     def nested_page():
-        return 'PARENT NESTED RESPONSE'
+        return "PARENT NESTED RESPONSE"
+
     application.register_blueprint(parent)
 
 application.register_blueprint(blueprint)
 
 
-application.url_map.add(Rule('/endpoint', endpoint='endpoint'))
+application.url_map.add(Rule("/endpoint", endpoint="endpoint"))
 
 _test_application = webtest.TestApp(application)

tests/framework_flask/_test_middleware.py

@@ -13,33 +13,48 @@
 # limitations under the License.
 
 import webtest
-
+from conftest import is_not_flask_v2_3 as before_first_request_support
 from flask import Flask
 
 application = Flask(__name__)
 
-@application.before_first_request
-def before_first_request():
-    pass
+# < Flask v2.3.0
+if before_first_request_support:
+
+    @application.before_first_request
+    def before_first_request():
+        pass
+
+
+# >= Flask v2.3.0
+def application_app_context():
+    with application.app_context():
+        pass
+
 
 @application.before_request
 def before_request():
     pass
 
+
 @application.after_request
 def after_request(response):
     return response
 
+
 @application.teardown_request
 def teardown_request(exc):
     pass
 
+
 @application.teardown_appcontext
 def teardown_appcontext(exc):
     pass
 
-@application.route('/middleware')
+
+@application.route("/middleware")
 def index_page():
-    return 'INDEX RESPONSE'
+    return "INDEX RESPONSE"
+
 
 _test_application = webtest.TestApp(application)

tests/framework_flask/conftest.py

@@ -15,7 +15,19 @@
 import platform
 
 import pytest
-from flask import __version__ as flask_version
+from flask import (
+    __version__ as flask_version,  # required for python 3.7 in lieu of get_package_version_tuple
+)
+
+from newrelic.common.package_version_utils import get_package_version_tuple
+
+try:
+    FLASK_VERSION = tuple(int(v) for v in flask_version.split("."))
+except:
+    # This does not work for Python 3.7 for v2.2.5
+    # This only works for flaskmaster
+    FLASK_VERSION = get_package_version_tuple("flask")
+
 from testing_support.fixtures import (  # noqa: F401; pylint: disable=W0611
     collector_agent_registration_fixture,
     collector_available_fixture,
@@ -36,10 +48,11 @@
 )
 
 
-is_flask_v2 = int(flask_version.split(".")[0]) >= 2
+is_flask_v2 = FLASK_VERSION[0] >= 2
+is_not_flask_v2_3 = FLASK_VERSION < (2, 3, 0)
 is_pypy = platform.python_implementation() == "PyPy"
 async_handler_support = is_flask_v2 and not is_pypy
 skip_if_not_async_handler_support = pytest.mark.skipif(
     not async_handler_support,
-    reason="Requires async handler support. (Flask >=v2.0.0)",
+    reason="Requires async handler support. (Flask >=v2.0.0, CPython)",
 )

tests/framework_flask/test_blueprints.py

@@ -13,18 +13,20 @@
 # limitations under the License.
 
 import pytest
-
-from testing_support.fixtures import override_application_settings
-from testing_support.validators.validate_code_level_metrics import validate_code_level_metrics
-from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics
-from testing_support.validators.validate_transaction_errors import validate_transaction_errors
-
-from newrelic.packages import six
-
 from conftest import is_flask_v2 as nested_blueprint_support
+from testing_support.validators.validate_code_level_metrics import (
+    validate_code_level_metrics,
+)
+from testing_support.validators.validate_transaction_errors import (
+    validate_transaction_errors,
+)
+from testing_support.validators.validate_transaction_metrics import (
+    validate_transaction_metrics,
+)
 
-skip_if_not_nested_blueprint_support = pytest.mark.skipif(not nested_blueprint_support,
-        reason="Requires nested blueprint support. (Flask >=v2.0.0)")
+skip_if_not_nested_blueprint_support = pytest.mark.skipif(
+    not nested_blueprint_support, reason="Requires nested blueprint support. (Flask >=v2.0.0)"
+)
 
 
 def target_application():
@@ -38,29 +40,32 @@ def target_application():
     # showing <local> scope in path.
 
     from _test_blueprints import _test_application
+
     return _test_application
 
+
 _test_blueprints_index_scoped_metrics = [
-        ('Function/flask.app:Flask.wsgi_app', 1),
-        ('Python/WSGI/Application', 1),
-        ('Python/WSGI/Response', 1),
-        ('Python/WSGI/Finalize', 1),
-        ('Function/_test_blueprints:index_page', 1),
-        ('Function/flask.app:Flask.preprocess_request', 1),
-        ('Function/_test_blueprints:before_app_request', 1),
-        ('Function/_test_blueprints:before_request', 1),
-        ('Function/flask.app:Flask.process_response', 1),
-        ('Function/_test_blueprints:after_request', 1),
-        ('Function/_test_blueprints:after_app_request', 1),
-        ('Function/flask.app:Flask.do_teardown_request', 1),
-        ('Function/_test_blueprints:teardown_app_request', 1),
-        ('Function/_test_blueprints:teardown_request', 1),
-        ('Function/flask.app:Flask.do_teardown_appcontext', 1),
-        ('Function/werkzeug.wsgi:ClosingIterator.close', 1)]
+    ("Function/flask.app:Flask.wsgi_app", 1),
+    ("Python/WSGI/Application", 1),
+    ("Python/WSGI/Response", 1),
+    ("Python/WSGI/Finalize", 1),
+    ("Function/_test_blueprints:index_page", 1),
+    ("Function/flask.app:Flask.preprocess_request", 1),
+    ("Function/_test_blueprints:before_app_request", 1),
+    ("Function/_test_blueprints:before_request", 1),
+    ("Function/flask.app:Flask.process_response", 1),
+    ("Function/_test_blueprints:after_request", 1),
+    ("Function/_test_blueprints:after_app_request", 1),
+    ("Function/flask.app:Flask.do_teardown_request", 1),
+    ("Function/_test_blueprints:teardown_app_request", 1),
+    ("Function/_test_blueprints:teardown_request", 1),
+    ("Function/flask.app:Flask.do_teardown_appcontext", 1),
+    ("Function/werkzeug.wsgi:ClosingIterator.close", 1),
+]
+
 
 @validate_transaction_errors(errors=[])
-@validate_transaction_metrics('_test_blueprints:index_page',
-        scoped_metrics=_test_blueprints_index_scoped_metrics)
+@validate_transaction_metrics("_test_blueprints:index_page", scoped_metrics=_test_blueprints_index_scoped_metrics)
 @validate_code_level_metrics("_test_blueprints", "index_page")
 @validate_code_level_metrics("_test_blueprints", "before_app_request")
 @validate_code_level_metrics("_test_blueprints", "before_request")
@@ -70,60 +75,61 @@ def target_application():
 @validate_code_level_metrics("_test_blueprints", "teardown_request")
 def test_blueprints_index():
     application = target_application()
-    response = application.get('/index')
-    response.mustcontain('BLUEPRINT INDEX RESPONSE')
+    response = application.get("/index")
+    response.mustcontain("BLUEPRINT INDEX RESPONSE")
+
 
 _test_blueprints_endpoint_scoped_metrics = [
-        ('Function/flask.app:Flask.wsgi_app', 1),
-        ('Python/WSGI/Application', 1),
-        ('Python/WSGI/Response', 1),
-        ('Python/WSGI/Finalize', 1),
-        ('Function/_test_blueprints:endpoint_page', 1),
-        ('Function/flask.app:Flask.preprocess_request', 1),
-        ('Function/_test_blueprints:before_app_request', 1),
-        ('Function/flask.app:Flask.process_response', 1),
-        ('Function/_test_blueprints:after_app_request', 1),
-        ('Function/flask.app:Flask.do_teardown_request', 1),
-        ('Function/_test_blueprints:teardown_app_request', 1),
-        ('Function/flask.app:Flask.do_teardown_appcontext', 1),
-        ('Function/werkzeug.wsgi:ClosingIterator.close', 1)]
+    ("Function/flask.app:Flask.wsgi_app", 1),
+    ("Python/WSGI/Application", 1),
+    ("Python/WSGI/Response", 1),
+    ("Python/WSGI/Finalize", 1),
+    ("Function/_test_blueprints:endpoint_page", 1),
+    ("Function/flask.app:Flask.preprocess_request", 1),
+    ("Function/_test_blueprints:before_app_request", 1),
+    ("Function/flask.app:Flask.process_response", 1),
+    ("Function/_test_blueprints:after_app_request", 1),
+    ("Function/flask.app:Flask.do_teardown_request", 1),
+    ("Function/_test_blueprints:teardown_app_request", 1),
+    ("Function/flask.app:Flask.do_teardown_appcontext", 1),
+    ("Function/werkzeug.wsgi:ClosingIterator.close", 1),
+]
+
 
 @validate_transaction_errors(errors=[])
-@validate_transaction_metrics('_test_blueprints:endpoint_page',
-        scoped_metrics=_test_blueprints_endpoint_scoped_metrics)
+@validate_transaction_metrics("_test_blueprints:endpoint_page", scoped_metrics=_test_blueprints_endpoint_scoped_metrics)
 @validate_code_level_metrics("_test_blueprints", "endpoint_page")
 @validate_code_level_metrics("_test_blueprints", "before_app_request")
 @validate_code_level_metrics("_test_blueprints", "after_app_request")
 @validate_code_level_metrics("_test_blueprints", "teardown_app_request")
 def test_blueprints_endpoint():
     application = target_application()
-    response = application.get('/endpoint')
-    response.mustcontain('BLUEPRINT ENDPOINT RESPONSE')
+    response = application.get("/endpoint")
+    response.mustcontain("BLUEPRINT ENDPOINT RESPONSE")
 
 
 _test_blueprints_nested_scoped_metrics = [
-        ('Function/flask.app:Flask.wsgi_app', 1),
-        ('Python/WSGI/Application', 1),
-        ('Python/WSGI/Response', 1),
-        ('Python/WSGI/Finalize', 1),
-        ('Function/_test_blueprints:nested_page', 1),
-        ('Function/flask.app:Flask.preprocess_request', 1),
-        ('Function/_test_blueprints:before_app_request', 1),
-        ('Function/_test_blueprints:before_request', 1),
-        ('Function/flask.app:Flask.process_response', 1),
-        ('Function/_test_blueprints:after_request', 1),
-        ('Function/_test_blueprints:after_app_request', 1),
-        ('Function/flask.app:Flask.do_teardown_request', 1),
-        ('Function/_test_blueprints:teardown_app_request', 1),
-        ('Function/_test_blueprints:teardown_request', 1),
-        ('Function/flask.app:Flask.do_teardown_appcontext', 1),
-        ('Function/werkzeug.wsgi:ClosingIterator.close', 1)]
+    ("Function/flask.app:Flask.wsgi_app", 1),
+    ("Python/WSGI/Application", 1),
+    ("Python/WSGI/Response", 1),
+    ("Python/WSGI/Finalize", 1),
+    ("Function/_test_blueprints:nested_page", 1),
+    ("Function/flask.app:Flask.preprocess_request", 1),
+    ("Function/_test_blueprints:before_app_request", 1),
+    ("Function/flask.app:Flask.process_response", 1),
+    ("Function/_test_blueprints:after_app_request", 1),
+    ("Function/flask.app:Flask.do_teardown_request", 1),
+    ("Function/_test_blueprints:teardown_app_request", 1),
+    ("Function/flask.app:Flask.do_teardown_appcontext", 1),
+    ("Function/werkzeug.wsgi:ClosingIterator.close", 1),
+]
+
 
 @skip_if_not_nested_blueprint_support
 @validate_transaction_errors(errors=[])
-@validate_transaction_metrics('_test_blueprints:nested_page')
+@validate_transaction_metrics("_test_blueprints:nested_page", scoped_metrics=_test_blueprints_nested_scoped_metrics)
 @validate_code_level_metrics("_test_blueprints", "nested_page")
 def test_blueprints_nested():
-        application = target_application()
-        response = application.get('/parent/child/nested')
-        response.mustcontain('PARENT NESTED RESPONSE')
+    application = target_application()
+    response = application.get("/parent/child/nested")
+    response.mustcontain("PARENT NESTED RESPONSE")