Execution context - correctly check if gevent has patched threading.local (#579)

* Typo in call to is_monkey_patched
* Adds proper gevent tests
* remove pinning of Logbook introduced in #195
* exclude gevent on pypy-2

see gevent/gevent#1380

Author: ramshaw888

.ci/.jenkins_exclude.yml

@@ -167,3 +167,6 @@ exclude:
     FRAMEWORK: zerorpc-0.4
   - PYTHON_VERSION: python-3.8-rc
     FRAMEWORK: zerorpc-0.4
+  # gevent
+  - PYTHON_VERSION: pypy-2  # see https://github.com/gevent/gevent/issues/1380, fix will be in gevent 1.5
+    FRAMEWORK: gevent-newest

.ci/.jenkins_framework.yml

@@ -28,5 +28,5 @@ FRAMEWORK:
   - cassandra-newest
   - psutil-newest
   - eventlet-newest
+  - gevent-newest
   - zerorpc-0.4
-

.ci/.jenkins_framework_full.yml

@@ -59,4 +59,5 @@ FRAMEWORK:
   - elasticsearch-5
   - elasticsearch-6
   - elasticsearch-7
+  - gevent-newest
   - zerorpc-0.4

elasticapm/context/__init__.py

@@ -52,7 +52,7 @@ def threading_local_monkey_patched():
     except ImportError:
         pass
     else:
-        if is_object_patched("_threading", "local"):
+        if is_object_patched("threading", "local"):
             return True
 
     try:

tests/context/eventlet_threading_tests.py

@@ -0,0 +1,52 @@
+#  BSD 3-Clause License
+#
+#  Copyright (c) 2019, Elasticsearch BV
+#  All rights reserved.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  * Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from
+#    this software without specific prior written permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+#  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+#  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+import pytest  # isort:skip
+
+eventlet = pytest.importorskip("eventlet")  # isort:skip
+
+from eventlet.patcher import is_monkey_patched
+
+import elasticapm.context
+from elasticapm.context.threadlocal import ThreadLocalContext
+
+pytestmark = pytest.mark.eventlet
+
+
+def test_eventlet_thread_monkeypatched():
+    eventlet.monkey_patch(thread=True)
+    assert is_monkey_patched("thread")
+
+    execution_context = elasticapm.context.init_execution_context()
+
+    # Should always use ThreadLocalContext when eventlet has patched
+    # threading.local
+    assert isinstance(execution_context, ThreadLocalContext)

tests/context/gevent_threading_tests.py

@@ -0,0 +1,49 @@
+#  BSD 3-Clause License
+#
+#  Copyright (c) 2019, Elasticsearch BV
+#  All rights reserved.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  * Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from
+#    this software without specific prior written permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+#  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+#  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+import pytest
+
+import elasticapm.context
+from elasticapm.context.threadlocal import ThreadLocalContext
+
+gevent = pytest.importorskip("gevent")
+pytestmark = pytest.mark.gevent
+
+
+def test_gevent_thread_monkeypatched():
+    gevent.monkey.patch_thread()
+    assert gevent.monkey.is_object_patched("threading", "local")
+
+    execution_context = elasticapm.context.init_execution_context()
+
+    # Should always use ThreadLocalContext when gevent has patched
+    # threading.local
+    assert isinstance(execution_context, ThreadLocalContext)

tests/requirements/requirements-base.txt

@@ -19,7 +19,7 @@ statistics==1.0.3.5
 urllib3
 certifi
 Jinja2
-Logbook==1.3.0
+Logbook
 MarkupSafe
 WebOb
 Werkzeug

tests/requirements/requirements-gevent-newest.txt

@@ -0,0 +1,2 @@
+gevent
+-r requirements-base.txt

tests/scripts/envs/gevent.sh

@@ -0,0 +1 @@
+export PYTEST_MARKER="-m gevent"