Tests: Make it easy to get code coverage reports (#1386)

* Tests: Make it easy to get code coverage reports

* Fix coverage annotations

* ignore coverage folder

* Add coverage for integrations

---------

Co-authored-by: Matthias Pfefferle <[email protected]>

Author: obenland

.gitignore

@@ -2,6 +2,7 @@ _site
 .sass-cache
 .jekyll-cache
 .jekyll-metadata
+/coverage/
 /node_modules/
 /vendor/
 package-lock.json

.wp-env.json

@@ -11,7 +11,8 @@
 			"port": 80,
 			"mappings": {
 				"wp-content/plugins/activitypub": ".",
-				"wp-content/plugins/activitypub/tests": "./tests"
+				"wp-content/plugins/activitypub/tests": "./tests",
+				"wp-content/plugins/activitypub/coverage": "./coverage"
 			}
 		}
 	}

docs/development-environment.md

@@ -99,3 +99,29 @@ Common PHPUnit arguments:
 - `--exclude-group`: Exclude tests with a specific @group annotation
 - `--verbose`: Output more verbose information
 - `--debug`: Display debugging information
+
+### Code Coverage Reports
+
+The coverage configuration is already set up in `phpunit.xml.dist` to analyze the code in the `includes` directory. To generate code coverage reports, you'll need to start wp-env with Xdebug enabled for coverage:
+
+```bash
+# Start the environment with Xdebug enabled.
+npm run env -- start --xdebug=coverage
+```
+```bash
+# Run tests with code coverage.
+npm run env-test -- --coverage-text
+```
+
+The above will display a text-based coverage report in your terminal. For a more detailed HTML report:
+
+```bash
+# Generate HTML coverage report in Docker.
+npm run env-test -- --coverage-html ./coverage
+```
+```bash
+# Open the coverage report in your default browser (macOS).
+open coverage/index.html
+```
+
+The HTML report will be generated directly in the `coverage` directory in your local filesystem. The `index.html` file can then be opened in a browser, showing a detailed analysis of which lines of code are covered by tests.

includes/activity/class-base-object.php

@@ -24,7 +24,7 @@
  * @method string|null             get_actor()         Gets one or more entities that performed or are expected to perform the activity.
  * @method string|null             get_attributed_to() Gets the entity attributed as the original author.
  * @method array|null              get_attachment()    Gets the attachment property of the object.
- * @method string|null             get_cc()            Gets the secondary recipients of the object.
+ * @method array|null              get_cc()            Gets the secondary recipients of the object.
  * @method string|null             get_content()       Gets the content property of the object.
  * @method array|null              get_icon()          Gets the icon property of the object.
  * @method string|null             get_id()            Gets the object's unique global identifier.

phpunit.xml.dist

@@ -14,4 +14,10 @@
 	<listeners>
 		<listener class="Activitypub\Tests\Activitypub_Testcase_Timer" file="tests/class-activitypub-testcase-timer.php" />
 	</listeners>
+	<coverage>
+		<include>
+			<directory suffix=".php">./includes</directory>
+			<directory suffix=".php">./integration</directory>
+		</include>
+	</coverage>
 </phpunit>

tests/includes/activity/class-test-base-object.php

@@ -31,7 +31,7 @@ public function test_to_string() {
 	/**
 	 * Test the magic add method.
 	 *
-	 * @covers ::add_* Magic function.
+	 * @covers ::__call
 	 *
 	 * @dataProvider data_magic_add
 	 *

tests/includes/class-test-comment.php

@@ -19,7 +19,8 @@ class Test_Comment extends \WP_UnitTestCase {
 	/**
 	 * Test get source id or url.
 	 *
-	 * @covers ::get_source_id, ::get_source_url
+	 * @covers ::get_source_id
+	 * @covers ::get_source_url
 	 */
 	public function test_get_source_id_or_url() {
 		$comment_id = wp_insert_comment(
@@ -115,47 +116,6 @@ public function test_check_ability_to_federate_threaded_comment( $parent_comment
 		$this->assertEquals( $expected['should_be_federated'], Comment::should_be_federated( $comment ) );
 	}
 
-	/**
-	 * Test get comment ancestors.
-	 *
-	 * @covers ::get_comment_ancestors
-	 */
-	public function test_get_comment_ancestors() {
-		$comment_id = wp_insert_comment(
-			array(
-				'comment_type'         => 'comment',
-				'comment_content'      => 'This is a comment.',
-				'comment_author_url'   => 'https://example.com',
-				'comment_author_email' => '',
-				'comment_meta'         => array(
-					'protocol' => 'activitypub',
-				),
-			)
-		);
-
-		$this->assertEquals( array(), \Activitypub\get_comment_ancestors( $comment_id ) );
-
-		$comment_array = get_comment( $comment_id, ARRAY_A );
-
-		$parent_comment_id = wp_insert_comment(
-			array(
-				'comment_type'         => 'parent comment',
-				'comment_content'      => 'This is a parent comment.',
-				'comment_author_url'   => 'https://example.com',
-				'comment_author_email' => '',
-				'comment_meta'         => array(
-					'protocol' => 'activitypub',
-				),
-			)
-		);
-
-		$comment_array['comment_parent'] = $parent_comment_id;
-
-		wp_update_comment( $comment_array );
-
-		$this->assertEquals( array( $parent_comment_id ), \Activitypub\get_comment_ancestors( $comment_id ) );
-	}
-
 	/**
 	 * Test pre_comment_approved.
 	 *

tests/includes/class-test-functions.php

@@ -36,7 +36,7 @@ public function set_up() {
 	/**
 	 * Test the get_remote_metadata_by_actor function.
 	 *
-	 * @covers ::get_remote_metadata_by_actor
+	 * @covers \ActivityPub\get_remote_metadata_by_actor
 	 */
 	public function test_get_remote_metadata_by_actor() {
 		$metadata = \ActivityPub\get_remote_metadata_by_actor( '[email protected]' );
@@ -48,7 +48,7 @@ public function test_get_remote_metadata_by_actor() {
 	/**
 	 * Test object_id_to_comment.
 	 *
-	 * @covers ::object_id_to_comment
+	 * @covers \ActivityPub\object_id_to_comment
 	 */
 	public function test_object_id_to_comment_basic() {
 		$single_comment_source_id = 'https://example.com/single';
@@ -80,7 +80,7 @@ public function test_object_id_to_comment_basic() {
 	/**
 	 * Test object_id_to_comment with invalid source ID.
 	 *
-	 * @covers ::object_id_to_comment
+	 * @covers \ActivityPub\object_id_to_comment
 	 */
 	public function test_object_id_to_comment_none() {
 		$single_comment_source_id = 'https://example.com/none';
@@ -91,7 +91,7 @@ public function test_object_id_to_comment_none() {
 	/**
 	 * Test object_id_to_comment with duplicate source ID.
 	 *
-	 * @covers ::object_id_to_comment
+	 * @covers \ActivityPub\object_id_to_comment
 	 */
 	public function test_object_id_to_comment_duplicate() {
 		$duplicate_comment_source_id = 'https://example.com/duplicate';
@@ -129,7 +129,7 @@ public function test_object_id_to_comment_duplicate() {
 	 * Test object_to_uri.
 	 *
 	 * @dataProvider object_to_uri_provider
-	 * @covers ::object_to_uri
+	 * @covers \Activitypub\object_to_uri
 	 *
 	 * @param mixed $input  The input to test.
 	 * @param mixed $output The expected output.
@@ -141,7 +141,7 @@ public function test_object_to_uri( $input, $output ) {
 	/**
 	 * Test is_self_ping.
 	 *
-	 * @covers ::is_self_ping
+	 * @covers \Activitypub\is_self_ping
 	 */
 	public function test_is_self_ping() {
 		$this->assertFalse( \Activitypub\is_self_ping( 'https://example.org' ) );
@@ -220,7 +220,7 @@ public function object_to_uri_provider() {
 	/**
 	 * Test is_activity with array input.
 	 *
-	 * @covers ::is_activity
+	 * @covers \Activitypub\is_activity
 	 *
 	 * @dataProvider is_activity_data
 	 *
@@ -280,7 +280,7 @@ public function is_activity_data() {
 	/**
 	 * Test is_activity with invalid input.
 	 *
-	 * @covers ::is_activity
+	 * @covers \Activitypub\is_activity
 	 */
 	public function test_is_activity_with_invalid_input() {
 		$invalid_inputs = array(
@@ -300,10 +300,51 @@ public function test_is_activity_with_invalid_input() {
 		}
 	}
 
+	/**
+	 * Test get comment ancestors.
+	 *
+	 * @covers \Activitypub\get_comment_ancestors
+	 */
+	public function test_get_comment_ancestors() {
+		$comment_id = wp_insert_comment(
+			array(
+				'comment_type'         => 'comment',
+				'comment_content'      => 'This is a comment.',
+				'comment_author_url'   => 'https://example.com',
+				'comment_author_email' => '',
+				'comment_meta'         => array(
+					'protocol' => 'activitypub',
+				),
+			)
+		);
+
+		$this->assertEquals( array(), \Activitypub\get_comment_ancestors( $comment_id ) );
+
+		$comment_array = get_comment( $comment_id, ARRAY_A );
+
+		$parent_comment_id = wp_insert_comment(
+			array(
+				'comment_type'         => 'parent comment',
+				'comment_content'      => 'This is a parent comment.',
+				'comment_author_url'   => 'https://example.com',
+				'comment_author_email' => '',
+				'comment_meta'         => array(
+					'protocol' => 'activitypub',
+				),
+			)
+		);
+
+		$comment_array['comment_parent'] = $parent_comment_id;
+
+		wp_update_comment( $comment_array );
+
+		$this->assertEquals( array( $parent_comment_id ), \Activitypub\get_comment_ancestors( $comment_id ) );
+	}
+
 	/**
 	 * Test is_post_disabled function.
 	 *
-	 * @covers ::is_post_disabled
+	 * @covers \Activitypub\is_post_disabled
 	 */
 	public function test_is_post_disabled() {
 		// Test standard public post.
@@ -356,7 +397,7 @@ public function test_is_post_disabled() {
 	/**
 	 * Test is_post_disabled with private visibility.
 	 *
-	 * @covers ::is_post_disabled
+	 * @covers \Activitypub\is_post_disabled
 	 */
 	public function test_is_post_disabled_private_visibility() {
 		$visible_private_post_id = self::factory()->post->create();
@@ -377,7 +418,7 @@ public function test_is_post_disabled_private_visibility() {
 	/**
 	 * Test is_post_disabled with invalid post.
 	 *
-	 * @covers ::is_post_disabled
+	 * @covers \Activitypub\is_post_disabled
 	 */
 	public function test_is_post_disabled_invalid_post() {
 		$this->assertTrue( \Activitypub\is_post_disabled( 0 ) );
@@ -388,7 +429,7 @@ public function test_is_post_disabled_invalid_post() {
 	/**
 	 * Test get_masked_wp_version function.
 	 *
-	 * @covers ::get_masked_wp_version
+	 * @covers \Activitypub\get_masked_wp_version
 	 * @dataProvider provide_wp_versions
 	 *
 	 * @param string $input    The input version.

tests/includes/class-test-migration.php

@@ -178,6 +178,23 @@ public function test_migrate_actor_mode() {
 		$this->assertEquals( ACTIVITYPUB_ACTOR_MODE, \get_option( 'activitypub_actor_mode', ACTIVITYPUB_ACTOR_MODE ) );
 	}
 
+	/**
+	 * Tests scheduling of migration.
+	 *
+	 * @covers ::maybe_migrate
+	 */
+	public function test_migration_scheduling() {
+		update_option( 'activitypub_db_version', '0.0.1' );
+
+		Migration::maybe_migrate();
+
+		$schedule = \wp_next_scheduled( 'activitypub_migrate', array( '0.0.1' ) );
+		$this->assertNotFalse( $schedule );
+
+		// Clean up.
+		delete_option( 'activitypub_db_version' );
+	}
+
 	/**
 	 * Test migrate to 4.1.0.
 	 *

tests/includes/collection/class-test-extra-fields.php

@@ -19,7 +19,7 @@ class Test_Extra_Fields extends \WP_UnitTestCase {
 	/**
 	 * Test the get_attachment.
 	 *
-	 * @covers ::get_attachment
+	 * @covers ::fields_to_attachments
 	 */
 	public function test_get_attachment() {
 		$post = self::factory()->post->create_and_get(