Skip to content

(feat) : Enhance UnixBuild with proper cleanup and improved test organization#130

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

Merged
asgrim merged 2 commits into from Nov 26, 2024
Merged

(feat) : Enhance UnixBuild with proper cleanup and improved test organization #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7577cd
enhance-unix-build-cleanup
Nov 23, 2024
eaabc96
Simplify UnixBuild to use phpize --clean, and use the PhpizePath VO
asgrim Nov 26, 2024
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
48 changes: 47 additions & 1 deletion src/Building/UnixBuild.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,18 @@ public function __invoke(
};
}

$phpizePath ??= PhpizePath::guessFrom($targetPlatform->phpBinaryPath);

/**
* Call a cleanup first; most of the time, we expect to be changing a
* version (e.g. upgrade, downgrade), in which case the source is
* already clean anyway; however, sometimes we want to rebuild the
* current ext, so this will perform a clean first
*/
$this->cleanup($phpizePath, $downloadedPackage, $output, $outputCallback);

$this->phpize(
$phpizePath ?? PhpizePath::guessFrom($targetPlatform->phpBinaryPath),
$phpizePath,
$downloadedPackage,
$output,
$outputCallback,
Expand DownExpand Up@@ -151,4 +161,40 @@ private function make(
$outputCallback,
);
}

/** @param callable(SymfonyProcess::ERR|SymfonyProcess::OUT, string): void|null $outputCallback */
private function cleanup(
PhpizePath $phpize,
DownloadedPackage $downloadedPackage,
OutputInterface $output,
callable|null $outputCallback,
): void {
/**
* A basic, but fallible check to see if we should clean first. This
* should work "most" of the time, unless someone has removed the
* configure script manually...
*/
if (! file_exists($downloadedPackage->extractedSourcePath . '/configure')) {
if ($output->isVerbose()) {
$output->writeln('<comment>Skipping phpize --clean, configure does not exist</comment>');
}

return;
}

$phpizeCleanCommand = [$phpize->phpizeBinaryPath, '--clean'];

if ($output->isVerbose()) {
$output->writeln('<comment>Running phpize --clean step using: ' . implode(' ', $phpizeCleanCommand) . '</comment>');
}

Process::run(
$phpizeCleanCommand,
$downloadedPackage->extractedSourcePath,
self::PHPIZE_TIMEOUT_SECS,
$outputCallback,
);

$output->writeln('<info>Build files cleaned up.</info>');
}
}
85 changes: 85 additions & 0 deletions test/integration/Building/UnixBuildTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Process\Process;

use function dirname;
Expand DownExpand Up@@ -173,4 +174,88 @@ public function testUnixBuildCanBuildExtensionWithBuildPath(): void
(new Process(['make', 'clean'], $downloadedPackage->extractedSourcePath))->mustRun();
(new Process(['phpize', '--clean'], $downloadedPackage->extractedSourcePath))->mustRun();
}

public function testCleanupDoesNotCleanWhenConfigureIsMissing(): void
{
if (Platform::isWindows()) {
self::markTestSkipped('Unix build test cannot be run on Windows');
}

(new Process(['phpize', '--clean'], self::TEST_EXTENSION_PATH))->mustRun();
self::assertFileDoesNotExist(self::TEST_EXTENSION_PATH . '/configure');

$output = new BufferedOutput();
$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);

$downloadedPackage = DownloadedPackage::fromPackageAndExtractedPath(
new Package(
$this->createMock(CompletePackage::class),
ExtensionType::PhpModule,
ExtensionName::normaliseFromString('pie_test_ext'),
'pie_test_ext',
'0.1.0',
null,
[],
true,
true,
null,
),
self::TEST_EXTENSION_PATH,
);

$unixBuilder = new UnixBuild();
$unixBuilder->__invoke(
$downloadedPackage,
TargetPlatform::fromPhpBinaryPath(PhpBinaryPath::fromCurrentProcess(), null),
['--enable-pie_test_ext'],
$output,
null,
);

$outputString = $output->fetch();
self::assertStringContainsString('Skipping phpize --clean, configure does not exist', $outputString);
self::assertStringNotContainsString('Build files cleaned up', $outputString);
}

public function testVerboseOutputShowsCleanupMessages(): void
{
if (Platform::isWindows()) {
self::markTestSkipped('Unix build test cannot be run on Windows');
}

(new Process(['phpize'], self::TEST_EXTENSION_PATH))->mustRun();
self::assertFileExists(self::TEST_EXTENSION_PATH . '/configure');

$output = new BufferedOutput();
$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);

$downloadedPackage = DownloadedPackage::fromPackageAndExtractedPath(
new Package(
$this->createMock(CompletePackage::class),
ExtensionType::PhpModule,
ExtensionName::normaliseFromString('pie_test_ext'),
'pie_test_ext',
'0.1.0',
null,
[ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
true,
true,
null,
),
self::TEST_EXTENSION_PATH,
);

$unixBuilder = new UnixBuild();
$unixBuilder->__invoke(
$downloadedPackage,
TargetPlatform::fromPhpBinaryPath(PhpBinaryPath::fromCurrentProcess(), null),
['--enable-pie_test_ext'],
$output,
null,
);

$outputString = $output->fetch();
self::assertStringContainsString('Running phpize --clean step', $outputString);
self::assertStringContainsString('Build files cleaned up', $outputString);
}
}