Skip to content

Make installation more robust #49

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make installation more robust #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
89 changes: 50 additions & 39 deletions src/PuliPluginImpl.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
use Composer\Composer;
use Composer\Config;
use Composer\IO\IOInterface;
use Composer\Json\JsonFile;
use Composer\Package\AliasPackage;
use Composer\Package\PackageInterface;
use Composer\Script\Event;
use Composer\Util\RemoteFilesystem;
use Exception;
use RuntimeException;
use Symfony\Component\Filesystem\Filesystem;
Expand Down Expand Up @@ -103,11 +105,6 @@ class PuliPluginImpl
*/
private $initialized = false;

/**
* @var string
*/
private $autoloadFile;

public function __construct(Event $event, PuliRunner $puliRunner = null)
{
$this->composer = $event->getComposer();
Expand All @@ -116,38 +113,19 @@ public function __construct(Event $event, PuliRunner $puliRunner = null)
$this->isDev = $event->isDevMode();
$this->puliRunner = $puliRunner;
$this->rootDir = Path::normalize(getcwd());

$vendorDir = $this->config->get('vendor-dir');

// On TravisCI, $vendorDir is a relative path. Probably an old Composer
// build or something. Usually, $vendorDir should be absolute already.
$vendorDir = Path::makeAbsolute($vendorDir, $this->rootDir);

$this->autoloadFile = $vendorDir.'/autoload.php';
}

public function preAutoloadDump()
{
if (!$this->initialized) {
$this->initialize();
}

// This method is called twice. Run it only once.
// This method is called multiple times. Run it only once.
if (!$this->runPreAutoloadDump) {
return;
}

$this->runPreAutoloadDump = false;

try {
$factoryClass = $this->getConfigKey('factory.in.class');
$factoryFile = $this->getConfigKey('factory.in.file');
} catch (PuliRunnerException $e) {
$this->printWarning('Could not load Puli configuration', $e);

return;
}

$factoryClass = $this->getConfigKeyFromJsonFile('factory.in.class');
$factoryFile = $this->getConfigKeyFromJsonFile('factory.in.file');
$factoryFile = Path::makeAbsolute($factoryFile, $this->rootDir);

$autoload = $this->composer->getPackage()->getAutoload();
Expand Down Expand Up @@ -178,7 +156,7 @@ public function postAutoloadDump()
$this->initialize();
}

// This method is called twice. Run it only once.
// This method is called multiple times. Run it only once.
if (!$this->runPostAutoloadDump) {
return;
}
Expand All @@ -193,8 +171,15 @@ public function postAutoloadDump()
return;
}

$this->insertFactoryClassConstant($this->autoloadFile, $factoryClass);
$this->setBootstrapFile($this->autoloadFile);
$vendorDir = $this->config->get('vendor-dir');

// On TravisCI, $vendorDir is a relative path. Probably an old Composer
// build or something. Usually, $vendorDir should be absolute already.
$vendorDir = Path::makeAbsolute($vendorDir, $this->rootDir);

$autoloadFile = $vendorDir.'/autoload.php';
$this->insertFactoryClassConstant($autoloadFile, $factoryClass);
$this->setBootstrapFile($autoloadFile);
}

/**
Expand All @@ -206,7 +191,7 @@ public function postInstall()
$this->initialize();
}

// This method is called twice. Run it only once.
// This method is called multiple times. Run it only once.
if (!$this->runPostInstall) {
return;
}
Expand Down Expand Up @@ -251,13 +236,6 @@ public function postInstall()

private function initialize()
{
if (!file_exists($this->autoloadFile)) {
$filesystem = new Filesystem();
// Avoid problems if using the runner before autoload.php has been
// generated
$filesystem->dumpFile($this->autoloadFile, '');
}

$this->initialized = true;

// Keep the manually set runner
Expand Down Expand Up @@ -518,7 +496,7 @@ private function setBootstrapFile($autoloadFile)
/**
* Loads Composer's currently installed packages.
*
* @return PackageInterface[] The installed packages indexed by their names.
* @return PackageInterface[] The installed packages indexed by their names
*/
private function loadComposerPackages()
{
Expand All @@ -533,6 +511,39 @@ private function loadComposerPackages()
return $packages;
}

private function getConfigKeyFromJsonFile($key)
{
$value = null;
$jsonPath = realpath(substr($this->config->get('vendor-dir'), 0, -strlen($this->config->get('vendor-dir', Config::RELATIVE_PATHS)))).DIRECTORY_SEPARATOR.'puli.json';
if (file_exists($jsonPath)) {
$jsonFile = new JsonFile($jsonPath, new RemoteFilesystem($this->io));
$config = $jsonFile->read();
if (empty($config['version']) || '1.0' !== $config['version']) {
throw new \RuntimeException('Invalid configuration version schema of puli.json file!');
}
}
switch ($key) {
case 'factory.in.file':
if (empty($config) || empty($config['config']['factory']['in']['file'])) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't the empty($config) implied by the right-hand-side of the condition?

$value = '.puli/GeneratedPuliFactory.php';
} else {
$value = $config['config']['factory']['in']['file'];
}
break;
case 'factory.in.class':
if (empty($config) || empty($config['config']['factory']['in']['class'])) {
$value = 'Puli\\GeneratedPuliFactory';
} else {
$value = $config['config']['factory']['in']['class'];
}
break;
default:
throw new \RuntimeException(sprintf('Cannot extract key "%s" from config!', $key));
}

return $value;
}

private function getConfigKey($key)
{
$value = trim($this->puliRunner->run('config %key% --parsed', array(
Expand Down
63 changes: 25 additions & 38 deletions tests/PuliPluginImplTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1717,36 +1717,27 @@ public function testDoNotRemovePuliDirIfParentOfRootDirectory()

public function testInsertFactoryClassIntoClassMap()
{
$this->puliRunner->expects($this->at(0))
->method('run')
->with('-V')
->willReturn('Puli version '.PuliPluginImpl::MIN_CLI_VERSION."\n");

$this->rootPackage->setAutoload(array('classmap' => array('src')));

$this->plugin->preAutoloadDump();

$this->assertSame(array('classmap' => array('src', $this->tempDir)), $this->rootPackage->getAutoload());
$this->assertSame(array('classmap' => array('src', $this->tempDir.'/.puli/GeneratedPuliFactory.php')), $this->rootPackage->getAutoload());
}

public function testCreatesStubFactoryClassWithNamespaceIfDoesNotExist()
{
$this->puliRunner->expects($this->at(0))
->method('run')
->with('-V')
->willReturn('Puli version '.PuliPluginImpl::MIN_CLI_VERSION."\n");
$this->puliRunner->expects($this->at(1))
->method('run')
->with('config %key% --parsed', array(
'key' => 'factory.in.class',
))
->willReturn("Puli\\MyFactory\n");
$this->puliRunner->expects($this->at(2))
->method('run')
->with('config %key% --parsed', array(
'key' => 'factory.in.file',
))
->willReturn(".puli/factory.class\n");
$jsonConfig = array(
'version' => '1.0',
'config' => array(
'factory' => array(
'in' => array(
'class' => 'Puli\\MyFactory',
'file' => '.puli/factory.class',
),
),
),
);
file_put_contents($this->tempDir.'/puli.json', json_encode($jsonConfig));

$this->plugin->preAutoloadDump();

Expand All @@ -1755,22 +1746,18 @@ public function testCreatesStubFactoryClassWithNamespaceIfDoesNotExist()

public function testCreatesStubFactoryClassWithoutNamespaceIfDoesNotExist()
{
$this->puliRunner->expects($this->at(0))
->method('run')
->with('-V')
->willReturn('Puli version '.PuliPluginImpl::MIN_CLI_VERSION."\n");
$this->puliRunner->expects($this->at(1))
->method('run')
->with('config %key% --parsed', array(
'key' => 'factory.in.class',
))
->willReturn("MyFactory\n");
$this->puliRunner->expects($this->at(2))
->method('run')
->with('config %key% --parsed', array(
'key' => 'factory.in.file',
))
->willReturn(".puli/factory.class\n");
$jsonConfig = array(
'version' => '1.0',
'config' => array(
'factory' => array(
'in' => array(
'class' => 'MyFactory',
'file' => '.puli/factory.class',
),
),
),
);
file_put_contents($this->tempDir.'/puli.json', json_encode($jsonConfig));

$this->plugin->preAutoloadDump();

Expand Down