Issue #3112393 by cmlara, smustgrave, AdamPS, alexpott: Allow vendor hardening to remove individual files

merge-requests/6513/merge
Alex Pott 2024-03-01 13:04:39 +00:00
parent a9f3b75195
commit 661f5453d0
No known key found for this signature in database
GPG Key ID: BDA67E7EE836E5CE
2 changed files with 10 additions and 7 deletions

View File

@ -343,27 +343,27 @@ class VendorHardeningPlugin implements PluginInterface, EventSubscriberInterface
return;
}
$this->io->writeError(sprintf('%sCleaning directories in <comment>%s</comment>', str_repeat(' ', 4), $package_name), TRUE, IOInterface::VERY_VERBOSE);
$this->io->writeError(sprintf('%sCleaning paths in <comment>%s</comment>', str_repeat(' ', 4), $package_name), TRUE, IOInterface::VERY_VERBOSE);
$fs = new Filesystem();
foreach ($paths_for_package as $cleanup_item) {
$cleanup_path = $package_dir . '/' . $cleanup_item;
if (!is_dir($cleanup_path)) {
if (!file_exists($cleanup_path)) {
// If the package has changed or the --prefer-dist version does not
// include the directory. This is not an error.
$this->io->writeError(sprintf("%s<comment>Directory '%s' does not exist.</comment>", str_repeat(' ', 6), $cleanup_path), TRUE, IOInterface::VERY_VERBOSE);
$this->io->writeError(sprintf("%s<comment>Path '%s' does not exist.</comment>", str_repeat(' ', 6), $cleanup_path), TRUE, IOInterface::VERY_VERBOSE);
continue;
}
if (!$fs->removeDirectory($cleanup_path)) {
if (!$fs->remove($cleanup_path)) {
// Always display a message if this fails as it means something
// has gone wrong. Therefore the message has to include the
// package name as the first informational message might not
// exist.
$this->io->writeError(sprintf("%s<error>Failure removing directory '%s'</error> in package <comment>%s</comment>.", str_repeat(' ', 6), $cleanup_item, $package_name), TRUE, IOInterface::NORMAL);
$this->io->writeError(sprintf("%s<error>Failure removing path '%s'</error> in package <comment>%s</comment>.", str_repeat(' ', 6), $cleanup_item, $package_name), TRUE, IOInterface::NORMAL);
continue;
}
$this->io->writeError(sprintf("%sRemoving directory <info>'%s'</info>", str_repeat(' ', 4), $cleanup_item), TRUE, IOInterface::VERBOSE);
$this->io->writeError(sprintf("%sRemoving path <info>'%s'</info>", str_repeat(' ', 4), $cleanup_item), TRUE, IOInterface::VERBOSE);
}
}

View File

@ -35,6 +35,7 @@ class VendorHardeningPluginTest extends TestCase {
'tests' => [
'SomeTest.php' => '<?php',
],
'SomeFile.php' => '<?php',
],
],
]);
@ -92,14 +93,16 @@ class VendorHardeningPluginTest extends TestCase {
$ref_io->setValue($plugin, $io->reveal());
$this->assertFileExists(vfsStream::url('vendor/drupal/package/tests/SomeTest.php'));
$this->assertFileExists(vfsStream::url('vendor/drupal/package/SomeFile.php'));
$package = $this->prophesize(PackageInterface::class);
$package->getName()->willReturn('drupal/package');
$ref_clean = new \ReflectionMethod($plugin, 'cleanPathsForPackage');
$ref_clean->invokeArgs($plugin, [$package->reveal(), ['tests']]);
$ref_clean->invokeArgs($plugin, [$package->reveal(), ['tests', 'SomeFile.php']]);
$this->assertFileDoesNotExist(vfsStream::url('vendor/drupal/package/tests'));
$this->assertFileDoesNotExist(vfsStream::url('vendor/drupal/package/SomeFile.php'));
}
/**