Skip to content

Commit 139b831

Browse files
asgrimasgrim
authored
Merge pull request #115 from asgrim/support-sub-build-path
Added support for build-path php-ext configuration
2 parents 96ebe7b + 19a357d commit 139b831

15 files changed

+166
-9
lines changed

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"require": {
3030
"php": "8.1.*||8.2.*||8.3.*||8.4.*",
3131
"ext-zip": "*",
32-
"composer/composer": "^2.8.2",
32+
"composer/composer": "dev-main",
3333
"fidry/cpu-core-counter": "^1.2",
3434
"illuminate/container": "^10.47",
3535
"symfony/console": "^6.4",

‎composer.lock

+11-8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/extension-maintainers.md

+28
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,34 @@ If an end user does not specify a flag defined in the `configure-options`
132132
definition, it will simply not be passed to `./configure`. There is no way to
133133
specify a default value in the `configure-options` definition.
134134

135+
#### `build-path`
136+
137+
The `build-path` setting may be used if your source code is not in the root
138+
of your repository. For example, if your repository structure is like:
139+
140+
```
141+
/
142+
docs/
143+
src/
144+
config.m4
145+
config.w32
146+
myext.c
147+
...etc
148+
```
149+
150+
In this case, the actual extension source code would be built in `src/`, so you
151+
should specify this path in `build-path`, for example:
152+
153+
```json
154+
{
155+
"name": "myvendor/myext",
156+
"php-ext": {
157+
"extension-name": "myext",
158+
"build-path": "src"
159+
}
160+
}
161+
```
162+
135163
### Extension dependencies
136164

137165
Extension authors may define some dependencies in `require`, but practically,

‎src/DependencyResolver/Package.php

+6
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ public function __construct(
3636
public readonly array $configureOptions,
3737
public readonly bool $supportZts,
3838
public readonly bool $supportNts,
39+
public readonly string|null $buildPath,
3940
) {
4041
}
4142

@@ -58,6 +59,10 @@ public static function fromComposerCompletePackage(CompletePackageInterface $com
5859
? $phpExtOptions['support-nts']
5960
: true;
6061

62+
$buildPath = $phpExtOptions !== null && array_key_exists('build-path', $phpExtOptions)
63+
? $phpExtOptions['build-path']
64+
: null;
65+
6166
return new self(
6267
$completePackage,
6368
ExtensionType::tryFrom($completePackage->getType()) ?? ExtensionType::PhpModule,
@@ -68,6 +73,7 @@ public static function fromComposerCompletePackage(CompletePackageInterface $com
6873
$configureOptions,
6974
$supportZts,
7075
$supportNts,
76+
$buildPath,
7177
);
7278
}
7379

‎src/Downloading/DownloadedPackage.php

+13
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
use Php\Pie\DependencyResolver\Package;
88

9+
use function is_string;
10+
use function realpath;
11+
12+
use const DIRECTORY_SEPARATOR;
13+
914
/**
1015
* @internal This is not public API for PIE, so should not be depended upon unless you accept the risk of BC breaks
1116
*
@@ -21,6 +26,14 @@ private function __construct(
2126

2227
public static function fromPackageAndExtractedPath(Package $package, string $extractedSourcePath): self
2328
{
29+
if ($package->buildPath !== null) {
30+
$extractedSourcePathWithBuildPath = realpath($extractedSourcePath . DIRECTORY_SEPARATOR . $package->buildPath);
31+
32+
if (is_string($extractedSourcePathWithBuildPath)) {
33+
$extractedSourcePath = $extractedSourcePathWithBuildPath;
34+
}
35+
}
36+
2437
return new self($package, $extractedSourcePath);
2538
}
2639
}

‎test/integration/Building/UnixBuildTest.php

+57
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
use Symfony\Component\Console\Output\BufferedOutput;
2121
use Symfony\Component\Process\Process;
2222

23+
use function dirname;
24+
2325
#[CoversClass(UnixBuild::class)]
2426
final class UnixBuildTest extends TestCase
2527
{
@@ -44,6 +46,7 @@ public function testUnixBuildCanBuildExtension(): void
4446
[ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
4547
true,
4648
true,
49+
null,
4750
),
4851
self::TEST_EXTENSION_PATH,
4952
);
@@ -96,6 +99,7 @@ public function testUnixBuildWillThrowExceptionWhenExpectedBinaryNameMismatches(
9699
[ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
97100
true,
98101
true,
102+
null,
99103
),
100104
self::TEST_EXTENSION_PATH,
101105
);
@@ -116,4 +120,57 @@ public function testUnixBuildWillThrowExceptionWhenExpectedBinaryNameMismatches(
116120
(new Process(['phpize', '--clean'], $downloadedPackage->extractedSourcePath))->mustRun();
117121
}
118122
}
123+
124+
public function testUnixBuildCanBuildExtensionWithBuildPath(): void
125+
{
126+
if (Platform::isWindows()) {
127+
self::markTestSkipped('Unix build test cannot be run on Windows');
128+
}
129+
130+
$output = new BufferedOutput();
131+
132+
$downloadedPackage = DownloadedPackage::fromPackageAndExtractedPath(
133+
new Package(
134+
$this->createMock(CompletePackage::class),
135+
ExtensionType::PhpModule,
136+
ExtensionName::normaliseFromString('pie_test_ext'),
137+
'pie_test_ext',
138+
'0.1.0',
139+
null,
140+
[ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
141+
true,
142+
true,
143+
'pie_test_ext',
144+
),
145+
dirname(self::TEST_EXTENSION_PATH),
146+
);
147+
148+
$unixBuilder = new UnixBuild();
149+
$builtBinary = $unixBuilder->__invoke(
150+
$downloadedPackage,
151+
TargetPlatform::fromPhpBinaryPath(PhpBinaryPath::fromCurrentProcess(), null),
152+
['--enable-pie_test_ext'],
153+
$output,
154+
null,
155+
);
156+
157+
self::assertNotEmpty($builtBinary);
158+
159+
$outputString = $output->fetch();
160+
161+
self::assertStringContainsString('phpize complete.', $outputString);
162+
self::assertStringContainsString('Configure complete with options: --enable-pie_test_ext', $outputString);
163+
self::assertStringContainsString('Build complete:', $outputString);
164+
self::assertStringContainsString('pie_test_ext.so', $outputString);
165+
166+
self::assertSame(
167+
0,
168+
(new Process(['make', 'test'], $downloadedPackage->extractedSourcePath))
169+
->mustRun()
170+
->getExitCode(),
171+
);
172+
173+
(new Process(['make', 'clean'], $downloadedPackage->extractedSourcePath))->mustRun();
174+
(new Process(['phpize', '--clean'], $downloadedPackage->extractedSourcePath))->mustRun();
175+
}
119176
}

‎test/integration/Downloading/GithubPackageReleaseAssetsTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ public function testDeterminingReleaseAssetUrlForWindows(): void
5151
[],
5252
true,
5353
true,
54+
null,
5455
);
5556

5657
$io = $this->createMock(IOInterface::class);

‎test/integration/Installing/UnixInstallTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ public function testUnixInstallCanInstallExtension(string $phpConfig): void
9090
[ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
9191
true,
9292
true,
93+
null,
9394
),
9495
self::TEST_EXTENSION_PATH,
9596
);

‎test/integration/Installing/WindowsInstallTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ public function testWindowsInstallCanInstallExtension(): void
5353
[],
5454
true,
5555
true,
56+
null,
5657
),
5758
self::TEST_EXTENSION_PATH,
5859
);

‎test/unit/Command/CommandHelperTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ public function testProcessingConfigureOptionsFromInput(): void
109109
],
110110
true,
111111
true,
112+
null,
112113
);
113114
$inputDefinition = new InputDefinition();
114115
$inputDefinition->addOption(new InputOption('with-stuff', null, InputOption::VALUE_REQUIRED));

‎test/unit/DependencyResolver/PackageTest.php

+13
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ public function testFromComposerCompletePackage(): void
2626
self::assertSame('1.2.3', $package->version);
2727
self::assertSame('vendor/foo:1.2.3', $package->prettyNameAndVersion());
2828
self::assertNull($package->downloadUrl);
29+
self::assertNull($package->buildPath);
2930
}
3031

3132
public function testFromComposerCompletePackageWithExtensionName(): void
@@ -72,8 +73,20 @@ public function testGithubOrgAndRepo(string $composerPackageName, string|null $d
7273
[],
7374
true,
7475
true,
76+
null,
7577
);
7678

7779
self::assertSame($expectedGithubOrgAndRepo, $package->githubOrgAndRepository());
7880
}
81+
82+
public function testFromComposerCompletePackageWithBuildPath(): void
83+
{
84+
$composerCompletePackage = new CompletePackage('vendor/foo', '1.2.3.0', '1.2.3');
85+
$composerCompletePackage->setPhpExt(['build-path' => 'some/subdirectory/path/']);
86+
87+
$package = Package::fromComposerCompletePackage($composerCompletePackage);
88+
89+
self::assertSame('vendor/foo:1.2.3', $package->prettyNameAndVersion());
90+
self::assertSame('some/subdirectory/path/', $package->buildPath);
91+
}
7992
}

‎test/unit/Downloading/DownloadedPackageTest.php

+27
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@
1212
use PHPUnit\Framework\Attributes\CoversClass;
1313
use PHPUnit\Framework\TestCase;
1414

15+
use function realpath;
1516
use function uniqid;
1617

18+
use const DIRECTORY_SEPARATOR;
19+
1720
#[CoversClass(DownloadedPackage::class)]
1821
final class DownloadedPackageTest extends TestCase
1922
{
@@ -29,6 +32,7 @@ public function testFromPackageAndExtractedPath(): void
2932
[],
3033
true,
3134
true,
35+
null,
3236
);
3337

3438
$extractedSourcePath = uniqid('/path/to/downloaded/package', true);
@@ -38,4 +42,27 @@ public function testFromPackageAndExtractedPath(): void
3842
self::assertSame($extractedSourcePath, $downloadedPackage->extractedSourcePath);
3943
self::assertSame($package, $downloadedPackage->package);
4044
}
45+
46+
public function testFromPackageAndExtractedPathWithBuildPath(): void
47+
{
48+
$package = new Package(
49+
$this->createMock(CompletePackage::class),
50+
ExtensionType::PhpModule,
51+
ExtensionName::normaliseFromString('foo'),
52+
'foo/bar',
53+
'1.2.3',
54+
null,
55+
[],
56+
true,
57+
true,
58+
'Downloading',
59+
);
60+
61+
$extractedSourcePath = realpath(__DIR__ . '/../');
62+
63+
$downloadedPackage = DownloadedPackage::fromPackageAndExtractedPath($package, $extractedSourcePath);
64+
65+
self::assertSame($extractedSourcePath . DIRECTORY_SEPARATOR . 'Downloading', $downloadedPackage->extractedSourcePath);
66+
self::assertSame($package, $downloadedPackage->package);
67+
}
4168
}

‎test/unit/Downloading/Exception/CouldNotFindReleaseAssetTest.php

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ public function testForPackage(): void
3232
[],
3333
true,
3434
true,
35+
null,
3536
);
3637

3738
$exception = CouldNotFindReleaseAsset::forPackage($package, ['something.zip', 'something2.zip']);
@@ -51,6 +52,7 @@ public function testForPackageWithMissingTag(): void
5152
[],
5253
true,
5354
true,
55+
null,
5456
);
5557

5658
$exception = CouldNotFindReleaseAsset::forPackageWithMissingTag($package);

‎test/unit/Downloading/GithubPackageReleaseAssetsTest.php

+3
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ public function testUrlIsReturnedWhenFindingWindowsDownloadUrl(): void
7979
[],
8080
true,
8181
true,
82+
null,
8283
);
8384

8485
$releaseAssets = new GithubPackageReleaseAssets('https://test-github-api-base-url.thephp.foundation');
@@ -137,6 +138,7 @@ public function testUrlIsReturnedWhenFindingWindowsDownloadUrlWithCompilerAndThr
137138
[],
138139
true,
139140
true,
141+
null,
140142
);
141143

142144
$releaseAssets = new GithubPackageReleaseAssets('https://test-github-api-base-url.thephp.foundation');
@@ -176,6 +178,7 @@ public function testFindWindowsDownloadUrlForPackageThrowsExceptionWhenAssetNotF
176178
[],
177179
true,
178180
true,
181+
null,
179182
);
180183

181184
$releaseAssets = new GithubPackageReleaseAssets('https://test-github-api-base-url.thephp.foundation');

0 commit comments

Comments
 (0)