Add support for os-families in extensions composer.json

src/Command/BuildCommand.php

@@ -60,6 +60,8 @@ public function execute(InputInterface $input, OutputInterface $output): int
         $package = ($this->dependencyResolver)($composer, $targetPlatform, $requestedNameAndVersion);
         $output->writeln(sprintf('<info>Found package:</info> %s which provides <info>%s</info>', $package->prettyNameAndVersion(), $package->extensionName->nameWithExtPrefix()));
 
+        CommandHelper::ensureOsFamilyCompatibilityFromPackage($package);
+
         // Now we know what package we have, we can validate the configure options for the command and re-create the
         // Composer instance with the populated configure options
         CommandHelper::bindConfigureOptionsFromPackage($this, $package, $input);

src/Command/CommandHelper.php

@@ -21,13 +21,15 @@
 use Webmozart\Assert\Assert;
 
 use function array_key_exists;
+use function in_array;
 use function is_array;
 use function is_string;
 use function reset;
 use function sprintf;
 use function strtolower;
 use function trim;
 
+use const PHP_OS_FAMILY;
 use const PHP_VERSION;
 
 /** @internal This is not public API for PIE, so should not be depended upon unless you accept the risk of BC breaks */
@@ -210,6 +212,21 @@ public static function bindConfigureOptionsFromPackage(Command $command, Package
         self::validateInput($input, $command);
     }
 
+    public static function ensureOsFamilyCompatibilityFromPackage(Package $package): void
+    {
+        if ($package->osFamilies === [] || in_array('*', $package->osFamilies, true)) {
+            return;
+        }
+
+        if (! in_array(PHP_OS_FAMILY, $package->osFamilies, true)) {
+            throw new InvalidArgumentException(sprintf(
+                'The package "%s" is not compatible with the "%s" operating system family',
+                $package->prettyNameAndVersion(),
+                PHP_OS_FAMILY,
+            ));
+        }
+    }
+
     /** @return list<non-empty-string> */
     public static function processConfigureOptionsFromInput(Package $package, InputInterface $input): array
     {

src/Command/InstallCommand.php

@@ -65,6 +65,8 @@ public function execute(InputInterface $input, OutputInterface $output): int
         $package = ($this->dependencyResolver)($composer, $targetPlatform, $requestedNameAndVersion);
         $output->writeln(sprintf('<info>Found package:</info> %s which provides <info>%s</info>', $package->prettyNameAndVersion(), $package->extensionName->nameWithExtPrefix()));
 
+        CommandHelper::ensureOsFamilyCompatibilityFromPackage($package);
+
         // Now we know what package we have, we can validate the configure options for the command and re-create the
         // Composer instance with the populated configure options
         CommandHelper::bindConfigureOptionsFromPackage($this, $package, $input);

src/DependencyResolver/Package.php

@@ -14,6 +14,7 @@
 use function array_slice;
 use function explode;
 use function implode;
+use function is_string;
 use function parse_url;
 use function str_contains;
 use function str_starts_with;
@@ -25,7 +26,10 @@
  */
 final class Package
 {
-    /** @param list<ConfigureOption> $configureOptions */
+    /**
+     * @param list<ConfigureOption> $configureOptions
+     * @param list<string>          $osFamilies
+     */
     public function __construct(
         public readonly CompletePackageInterface $composerPackage,
         public readonly ExtensionType $extensionType,
@@ -36,6 +40,7 @@ public function __construct(
         public readonly array $configureOptions,
         public readonly bool $supportZts,
         public readonly bool $supportNts,
+        public readonly array $osFamilies,
     ) {
     }
 
@@ -58,6 +63,17 @@ public static function fromComposerCompletePackage(CompletePackageInterface $com
             ? $phpExtOptions['support-nts']
             : true;
 
+        /** @var list<string>|string $osFamilies */
+        $osFamilies = $phpExtOptions !== null && array_key_exists('os-families', $phpExtOptions)
+            ? $phpExtOptions['os-families']
+            : [];
+
+        if (is_string($osFamilies)) {
+            $osFamilies = [$osFamilies];
+        }
+
+        $osFamilies = array_map('strtolower', $osFamilies);
+
         return new self(
             $completePackage,
             ExtensionType::tryFrom($completePackage->getType()) ?? ExtensionType::PhpModule,
@@ -68,6 +84,7 @@ public static function fromComposerCompletePackage(CompletePackageInterface $com
             $configureOptions,
             $supportZts,
             $supportNts,
+            $osFamilies,
         );
     }
 

test/integration/Building/UnixBuildTest.php

@@ -44,6 +44,7 @@ public function testUnixBuildCanBuildExtension(): void
                 [ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
                 true,
                 true,
+                [],
             ),
             self::TEST_EXTENSION_PATH,
         );
@@ -96,6 +97,7 @@ public function testUnixBuildWillThrowExceptionWhenExpectedBinaryNameMismatches(
                 [ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
                 true,
                 true,
+                [],
             ),
             self::TEST_EXTENSION_PATH,
         );

test/integration/Downloading/GithubPackageReleaseAssetsTest.php

@@ -51,6 +51,7 @@ public function testDeterminingReleaseAssetUrlForWindows(): void
             [],
             true,
             true,
+            [],
         );
 
         $io     = $this->createMock(IOInterface::class);

test/integration/Installing/UnixInstallTest.php

@@ -90,6 +90,7 @@ public function testUnixInstallCanInstallExtension(string $phpConfig): void
                 [ConfigureOption::fromComposerJsonDefinition(['name' => 'enable-pie_test_ext'])],
                 true,
                 true,
+                [],
             ),
             self::TEST_EXTENSION_PATH,
         );

test/integration/Installing/WindowsInstallTest.php

@@ -53,6 +53,7 @@ public function testWindowsInstallCanInstallExtension(): void
                 [],
                 true,
                 true,
+                [],
             ),
             self::TEST_EXTENSION_PATH,
         );

test/unit/Command/CommandHelperTest.php

@@ -6,6 +6,7 @@
 
 use Composer\Package\CompletePackage;
 use Composer\Util\Platform;
+use Generator;
 use InvalidArgumentException;
 use Php\Pie\Command\CommandHelper;
 use Php\Pie\ConfigureOption;
@@ -27,6 +28,8 @@
 use function array_combine;
 use function array_map;
 
+use const PHP_OS_FAMILY;
+
 #[CoversClass(CommandHelper::class)]
 final class CommandHelperTest extends TestCase
 {
@@ -109,6 +112,7 @@ public function testProcessingConfigureOptionsFromInput(): void
             ],
             true,
             true,
+            [],
         );
         $inputDefinition = new InputDefinition();
         $inputDefinition->addOption(new InputOption('with-stuff', null, InputOption::VALUE_REQUIRED));
@@ -171,4 +175,69 @@ public function testWindowsMachinesCannotUseWithPhpizePathOption(): void
         $this->expectExceptionMessage('The --with-phpize-path=/path/to/phpize cannot be used on Windows.');
         CommandHelper::determineTargetPlatformFromInputs($input, $output);
     }
+
+    /** @param list<string> $allowedOsFamilies */
+    #[DataProvider('provideOsFamilies')]
+    public function testEnsureOsFamilyCompatibilityFromPackage(array $allowedOsFamilies): void
+    {
+        CommandHelper::ensureOsFamilyCompatibilityFromPackage($this->createCompletePackage($allowedOsFamilies));
+
+        self::expectNotToPerformAssertions();
+    }
+
+    /** @return Generator<int, list<list{0?: string}>, mixed, void> */
+    public static function provideOsFamilies(): Generator
+    {
+        yield [[PHP_OS_FAMILY]];
+
+        yield [[]];
+
+        yield [['*']];
+
+        yield [['Solaris', '*']];
+    }
+
+    #[RequiresOperatingSystemFamily('Windows')]
+    public function testEnsureOsFamilyCompatibilityFromPackageOnWindowsThrows(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('The package "foo/bar" is not compatible with the "Windows" operating system family');
+
+        CommandHelper::ensureOsFamilyCompatibilityFromPackage($this->createCompletePackage(['Linux']));
+    }
+
+    #[RequiresOperatingSystemFamily('Darwin')]
+    public function testEnsureOsFamilyCompatibilityFromPackageOnDarwinThrows(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('The package "foo/bar:1.0.0" is not compatible with the "Darwin" operating system family');
+
+        CommandHelper::ensureOsFamilyCompatibilityFromPackage($this->createCompletePackage(['Windows']));
+    }
+
+    #[RequiresOperatingSystemFamily('Linux')]
+    public function testEnsureOsFamilyCompatibilityFromPackageOnLinuxThrows(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('The package "foo/bar:1.0.0" is not compatible with the "Linux" operating system family');
+
+        CommandHelper::ensureOsFamilyCompatibilityFromPackage($this->createCompletePackage(['Windows', 'Darwin']));
+    }
+
+    /** @param list<string> $allowedOsFamilies */
+    private function createCompletePackage(array $allowedOsFamilies): Package
+    {
+        return new Package(
+            new CompletePackage('foo/bar', '1.0.0.0', '1.0.0'),
+            ExtensionType::PhpModule,
+            ExtensionName::normaliseFromString('ext-foo'),
+            'foo/bar',
+            '1.0.0',
+            null,
+            [],
+            true,
+            true,
+            $allowedOsFamilies,
+        );
+    }
 }

test/unit/DependencyResolver/PackageTest.php

@@ -42,6 +42,34 @@ public function testFromComposerCompletePackageWithExtensionName(): void
         self::assertNull($package->downloadUrl);
     }
 
+    public function testFromComposerCompletePackageWithOsFamilies(): void
+    {
+        $composerCompletePackage = new CompletePackage('vendor/foo', '1.2.3.0', '1.2.3');
+        $composerCompletePackage->setPhpExt(['os-families' => ['WINDOWS', 'Darwin']]);
+
+        $package = Package::fromComposerCompletePackage($composerCompletePackage);
+
+        self::assertSame(['windows', 'darwin'], $package->osFamilies);
+        self::assertSame('vendor/foo', $package->name);
+        self::assertSame('1.2.3', $package->version);
+        self::assertSame('vendor/foo:1.2.3', $package->prettyNameAndVersion());
+        self::assertNull($package->downloadUrl);
+    }
+
+    public function testFromComposerCompletePackageWithOsFamiliesWildcard(): void
+    {
+        $composerCompletePackage = new CompletePackage('vendor/foo', '1.2.3.0', '1.2.3');
+        $composerCompletePackage->setPhpExt(['os-families' => ['*']]);
+
+        $package = Package::fromComposerCompletePackage($composerCompletePackage);
+
+        self::assertSame(['*'], $package->osFamilies);
+        self::assertSame('vendor/foo', $package->name);
+        self::assertSame('1.2.3', $package->version);
+        self::assertSame('vendor/foo:1.2.3', $package->prettyNameAndVersion());
+        self::assertNull($package->downloadUrl);
+    }
+
     /**
      * @return array<string, array{0: string, 1: string|null, 2: string}>
      *
@@ -72,6 +100,7 @@ public function testGithubOrgAndRepo(string $composerPackageName, string|null $d
             [],
             true,
             true,
+            [],
         );
 
         self::assertSame($expectedGithubOrgAndRepo, $package->githubOrgAndRepository());

test/unit/Downloading/DownloadedPackageTest.php

@@ -29,6 +29,7 @@ public function testFromPackageAndExtractedPath(): void
             [],
             true,
             true,
+            [],
         );
 
         $extractedSourcePath = uniqid('/path/to/downloaded/package', true);

test/unit/Downloading/Exception/CouldNotFindReleaseAssetTest.php

@@ -32,6 +32,7 @@ public function testForPackage(): void
             [],
             true,
             true,
+            [],
         );
 
         $exception = CouldNotFindReleaseAsset::forPackage($package, ['something.zip', 'something2.zip']);
@@ -51,6 +52,7 @@ public function testForPackageWithMissingTag(): void
             [],
             true,
             true,
+            [],
         );
 
         $exception = CouldNotFindReleaseAsset::forPackageWithMissingTag($package);

test/unit/Downloading/GithubPackageReleaseAssetsTest.php

@@ -79,6 +79,7 @@ public function testUrlIsReturnedWhenFindingWindowsDownloadUrl(): void
             [],
             true,
             true,
+            [],
         );
 
         $releaseAssets = new GithubPackageReleaseAssets('https://test-github-api-base-url.thephp.foundation');
@@ -137,6 +138,7 @@ public function testUrlIsReturnedWhenFindingWindowsDownloadUrlWithCompilerAndThr
             [],
             true,
             true,
+            [],
         );
 
         $releaseAssets = new GithubPackageReleaseAssets('https://test-github-api-base-url.thephp.foundation');
@@ -176,6 +178,7 @@ public function testFindWindowsDownloadUrlForPackageThrowsExceptionWhenAssetNotF
             [],
             true,
             true,
+            [],
         );
 
         $releaseAssets = new GithubPackageReleaseAssets('https://test-github-api-base-url.thephp.foundation');

test/unit/Platform/WindowsExtensionAssetNameTest.php

@@ -50,6 +50,7 @@ public function setUp(): void
             [],
             true,
             true,
+            [],
         );
     }