improve test documentation

Explain how pdo/*.inc test files are used by driver specific tests.
newrelic · Dec 31, 2024 · bb4d7fb · bb4d7fb
1 parent 9bb85e4
commit bb4d7fb
Show file tree

Hide file tree

Showing 7 changed files with 137 additions and 0 deletions.
diff --git a/tests/integration/pdo/test_instance_reporting.inc b/tests/integration/pdo/test_instance_reporting.inc
@@ -4,6 +4,27 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+  This file contains code that executes SQL statements using a given connection object.
+  It is used to test database instance reporting functionality which results in database
+  instance metrics being created as well as database instance attributes being added to
+  slow sql traces as well as span events.
+  It is common for all database driver specific tests that prepare connection objects
+  using different methods:
+  - ./mysql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./pgsql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./sqlite:
+    - ./base-class
+    - ./constructor
+    - ./factory
+*/
+
 require_once(dirname(__FILE__).'/../../include/tap.php');
 
 function test_instance_reporting($conn, $want_drop_table_result=1) {

diff --git a/tests/integration/pdo/test_prepared_stmt_1.inc b/tests/integration/pdo/test_prepared_stmt_1.inc
@@ -4,6 +4,26 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+  This file contains code that runs the PDOStatement::execute() test on PDOStatement
+  object prepared using a given connection object.
+  It is common for all database driver specific tests that prepare connection objects
+  using different methods:
+  - ./mysql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./pgsql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./sqlite:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  It tests PDOStatement without any values bound.
+*/
+
 require_once(dirname(__FILE__).'/../../include/tap.php');
 
 function test_prepared_stmt($conn, $query) {

diff --git a/tests/integration/pdo/test_prepared_stmt_2.inc b/tests/integration/pdo/test_prepared_stmt_2.inc
@@ -4,6 +4,26 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+  This file contains code that runs the PDOStatement::execute() test on PDOStatement
+  object prepared using a given connection object.
+  It is common for all database driver specific tests that prepare connection objects
+  using different methods:
+  - ./mysql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./pgsql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./sqlite:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  It tests PDOStatement with values bound.
+*/
+
 require_once(dirname(__FILE__).'/../../include/tap.php');
 
 function test_prepared_stmt($conn, $query) {

diff --git a/tests/integration/pdo/test_query_1.inc b/tests/integration/pdo/test_query_1.inc
@@ -4,6 +4,25 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+  This file contains code that runs the PDO::query test using given connection object.
+  It is common for all database driver specific tests that prepare connection objects
+  using different methods:
+  - ./mysql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./pgsql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./sqlite:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  It tests one argument form of PDO::query().
+*/
+
 require_once(dirname(__FILE__).'/../../include/tap.php');
 
 function test_pdo_query($conn, $want_drop_table_result=1) {

diff --git a/tests/integration/pdo/test_query_2.inc b/tests/integration/pdo/test_query_2.inc
@@ -4,6 +4,25 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+  This file contains code that runs the PDO::query test using given connection object.
+  It is common for all database driver specific tests that prepare connection objects
+  using different methods:
+  - ./mysql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./pgsql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./sqlite:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  It tests the FETCH_COLUMN variant of PDO::query().
+*/
+
 require_once(dirname(__FILE__).'/../../include/tap.php');
 
 function test_pdo_query($conn, $want_drop_table_result=1) {

diff --git a/tests/integration/pdo/test_query_3.inc b/tests/integration/pdo/test_query_3.inc
@@ -4,6 +4,25 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+  This file contains code that runs the PDO::query test using given connection object.
+  It is common for all database driver specific tests that prepare connection objects
+  using different methods:
+  - ./mysql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./pgsql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./sqlite:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  It tests the FETCH_CLASS variant of PDO::query().
+*/
+
 require_once(dirname(__FILE__).'/../../include/tap.php');
 
 class Row {

diff --git a/tests/integration/pdo/test_query_4.inc b/tests/integration/pdo/test_query_4.inc
@@ -4,6 +4,25 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+  This file contains code that runs the PDO::query test using given connection object.
+  It is common for all database driver specific tests that prepare connection objects
+  using different methods:
+  - ./mysql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./pgsql:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  - ./sqlite:
+    - ./base-class
+    - ./constructor
+    - ./factory
+  It tests the FETCH_INTO variant of PDO::query().
+*/
+
 require_once(dirname(__FILE__).'/../../include/tap.php');
 
 class Row {