Forked from
project / automatic_updates
616 commits behind the upstream repository.
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
CronUpdaterTest.php 12.24 KiB
<?php
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdater;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Form\FormState;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
use Drupal\package_manager\Event\PostDestroyEvent;
use Drupal\package_manager\Event\PostRequireEvent;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\PreDestroyEvent;
use Drupal\package_manager\Event\PreRequireEvent;
use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Exception\StageValidationException;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\update\UpdateSettingsForm;
use Psr\Log\Test\TestLogger;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
* @covers \Drupal\automatic_updates\CronUpdater
* @covers \automatic_updates_form_update_settings_alter
*
* @group automatic_updates
*/
class CronUpdaterTest extends AutomaticUpdatesKernelTestBase {
use PackageManagerBypassTestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'automatic_updates',
'automatic_updates_test',
];
/**
* The test logger.
*
* @var \Psr\Log\Test\TestLogger
*/
private $logger;
/**
* {@inheritdoc}
*/
protected function setUp(): void {
// Because package_manager_bypass is enabled, a staging directory will not
// actually exist. Therefore, we need to disable these validators because
// they attempt to compare the active and stage directories.
$this->disableValidators[] = 'automatic_updates.validator.staged_database_updates';
$this->disableValidators[] = 'automatic_updates.staged_projects_validator';
parent::setUp();
$this->logger = new TestLogger();
$this->container->get('logger.factory')
->get('automatic_updates')
->addLogger($this->logger);
}
/**
* {@inheritdoc}
*/
public function register(ContainerBuilder $container) { parent::register($container);
// Since this test dynamically adds additional loggers to certain channels,
// we need to ensure they will persist even if the container is rebuilt when
// staged changes are applied.
// @see ::testStageDestroyedOnError()
$container->getDefinition('logger.factory')->addTag('persist');
}
/**
* Data provider for ::testUpdaterCalled().
*
* @return array[]
* Sets of arguments to pass to the test method.
*/
public function providerUpdaterCalled(): array {
$fixture_dir = __DIR__ . '/../../fixtures/release-history';
return [
'disabled, normal release' => [
CronUpdater::DISABLED,
"$fixture_dir/drupal.9.8.2.xml",
FALSE,
],
'disabled, security release' => [
CronUpdater::DISABLED,
"$fixture_dir/drupal.9.8.1-security.xml",
FALSE,
],
'security only, security release' => [
CronUpdater::SECURITY,
"$fixture_dir/drupal.9.8.1-security.xml",
TRUE,
],
'security only, normal release' => [
CronUpdater::SECURITY,
"$fixture_dir/drupal.9.8.2.xml",
FALSE,
],
'enabled, normal release' => [
CronUpdater::ALL,
"$fixture_dir/drupal.9.8.2.xml",
TRUE,
],
'enabled, security release' => [
CronUpdater::ALL,
"$fixture_dir/drupal.9.8.1-security.xml",
TRUE,
],
];
}
/**
* Tests that the cron handler calls the updater as expected.
*
* @param string $setting
* Whether automatic updates should be enabled during cron. Possible values
* are 'disable', 'security', and 'patch'.
* @param string $release_data
* If automatic updates are enabled, the path of the fake release metadata
* that should be served when fetching information on available updates.
* @param bool $will_update
* Whether an update should be performed, given the previous two arguments.
*
* @dataProvider providerUpdaterCalled
*/
public function testUpdaterCalled(string $setting, string $release_data, bool $will_update): void {
// Our form alter does not refresh information on available updates, so
// ensure that the appropriate update data is loaded beforehand.
$this->setReleaseMetadata([$release_data]); $this->setCoreVersion('9.8.0');
update_get_available(TRUE);
// Submit the configuration form programmatically, to prove our alterations
// work as expected.
$form_builder = $this->container->get('form_builder');
$form_state = new FormState();
$form = $form_builder->buildForm(UpdateSettingsForm::class, $form_state);
// Ensure that the version ranges in the setting's description, which are
// computed dynamically, look correct.
$this->assertStringContainsString('Automatic updates are only supported for 9.8.x versions of Drupal core. Drupal 9.8 will receive security updates until 9.10.0 is released.', $form['automatic_updates_cron']['#description']);
$form_state->setValue('automatic_updates_cron', $setting);
$form_builder->submitForm(UpdateSettingsForm::class, $form_state);
// Since we're just trying to ensure that all of Package Manager's services
// are called as expected, disable validation by replacing the event
// dispatcher with a dummy version.
$event_dispatcher = $this->prophesize(EventDispatcherInterface::class);
$this->container->set('event_dispatcher', $event_dispatcher->reveal());
// Run cron and ensure that Package Manager's services were called or
// bypassed depending on configuration.
$this->container->get('cron')->run();
$will_update = (int) $will_update;
$this->assertCount($will_update, $this->container->get('package_manager.beginner')->getInvocationArguments());
// If updates happen, then there will be two calls to the stager: one to
// change the constraints in composer.json, and another to actually update
// the installed dependencies.
$this->assertCount($will_update * 2, $this->container->get('package_manager.stager')->getInvocationArguments());
$this->assertCount($will_update, $this->container->get('package_manager.committer')->getInvocationArguments());
}
/**
* Data provider for ::testStageDestroyedOnError().
*
* @return array[]
* Sets of arguments to pass to the test method.
*/
public function providerStageDestroyedOnError(): array {
return [
'pre-create exception' => [
PreCreateEvent::class,
'Exception',
],
'post-create exception' => [
PostCreateEvent::class,
'Exception',
],
'pre-require exception' => [
PreRequireEvent::class,
'Exception',
],
'post-require exception' => [
PostRequireEvent::class,
'Exception',
],
'pre-apply exception' => [
PreApplyEvent::class,
'Exception',
],
'post-apply exception' => [
PostApplyEvent::class,
'Exception',
],
'pre-destroy exception' => [
PreDestroyEvent::class,
'Exception',
],
'post-destroy exception' => [ PostDestroyEvent::class,
'Exception',
],
// Only pre-operation events can add validation results.
// @see \Drupal\package_manager\Event\PreOperationStageEvent
// @see \Drupal\package_manager\Stage::dispatch()
'pre-create validation error' => [
PreCreateEvent::class,
StageValidationException::class,
],
'pre-require validation error' => [
PreRequireEvent::class,
StageValidationException::class,
],
'pre-apply validation error' => [
PreApplyEvent::class,
StageValidationException::class,
],
'pre-destroy validation error' => [
PreDestroyEvent::class,
StageValidationException::class,
],
];
}
/**
* Tests that the stage is destroyed if an error occurs during a cron update.
*
* @param string $event_class
* The stage life cycle event which should raise an error.
* @param string $exception_class
* The class of exception that will be thrown when the given event is fired.
*
* @dataProvider providerStageDestroyedOnError
*/
public function testStageDestroyedOnError(string $event_class, string $exception_class): void {
$this->installConfig('automatic_updates');
$this->setCoreVersion('9.8.0');
// Ensure that there is a security release to which we should update.
$this->setReleaseMetadata([__DIR__ . "/../../fixtures/release-history/drupal.9.8.1-security.xml"]);
// If the pre- or post-destroy events throw an exception, it will not be
// caught by the cron updater, but it *will* be caught by the main cron
// service, which will log it as a cron error that we'll want to check for.
$cron_logger = new TestLogger();
$this->container->get('logger.factory')
->get('cron')
->addLogger($cron_logger);
// When the event specified by $event_class is fired, either throw an
// exception directly from the event subscriber, or set a validation error
// (if the exception class is StageValidationException).
if ($exception_class === StageValidationException::class) {
$results = [
ValidationResult::createError(['Destroy the stage!']),
];
TestSubscriber1::setTestResult($results, $event_class);
$exception = new StageValidationException($results);
}
else {
/** @var \Throwable $exception */
$exception = new $exception_class('Destroy the stage!');
TestSubscriber1::setException($exception, $event_class);
}
$expected_log_message = $exception->getMessage();
// Ensure that nothing has been logged yet.
$this->assertEmpty($cron_logger->records);
$this->assertEmpty($this->logger->records);
/** @var \Drupal\automatic_updates\CronUpdater $updater */
$updater = $this->container->get('automatic_updates.cron_updater');
$this->assertTrue($updater->isAvailable());
$this->container->get('cron')->run();
$logged_by_updater = $this->logger->hasRecord($expected_log_message, RfcLogLevel::ERROR);
// To check if the exception was logged by the main cron service, we need
// to set up a special predicate, because exceptions logged by cron are
// always formatted in a particular way that we don't control. But the
// original exception object is stored with the log entry, so we look for
// that and confirm that its message is the same.
// @see watchdog_exception()
$predicate = function (array $record) use ($exception): bool {
if (isset($record['context']['exception'])) {
return $record['context']['exception']->getMessage() === $exception->getMessage();
}
return FALSE;
};
$logged_by_cron = $cron_logger->hasRecordThatPasses($predicate, RfcLogLevel::ERROR);
// If a pre-destroy event flags a validation error, it's handled like any
// other event (logged by the cron updater, but not the main cron service).
// But if a pre- or post-destroy event throws an exception, the cron updater
// won't try to catch it. Instead, it will be caught and logged by the main
// cron service.
if ($event_class === PreDestroyEvent::class || $event_class === PostDestroyEvent::class) {
if ($exception instanceof StageValidationException) {
$this->assertTrue($logged_by_updater);
$this->assertFalse($logged_by_cron);
}
else {
$this->assertFalse($logged_by_updater);
$this->assertTrue($logged_by_cron);
}
// If the pre-destroy event throws an exception or flags a validation
// error, the stage won't be destroyed. But, once the post-destroy event
// is fired, the stage should be fully destroyed and marked as available.
$this->assertSame($event_class === PostDestroyEvent::class, $updater->isAvailable());
}
// For all other events, the error should be caught and logged by the cron
// updater, not the main cron service, and the stage should always be
// destroyed and marked as available.
else {
$this->assertTrue($logged_by_updater);
$this->assertFalse($logged_by_cron);
$this->assertTrue($updater->isAvailable());
}
}
}