Only export properties for configuration, code coverage data, and test results when serializing CodeCoverage for #1090

Author: sebastianbergmann

ChangeLog-12.3.md

@@ -2,6 +2,12 @@
 
 All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## [12.3.5] - 2025-MM-DD
+
+### Changed
+
+* [#1090](https://github.com/sebastianbergmann/php-code-coverage/issues/1090): Only export properties for configuration, code coverage data, and test results when serializing `CodeCoverage`
+
 ## [12.3.4] - 2025-08-29
 
 ### Changed
@@ -38,6 +44,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 
 * [#1080](https://github.com/sebastianbergmann/php-code-coverage/pull/1080): Support for reporting code coverage information in OpenClover XML format; unlike the existing Clover XML reporter, which remains unchanged, the XML documents generated by this new reporter validate against the OpenClover project's XML schema definition, with one exception: we do not generate the `<testproject>` element. This feature is experimental and the generated XML might change in order to improve compliance with the OpenClover project's XML schema definition further. Such changes will be made in bugfix and/or minor releases even if they break backward compatibility.
 
+[12.3.5]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.4...main
 [12.3.4]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.3...12.3.4
 [12.3.3]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.2...12.3.3
 [12.3.2]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.3.1...12.3.2

src/CodeCoverage.php

@@ -76,6 +76,27 @@ public function __construct(Driver $driver, Filter $filter)
         $this->data   = new ProcessedCodeCoverageData;
     }
 
+    /**
+     * @return non-empty-list<non-empty-string>
+     */
+    public function __sleep(): array
+    {
+        return [
+            // Configuration
+            'cacheDirectory',
+            'checkForUnintentionallyCoveredCode',
+            'includeUncoveredFiles',
+            'ignoreDeprecatedCode',
+            'parentClassesExcludedFromUnintentionallyCoveredCodeCheck',
+            'useAnnotationsForIgnoringCode',
+            'filter',
+
+            // Data
+            'data',
+            'tests',
+        ];
+    }
+
     /**
      * Returns the code coverage information as a graph of node objects.
      */

tests/tests/Report/PhpTest.php

@@ -10,6 +10,7 @@
 namespace SebastianBergmann\CodeCoverage\Report;
 
 use ReflectionProperty;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\TestCase;
 
 final class PhpTest extends TestCase
@@ -28,7 +29,9 @@ public function testPHPSerialisationProducesValidCode(): void
 
         $unserialized = require TEST_FILES_PATH . 'tmp/serialized.php';
 
-        $this->assertEquals($coverage, $unserialized);
+        $this->assertInstanceOf(CodeCoverage::class, $unserialized);
+        $this->assertEquals($coverage->getData(), $unserialized->getData());
+        $this->assertEquals($coverage->getTests(), $unserialized->getTests());
     }
 
     public function testPHPSerialisationProducesValidCodeWhenOutputIncludesSingleQuote(): void
@@ -40,7 +43,9 @@ public function testPHPSerialisationProducesValidCodeWhenOutputIncludesSingleQuo
 
         $unserialized = require TEST_FILES_PATH . 'tmp/serialized.php';
 
-        $this->assertEquals($coverage, $unserialized);
+        $this->assertInstanceOf(CodeCoverage::class, $unserialized);
+        $this->assertEquals($coverage->getData(), $unserialized->getData());
+        $this->assertEquals($coverage->getTests(), $unserialized->getTests());
     }
 
     public function testCacheDataNeverGetSaved(): void