Do not include information about the Git repository in the Open Test Reporting XML format by default

Author: sebastianbergmann

ChangeLog-12.2.md

@@ -2,6 +2,12 @@
 
 All notable changes of the PHPUnit 12.2 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
 
+## [12.2.4] - 2025-MM-DD
+
+### Changed
+
+* Including information about the Git repository (such as the commit hash and branch name) in the Open Test Reporting XML format is now an opt-in feature that can be enabled via the `--include-git-information` CLI option or the `includeGitInformation` attribute in the XML configuration file
+
 ## [12.2.3] - 2025-06-20
 
 ### Added
@@ -76,6 +82,7 @@ This feature is experimental and the generated XML may change to enhance complia
 * A warning is now emitted when more than one of `#[Small]`, `#[Medium]`, or `#[Large]` is used on a test class
 * A warning is now emitted when a data provider provides data sets that have more values than the test method consumes using arguments
 
+[12.2.4]: https://github.com/sebastianbergmann/phpunit/compare/12.2.3...12.2
 [12.2.3]: https://github.com/sebastianbergmann/phpunit/compare/12.2.2...12.2.3
 [12.2.2]: https://github.com/sebastianbergmann/phpunit/compare/12.2.1...12.2.2
 [12.2.1]: https://github.com/sebastianbergmann/phpunit/compare/12.2.0...12.2.1

phpunit.xsd

@@ -299,7 +299,7 @@
     <xs:group name="loggingGroup">
         <xs:all>
             <xs:element name="junit" type="logToFileType" minOccurs="0" />
-            <xs:element name="otr" type="logToFileType" minOccurs="0" />
+            <xs:element name="otr" type="otrType" minOccurs="0" />
             <xs:element name="teamcity" type="logToFileType" minOccurs="0" />
             <xs:element name="testdoxHtml" type="logToFileType" minOccurs="0" />
             <xs:element name="testdoxText" type="logToFileType" minOccurs="0" />
@@ -311,6 +311,10 @@
     <xs:complexType name="logToDirectoryType">
         <xs:attribute name="outputDirectory" type="xs:anyURI" use="required"/>
     </xs:complexType>
+    <xs:complexType name="otrType">
+        <xs:attribute name="outputFile" type="xs:anyURI" use="required"/>
+        <xs:attribute name="includeGitInformation" type="xs:boolean" default="false"/>
+    </xs:complexType>
     <xs:complexType name="coverageReportCrap4JType">
         <xs:attribute name="outputFile" type="xs:anyURI" use="required"/>
         <xs:attribute name="threshold" type="xs:integer"/>

src/Logging/OpenTestReporting/OtrXmlLogger.php

@@ -69,13 +69,14 @@ final class OtrXmlLogger
     private ?Throwable $parentErrored = null;
     private ?Throwable $parentFailed  = null;
     private bool $alreadyFinished     = false;
+    private bool $includeGitInformation;
 
     /**
      * @param non-empty-string $uri
      *
      * @throws CannotOpenUriForWritingException
      */
-    public function __construct(string $uri, Facade $facade)
+    public function __construct(Facade $facade, string $uri, bool $includeGitInformation)
     {
         $this->writer = new XMLWriter;
 
@@ -88,12 +89,18 @@ public function __construct(string $uri, Facade $facade)
         $this->writer->setIndent(true);
 
         $this->registerSubscribers($facade);
+
+        $this->includeGitInformation = $includeGitInformation;
     }
 
     public function testRunnerStarted(): void
     {
         $infrastructure = new InfrastructureInformationProvider;
-        $gitInformation = $infrastructure->gitInformation();
+        $gitInformation = false;
+
+        if ($this->includeGitInformation) {
+            $gitInformation = $infrastructure->gitInformation();
+        }
 
         $this->writer->startDocument();
 

src/TextUI/Application.php

@@ -655,8 +655,9 @@ private function registerLogfileWriters(Configuration $configuration): void
         if ($configuration->hasLogfileOtr()) {
             try {
                 new OtrXmlLogger(
-                    $configuration->logfileOtr(),
                     EventFacade::instance(),
+                    $configuration->logfileOtr(),
+                    $configuration->includeGitInformationInOtrLogfile(),
                 );
             } catch (CannotOpenUriForWritingException $e) {
                 EventFacade::emitter()->testRunnerTriggeredPhpunitWarning(

src/TextUI/Configuration/Cli/Builder.php

@@ -92,6 +92,7 @@ final class Builder
         'list-tests-xml=',
         'log-junit=',
         'log-otr=',
+        'include-git-information',
         'log-teamcity=',
         'migrate-configuration',
         'no-configuration',
@@ -275,6 +276,7 @@ public function fromParameters(array $parameters): Configuration
         $iniSettings                       = [];
         $junitLogfile                      = null;
         $otrLogfile                        = null;
+        $includeGitInformation             = null;
         $listGroups                        = false;
         $listSuites                        = false;
         $listTestFiles                     = false;
@@ -606,6 +608,11 @@ public function fromParameters(array $parameters): Configuration
 
                     break;
 
+                case '--include-git-information':
+                    $includeGitInformation = true;
+
+                    break;
+
                 case '--log-teamcity':
                     $teamcityLogfile = $option[1];
 
@@ -1305,6 +1312,7 @@ public function fromParameters(array $parameters): Configuration
             $iniSettings,
             $junitLogfile,
             $otrLogfile,
+            $includeGitInformation,
             $listGroups,
             $listSuites,
             $listTestFiles,

src/TextUI/Configuration/Cli/Configuration.php

@@ -128,6 +128,7 @@
     private ?array $iniSettings;
     private ?string $junitLogfile;
     private ?string $otrLogfile;
+    private ?bool $includeGitInformationInOtrLogfile;
     private bool $listGroups;
     private bool $listSuites;
     private bool $listTestFiles;
@@ -192,7 +193,7 @@
      * @param ?non-empty-list<non-empty-string>                    $coverageFilter
      * @param ?non-empty-list<non-empty-string>                    $extensions
      */
-    public function __construct(array $arguments, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnPhpunitNotice, ?bool $failOnPhpunitWarning, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnPhpunitNotice, ?bool $doNotFailOnPhpunitWarning, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $excludeFilter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?string $otrLogfile, bool $listGroups, bool $listSuites, bool $listTestFiles, bool $listTests, ?string $listTestsXml, ?bool $noCoverage, ?bool $noExtensions, ?bool $noOutput, ?bool $noProgress, ?bool $noResults, ?bool $noLogging, ?bool $processIsolation, ?int $randomOrderSeed, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?string $teamcityLogfile, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?array $testSuffixes, ?string $testSuite, ?string $excludeTestSuite, bool $useDefaultConfiguration, ?bool $displayDetailsOnAllIssues, ?bool $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnPhpunitDeprecations, ?bool $displayDetailsOnPhpunitNotices, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $testdoxPrinter, ?bool $testdoxPrinterSummary, bool $debug, bool $withTelemetry, ?array $extensions)
+    public function __construct(array $arguments, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnPhpunitNotice, ?bool $failOnPhpunitWarning, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnPhpunitNotice, ?bool $doNotFailOnPhpunitWarning, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $excludeFilter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?string $otrLogfile, ?bool $includeGitInformation, bool $listGroups, bool $listSuites, bool $listTestFiles, bool $listTests, ?string $listTestsXml, ?bool $noCoverage, ?bool $noExtensions, ?bool $noOutput, ?bool $noProgress, ?bool $noResults, ?bool $noLogging, ?bool $processIsolation, ?int $randomOrderSeed, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?string $teamcityLogfile, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?array $testSuffixes, ?string $testSuite, ?string $excludeTestSuite, bool $useDefaultConfiguration, ?bool $displayDetailsOnAllIssues, ?bool $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnPhpunitDeprecations, ?bool $displayDetailsOnPhpunitNotices, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $testdoxPrinter, ?bool $testdoxPrinterSummary, bool $debug, bool $withTelemetry, ?array $extensions)
     {
         $this->arguments                                    = $arguments;
         $this->atLeastVersion                               = $atLeastVersion;
@@ -273,6 +274,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba
         $this->iniSettings                                  = $iniSettings;
         $this->junitLogfile                                 = $junitLogfile;
         $this->otrLogfile                                   = $otrLogfile;
+        $this->includeGitInformationInOtrLogfile            = $includeGitInformation;
         $this->listGroups                                   = $listGroups;
         $this->listSuites                                   = $listSuites;
         $this->listTestFiles                                = $listTestFiles;
@@ -1810,6 +1812,26 @@ public function otrLogfile(): string
         return $this->otrLogfile;
     }
 
+    /**
+     * @phpstan-assert-if-true !null $this->includeGitInformationInOtrLogfile
+     */
+    public function hasIncludeGitInformationInOtrLogfile(): bool
+    {
+        return $this->includeGitInformationInOtrLogfile !== null;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function includeGitInformationInOtrLogfile(): bool
+    {
+        if (!$this->hasIncludeGitInformationInOtrLogfile()) {
+            throw new Exception;
+        }
+
+        return $this->includeGitInformationInOtrLogfile;
+    }
+
     public function listGroups(): bool
     {
         return $this->listGroups;