Ignore the global plugin when updating local projects #39
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,245 @@ | ||
| <?php | ||
|
|
||
| namespace PackageVersionsTest; | ||
|
|
||
| use PHPUnit_Framework_TestCase; | ||
| use RecursiveCallbackFilterIterator; | ||
| use RecursiveDirectoryIterator; | ||
| use RecursiveIteratorIterator; | ||
| use SplFileInfo; | ||
| use ZipArchive; | ||
|
|
||
| /** | ||
| * @coversNothing | ||
| */ | ||
| class E2EInstaller extends PHPUnit_Framework_TestCase | ||
|
Owner
There was a problem hiding this comment. Going to rename/move this class around. Also will add
Contributor
Author
There was a problem hiding this comment. Sure thing - wasn't really sure how to name it |
||
| { | ||
| /** | ||
| * @var string | ||
| */ | ||
| private $tempGlobalComposerHome; | ||
|
|
||
|
|
||
| /** | ||
| * @var string | ||
| */ | ||
| private $tempLocalComposerHome; | ||
|
|
||
| /** | ||
| * @var string | ||
| */ | ||
| private $tempArtifact; | ||
|
|
||
| public function setUp() | ||
| { | ||
| $this->tempGlobalComposerHome = sys_get_temp_dir() . '/' . uniqid('InstallerTest', true) . '/global'; | ||
| $this->tempLocalComposerHome = sys_get_temp_dir() . '/' . uniqid('InstallerTest', true) . '/local'; | ||
| $this->tempArtifact = sys_get_temp_dir() . '/' . uniqid('InstallerTest', true) . '/artifacts'; | ||
| mkdir($this->tempGlobalComposerHome, 0700, true); | ||
| mkdir($this->tempLocalComposerHome, 0700, true); | ||
| mkdir($this->tempArtifact, 0700, true); | ||
|
|
||
| putenv('COMPOSER_HOME=' . $this->tempGlobalComposerHome); | ||
|
Owner
There was a problem hiding this comment. This environment variable must be reset in |
||
| } | ||
|
|
||
| public function tearDown() | ||
| { | ||
| $this->rmDir($this->tempGlobalComposerHome); | ||
| $this->rmDir($this->tempLocalComposerHome); | ||
| $this->rmDir($this->tempArtifact); | ||
|
|
||
| putenv('COMPOSER_HOME'); | ||
| } | ||
|
|
||
| public function testGloballyInstalledPluginDoesNotGenerateVersionsForLocalProject() | ||
| { | ||
| $this->createPackageVersionsArtifact(); | ||
|
|
||
| $this->writeComposerJsonFile( | ||
| [ | ||
| 'name' => 'package-versions/e2e-global', | ||
| 'require' => [ | ||
| 'ocramius/package-versions' => '1.0.0' | ||
| ], | ||
| 'repositories' => [ | ||
| [ | ||
| 'packagist' => false, | ||
| ], | ||
| [ | ||
| 'type' => 'artifact', | ||
| 'url' => $this->tempArtifact, | ||
| ] | ||
| ] | ||
| ], | ||
| $this->tempGlobalComposerHome | ||
| ); | ||
|
|
||
| $this->execComposerInDir('global update', $this->tempGlobalComposerHome); | ||
|
|
||
| $this->createArtifact(); | ||
| $this->writeComposerJsonFile( | ||
| [ | ||
| 'name' => 'package-versions/e2e-local', | ||
| 'require' => [ | ||
| 'test/package' => '2.0.0' | ||
| ], | ||
| 'repositories' => [ | ||
| [ | ||
| 'packagist' => false, | ||
| ], | ||
| [ | ||
| 'type' => 'artifact', | ||
| 'url' => $this->tempArtifact, | ||
| ] | ||
| ] | ||
| ], | ||
| $this->tempLocalComposerHome | ||
| ); | ||
|
|
||
| $this->execComposerInDir('update', $this->tempLocalComposerHome); | ||
| $this->assertFileNotExists( | ||
| $this->tempLocalComposerHome . '/vendor/ocramius/package-versions/src/PackageVersions/Versions.php' | ||
| ); | ||
| } | ||
|
|
||
| public function testRemovingPluginDoesNotAttemptToGenerateVersions() | ||
| { | ||
| $this->createPackageVersionsArtifact(); | ||
| $this->createArtifact(); | ||
|
|
||
| $this->writeComposerJsonFile( | ||
| [ | ||
| 'name' => 'package-versions/e2e-local', | ||
| 'require' => [ | ||
| 'test/package' => '2.0.0', | ||
| 'ocramius/package-versions' => '1.0.0' | ||
| ], | ||
| 'repositories' => [ | ||
| [ | ||
| 'packagist' => false, | ||
| ], | ||
| [ | ||
| 'type' => 'artifact', | ||
| 'url' => $this->tempArtifact, | ||
| ] | ||
| ] | ||
| ], | ||
| $this->tempLocalComposerHome | ||
| ); | ||
|
|
||
| $this->execComposerInDir('update', $this->tempLocalComposerHome); | ||
| $this->assertFileExists( | ||
| $this->tempLocalComposerHome . '/vendor/ocramius/package-versions/src/PackageVersions/Versions.php' | ||
| ); | ||
|
|
||
| $this->execComposerInDir('remove ocramius/package-versions', $this->tempLocalComposerHome); | ||
|
|
||
| $this->assertFileNotExists( | ||
| $this->tempLocalComposerHome . '/vendor/ocramius/package-versions/src/PackageVersions/Versions.php' | ||
| ); | ||
| } | ||
|
|
||
| private function createPackageVersionsArtifact() | ||
|
Owner
There was a problem hiding this comment. Should this return the path to the generated artifact?
Contributor
Author
There was a problem hiding this comment. I dont think so - the path to the zip isn't used for anything, just the folder where they reside |
||
| { | ||
| $zip = new ZipArchive(); | ||
|
|
||
| $zip->open($this->tempArtifact . '/ocramius-package-versions-1.0.0.zip', ZipArchive::CREATE); | ||
|
|
||
| $files = array_filter( | ||
| iterator_to_array(new RecursiveIteratorIterator( | ||
| new RecursiveCallbackFilterIterator( | ||
| new RecursiveDirectoryIterator(realpath(__DIR__ . '/../../'), RecursiveDirectoryIterator::SKIP_DOTS), | ||
| function (SplFileInfo $file, $key, RecursiveDirectoryIterator $iterator) { | ||
| return $iterator->getSubPathname()[0] !== '.' && $iterator->getSubPathname() !== 'vendor'; | ||
| } | ||
| ), | ||
| RecursiveIteratorIterator::LEAVES_ONLY | ||
| )), | ||
| function (SplFileInfo $file) { | ||
| return !$file->isDir(); | ||
| } | ||
| ); | ||
|
|
||
| array_walk( | ||
| $files, | ||
| function (SplFileInfo $file) use ($zip) { | ||
| if ($file->getFilename() === 'composer.json') { | ||
| $contents = json_decode(file_get_contents($file->getRealPath()), true); | ||
| $contents['version'] = '1.0.0'; | ||
|
|
||
| return $zip->addFromString('composer.json', json_encode($contents)); | ||
| } | ||
|
|
||
| $zip->addFile( | ||
| $file->getRealPath(), | ||
| substr($file->getRealPath(), strlen(realpath(__DIR__ . '/../../')) + 1) | ||
| ); | ||
| } | ||
| ); | ||
|
|
||
| $zip->close(); | ||
| } | ||
|
|
||
| private function createArtifact() | ||
| { | ||
| $zip = new ZipArchive(); | ||
|
|
||
| $zip->open($this->tempArtifact . '/test-package-2.0.0.zip', ZipArchive::CREATE); | ||
| $zip->addFromString( | ||
| 'composer.json', | ||
| json_encode( | ||
| [ | ||
| 'name' => 'test/package', | ||
| 'version' => '2.0.0' | ||
| ], | ||
| JSON_PRETTY_PRINT | ||
| ) | ||
| ); | ||
| $zip->close(); | ||
| } | ||
|
|
||
| private function writeComposerJsonFile(array $config, string $directory) | ||
| { | ||
| file_put_contents( | ||
| $directory . '/composer.json', | ||
| json_encode($config, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT) | ||
| ); | ||
| } | ||
|
|
||
| private function execComposerInDir(string $command, string $dir) : array | ||
| { | ||
| $currentDir = getcwd(); | ||
| chdir($dir); | ||
| exec(__DIR__ . '/../../vendor/bin/composer ' . $command . ' 2> /dev/null', $output, $exitCode); | ||
| $this->assertEquals(0, $exitCode); | ||
| chdir($currentDir); | ||
| return $output; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $directory | ||
| * | ||
| * @return void | ||
| */ | ||
| private function rmDir(string $directory) | ||
| { | ||
| if (! is_dir($directory)) { | ||
| unlink($directory); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| array_map( | ||
| function ($item) use ($directory) { | ||
| $this->rmDir($directory . '/' . $item); | ||
| }, | ||
| array_filter( | ||
| scandir($directory), | ||
| function (string $dirItem) { | ||
| return ! in_array($dirItem, ['.', '..'], true); | ||
| } | ||
| ) | ||
| ); | ||
|
|
||
| rmdir($directory); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AydinHassan just a doubt, given that there's no real way to know from the code: what about when the package is indirectly depending on
package-versions? Will it still run?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also: what about when we are currently operating in package-versions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Ocramius will run in both contexts as it would be in the lock file - is that expected?
The first is actually my use case - A globally installed tool depends on
PackageVersions.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AydinHassan great, thanks!