Reduce noise in tests

Signed-off-by: Bob Weinand <[email protected]>
DataDog · Feb 5, 2025 · 8154bb8 · 8154bb8
1 parent d76b7d7
commit 8154bb8
Show file tree

Hide file tree

Showing 9 changed files with 113 additions and 81 deletions.
diff --git a/.circleci/continue_config.yml b/.circleci/continue_config.yml
@@ -1759,12 +1759,12 @@ jobs:
           command: |
             set -euo pipefail
             <<# parameters.coverage >>unset CI && unset CIRCLECI && export DD_AUTOLOAD_NO_COMPILE=true<</ parameters.coverage >>
-            DD_TRACE_AGENT_TIMEOUT=1000 <<# parameters.disable_runner_distributed_tracing >> DD_DISTRIBUTED_TRACING=false <</ parameters.disable_runner_distributed_tracing >> DD_TRACE_TEST_SAPI=<< parameters.sapi >> make << parameters.make_target >> PHPUNIT_OPTS="--log-junit test-results/php-composer/results-<< parameters.make_target >>.xml"
+            _DD_DEBUG_SIDECAR_LOG_METHOD=file://$(pwd)/tests/sidecar.log DD_TRACE_AGENT_TIMEOUT=1000 <<# parameters.disable_runner_distributed_tracing >> DD_DISTRIBUTED_TRACING=false <</ parameters.disable_runner_distributed_tracing >> DD_TRACE_TEST_SAPI=<< parameters.sapi >> make << parameters.make_target >> PHPUNIT_OPTS="--log-junit test-results/php-composer/results-<< parameters.make_target >>.xml"
       - <<: *STEP_CODE_COVERAGE
       - run:
           command: |
             mkdir -p /tmp/artifacts
-            find ~/datadog/tests -type f \( -name 'phpunit_error.log' -o -name 'nginx_*.log' -o -name 'apache_*.log' -o -name 'php_fpm_*.log' -o -name 'dd_php_error.log' \) -exec cp --parents '{}' /tmp/artifacts \;
+            find ~/datadog/tests -type f \( -name 'phpunit_error.log' -o -name 'nginx_*.log' -o -name 'apache_*.log' -o -name 'php_fpm_*.log' -o -name 'dd_php_error.log' -o -name 'sidecar.log' \) -exec cp --parents '{}' /tmp/artifacts \;
             mkdir -p /tmp/artifacts/core_dumps
             find /tmp -name "core.*" | xargs -I % -n 1 cp % /tmp/artifacts/core_dumps
             ! [ "$(ls -A /tmp/artifacts/core_dumps)" ] || cp tmp/build_extension/modules/ddtrace.so /tmp/artifacts/
@@ -1856,12 +1856,12 @@ jobs:
           command: |
             set -euo pipefail
             <<# parameters.coverage >>unset CI && unset CIRCLECI && export DD_AUTOLOAD_NO_COMPILE=true<</ parameters.coverage >>
-            DD_TRACE_AGENT_TIMEOUT=1000 <<# parameters.disable_runner_distributed_tracing >> DD_DISTRIBUTED_TRACING=false <</ parameters.disable_runner_distributed_tracing >> DD_TRACE_TEST_SAPI=<< parameters.sapi >> make << parameters.make_target >> RUST_DEBUG_BUILD=1 PHPUNIT_OPTS="--log-junit test-results/php-composer/results.xml"
+            _DD_DEBUG_SIDECAR_LOG_METHOD=file://$(pwd)/tests/sidecar.log DD_TRACE_AGENT_TIMEOUT=1000 <<# parameters.disable_runner_distributed_tracing >> DD_DISTRIBUTED_TRACING=false <</ parameters.disable_runner_distributed_tracing >> DD_TRACE_TEST_SAPI=<< parameters.sapi >> make << parameters.make_target >> RUST_DEBUG_BUILD=1 PHPUNIT_OPTS="--log-junit test-results/php-composer/results.xml"
       - <<: *STEP_CODE_COVERAGE
       - run:
           command: |
             mkdir -p /tmp/artifacts
-            find ~/datadog/tests -type f \( -name 'phpunit_error.log' -o -name 'nginx_*.log' -o -name 'apache_*.log' -o -name 'php_fpm_*.log' -o -name 'dd_php_error.log' -o -name 'core'  -o -name 'core.*' \) -exec cp --parents '{}' /tmp/artifacts \;
+            find ~/datadog/tests -type f \( -name 'phpunit_error.log' -o -name 'nginx_*.log' -o -name 'apache_*.log' -o -name 'php_fpm_*.log' -o -name 'dd_php_error.log' -o -name 'sidecar.log' -o -name 'core' -o -name 'core.*' \) -exec cp --parents '{}' /tmp/artifacts \;
             ! [ "$(ls -A /tmp/artifacts/core_dumps)" ] || cp tmp/build_extension/modules/ddtrace.so /tmp/artifacts/
           when: on_fail
       - store_artifacts:

diff --git a/Makefile b/Makefile
@@ -1068,7 +1068,6 @@ TEST_INTEGRATIONS_84 := \
 	test_integrations_pdo \
 	test_integrations_elasticsearch7 \
 	test_integrations_elasticsearch_latest \
-	test_integrations_phpredis5 \
 	test_integrations_predis_latest \
 	test_integrations_frankenphp \
 	test_integrations_roadrunner \
@@ -1091,7 +1090,7 @@ TEST_WEB_84 := \
 	test_web_custom \
 	test_web_zend_1_21
 
-# to check: test_web_drupal_95, test_web_laravel_latest, test_web_slim_latest
+# to check: test_web_drupal_95, test_web_laravel_latest, test_web_slim_latest, test_integrations_phpredis6
 
 FILTER ?= .
 MAX_RETRIES := 3
@@ -1335,9 +1334,11 @@ test_integrations_frankenphp: global_test_run_dependencies
 test_integrations_roadrunner: global_test_run_dependencies tests/Frameworks/Roadrunner/Version_2/composer.lock-php$(PHP_MAJOR_MINOR)
 	$(call run_tests_debug,tests/Integrations/Roadrunner/V2)
 test_integrations_googlespanner_latest: global_test_run_dependencies tests/Integrations/GoogleSpanner/Latest/composer.lock-php$(PHP_MAJOR_MINOR)
+	$(eval TEST_EXTRA_ENV=ZEND_DONT_UNLOAD_MODULES=1)
 	$(eval TEST_EXTRA_INI=-d extension=grpc.so)
 	$(call run_tests_debug,tests/Integrations/GoogleSpanner/Latest)
 	$(eval TEST_EXTRA_INI=)
+	$(eval TEST_EXTRA_ENV=)
 test_integrations_sqlsrv: global_test_run_dependencies
 	$(eval TEST_EXTRA_INI=-d extension=sqlsrv.so)
 	$(call run_tests_debug,tests/Integrations/SQLSRV)

diff --git a/tests/Common/TracerTestTrait.php b/tests/Common/TracerTestTrait.php
@@ -3,6 +3,8 @@
 namespace DDTrace\Tests\Common;
 
 use DDTrace\GlobalTracer;
+use DDTrace\HookData;
+use DDTrace\SpanData;
 use DDTrace\Tests\DebugTransport;
 use DDTrace\Tests\Frameworks\Util\Request\GetSpec;
 use DDTrace\Tests\Frameworks\Util\Request\RequestSpec;
@@ -106,7 +108,7 @@ public function sendTracesToTestAgent($traces)
         curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); // Set the headers
 
         // Execute the cURL session
-        $response = curl_exec($curl);
+        $response = self::curlWithoutSpan($curl);
 
         // Close the cURL session
         curl_close($curl);
@@ -135,6 +137,15 @@ public function inRootSpan($fn, $tracer = null)
         return $this->flushAndGetTraces();
     }
 
+    public static function curlWithoutSpan($curl)
+    {
+        $limit = ini_get("datadog.trace.spans_limit");
+        ini_set("datadog.trace.spans_limit", 0);
+        $ret = curl_exec($curl);
+        ini_set("datadog.trace.spans_limit", $limit);
+        return $ret;
+    }
+
     /**
      * @param $fn
      * @param null $tracer
@@ -186,7 +197,7 @@ public function inWebServer($fn, $rootPath, $envs = [], $inis = [], &$curlInfo =
                     $curl = curl_init('http://127.0.0.1:' . self::$webserverPort . $request->getPath());
                     curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
                     curl_setopt($curl, CURLOPT_HTTPHEADER, $request->getHeaders());
-                    $response = curl_exec($curl);
+                    $response = self::curlWithoutSpan($curl);
                     if (\is_array($curlInfo)) {
                         $curlInfo = \array_merge($curlInfo, \curl_getinfo($curl));
                     }
@@ -269,7 +280,17 @@ public function executeCli($scriptPath, $customEnvs = [], $customInis = [], $arg
         $commandToExecute = "$envs " . PHP_BINARY . " $inis $script $arguments";
         $output = [];
         $exitCode = 0;
+        $createHook = \DDTrace\install_hook('DDTrace\Integrations\Exec\ExecIntegration::createSpan', function (HookData $hook) {
+            $hook->disableJitInlining();
+            $hook->suppressCall();
+            $hook->overrideReturnValue(new SpanData);
+        });
+        $finishHook = \DDTrace\install_hook('DDTrace\Integrations\Exec\ExecIntegration::finishSpanRestoreStack', function (HookData $hook) {
+            $hook->suppressCall();
+        });
         exec($commandToExecute . ' 2>&1', $output, $exitCode);
+        \DDTrace\remove_hook($createHook);
+        \DDTrace\remove_hook($finishHook);
         $ret = $withOutput ? implode("\n", $output) : null;
         if (!$skipSyncFlush && \dd_trace_env_config("DD_TRACE_SIDECAR_TRACE_SENDER")) {
             \dd_trace_synchronous_flush();
@@ -284,7 +305,7 @@ public function resetRequestDumper()
     {
         $curl = curl_init(self::$agentRequestDumperUrl . '/clear-dumped-data');
         curl_setopt($curl, CURLOPT_HTTPHEADER, ['x-datadog-test-session-token: ' . ini_get("datadog.trace.agent_test_session_token")]);
-        curl_exec($curl);
+        self::curlWithoutSpan($curl);
     }
 
     /**
@@ -297,7 +318,7 @@ public function resetRequestDumper()
      * @return array[]
      * @throws Exception
      */
-    public function tracesFromWebRequest($fn, $tracer = null, callable $until = null)
+    public function tracesFromWebRequest($fn, $tracer = null, $until = null)
     {
         self::putEnv('DD_TRACE_SHUTDOWN_TIMEOUT=666666'); // Arbitrarily high value to avoid flakiness
         self::putEnv('DD_TRACE_AGENT_RETRIES=3');
@@ -380,7 +401,7 @@ private function parseRawDumpedSpans($rawSpans)
      * @return array
      * @throws \Exception
      */
-    private function parseTracesFromDumpedData(callable $until = null, $throw = false)
+    private function parseTracesFromDumpedData($until = null, $throw = false)
     {
         $loaded = $this->retrieveDumpedTraceData($until, $throw);
         if (!$loaded) {
@@ -439,21 +460,24 @@ public function parseMultipleRequestsFromDumpedData()
 
     /**
      * Returns the raw response body, if any, or null otherwise.
+     * @param callable|null $until
      */
-    public function retrieveDumpedData(callable $until = null, $throw = false)
+    public function retrieveDumpedData($until = null, $throw = false)
     {
         return $this->retrieveAnyDumpedData($until, $throw);
     }
 
     /**
      * Returns the raw response body, if any, or null otherwise.
+     * @param callable|null $until
      */
-    public function retrieveDumpedMetrics(callable $until = null, $throw = false)
+    public function retrieveDumpedMetrics($until = null, $throw = false)
     {
         return $this->retrieveAnyDumpedData($until, $throw, true);
     }
 
-    public function retrieveAnyDumpedData(callable $until = null, $throw, $metrics = false) {
+    /** @param callable|null $until */
+    public function retrieveAnyDumpedData($until, $throw, $metrics = false) {
         $until = $until ?? $this->untilFirstTraceRequest();
 
         $allResponses = [];
@@ -470,7 +494,7 @@ public function retrieveAnyDumpedData(callable $until = null, $throw, $metrics =
             curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
             curl_setopt($curl, CURLOPT_HTTPHEADER, ['x-datadog-test-session-token: ' . ini_get("datadog.trace.agent_test_session_token")]);
             // Retrieving data
-            $response = curl_exec($curl);
+            $response = self::curlWithoutSpan($curl);
             if (!$response) {
                 // PHP-FPM requests are much slower in the container
                 // Temporary workaround until we get a proper test runner

diff --git a/tests/Integrations/Curl/CurlIntegrationTest.php b/tests/Integrations/Curl/CurlIntegrationTest.php
@@ -603,7 +603,7 @@ function ($execute) {
         $this->assertFlameGraph($traces, [
             SpanAssertion::build('web.request', 'top_level_app', 'web', 'GET /curl_in_web_request.php')
                 ->withExistingTagsNames(['http.method', 'http.url', 'http.status_code'])
-                ->withExactMetrics(['_sampling_priority_v1' => 1, 'process_id' => getmypid()])
+                ->withExactMetrics(['_sampling_priority_v1' => 1, '_dd.agent_psr' => 1, 'process_id' => getmypid()])
                 ->withChildren([
                     SpanAssertion::build('curl_exec', 'curl', 'http', 'http://httpbin_integration/status/?')
                         ->withExactTags([

diff --git a/tests/Integrations/DeferredLoading/index.php b/tests/Integrations/DeferredLoading/index.php
@@ -2,6 +2,8 @@
 
 require __DIR__ . '/vendor/autoload.php';
 
+error_reporting(E_ALL & ~E_DEPRECATED);
+
 // This script HAS to invoke at least two integrations via deferred integration loading mechanism.
 
 // PDO

diff --git a/tests/Integrations/Logs/LaminasLogV2/LaminasLogV2Test.php b/tests/Integrations/Logs/LaminasLogV2/LaminasLogV2Test.php
@@ -26,6 +26,9 @@ protected function getLogger($jsonFormatter = false)
         $writer = new Stream(static::logFile());
 
         if ($jsonFormatter) {
+            if (!class_exists(Json::class)) {
+                $this->markTestSkipped("LaminasLog v2.7+ have an explicit PHP version support range. 2.6 gets automatically installed on PHP 8.4. But Json requires v2.10+. Skipping.");
+            }
             $writer->setFormatter(new Json());
         }
 

diff --git a/tests/Integrations/PCNTL/PCNTLTest.php b/tests/Integrations/PCNTL/PCNTLTest.php
@@ -7,12 +7,17 @@
 
 final class PCNTLTest extends IntegrationTestCase
 {
-    private static $acceptable_test_execution_time = 2;
+    private static $acceptable_test_execution_time;
 
     protected function ddSetUp()
     {
         if (!\dd_trace_env_config("DD_TRACE_SIDECAR_TRACE_SENDER")) {
             self::$acceptable_test_execution_time = 1.4;
+        } elseif (time() < 1743515423) {
+            // We'll revisit it once we move off circleci. Relaxing the time check until 2025-04-01.
+            self::$acceptable_test_execution_time = 4;
+        } else {
+            self::$acceptable_test_execution_time = 2.5;
         }
 
         $this->resetRequestDumper();
@@ -41,47 +46,6 @@ public function testDoesNoHangAtShutdownWhenDisabled($scriptPath)
         $this->assertLessThan(self::$acceptable_test_execution_time, $end - $start);
     }
 
-    /**
-     * @dataProvider dataProviderAllScripts
-     */
-    public function testDoesNoHangAtShutdownWhenEnabled($scriptPath)
-    {
-        if (extension_loaded('xdebug')) {
-            $this->markTestSkipped('xdebug is enabled, which causes the tracer to slow down dramatically.');
-        }
-
-        $start = \microtime(true);
-        $this->executeCli(
-            $scriptPath,
-            [
-                'DD_TRACE_CLI_ENABLED' => 'true',
-                'DD_TRACE_SHUTDOWN_TIMEOUT' => 5000,
-            ],
-            [],
-            '',
-            false,
-            true
-        );
-        $end = \microtime(true);
-        $this->assertLessThan(self::$acceptable_test_execution_time, $end - $start);
-        if (\dd_trace_env_config("DD_TRACE_SIDECAR_TRACE_SENDER")) {
-            \dd_trace_synchronous_flush();
-        }
-    }
-
-    public function dataProviderAllScripts()
-    {
-        return [
-            [__DIR__ . '/scripts/synthetic.php'],
-            [__DIR__ . '/scripts/short-running.php'],
-            [__DIR__ . '/scripts/short-running-multiple.php'],
-            [__DIR__ . '/scripts/short-running-multiple-nested.php'],
-            [__DIR__ . '/scripts/long-running-autoflush.php'],
-            [__DIR__ . '/scripts/long-running-manual-flush.php'],
-            [__DIR__ . '/scripts/access-tracer-after-fork.php'],
-        ];
-    }
-
     public function testCliShortRunningTracingWhenEnabled()
     {
         list($requests) = $this->inCli(
@@ -96,23 +60,26 @@ public function testCliShortRunningTracingWhenEnabled()
             $this->untilNumberOfTraces(2)
         );
 
-        // ignore curl noise from unrelated stuff
-        $requests = array_filter($requests, function ($request) { return $request[0]["name"] == "synthetic.php"; });
-
-        $this->assertFlameGraph([$requests[1]], [
-            SpanAssertion::exists('synthetic.php')->withChildren([
-                SpanAssertion::exists('pcntl_fork'),
-            ]),
-        ]);
+        try {
+            $this->assertFlameGraph([$requests[1]], [
+                SpanAssertion::exists('synthetic.php')->withChildren([
+                    SpanAssertion::exists('pcntl_fork'),
+                ]),
+            ]);
 
-        $this->assertFlameGraph([$requests[0]], [
-            SpanAssertion::exists('synthetic.php'),
-        ]);
+            $this->assertFlameGraph([$requests[0]], [
+                SpanAssertion::exists('synthetic.php'),
+            ]);
 
-        $childSpan = $requests[0][0];
-        $parentSpan = $requests[1][1];
-        $this->assertSame($childSpan["trace_id"], $parentSpan["trace_id"]);
-        $this->assertSame($childSpan["parent_id"], $parentSpan["span_id"]);
+            $childSpan = $requests[0][0];
+            $parentSpan = $requests[1][1];
+            $this->assertSame($childSpan["trace_id"], $parentSpan["trace_id"]);
+            $this->assertSame($childSpan["parent_id"], $parentSpan["span_id"]);
+        } catch (\Exception $e) {
+            echo "Raw requests:\n";
+            var_dump($requests);
+            throw $e;
+        }
     }
 
     public function testAccessingTracerAfterForkIsUnproblematic()
@@ -321,4 +288,45 @@ public function testCliLongRunningMultipleForksManualFlush()
             ]);
         }
     }
+
+    /**
+     * @dataProvider dataProviderAllScripts
+     */
+    public function testDoesNoHangAtShutdownWhenEnabled($scriptPath)
+    {
+        if (extension_loaded('xdebug')) {
+            $this->markTestSkipped('xdebug is enabled, which causes the tracer to slow down dramatically.');
+        }
+
+        $start = \microtime(true);
+        $this->executeCli(
+            $scriptPath,
+            [
+                'DD_TRACE_CLI_ENABLED' => 'true',
+                'DD_TRACE_SHUTDOWN_TIMEOUT' => 5000,
+            ],
+            [],
+            '',
+            false,
+            true
+        );
+        $end = \microtime(true);
+        $this->assertLessThan(self::$acceptable_test_execution_time, $end - $start);
+        if (\dd_trace_env_config("DD_TRACE_SIDECAR_TRACE_SENDER")) {
+            \dd_trace_synchronous_flush();
+        }
+    }
+
+    public function dataProviderAllScripts()
+    {
+        return [
+            [__DIR__ . '/scripts/synthetic.php'],
+            [__DIR__ . '/scripts/short-running.php'],
+            [__DIR__ . '/scripts/short-running-multiple.php'],
+            [__DIR__ . '/scripts/short-running-multiple-nested.php'],
+            [__DIR__ . '/scripts/long-running-autoflush.php'],
+            [__DIR__ . '/scripts/long-running-manual-flush.php'],
+            [__DIR__ . '/scripts/access-tracer-after-fork.php'],
+        ];
+    }
 }
diff --git a/tests/Integrations/PDO/PDOTest.php b/tests/Integrations/PDO/PDOTest.php
@@ -720,13 +720,7 @@ private function ensureActiveQueriesErrorCanHappen()
         $pdo = $this->pdoInstance($opts);
 
         $this->isolateTracer(function () use ($pdo) {
-            $pdo->beginTransaction();
-            $stmt = $pdo->prepare("INSERT INTO tests (name) VALUES (?)");
-
-            for ($i = 0; $i < 1000; $i++) {
-                $stmt->execute(['Jerry']);
-            }
-            $pdo->commit();
+            $pdo->query("INSERT INTO tests (name) VALUES " . str_repeat("('Jerry'), ", 999) . "('Jerry')");
         });
         return $pdo;
     }

diff --git a/tests/Integrations/Swoole/CommonScenariosTest.php b/tests/Integrations/Swoole/CommonScenariosTest.php
@@ -95,7 +95,7 @@ public function provideSpecs()
                         'http.method' => 'GET',
                         'http.url' => 'http://localhost/error?key=value&<redacted>',
                         'http.status_code' => '500',
-                        'error.stack' => PHP_VERSION_ID >= 80400 ? "#0 [internal function]: {closure:" . dirname(__DIR__, 2) . "/Frameworks/Swoole/index.php:9}()" : "#0 [internal function]: {closure}()\n#1 {main}",
+                        'error.stack' => (PHP_VERSION_ID >= 80400 ? "#0 [internal function]: {closure:" . dirname(__DIR__, 2) . "/Frameworks/Swoole/index.php:9}()" : "#0 [internal function]: {closure}()") . "\n#1 {main}",
                         Tag::SPAN_KIND => 'server',
                         Tag::COMPONENT => 'swoole'
                     ])->setError('Exception', 'Uncaught Exception: Error page'),
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,8 @@ @@
     require __DIR__ . '/vendor/autoload.php';
+    error_reporting(E_ALL & ~E_DEPRECATED);
     // This script HAS to invoke at least two integrations via deferred integration loading mechanism.
     // PDO
@@ Expand Down @@