tests(agent): enhance guzzle tests (#713)

lavarou · web-flow · commit 26634620bf4a · 2023-08-16T21:08:10.000-04:00
* cleanup skipif.inc for guzzle5: 
skipif.inc for guzzle5 ensures tests run on correct version of PHP
and skip test if PHP version does not fall into &gt;=5.4,&lt;7.4 interval.
Additionally, it warns (and skips) if guzzle5 installation is not found.

* add skipif.inc for guzzle6
skipif.inc for guzzle6 ensures tests run on correct version of PHP
and skip test if PHP version does not fall into &gt;=5.5,&lt;8.0 interval.
Additionally, it warns (and skips) if guzzle6 installation is not found.

* add tests for version 7 of guzzle
Version 6 of Guzzle supports PHPs up to but not including 8.0. In 
order to test agent's instrumentation of guzzle on PHPs 8.0+, 
version 7 of Guzzle needs to be used. There are no fundamental
changes in version 7 of Guzzle therefore agent's instrumentation
of version 6 of guzzle works for version 7 too. However, this results
in guzzle7 being detected as guzzle6 and that's why metrics in
integration tests expectation include `Supportability/library/Guzzle
6/detected` as well as `Supportability/library/Guzzle 4-5/detected`.

* composer update guzzle 6 &amp; 7 in guzzle.tar.bz2
  - Upgrading guzzlehttp/guzzle (6.3.3 =&gt; 6.5.8) (with dependencies)
  - Upgrading guzzlehttp/guzzle (7.4.5 =&gt; 7.7.0) (with dependencies)
diff --git a/tests/include/guzzle.tar.bz2 b/tests/include/guzzle.tar.bz2
diff --git a/tests/integration/external/guzzle5/skipif.inc b/tests/integration/external/guzzle5/skipif.inc
@@ -4,10 +4,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-if (version_compare(PHP_VERSION, '8.1', '>=')) {
-  die("skip: PHP < 8.1 required\n");
+if (version_compare(PHP_VERSION, '5.5', '<')) {
+    die("skip: PHP >= 5.5 required\n");
 }
 
+if (version_compare(PHP_VERSION, '7.4', '>=')) {
+  die("skip: PHP < 7.4 required\n");
+}
+
+require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
+
 if (!unpack_guzzle(5)) {
-    die("skip: guzzle 5 installation required\n");
+    die("warn: guzzle 5 installation required\n");
 }
diff --git a/tests/integration/external/guzzle5/test_cat.php b/tests/integration/external/guzzle5/test_cat.php
@@ -10,14 +10,8 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
 
-if (version_compare(phpversion(), '5.4.0', '<')) {
-    die("skip: PHP >= 5.4.0 required\n");
-}
-
 if (!isset($_ENV["ACCOUNT_supportability"]) || !isset($_ENV["APP_supportability"])) {
     die("skip: env vars required");
 }
diff --git a/tests/integration/external/guzzle5/test_dt.php b/tests/integration/external/guzzle5/test_dt.php
@@ -10,13 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
-
-if (version_compare(phpversion(), '5.5.0', '<')) {
-    die("skip: PHP >= 5.5.0 required\n");
-}
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle5/test_dt_newrelic_header_disabled.php b/tests/integration/external/guzzle5/test_dt_newrelic_header_disabled.php
@@ -10,13 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
-
-if (version_compare(phpversion(), '5.5.0', '<')) {
-    die("skip: PHP >= 5.5.0 required\n");
-}
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle5/test_dt_synthetics.php b/tests/integration/external/guzzle5/test_dt_synthetics.php
@@ -10,14 +10,8 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
 
-if (version_compare(phpversion(), '5.4.0', '<')) {
-    die("skip: PHP >= 5.4.0 required\n");
-}
-
 if (!isset($_ENV["SYNTHETICS_HEADER_supportability"])) {
     die("skip: env vars required");
 }
diff --git a/tests/integration/external/guzzle5/test_dt_synthetics_logging_off.php b/tests/integration/external/guzzle5/test_dt_synthetics_logging_off.php
@@ -10,14 +10,8 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
 
-if (version_compare(phpversion(), '5.4.0', '<')) {
-    die("skip: PHP >= 5.4.0 required\n");
-}
-
 if (!isset($_ENV["SYNTHETICS_HEADER_supportability"])) {
     die("skip: env vars required");
 }
diff --git a/tests/integration/external/guzzle5/test_no_cat_no_dt.php b/tests/integration/external/guzzle5/test_no_cat_no_dt.php
@@ -5,18 +5,12 @@
  */
 
 /*DESCRIPTION
-Test that Cross Application Tracing (CAT) works with guzzle 5.
+Test that neither CAT nor DT headers are added when CAT and DT are disabled.
 */
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
-
-if (version_compare(phpversion(), '5.4.0', '<')) {
-    die("skip: PHP >= 5.4.0 required\n");
-}
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle5/test_spans_external.php b/tests/integration/external/guzzle5/test_spans_external.php
@@ -10,8 +10,6 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
 
 if (version_compare(PHP_VERSION, "7.0", "<")) {
diff --git a/tests/integration/external/guzzle5/test_spans_external.php5.php b/tests/integration/external/guzzle5/test_spans_external.php5.php
@@ -10,13 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
 require('skipif.inc');
-
-if (version_compare(phpversion(), '5.4.0', '<')) {
-    die("skip: PHP >= 5.4.0 required\n");
-}
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle6/skipif.inc b/tests/integration/external/guzzle6/skipif.inc
@@ -0,0 +1,19 @@
+<?php
+/*
+ * Copyright 2022 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+if (version_compare(PHP_VERSION, '5.5', '<')) {
+    die("skip: PHP >= 5.5 required\n");
+}
+
+if (version_compare(PHP_VERSION, '8.0', '>=')) {
+  die("skip: PHP < 8.0 required\n");
+}
+
+require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
+
+if (!unpack_guzzle(6)) {
+    die("warn: guzzle 6 installation required\n");
+}
diff --git a/tests/integration/external/guzzle6/test_cat.php b/tests/integration/external/guzzle6/test_cat.php
@@ -10,15 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
-if (version_compare(phpversion(), '5.5.0', '<=')) {
-    die("skip: PHP > 5.5.0 required\n");
-}
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
+require('skipif.inc');
 
 if (!isset($_ENV["ACCOUNT_supportability"]) || !isset($_ENV["APP_supportability"])) {
     die("skip: env vars required");
diff --git a/tests/integration/external/guzzle6/test_dt.php b/tests/integration/external/guzzle6/test_dt.php
@@ -10,15 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
-if (version_compare(phpversion(), '5.5.0', '<=')) {
-    die("skip: PHP > 5.5.0 required\n");
-}
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
+require('skipif.inc');
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle6/test_dt_newrelic_header_disabled.php b/tests/integration/external/guzzle6/test_dt_newrelic_header_disabled.php
@@ -10,15 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
-if (version_compare(phpversion(), '5.5.0', '<=')) {
-    die("skip: PHP > 5.5.0 required\n");
-}
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
+require('skipif.inc');
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle6/test_dt_synthetics.php b/tests/integration/external/guzzle6/test_dt_synthetics.php
@@ -10,15 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
-if (version_compare(phpversion(), '5.5.0', '<=')) {
-    die("skip: PHP > 5.5.0 required\n");
-}
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
+require('skipif.inc');
 
 if (!isset($_ENV["SYNTHETICS_HEADER_supportability"])) {
     die("skip: env vars required");
diff --git a/tests/integration/external/guzzle6/test_dt_synthetics_logging_off.php b/tests/integration/external/guzzle6/test_dt_synthetics_logging_off.php
@@ -10,15 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
-if (version_compare(phpversion(), '5.5.0', '<=')) {
-    die("skip: PHP > 5.5.0 required\n");
-}
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
+require('skipif.inc');
 
 if (!isset($_ENV["SYNTHETICS_HEADER_supportability"])) {
     die("skip: env vars required");
diff --git a/tests/integration/external/guzzle6/test_no_cat_no_dt.php b/tests/integration/external/guzzle6/test_no_cat_no_dt.php
@@ -5,20 +5,12 @@
  */
 
 /*DESCRIPTION
-Test that Cross Application Tracing (CAT) works with guzzle 6.
+Test that neither CAT nor DT headers are added when CAT and DT are disabled.
 */
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
-if (version_compare(phpversion(), '5.5.0', '<=')) {
-    die("skip: PHP > 5.5.0 required\n");
-}
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
+require('skipif.inc');
  */
 
 /*INI
diff --git a/tests/integration/external/guzzle6/test_spans_are_created_correctly.php b/tests/integration/external/guzzle6/test_spans_are_created_correctly.php
@@ -10,15 +10,11 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
+require('skipif.inc');
 
 if (version_compare(PHP_VERSION, "7.0", "<")) {
   die("skip: CLM for PHP 5 not supported\n");
 }
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle6/test_spans_are_created_correctly.php5.php b/tests/integration/external/guzzle6/test_spans_are_created_correctly.php5.php
@@ -10,15 +10,7 @@
 
 /*SKIPIF
 <?php
-require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
-
-if (version_compare(phpversion(), '5.5.0', '<=')) {
-    die("skip: PHP > 5.5.0 required\n");
-}
-
-if (!unpack_guzzle(6)) {
-    die("skip: guzzle 6 installation required\n");
-}
+require('skipif.inc');
 */
 
 /*INI
diff --git a/tests/integration/external/guzzle7/skipif.inc b/tests/integration/external/guzzle7/skipif.inc
@@ -0,0 +1,21 @@
+<?php
+/*
+ * Copyright 2022 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+require_once(realpath(dirname(__FILE__)) . '/../../../include/unpack_guzzle.php');
+
+if (version_compare(phpversion(), '7.2.5', '<')) {
+    die("skip: PHP >= 7.2.5 required\n");
+}
+
+/*
+if (version_compare(phpversion(), '8.2', '>')) {
+    die("skip: PHP < 8.3 required\n");
+}
+*/
+
+if (!unpack_guzzle(7)) {
+    die("warn: guzzle 7 installation required\n");
+}
diff --git a/tests/integration/external/guzzle7/test_cat.php b/tests/integration/external/guzzle7/test_cat.php
diff --git a/tests/integration/external/guzzle7/test_dt.php b/tests/integration/external/guzzle7/test_dt.php
diff --git a/tests/integration/external/guzzle7/test_dt_newrelic_header_disabled.php b/tests/integration/external/guzzle7/test_dt_newrelic_header_disabled.php
diff --git a/tests/integration/external/guzzle7/test_dt_synthetics.php b/tests/integration/external/guzzle7/test_dt_synthetics.php
diff --git a/tests/integration/external/guzzle7/test_no_cat_no_dt.php b/tests/integration/external/guzzle7/test_no_cat_no_dt.php
diff --git a/tests/integration/external/guzzle7/test_spans_are_created_correctly.php b/tests/integration/external/guzzle7/test_spans_are_created_correctly.php
