Using PHPUnit as a dev requirement in a project (which uses git for version control) and running it using vendor/bin/phpunit will show the most recent tagged version of project instead of the phpunit version.

This can be tracked down to SebastianBergmann\Version::isGitRepository. As the isGitRespository method is recursive to check till the root if there is some .git folder it can show any tag of a parent git repository instead of a phpunit tagged version.

        /**
         * @param  string $path
         * @return boolean
         */
        private function isGitRepository($path)
        {
            if (is_dir($path . DIRECTORY_SEPARATOR . '.git')) {
                return TRUE;
            }

            $path = dirname($path);

            if ($path == '/') { <-- this should be changed to stop at a defined folder (e.g. the phpunit directory in the projects vendor folder)
                return FALSE;
            }

            return $this->isGitRepository($path);
        }

I've PHPUnit 4.3.1 installed using Composer.

$version = new SebastianBergmann\Version('4.3.1', dirname(dirname(__DIR__)));

The problem is that this returns legacy-version-7-belgium-1829-gd13dcc3 instead of the tagged release. When looking at the code it becomes clear that whenever a .git directory is found (recursively) it will always return a git based hash as version.

But the .git directory that is found is the one of my own project (the project root). There is no .git directory inside vendor/phpunit/...

Is there a way to stop this or to limit the level of recursiveness?

When runing phpcpd it uses as a dependency this lib "Version" ant it produces an infinate recursion and uses up all memory, i Installed using pear, so no git hub repository is present.

Fatal error: Maximum function nesting level of '100' reached, aborting! in C:\Pr ogram Files (x86)\PHP\pear\SebastianBergmann\Version\Version.php on line 125

INSTALLED PACKAGES, CHANNEL PEAR.PHPUNIT.DE:
============================================
PACKAGE                   VERSION STATE
File_Iterator             1.3.3   stable
FinderFacade              1.0.6   stable
PHPUnit                   3.7.19  stable
PHPUnit_MockObject        1.2.3   stable
PHPUnit_SkeletonGenerator 1.2.0   stable
PHP_CodeCoverage          1.2.9   stable
PHP_Timer                 1.0.4   stable
PHP_TokenStream           1.1.5   stable
Text_Template             1.1.4   stable
Version                   1.0.0   stable
phpcpd                    1.4.1   stable
phpdcd                    0.9.3   beta
phploc                    1.7.4   stable
ppw                       1.0.4   stable

Call Stack:
    0.0002     322912   1. {main}() C:\Program Files (x86)\PHP\phpcpd:0
    0.0165     772056   2. SebastianBergmann\PHPCPD\TextUI\Command->__construct(
) C:\Program Files (x86)\PHP\phpcpd:55
    0.0169     797368   3. SebastianBergmann\Version->getVersion() C:\Program Fi
les (x86)\PHP\pear\SebastianBergmann\PHPCPD\TextUI\Command.php:68
    0.0169     797368   4. SebastianBergmann\Version->getGitInformation() C:\Pro
gram Files (x86)\PHP\pear\SebastianBergmann\Version\Version.php:81
    0.0169     797368   5. SebastianBergmann\Version->isGitRepository() C:\Progr
am Files (x86)\PHP\pear\SebastianBergmann\Version\Version.php:103
    0.0170     797472   6. SebastianBergmann\Version->isGitRepository() C:\Progr
am Files (x86)\PHP\pear\SebastianBergmann\Version\Version.php:135
    0.0170     797576   7. SebastianBergmann\Version->isGitRepository() C:\Progr
am Files (x86)\PHP\pear\SebastianBergmann\Version\Version.php:135
    0.0171     797672   8. SebastianBergmann\Version->isGitRepository() C:\Progr
am Files (x86)\PHP\pear\SebastianBergmann\Version\Version.php:135
    0.0171     797744   9. SebastianBergmann\Version->isGitRepository() C:\Progr
am Files (x86)\PHP\pear\SebastianBergmann\Version\Version.php:135

When trying to checkout PHPUnit as Git submodules in a project, so that I can fork and modify them, I get this error from CodeCoverage:

• PHP Fatal error: require_once(): Failed opening required 'SebastianBergmann/Version/autoload.php' in /home/installuser/Dropbox/projects/ischool/website/web/lib/php-code-coverage/PHP/CodeCoverage/Autoload.php on line 49

My include_path is:

• /home/installuser/Dropbox/projects/ischool/website/tests/../web
• /home/installuser/Dropbox/projects/ischool/website/tests/../web/lib
• /home/installuser/Dropbox/projects/ischool/website/tests/../web/lib/phpunit
• /home/installuser/Dropbox/projects/ischool/website/tests/../web/lib/php-code-coverage
• .
• /usr/share/php
• /usr/share/pear'

There's no way to resolve this without installing the module globally using PEAR (defeating the point of what I was trying to do, and making the code harder to install) or moving the files around.

If you could create the directory:

src/SebastianBergmann/Version

and move src/autoload.php into it, then I could add sebastianbergmann-version/src to my PHP include path, and it would find the files and I would be able to load phpunit and its dependencies from the Git checkout. Thanks :)

This enables the use of this component on systems where chdir() or exec() is disabled (but proc_open() is not). This also allows us to forgo the silence operator, which is convenient if xdebug.scream is enabled.

This fixes an issue we're currently having where git describe --tags return 1.7.0-beta.2-208-g6d1683e, and thus the version becomes 1.7-208 instead of 1.7-g6d1683e.

When using the getVersion() on a Windows based host it seems that getVersion() gets stuck in an infinite loop while trying to determine if the directory is a Git repo:

 Fatal error: Maximum function nesting level of '100' reached, aborting! in C:\[...]\vendor\sebastian\version\src\Version.php on line 125

Call Stack:
  0.0009     122592   1. {main}() C:\[...]\vendor\sebastian\phpcpd\composer\bin\phpcpd:0
  0.0081     351000   2. SebastianBergmann\PHPCPD\TextUI\Command->__construct() C:\[...]\vendor\sebastian\phpcpd\composer\bin\phpcpd:69
  0.0087     362728   3. SebastianBergmann\Version->getVersion() C:\[...]\vendor\sebastian\phpcpd\src\TextUI\Command.php:68
  0.0087     362864   4. SebastianBergmann\Version->getGitInformation() C:\[...]\vendor\sebastian\version\src\Version.php:81
  0.0087     362904   5. SebastianBergmann\Version->isGitRepository() C:\[...]\vendor\sebastian\version\src\Version.php:103
  0.0092     363080   6. SebastianBergmann\Version->isGitRepository() C:\[...]\vendor\sebastian\version\src\Version.php:135
  0.0095     363176   7. SebastianBergmann\Version->isGitRepository() C:\[...]\vendor\sebastian\version\src\Version.php:135
  0.0099     363272   8. SebastianBergmann\Version->isGitRepository() C:\[...]\vendor\sebastian\version\src\Version.php:135
  0.0102     363360   9. SebastianBergmann\Version->isGitRepository() C:\[...]\vendor\sebastian\version\src\Version.php:135
  0.0105     363440  10. SebastianBergmann\Version->isGitRepository() C:\[...]\vendor\sebastian\version\src\Version.php:135
  [etc]

I checked the code and it seems that the following check fails:

[line: 131] if ($path == '/') {

because on windows $path will be 'C:'

Backstory

This was an interesting one track down. The symptom was that PHPStan only worked when run directly, but not when run as part of a git invoked workflow (e.g. through git rebase --exec).

The cause was that phpstan-drupal includes a file from the Drupal framework that queries the runner to figure out which PHPUnit version is being used.

The version returned when running git did not match the actual PHPUnit version installed which caused the alias that Drupal created to a PHPUnit bridge class to break.

Problem

The Version class uses a git command to find the tag of the currently installed package version for packages that composer has checked out from git. This works when executed directly.

However, when used in a git based workflow such as git rebase --exec or git bisect then this fails. The cause is that for those commands git will add environment variables that specify the GIT_DIR on which its performing those workflows, so that moving around and calling git commands still operates according to the git repository the workflow is being executed on.

As a result when Version calls git describe --tags this does not use the .git folder in the working directory of proc_open but instead uses the git folder for which the git workflow is in progress.

Solution

To remedy this the Version class should specify --git-dir directly. A few lines above we already know explicitly what git directory we're interested in. Specifying the argument to git overrides any environment variables that may be set. This allows the library to work in automated git workflows invoked from other repositories.

• [ ] Use GitHub Actions instead of Travis CI
• [ ] Have Composer in tools/composer and managed through composer self-update (see update-tools target in build.xml
• [ ] Install Psalm using Phive as tools/psalm (phive install --copy psalm)
• [ ] Install PHP-CS-Fixer using Phive as tools/php-cs-fixer (phive install --copy php-cs-fixer)
• [ ] Create Psalm configuration
• [ ] Add Psalm build step to GitHub Actions-based CI workflow
• [ ] Add PHP-CS-Fixer build step to GitHub Actions-based CI workflow