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

Multiple/Parallel PHP Version Support for Valet #1192

Merged
merged 11 commits into from
Mar 14, 2022
+935 −49
Merged

Multiple/Parallel PHP Version Support for Valet #1192

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
37b4af4
Multiple/Parallel PHP Version Support for Valet
NasirNobin Feb 6, 2022
acf190c
Apply suggestions from code review
NasirNobin Feb 14, 2022
c247dc9
Add Valet PHP isolation remover option & apply more suggestions from …
NasirNobin Feb 14, 2022
8de8d9b
Stop unused PHP versions
NasirNobin Feb 14, 2022
794e366
StyleCI Patch
NasirNobin Feb 14, 2022
5c10437
Apply refactor & cleanup from the code review
NasirNobin Feb 15, 2022
49ca4ae
Apply suggestions from code review
NasirNobin Feb 16, 2022
3c83367
Apply more suggestions from code review
NasirNobin Feb 16, 2022
cc41e3c
Update cli/Valet/PhpFpm.php
NasirNobin Feb 17, 2022
9a5d30b
Tests for Parallel PHP Version Support
NasirNobin Feb 18, 2022
7a80a2e
Apply suggestions from code review
NasirNobin Feb 19, 2022
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
12 changes: 9 additions & 3 deletions cli/Valet/PhpFpm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,12 @@ public function useVersion($version, $force = false, $directory = null)
$site = $this->site->getSiteUrl($directory);

if (! $site) {
warning(sprintf("The [%s] site could not be found in Valet's site list.", $directory));
return;
throw new DomainException(
sprintf(
"The [%s] site could not be found in Valet's site list.",
$directory
)
);
}

if ($version == 'default') { // Remove isolation for this site
Expand All @@ -233,6 +237,7 @@ public function useVersion($version, $force = false, $directory = null)
$this->stopIfUnused($oldCustomPhpVersion);
$this->nginx->restart();
info(sprintf('The site [%s] is now using the default PHP version.', $site));

return;
}
}
Expand Down Expand Up @@ -263,6 +268,7 @@ public function useVersion($version, $force = false, $directory = null)
$this->restart($version);
$this->nginx->restart();
info(sprintf('The site [%s] is now using %s.', $site, $version));

return;
}

Expand Down Expand Up @@ -424,6 +430,6 @@ public function utilizedPhpVersions()
return $this->normalizePhpVersion($phpVersion); // Example output php@7.4
}
}
})->merge([$this->brew->getLinkedPhpFormula()])->filter()->unique()->toArray();
})->merge([$this->brew->getLinkedPhpFormula()])->filter()->unique()->values()->toArray();
}
}
285 changes: 281 additions & 4 deletions tests/PhpFpmTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,186 @@ public function test_fpm_is_configured_with_the_correct_user_group_and_port()
$this->assertStringContainsString(sprintf("\nuser = %s", user()), $contents);
$this->assertStringContainsString("\ngroup = staff", $contents);
$this->assertStringContainsString("\nlisten = ".VALET_HOME_PATH.'/valet.sock', $contents);

// Passing speicifc version will change the .sock file
resolve(StubForUpdatingFpmConfigFiles::class)->updateConfiguration('php@7.2');
$contents = file_get_contents(__DIR__.'/output/fpm.conf');
$this->assertStringContainsString(sprintf("\nuser = %s", user()), $contents);
$this->assertStringContainsString("\ngroup = staff", $contents);
$this->assertStringContainsString("\nlisten = ".VALET_HOME_PATH.'/valet72.sock', $contents);
}

public function test_it_can_generate_sock_file_name_from_php_version()
{
$this->assertEquals('valet72.sock', resolve(PhpFpm::class)->fpmSockName('php@7.2'));
$this->assertEquals('valet72.sock', resolve(PhpFpm::class)->fpmSockName('php@72'));
$this->assertEquals('valet72.sock', resolve(PhpFpm::class)->fpmSockName('php72'));
$this->assertEquals('valet72.sock', resolve(PhpFpm::class)->fpmSockName('72'));
}

public function test_utilized_php_versions()
{
$fileSystemMock = Mockery::mock(Filesystem::class);
$brewMock = Mockery::mock(Brew::class);

$phpFpmMock = Mockery::mock(PhpFpm::class, [
$brewMock,
Mockery::mock(CommandLine::class),
$fileSystemMock,
resolve(Configuration::class),
Mockery::mock(Site::class),
Mockery::mock(Nginx::class),
])->makePartial();

swap(PhpFpm::class, $phpFpmMock);

$brewMock->shouldReceive('supportedPhpVersions')->andReturn(collect([
'php@7.1',
'php@7.2',
'php@7.3',
'php@7.4',
]));

$brewMock->shouldReceive('getLinkedPhpFormula')->andReturn('php@7.3');

$fileSystemMock->shouldReceive('scandir')
->once()
->with(VALET_HOME_PATH.'/Nginx')
->andReturn(['.gitkeep', 'isolated-site-71.test', 'isolated-site-72.test', 'isolated-site-73.test']);

$fileSystemMock->shouldNotReceive('get')->with(VALET_HOME_PATH.'/Nginx/.gitkeep');

$sites = [
[
'site' => 'isolated-site-71.test',
'conf' => '# Valet isolated PHP version : 71'.PHP_EOL.'valet71.sock',
],
[
'site' => 'isolated-site-72.test',
'conf' => '# Valet isolated PHP version : php@7.2'.PHP_EOL.'valet72.sock',
],
[
'site' => 'isolated-site-73.test',
'conf' => '# Valet isolated PHP version : 73'.PHP_EOL.'valet.sock',
],
];

foreach ($sites as $site) {
$fileSystemMock->shouldReceive('get')->once()->with(VALET_HOME_PATH.'/Nginx/'.$site['site'])->andReturn($site['conf']);
}

$this->assertEquals(['php@7.1', 'php@7.2', 'php@7.3'], resolve(PhpFpm::class)->utilizedPhpVersions());
}

public function test_global_php_version_update_will_swap_socks()
{
$fileSystemMock = Mockery::mock(Filesystem::class);

$phpFpmMock = Mockery::mock(PhpFpm::class, [
Mockery::mock(Brew::class),
Mockery::mock(CommandLine::class),
$fileSystemMock,
resolve(Configuration::class),
Mockery::mock(Site::class),
Mockery::mock(Nginx::class),
])->makePartial();

swap(PhpFpm::class, $phpFpmMock);

$fileSystemMock->shouldReceive('scandir')
->once()
->with(VALET_HOME_PATH.'/Nginx')
->andReturn([
'.gitkeep',
'isolated-site-71.test',
'isolated-site-72.test',
'isolated-site-73.test',
'non-isolated-site.test',
]);

// Skip dotfiles
$fileSystemMock->shouldNotReceive('get')->with(VALET_HOME_PATH.'/Nginx/.gitkeep');

// Any isolated site running on php72 would be replaced with default valet.sock,
// as 72 will be the default version after the global PHP version switch
$fileSystemMock->shouldReceive('get')
->once()
->with(VALET_HOME_PATH.'/Nginx/isolated-site-72.test')
->andReturn('# Valet isolated PHP version : 72'.PHP_EOL.'server { fastcgi_pass: valet72.sock }');

$fileSystemMock->shouldReceive('put')->once()->withArgs([
VALET_HOME_PATH.'/Nginx/isolated-site-72.test',
'# Valet isolated PHP version : 72'.PHP_EOL.'server { fastcgi_pass: valet.sock }',
]);

// Any isolated site running on current PHP version (with valet.sock),
// should be still be running on the same version after the global version update
$fileSystemMock->shouldReceive('get')
->once()
->with(VALET_HOME_PATH.'/Nginx/isolated-site-71.test')
->andReturn('# Valet isolated PHP version : 71'.PHP_EOL.'server { fastcgi_pass: valet.sock }');

$fileSystemMock->shouldReceive('put')->once()->withArgs([
VALET_HOME_PATH.'/Nginx/isolated-site-71.test',
'# Valet isolated PHP version : 71'.PHP_EOL.'server { fastcgi_pass: valet71.sock }',
]);

// PHP 7.3 sites won't be affected here
$fileSystemMock->shouldReceive('get')
->once()
->with(VALET_HOME_PATH.'/Nginx/isolated-site-73.test')
->andReturn('# Valet isolated PHP version : 73'.PHP_EOL.'server { fastcgi_pass: valet73.sock }');

$fileSystemMock->shouldNotReceive('put')->withArgs([
VALET_HOME_PATH.'/Nginx/isolated-site-73.test',
Mockery::any(),
]);

// Nginx config that doesn't have the isolation header, It would not swap .sock files
$fileSystemMock->shouldReceive('get')->once()->with(VALET_HOME_PATH.'/Nginx/non-isolated-site.test')->andReturn('valet.sock');
$fileSystemMock->shouldNotReceive('put')->withArgs([
VALET_HOME_PATH.'/Nginx/non-isolated-site.test',
'valet71.sock',
]);

// Switching from php7.1 to php7.2
resolve(PhpFpm::class)->updateConfigurationForGlobalUpdate('php@7.2', 'php@7.1');
}

public function test_stop_unused_php_versions()
{
$brewMock = Mockery::mock(Brew::class);

$phpFpmMock = Mockery::mock(PhpFpm::class, [
$brewMock,
Mockery::mock(CommandLine::class),
Mockery::mock(Filesystem::class),
resolve(Configuration::class),
Mockery::mock(Site::class),
Mockery::mock(Nginx::class),
])->makePartial();

swap(PhpFpm::class, $phpFpmMock);

$phpFpmMock->shouldReceive('utilizedPhpVersions')->andReturn([
'php@7.1',
'php@7.2',
]);

// Would do nothing
resolve(PhpFpm::class)->stopIfUnused(null);

// Currently, not utilizeing this PHP version, should be stopped
$brewMock->shouldReceive('stopService')->times(3)->with('php@7.3');
resolve(PhpFpm::class)->stopIfUnused('73');
resolve(PhpFpm::class)->stopIfUnused('php73');
resolve(PhpFpm::class)->stopIfUnused('php@7.3');

// Utilizeing PHP Versions, should not receive stop command
$brewMock->shouldNotReceive('stopService')->with('php@7.1');
$brewMock->shouldNotReceive('stopService')->with('php@7.2');
resolve(PhpFpm::class)->stopIfUnused('php@7.1');
resolve(PhpFpm::class)->stopIfUnused('php@7.2');
}

public function test_stopRunning_will_pass_filtered_result_of_getRunningServices_to_stopService()
Expand Down Expand Up @@ -122,24 +302,32 @@ public function test_use_version_if_already_linked_php_will_unlink_before_instal
$brewMock = Mockery::mock(Brew::class);
$nginxMock = Mockery::mock(Nginx::class);
$siteMock = Mockery::mock(Site::class);
$cliMock = Mockery::mock(CommandLine::class);
$fileSystemMock = Mockery::mock(Filesystem::class);

$phpFpmMock = Mockery::mock(PhpFpm::class, [
$brewMock,
resolve(CommandLine::class),
resolve(Filesystem::class),
$cliMock,
$fileSystemMock,
resolve(Configuration::class),
$siteMock,
$nginxMock,
])->makePartial();

$phpFpmMock->shouldReceive('install');
$phpFpmMock->shouldReceive('updateConfigurationForGlobalUpdate');
$cliMock->shouldReceive('quietly')->with('sudo rm '.VALET_HOME_PATH.'/valet*.sock')->once();
$fileSystemMock->shouldReceive('unlink')->with(VALET_HOME_PATH.'/valet.sock')->once();

$phpFpmMock->shouldReceive('updateConfiguration')->with('php@7.1')->once();
$phpFpmMock->shouldReceive('updateConfigurationForGlobalUpdate')->withArgs(['php@7.2', 'php@7.1'])->once();

$brewMock->shouldReceive('supportedPhpVersions')->andReturn(collect([
'php@7.2',
'php@5.6',
]));

$brewMock->shouldReceive('hasLinkedPhp')->andReturn(true);
$brewMock->shouldReceive('linkedPhp')->andReturn('php@7.1');
$brewMock->shouldReceive('getLinkedPhpFormula')->andReturn('php@7.1');
$brewMock->shouldReceive('unlink')->with('php@7.1');
$brewMock->shouldReceive('ensureInstalled')->with('php@7.2', [], $phpFpmMock->taps);
Expand All @@ -152,9 +340,98 @@ public function test_use_version_if_already_linked_php_will_unlink_before_instal

$nginxMock->shouldReceive('restart');

// Test both non prefixed and prefixed
$this->assertSame('php@7.2', $phpFpmMock->useVersion('php@7.2'));
}

public function test_use_version_with_site_paramter_will_isolate_a_site()
{
$brewMock = Mockery::mock(Brew::class);
$nginxMock = Mockery::mock(Nginx::class);
$siteMock = Mockery::mock(Site::class);

$phpFpmMock = Mockery::mock(PhpFpm::class, [
$brewMock,
resolve(CommandLine::class),
resolve(Filesystem::class),
resolve(Configuration::class),
$siteMock,
$nginxMock,
])->makePartial();

$brewMock->shouldReceive('supportedPhpVersions')->andReturn(collect([
'php@7.2',
'php@5.6',
]));

$brewMock->shouldReceive('ensureInstalled')->with('php@7.2', [], $phpFpmMock->taps);
$brewMock->shouldReceive('installed')->with('php@7.2');
$brewMock->shouldReceive('determineAliasedVersion')->with('php@7.2')->andReturn('php@7.2');
$brewMock->shouldReceive('linkedPhp')->once();

$siteMock->shouldReceive('getSiteUrl')->with('test')->andReturn('test.test');
$siteMock->shouldReceive('installSiteConfig')->withArgs(['test.test', 'valet72.sock', 'php@7.2']);
$siteMock->shouldReceive('customPhpVersion')->with('test.test')->andReturn('72');

$phpFpmMock->shouldReceive('stopIfUnused')->with('72')->once();
$phpFpmMock->shouldReceive('updateConfiguration')->with('php@7.2')->once();
$phpFpmMock->shouldReceive('restart')->with('php@7.2')->once();

$nginxMock->shouldReceive('restart');

// These should only run when doing global PHP switches
$brewMock->shouldNotReceive('stopService');
$brewMock->shouldNotReceive('link');
$brewMock->shouldNotReceive('unlink');
$phpFpmMock->shouldNotReceive('stopRunning');
$phpFpmMock->shouldNotReceive('install');
$phpFpmMock->shouldNotReceive('updateConfigurationForGlobalUpdate');

$this->assertSame(null, $phpFpmMock->useVersion('php@7.2', false, 'test'));
}

public function test_use_version_can_remove_isolation_for_a_site()
{
$nginxMock = Mockery::mock(Nginx::class);
$siteMock = Mockery::mock(Site::class);

$phpFpmMock = Mockery::mock(PhpFpm::class, [
Mockery::mock(Brew::class),
resolve(CommandLine::class),
resolve(Filesystem::class),
resolve(Configuration::class),
$siteMock,
$nginxMock,
])->makePartial();

$siteMock->shouldReceive('getSiteUrl')->with('test')->andReturn('test.test');
$siteMock->shouldReceive('customPhpVersion')->with('test.test')->andReturn('74');
$siteMock->shouldReceive('removeIsolation')->with('test.test')->once();
$phpFpmMock->shouldReceive('stopIfUnused')->with('74');
$nginxMock->shouldReceive('restart');

$this->assertSame(null, $phpFpmMock->useVersion('default', false, 'test'));
}

public function test_use_version_will_throw_if_site_is_not_parked_or_linked()
{
$siteMock = Mockery::mock(Site::class);

$phpFpmMock = Mockery::mock(PhpFpm::class, [
Mockery::mock(Brew::class),
resolve(CommandLine::class),
resolve(Filesystem::class),
resolve(Configuration::class),
$siteMock,
Mockery::mock(Nginx::class),
])->makePartial();

$this->expectException(DomainException::class);
$this->expectExceptionMessage("The [test] site could not be found in Valet's site list.");

$siteMock->shouldReceive('getSiteUrl');

$this->assertSame(null, $phpFpmMock->useVersion('default', false, 'test'));
}
}

class StubForUpdatingFpmConfigFiles extends PhpFpm
Expand Down
Loading