ci(sanic): update test suite to run with sanic v22.9 (backport #4262) (#4282)

* ci(sanic): update test suite to run with sanic v22.9 (#4262)

* Separate sanic test suites to match with sanic-testing dependency versions

* update app and snapshots to be compatible with sanic 22.9.0

* add sanic v22.9 in riot, update snapshot name

* kill child processes

* set span name and remove redundant snapshot

* add comment

Co-authored-by: Brett Langdon <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Munir Abdinur <[email protected]>
(cherry picked from commit 91c4278)

# Conflicts:
#	riotfile.py

* fix conflicts

Co-authored-by: Yun Kim <[email protected]>
Co-authored-by: Munir Abdinur <[email protected]>

Author: 3 people

riotfile.py

@@ -1833,8 +1833,28 @@ def select_pys(min_version=MIN_PYTHON_VERSION, max_version=MAX_PYTHON_VERSION):
                         "sanic": [
                             "~=21.9.0",
                             "~=21.12.0",
-                            latest,
                         ],
+                        "sanic-testing": "~=0.8.3",
+                    },
+                ),
+                Venv(
+                    pys=select_pys(min_version="3.7"),
+                    pkgs={
+                        "sanic": "~=22.3.0",
+                        "sanic-testing": "~=22.3.0",
+                    },
+                ),
+                Venv(
+                    pys=select_pys(min_version="3.7"),
+                    pkgs={
+                        "sanic": "~=22.9.0",
+                        "sanic-testing": "~=22.9.0",
+                    },
+                ),
+                Venv(
+                    pys=select_pys(min_version="3.7"),
+                    pkgs={
+                        "sanic": latest,
                         "sanic-testing": latest,
                     },
                 ),

tests/contrib/sanic/run_server.py

@@ -19,7 +19,10 @@
 app = Sanic("test_sanic_server")
 
 
-@tracer.wrap()
+# Depending on the version of sanic the application can be run in a child process.
+# This can alter the name of the function and the default span name. Setting the span name to
+# `random_sleep` ensures the snapshot tests produce consistent spans across sanic versions.
+@tracer.wrap("random_sleep")
 async def random_sleep():
     await asyncio.sleep(random.random() * 0.1)
 
@@ -41,4 +44,5 @@ async def shutdown_tracer(request):
     return json({"success": True})
 
 
-app.run(host="0.0.0.0", port=os.environ["SANIC_PORT"], access_log=False)
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=int(os.environ["SANIC_PORT"]), access_log=False)

tests/contrib/sanic/test_sanic_server.py

@@ -1,4 +1,5 @@
 import os
+import signal
 import subprocess
 
 import pytest
@@ -19,16 +20,18 @@ def sanic_client():
     env = os.environ.copy()
     env["SANIC_PORT"] = str(SERVER_PORT)
     args = ["ddtrace-run", "python", RUN_SERVER_PY]
-    subp = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True, env=env)
-
+    subp = subprocess.Popen(
+        args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True, env=env, preexec_fn=os.setsid
+    )
     client = Client("http://0.0.0.0:{}".format(SERVER_PORT))
     client.wait(path="/hello")
     try:
         yield client
     finally:
         resp = client.get_ignored("/shutdown-tracer")
         assert resp.status_code == 200
-        subp.terminate()
+        # sanic server can spawn child processes, ensure child process are killed
+        os.killpg(os.getpgid(subp.pid), signal.SIGTERM)
         try:
             # Give the server 3 seconds to shutdown, then kill it
             subp.wait(3)

tests/snapshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http.json

@@ -27,9 +27,9 @@
     "start": 1643465627712966000
   },
      {
-       "name": "__main__.random_sleep",
+       "name": "random_sleep",
        "service": "sanic",
-       "resource": "__main__.random_sleep",
+       "resource": "random_sleep",
        "trace_id": 0,
        "span_id": 2,
        "parent_id": 1,
@@ -65,9 +65,9 @@
     "start": 1643465627811584000
   },
      {
-       "name": "__main__.random_sleep",
+       "name": "random_sleep",
        "service": "sanic",
-       "resource": "__main__.random_sleep",
+       "resource": "random_sleep",
        "trace_id": 1,
        "span_id": 2,
        "parent_id": 1,

tests/snapshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http_pre_21.9.json

@@ -26,9 +26,9 @@
     "start": 1643465607624457000
   },
      {
-       "name": "__main__.random_sleep",
+       "name": "random_sleep",
        "service": "sanic",
-       "resource": "__main__.random_sleep",
+       "resource": "random_sleep",
        "trace_id": 0,
        "span_id": 2,
        "parent_id": 1,
@@ -63,9 +63,9 @@
     "start": 1643465607721195000
   },
      {
-       "name": "__main__.random_sleep",
+       "name": "random_sleep",
        "service": "sanic",
-       "resource": "__main__.random_sleep",
+       "resource": "random_sleep",
        "trace_id": 1,
        "span_id": 2,
        "parent_id": 1,