Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#41 Avoid issues when the package is scheduled for removal #46

Merged
merged 5 commits into from
Sep 6, 2017
Merged

#41 Avoid issues when the package is scheduled for removal #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
825042b
Avoid issues when the package is scheduled for removal (fixes #41)
Jean85 Sep 4, 2017
57f1713
Refactor to avoid using a dedicated exception in private methods
Jean85 Sep 5, 2017
d163a6f
Add integration test to Travis build for #41
Jean85 Sep 5, 2017
f1da66f
Revert wrongly committed change to Versions
Jean85 Sep 5, 2017
6e4fb4f
Use E2E test to write regression test
Jean85 Sep 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions src/PackageVersions/Installer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,7 @@ public static function dumpVersionsClass(Event $composerEvent)
return;
}

$io = $composerEvent->getIO();
$io->write('<info>ocramius/package-versions:</info> Generating version class...');

self::writeVersionClassToFile(
self::generateVersionsClass($versions),
$composer->getConfig(),
$composer->getPackage()
);

$io->write('<info>ocramius/package-versions:</info> ...done generating version class');
self::writeVersionClassToFile(self::generateVersionsClass($versions), $composer, $composerEvent->getIO());
}

private static function generateVersionsClass(array $versions) : string
Expand All @@ -111,24 +102,31 @@ private static function generateVersionsClass(array $versions) : string
}

/**
* @param string $versionClassSource
* @param Config $composerConfig
* @param RootPackageInterface $rootPackage
* @param string $versionClassSource
* @param Composer $composer
* @param IOInterface $io
*
* @return void
*
* @throws \RuntimeException
*/
private static function writeVersionClassToFile(
string $versionClassSource,
Config $composerConfig,
RootPackageInterface $rootPackage
) {
$installPath = self::locateRootPackageInstallPath($composerConfig, $rootPackage)
private static function writeVersionClassToFile(string $versionClassSource, Composer $composer, IOInterface $io)
{
$installPath = self::locateRootPackageInstallPath($composer->getConfig(), $composer->getPackage())
. '/src/PackageVersions/Versions.php';

if (! file_exists(dirname($installPath))) {
$io->write('<info>ocramius/package-versions:</info> Package not found (probably scheduled for removal); generation of version class skipped.');

return;
}

$io->write('<info>ocramius/package-versions:</info> Generating version class...');

file_put_contents($installPath, $versionClassSource);
chmod($installPath, 0664);

$io->write('<info>ocramius/package-versions:</info> ...done generating version class');
}

/**
Expand Down
36 changes: 36 additions & 0 deletions test/PackageVersionsTest/E2EInstallerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,42 @@ public function testRemovingPluginDoesNotAttemptToGenerateVersions()
);
}

public function testRemovingPluginWithNoDevDoesNotAttemptToGenerateVersions()
{
$this->createPackageVersionsArtifact();
$this->createArtifact();

$this->writeComposerJsonFile(
[
'name' => 'package-versions/e2e-local',
'require-dev' => [
'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('install --no-dev', $this->tempLocalComposerHome);

$this->assertFileNotExists(
$this->tempLocalComposerHome . '/vendor/ocramius/package-versions/src/PackageVersions/Versions.php'
);
}

private function createPackageVersionsArtifact()
{
$zip = new ZipArchive();
Expand Down
37 changes: 37 additions & 0 deletions test/PackageVersionsTest/InstallerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,6 +583,43 @@ public function testVersionsAreNotDumpedIfPackageVersionsNotExplicitlyRequired()
$this->rmDir($vendorDir);
}

public function testVersionsAreNotDumpedIfPackageIsScheduledForRemoval()
{
$config = $this->getMockBuilder(Config::class)->disableOriginalConstructor()->getMock();
$locker = $this->getMockBuilder(Locker::class)->disableOriginalConstructor()->getMock();
$package = $this->createMock(RootPackageInterface::class);

$vendorDir = sys_get_temp_dir() . '/' . uniqid('InstallerTest', true);
$expectedPath = $vendorDir . '/ocramius/package-versions/src/PackageVersions';

$locker
->expects(self::any())
->method('getLockData')
->willReturn([
'packages' => [
[
'name' => 'ocramius/package-versions',
'version' => '1.0.0',
]
],
]);

$this->composer->expects(self::any())->method('getConfig')->willReturn($config);
$this->composer->expects(self::any())->method('getLocker')->willReturn($locker);
$this->composer->expects(self::any())->method('getPackage')->willReturn($package);

$config->expects(self::any())->method('get')->with('vendor-dir')->willReturn($vendorDir);

Installer::dumpVersionsClass(new Event(
'post-install-cmd',
$this->composer,
$this->io
));

self::assertFileNotExists($expectedPath . '/Versions.php');
self::assertFileNotExists($expectedPath . '/Versions.php');
}

public function testGeneratedVersionFileAccessRights()
{
if (0 === strpos(\PHP_OS, 'WIN')) {
Expand Down