Changeset 36854

Timestamp:

03/05/2016 07:47:41 PM (9 years ago)

Author:

ericlewis

Message:

Build/Test Tools: Document PHP unit test classes.

Props boonebgorges.
Fixes #35494.

Location:

trunk/tests/phpunit/includes

Files:

• factory/class-wp-unittest-factory-for-thing.php (modified) (1 diff)
• factory/class-wp-unittest-factory.php (modified) (1 diff)
• testcase.php (modified) (2 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php

@@ -1 +1 @@
 <?php
 
+/**
+ * An abstract class that serves as a basis for all WordPress object-type factory classes.
+ */
 abstract class WP_UnitTest_Factory_For_Thing {
 

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory.php

@@ -1 +1 @@
 <?php
 
+/**
+ * A factory for making WordPress data with a cross-object type API.
+ *
+ * Tests should use this factory to generate test fixtures.
+ */
 class WP_UnitTest_Factory {
 

trunk/tests/phpunit/includes/testcase.php

@@ -4 +4 @@
 require_once dirname( __FILE__ ) . '/trac.php';
 
+/**
+ * Defines a basic fixture to run multiple tests.
+ *
+ * Resets the state of the WordPress installation before and after every test.
+ *
+ * Includes utility functions and assertions useful for testing WordPress.
+ *
+ * All WordPress unit tests should inherit from this class.
+ */
 class WP_UnitTestCase extends PHPUnit_Framework_TestCase {
 
@@ -125 +134 @@
     }
 
+    /**
+     * After a test method runs, reset any state in WordPress the test method might have changed.
+     */
     function tearDown() {
         global $wpdb, $wp_query, $wp, $post;