Tests cleanup for readability and consistency.

Author: hellofromtonya

tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php

@@ -43,14 +43,7 @@ class Tests_Privacy_WpPrivacyGeneratePersonalDataExportFile extends WP_UnitTestC
 	 */
 	public static $exports_dir;
 
-	/**
-	 * Create fixtures that are shared by multiple test cases.
-	 *
-	 * @since 5.2.0
-	 *
-	 * @param WP_UnitTest_Factory $factory The base factory object.
-	 */
-	public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+	public static function setUpBeforeClass() {
 		self::$export_request_id = wp_create_user_request( 'export-requester@example.com', 'export_personal_data' );
 		self::$exports_dir       = wp_privacy_exports_dir();
 	}
@@ -98,63 +91,6 @@ public function tearDown() {
 		parent::tearDown();
 	}
 
-	/**
-	 * Stores the name of the export zip file to check the file is actually created.
-	 *
-	 * @since 5.2.0
-	 *
-	 * @param string $archive_name Created export zip file path.
-	 */
-	public function action_wp_privacy_personal_data_export_file_created( $archive_name ) {
-		$this->export_file_name = $archive_name;
-	}
-
-	/**
-	 * Removes the privacy exports directory, including files and subdirectories.
-	 *
-	 * Ignores hidden files and has upper limit of nested levels, because of `list_files()`.
-	 *
-	 * @since 5.2.0
-	 *
-	 * @return bool Whether the privacy exports directory was removed.
-	 */
-	private function remove_exports_dir() {
-		/**
-		 * The `$exports_dir` will be a file after the `test_detect_cannot_create_folder()` test method, or,
-		 * if an incorrect value is returned to the `wp_privacy_exports_dir` filter.
-		 */
-		if ( is_file( untrailingslashit( self::$exports_dir ) ) ) {
-			wp_delete_file( untrailingslashit( self::$exports_dir ) );
-
-			return ! is_file( untrailingslashit( self::$exports_dir ) );
-		}
-
-		if ( ! is_dir( self::$exports_dir ) ) {
-			return true;
-		}
-
-		chmod( self::$exports_dir, 0755 );
-
-		$files = list_files( self::$exports_dir );
-
-		// Delete files first, then delete subdirectories.
-		foreach ( $files as $file ) {
-			if ( is_file( $file ) ) {
-				wp_delete_file( $file );
-			}
-		}
-
-		foreach ( $files as $file ) {
-			if ( is_dir( $file ) ) {
-				rmdir( $file );
-			}
-		}
-
-		rmdir( self::$exports_dir );
-
-		return ! is_dir( self::$exports_dir );
-	}
-
 	/**
 	 * When a remove request ID is passed to the export function an error should be displayed.
 	 *
@@ -215,17 +151,15 @@ public function test_detect_cannot_create_folder() {
 
 	/**
 	 * @dataProvider dataInvalidExportDataGrouped
+	 *
+	 * @param mixed $groups '_export_data_grouped' post meta value.
+	 * @param string $type  Expected groups data type.
 	 */
 	public function test_invalid_export_data_grouped_type_error( $groups, $type ) {
 		update_post_meta( self::$export_request_id, '_export_data_grouped', $groups );
 
 		$this->expectException( 'WPDieException' );
-		$this->expectOutputString(
-			sprintf(
-				'{"success":false,"data":"Warning: array_merge(): Expected parameter 2 to be an array, %s given."}',
-				$type
-			)
-		);
+		$this->expectOutputString( '{"success":false,"data":"Warning: array_merge(): Expected parameter 2 to be an array, ' . $type . ' given."}' );
 
 		wp_privacy_generate_personal_data_export_file( self::$export_request_id );
 	}
@@ -321,7 +255,6 @@ public function test_can_succeed() {
 	 * Test the export JSON file has all the expected parts.
 	 *
 	 * @dataProvider dataExportContents
-	 * @ticket 49029
 	 */
 	public function test_json_contents( $export_data_grouped ) {
 		$report_dir = $this->setup_export_contents_test( $export_data_grouped );
@@ -699,4 +632,61 @@ public function dataExportContents() {
 			),
 		);
 	}
+
+	/**
+	 * Stores the name of the export zip file to check the file is actually created.
+	 *
+	 * @since 5.2.0
+	 *
+	 * @param string $archive_name Created export zip file path.
+	 */
+	public function action_wp_privacy_personal_data_export_file_created( $archive_name ) {
+		$this->export_file_name = $archive_name;
+	}
+
+	/**
+	 * Removes the privacy exports directory, including files and subdirectories.
+	 *
+	 * Ignores hidden files and has upper limit of nested levels, because of `list_files()`.
+	 *
+	 * @since 5.2.0
+	 *
+	 * @return bool Whether the privacy exports directory was removed.
+	 */
+	private function remove_exports_dir() {
+		/**
+		 * The `$exports_dir` will be a file after the `test_detect_cannot_create_folder()` test method, or,
+		 * if an incorrect value is returned to the `wp_privacy_exports_dir` filter.
+		 */
+		if ( is_file( untrailingslashit( self::$exports_dir ) ) ) {
+			wp_delete_file( untrailingslashit( self::$exports_dir ) );
+
+			return ! is_file( untrailingslashit( self::$exports_dir ) );
+		}
+
+		if ( ! is_dir( self::$exports_dir ) ) {
+			return true;
+		}
+
+		chmod( self::$exports_dir, 0755 );
+
+		$files = list_files( self::$exports_dir );
+
+		// Delete files first, then delete subdirectories.
+		foreach ( $files as $file ) {
+			if ( is_file( $file ) ) {
+				wp_delete_file( $file );
+			}
+		}
+
+		foreach ( $files as $file ) {
+			if ( is_dir( $file ) ) {
+				rmdir( $file );
+			}
+		}
+
+		rmdir( self::$exports_dir );
+
+		return ! is_dir( self::$exports_dir );
+	}
 }