From 0dd0c8a9b8085ab6014d8f7125d8a8e40c5ae146 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 13 Jun 2023 11:44:19 -0400
Subject: [PATCH 001/142] add UnattendedUpdateStageBase
---
automatic_updates.routing.yml | 6 -
src/CronUpdateStage.php | 345 ++----------------
src/DrushUpdateStage.php | 243 +++++++++++-
src/UnattendedUpdateStageBase.php | 140 +++++++
.../Kernel/AutomaticUpdatesKernelTestBase.php | 9 -
5 files changed, 401 insertions(+), 342 deletions(-)
create mode 100644 src/UnattendedUpdateStageBase.php
diff --git a/automatic_updates.routing.yml b/automatic_updates.routing.yml
index 4f2e477ce2..c0dba2a45e 100644
--- a/automatic_updates.routing.yml
+++ b/automatic_updates.routing.yml
@@ -27,9 +27,3 @@ automatic_updates.finish:
options:
_maintenance_access: TRUE
_automatic_updates_status_messages: skip
-automatic_updates.cron.post_apply:
- path: '/automatic-update/cron/post-apply/{stage_id}/{installed_version}/{target_version}/{key}'
- defaults:
- _controller: 'automatic_updates.cron_update_stage:handlePostApply'
- requirements:
- _access_system_cron: 'TRUE'
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 533256f783..efa604d1fd 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -8,25 +8,16 @@ use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
use Drupal\Core\File\FileSystemInterface;
-use Drupal\Core\Mail\MailManagerInterface;
-use Drupal\Core\State\StateInterface;
use Drupal\Core\TempStore\SharedTempStoreFactory;
-use Drupal\Core\Url;
+use Drupal\Core\Utility\Error;
use Drupal\package_manager\ComposerInspector;
-use Drupal\package_manager\Event\PreCreateEvent;
-use Drupal\package_manager\Exception\ApplyFailedException;
-use Drupal\package_manager\Exception\StageEventException;
-use Drupal\package_manager\Exception\StageFailureMarkerException;
use Drupal\package_manager\FailureMarker;
use Drupal\package_manager\PathLocator;
-use Drupal\package_manager\ProjectInfo;
-use Drupal\update\ProjectRelease;
-use GuzzleHttp\Psr7\Uri as GuzzleUri;
use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
use PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface;
use PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface;
use PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface;
-use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Process\Process;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
@@ -38,47 +29,13 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
* It should not be called directly, and external code should not interact
* with it.
*/
-class CronUpdateStage extends UpdateStage implements CronInterface {
-
- /**
- * The current interface between PHP and the server.
- *
- * @var string
- */
- private static $serverApi = PHP_SAPI;
-
- /**
- * All automatic updates are disabled.
- *
- * @var string
- */
- public const DISABLED = 'disable';
-
- /**
- * Only perform automatic security updates.
- *
- * @var string
- */
- public const SECURITY = 'security';
-
- /**
- * All automatic updates are enabled.
- *
- * @var string
- */
- public const ALL = 'patch';
+class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface {
/**
* Constructs a CronUpdateStage object.
*
* @param \Drupal\automatic_updates\ReleaseChooser $releaseChooser
* The cron release chooser service.
- * @param \Drupal\Core\Mail\MailManagerInterface $mailManager
- * The mail manager service.
- * @param \Drupal\automatic_updates\StatusCheckMailer $statusCheckMailer
- * The status check mailer service.
- * @param \Drupal\Core\State\StateInterface $state
- * The state service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
* The config factory service.
* @param \Drupal\package_manager\ComposerInspector $composerInspector
@@ -107,11 +64,8 @@ class CronUpdateStage extends UpdateStage implements CronInterface {
* The decorated cron service.
*/
public function __construct(
- private readonly ReleaseChooser $releaseChooser,
- private readonly MailManagerInterface $mailManager,
- private readonly StatusCheckMailer $statusCheckMailer,
- private readonly StateInterface $state,
- private readonly ConfigFactoryInterface $configFactory,
+ ReleaseChooser $releaseChooser,
+ ConfigFactoryInterface $configFactory,
ComposerInspector $composerInspector,
PathLocator $pathLocator,
BeginnerInterface $beginner,
@@ -125,51 +79,26 @@ class CronUpdateStage extends UpdateStage implements CronInterface {
FailureMarker $failureMarker,
private readonly CronInterface $inner
) {
- parent::__construct($composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
- }
-
- /**
- * Indicates if we are currently running at the command line.
- *
- * @return bool
- * TRUE if we are running at the command line, otherwise FALSE.
- */
- final public static function isCommandLine(): bool {
- return self::$serverApi === 'cli';
+ parent::__construct($releaseChooser, $configFactory, $composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
}
/**
- * Handles updates during cron.
- *
- * @param int|null $timeout
- * (optional) How long to allow the file copying operation to run before
- * timing out, in seconds, or NULL to never time out. Defaults to 300
- * seconds.
- *
- * @return bool
- * If an update was attempted.
+ * Runs the terminal update command.
*/
- public function handleCron(?int $timeout = 300): bool {
- if ($this->getMode() === static::DISABLED) {
- return FALSE;
+ public function runTerminalUpdateCommand(): void {
+ // @todo Make a validator to ensure this path exists if settings select
+ // background updates.
+ // @todo Replace drush call with Symfony console command in
+ // https://www.drupal.org/i/3360485
+ $drush_path = $this->pathLocator->getVendorDirectory() . '/bin/drush';
+ $process = new Process([$drush_path, 'auto-update']);
+ try {
+ $process->start();
}
-
- $next_release = $this->getTargetRelease();
- if ($next_release) {
- return $this->performUpdate($next_release->getVersion(), $timeout);
+ catch (\Throwable $throwable) {
+ // @todo Does this work 10.0.x?
+ Error::logException($this->logger, $throwable, 'Could not perform background update.');
}
- return FALSE;
- }
-
- /**
- * Returns the release of Drupal core to update to, if any.
- *
- * @return \Drupal\update\ProjectRelease|null
- * The release of Drupal core to which we will update, or NULL if there is
- * nothing to update to.
- */
- public function getTargetRelease(): ?ProjectRelease {
- return $this->releaseChooser->getLatestInInstalledMinor($this);
}
/**
@@ -186,248 +115,24 @@ class CronUpdateStage extends UpdateStage implements CronInterface {
throw new \BadMethodCallException(__METHOD__ . '() cannot be called directly.');
}
- /**
- * Performs the update.
- *
- * @param string $target_version
- * The target version of Drupal core.
- * @param int|null $timeout
- * How long to allow the operation to run before timing out, in seconds, or
- * NULL to never time out.
- *
- * @return bool
- * Returns TRUE if any update was attempted, otherwise FALSE.
- */
- protected function performUpdate(string $target_version, ?int $timeout): bool {
- $project_info = new ProjectInfo('drupal');
- $update_started = FALSE;
-
- if (!$this->isAvailable()) {
- if ($project_info->isInstalledVersionSafe() && !$this->isApplying()) {
- $this->logger->notice('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.');
- return $update_started;
- }
- if (!$project_info->isInstalledVersionSafe() && $this->isApplying()) {
- $this->logger->notice(
- 'Cron will not perform any updates as an existing staged update is applying. The site is currently on an insecure version of Drupal core but will attempt to update to a secure version next time cron is run. This update may be applied manually at the <a href="%url">update form</a>.',
- ['%url' => Url::fromRoute('update.report_update')->setAbsolute()->toString()],
- );
- return $update_started;
- }
- }
-
- // Delete the existing staging area if not available and the site is
- // currently on an insecure version.
- if (!$project_info->isInstalledVersionSafe() && !$this->isAvailable() && !$this->isApplying()) {
- $destroy_message = $this->t('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
- $this->destroy(TRUE, $destroy_message);
- $this->logger->notice($destroy_message->getUntranslatedString());
- }
-
- $installed_version = $project_info->getInstalledVersion();
- if (empty($installed_version)) {
- $this->logger->error('Unable to determine the current version of Drupal core.');
- return $update_started;
- }
-
- // Do the bulk of the update in its own try-catch structure, so that we can
- // handle any exceptions or validation errors consistently, and destroy the
- // stage regardless of whether the update succeeds.
- try {
- $update_started = TRUE;
- // @see ::begin()
- $stage_id = parent::begin(['drupal' => $target_version], $timeout);
- $this->stage();
- $this->apply();
- }
- catch (\Throwable $e) {
- if ($e instanceof StageEventException && $e->event instanceof PreCreateEvent) {
- // If the error happened during PreCreateEvent then the update did not
- // really start.
- $update_started = FALSE;
- }
- // Send notifications about the failed update.
- $mail_params = [
- 'previous_version' => $installed_version,
- 'target_version' => $target_version,
- 'error_message' => $e->getMessage(),
- ];
- // Omit the backtrace in e-mails. That will be visible on the site, and is
- // also stored in the failure marker.
- if ($e instanceof StageFailureMarkerException || $e instanceof ApplyFailedException) {
- $mail_params['error_message'] = $this->failureMarker->getMessage(FALSE);
- }
- if ($e instanceof ApplyFailedException) {
- $mail_params['urgent'] = TRUE;
- $key = 'cron_failed_apply';
- }
- elseif (!$project_info->isInstalledVersionSafe()) {
- $mail_params['urgent'] = TRUE;
- $key = 'cron_failed_insecure';
- }
- else {
- $mail_params['urgent'] = FALSE;
- $key = 'cron_failed';
- }
-
- foreach ($this->statusCheckMailer->getRecipients() as $email => $langcode) {
- $this->mailManager->mail('automatic_updates', $key, $email, $langcode, $mail_params);
- }
- $this->logger->error($e->getMessage());
-
- // If an error occurred during the pre-create event, the stage will be
- // marked as available and we shouldn't try to destroy it, since the stage
- // must be claimed in order to be destroyed.
- if (!$this->isAvailable()) {
- $this->destroy();
- }
- return $update_started;
- }
- $this->triggerPostApply($stage_id, $installed_version, $target_version);
- return TRUE;
- }
-
- /**
- * Triggers the post-apply tasks.
- *
- * @param string $stage_id
- * The ID of the current stage.
- * @param string $start_version
- * The version of Drupal core that started the update.
- * @param string $target_version
- * The version of Drupal core to which we are updating.
- */
- protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
- // Perform a subrequest to run ::postApply(), which needs to be done in a
- // separate request.
- // @see parent::apply()
- $url = Url::fromRoute('automatic_updates.cron.post_apply', [
- 'stage_id' => $stage_id,
- 'installed_version' => $start_version,
- 'target_version' => $target_version,
- 'key' => $this->state->get('system.cron_key'),
- ]);
- $url = $url->setAbsolute()->toString();
-
- // If we're using a single-threaded web server (e.g., the built-in PHP web
- // server used in build tests), allow the post-apply request to be sent to
- // an alternate port.
- $port = $this->configFactory->get('automatic_updates.settings')
- ->get('cron_port');
- if ($port) {
- $url = (string) (new GuzzleUri($url))->withPort($port);
- }
-
- // Use the bare cURL API to make the request, so that we're not relying on
- // any third-party classes or other code which may have changed during the
- // update.
- $curl = curl_init($url);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
- $response = curl_exec($curl);
- $status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
- if ($status !== 200) {
- $this->logger->error('Post-apply tasks failed with output: %status %response', [
- '%status' => $status,
- '%response' => $response,
- ]);
- }
- curl_close($curl);
- }
-
- /**
- * Runs post-apply tasks.
- *
- * @param string $stage_id
- * The stage ID.
- * @param string $installed_version
- * The version of Drupal core that started the update.
- * @param string $target_version
- * The version of Drupal core to which we updated.
- *
- * @return \Symfony\Component\HttpFoundation\Response
- * An empty 200 response if the post-apply tasks succeeded.
- */
- public function handlePostApply(string $stage_id, string $installed_version, string $target_version): Response {
- $owner = $this->tempStore->getMetadata(static::TEMPSTORE_LOCK_KEY)
- ->getOwnerId();
- // Reload the tempstore with the correct owner ID so we can claim the stage.
- $this->tempStore = $this->tempStoreFactory->get('package_manager_stage', $owner);
-
- $this->claim($stage_id);
-
- // Run post-apply tasks in their own try-catch block so that, if anything
- // raises an exception, we'll log it and proceed to destroy the stage as
- // soon as possible (which is also what we do in ::performUpdate()).
- try {
- $this->postApply();
-
- $this->logger->info(
- 'Drupal core has been updated from %previous_version to %target_version',
- [
- '%previous_version' => $installed_version,
- '%target_version' => $target_version,
- ]
- );
-
- // Send notifications about the successful update.
- $mail_params = [
- 'previous_version' => $installed_version,
- 'updated_version' => $target_version,
- ];
- foreach ($this->statusCheckMailer->getRecipients() as $recipient => $langcode) {
- $this->mailManager->mail('automatic_updates', 'cron_successful', $recipient, $langcode, $mail_params);
- }
- }
- catch (\Throwable $e) {
- $this->logger->error($e->getMessage());
- }
-
- // If any pre-destroy event subscribers raise validation errors, ensure they
- // are formatted and logged. But if any pre- or post-destroy event
- // subscribers throw another exception, don't bother catching it, since it
- // will be caught and handled by the main cron service.
- try {
- $this->destroy();
- }
- catch (StageEventException $e) {
- $this->logger->error($e->getMessage());
- }
-
- return new Response();
- }
-
- /**
- * Gets the cron update mode.
- *
- * @return string
- * The cron update mode. Will be one of the following constants:
- * - \Drupal\automatic_updates\CronUpdateStage::DISABLED if updates during
- * cron are entirely disabled.
- * - \Drupal\automatic_updates\CronUpdateStage::SECURITY only security
- * updates can be done during cron.
- * - \Drupal\automatic_updates\CronUpdateStage::ALL if all updates are
- * allowed during cron.
- */
- final public function getMode(): string {
- $mode = $this->configFactory->get('automatic_updates.settings')->get('unattended.level');
- return $mode ?: static::SECURITY;
- }
-
/**
* {@inheritdoc}
*/
public function run() {
$method = $this->configFactory->get('automatic_updates.settings')
->get('unattended.method');
+ // Always run the cron service before we trigger the update terminal
+ // command.
+ $inner_success = $this->inner->run();
// If we are configured to run updates via the web, and we're actually being
// accessed via the web (i.e., anything that isn't the command line), go
// ahead and try to do the update. In all other circumstances, just run the
// normal cron handler.
- if ($method === 'web' && !self::isCommandLine() && $this->handleCron()) {
- return TRUE;
+ if ($this->getMode() !== self::DISABLED && $method === 'web' && !self::isCommandLine()) {
+ $this->runTerminalUpdateCommand();
}
- return $this->inner->run();
+ return $inner_success;
}
}
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index abfb53773e..5c792d79a1 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -4,17 +4,91 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates;
+use Drupal\Component\Datetime\TimeInterface;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\Mail\MailManagerInterface;
+use Drupal\Core\TempStore\SharedTempStoreFactory;
+use Drupal\Core\Url;
+use Drupal\package_manager\ComposerInspector;
+use Drupal\package_manager\Event\PreCreateEvent;
+use Drupal\package_manager\Exception\ApplyFailedException;
+use Drupal\package_manager\Exception\StageEventException;
+use Drupal\package_manager\Exception\StageFailureMarkerException;
+use Drupal\package_manager\FailureMarker;
+use Drupal\package_manager\PathLocator;
+use Drupal\package_manager\ProjectInfo;
use Drush\Drush;
+use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
+use PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface;
+use PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface;
+use PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
* An updater that runs via a Drush command.
*/
-final class DrushUpdateStage extends CronUpdateStage {
+final class DrushUpdateStage extends UnattendedUpdateStageBase {
/**
- * {@inheritdoc}
+ * Constructs a UnattendedUpdateStageBase object.
+ *
+ * @param \Drupal\Core\Mail\MailManagerInterface $mailManager
+ * The mail manager service.
+ * @param \Drupal\automatic_updates\StatusCheckMailer $statusCheckMailer
+ * The status check mailer service.
+ * @param \Drupal\automatic_updates\ReleaseChooser $releaseChooser
+ * The cron release chooser service.
+ * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
+ * The config factory service.
+ * @param \Drupal\package_manager\ComposerInspector $composerInspector
+ * The Composer inspector service.
+ * @param \Drupal\package_manager\PathLocator $pathLocator
+ * The path locator service.
+ * @param \PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface $beginner
+ * The beginner service.
+ * @param \PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface $stager
+ * The stager service.
+ * @param \PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface $committer
+ * The committer service.
+ * @param \Drupal\Core\File\FileSystemInterface $fileSystem
+ * The file system service.
+ * @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $eventDispatcher
+ * The event dispatcher service.
+ * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempStoreFactory
+ * The shared tempstore factory.
+ * @param \Drupal\Component\Datetime\TimeInterface $time
+ * The time service.
+ * @param \PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface $pathFactory
+ * The path factory service.
+ * @param \Drupal\package_manager\FailureMarker $failureMarker
+ * The failure marker service.
*/
- protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
+ public function __construct(
+ private readonly MailManagerInterface $mailManager,
+ private readonly StatusCheckMailer $statusCheckMailer,
+ ReleaseChooser $releaseChooser,
+ ConfigFactoryInterface $configFactory,
+ ComposerInspector $composerInspector,
+ PathLocator $pathLocator,
+ BeginnerInterface $beginner,
+ StagerInterface $stager,
+ CommitterInterface $committer,
+ FileSystemInterface $fileSystem,
+ EventDispatcherInterface $eventDispatcher,
+ SharedTempStoreFactory $tempStoreFactory,
+ TimeInterface $time,
+ PathFactoryInterface $pathFactory,
+ FailureMarker $failureMarker,
+ ) {
+ parent::__construct($releaseChooser, $configFactory, $composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
+ }
+
+ /**
+ * Runs the post apply command.
+ */
+ private function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
$alias = Drush::aliasManager()->getSelf();
$output = Drush::processManager()
@@ -31,11 +105,166 @@ final class DrushUpdateStage extends CronUpdateStage {
}
/**
- * {@inheritdoc}
+ * Performs the update.
+ *
+ * @param string $target_version
+ * The target version of Drupal core.
+ * @param int|null $timeout
+ * How long to allow the operation to run before timing out, in seconds, or
+ * NULL to never time out.
+ *
+ * @return bool
+ * Returns TRUE if any update was attempted, otherwise FALSE.
+ */
+ protected function performUpdate(string $target_version, ?int $timeout): bool {
+ $project_info = new ProjectInfo('drupal');
+ $update_started = FALSE;
+
+ if (!$this->isAvailable()) {
+ if ($project_info->isInstalledVersionSafe() && !$this->isApplying()) {
+ $this->logger->notice('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.');
+ return $update_started;
+ }
+ if (!$project_info->isInstalledVersionSafe() && $this->isApplying()) {
+ $this->logger->notice(
+ 'Cron will not perform any updates as an existing staged update is applying. The site is currently on an insecure version of Drupal core but will attempt to update to a secure version next time cron is run. This update may be applied manually at the <a href="%url">update form</a>.',
+ ['%url' => Url::fromRoute('update.report_update')->setAbsolute()->toString()],
+ );
+ return $update_started;
+ }
+ }
+
+ // Delete the existing staging area if not available and the site is
+ // currently on an insecure version.
+ if (!$project_info->isInstalledVersionSafe() && !$this->isAvailable() && !$this->isApplying()) {
+ $destroy_message = $this->t('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
+ $this->destroy(TRUE, $destroy_message);
+ $this->logger->notice($destroy_message->getUntranslatedString());
+ }
+
+ $installed_version = $project_info->getInstalledVersion();
+ if (empty($installed_version)) {
+ $this->logger->error('Unable to determine the current version of Drupal core.');
+ return $update_started;
+ }
+
+ // Do the bulk of the update in its own try-catch structure, so that we can
+ // handle any exceptions or validation errors consistently, and destroy the
+ // stage regardless of whether the update succeeds.
+ try {
+ $update_started = TRUE;
+ // @see ::begin()
+ $stage_id = parent::begin(['drupal' => $target_version], $timeout);
+ $this->stage();
+ $this->apply();
+ }
+ catch (\Throwable $e) {
+ if ($e instanceof StageEventException && $e->event instanceof PreCreateEvent) {
+ // If the error happened during PreCreateEvent then the update did not
+ // really start.
+ $update_started = FALSE;
+ }
+ // Send notifications about the failed update.
+ $mail_params = [
+ 'previous_version' => $installed_version,
+ 'target_version' => $target_version,
+ 'error_message' => $e->getMessage(),
+ ];
+ // Omit the backtrace in e-mails. That will be visible on the site, and is
+ // also stored in the failure marker.
+ if ($e instanceof StageFailureMarkerException || $e instanceof ApplyFailedException) {
+ $mail_params['error_message'] = $this->failureMarker->getMessage(FALSE);
+ }
+ if ($e instanceof ApplyFailedException) {
+ $mail_params['urgent'] = TRUE;
+ $key = 'cron_failed_apply';
+ }
+ elseif (!$project_info->isInstalledVersionSafe()) {
+ $mail_params['urgent'] = TRUE;
+ $key = 'cron_failed_insecure';
+ }
+ else {
+ $mail_params['urgent'] = FALSE;
+ $key = 'cron_failed';
+ }
+
+ foreach ($this->statusCheckMailer->getRecipients() as $email => $langcode) {
+ $this->mailManager->mail('automatic_updates', $key, $email, $langcode, $mail_params);
+ }
+ $this->logger->error($e->getMessage());
+
+ // If an error occurred during the pre-create event, the stage will be
+ // marked as available and we shouldn't try to destroy it, since the stage
+ // must be claimed in order to be destroyed.
+ if (!$this->isAvailable()) {
+ $this->destroy();
+ }
+ return $update_started;
+ }
+ $this->triggerPostApply($stage_id, $installed_version, $target_version);
+ return TRUE;
+ }
+
+ /**
+ * Runs post-apply tasks.
+ *
+ * @param string $stage_id
+ * The stage ID.
+ * @param string $installed_version
+ * The version of Drupal core that started the update.
+ * @param string $target_version
+ * The version of Drupal core to which we updated.
+ *
+ * @return \Symfony\Component\HttpFoundation\Response
+ * An empty 200 response if the post-apply tasks succeeded.
*/
- public function performUpdate(string $target_version, ?int $timeout): bool {
- // Overridden to expose this method to calling code.
- return parent::performUpdate($target_version, $timeout);
+ public function handlePostApply(string $stage_id, string $installed_version, string $target_version): Response {
+ $owner = $this->tempStore->getMetadata(static::TEMPSTORE_LOCK_KEY)
+ ->getOwnerId();
+ // Reload the tempstore with the correct owner ID so we can claim the stage.
+ $this->tempStore = $this->tempStoreFactory->get('package_manager_stage', $owner);
+
+ $this->claim($stage_id);
+
+ // Run post-apply tasks in their own try-catch block so that, if anything
+ // raises an exception, we'll log it and proceed to destroy the stage as
+ // soon as possible (which is also what we do in ::performUpdate()).
+ try {
+ $this->postApply();
+
+ $this->logger->info(
+ 'Drupal core has been updated from %previous_version to %target_version',
+ [
+ '%previous_version' => $installed_version,
+ '%target_version' => $target_version,
+ ]
+ );
+
+ // Send notifications about the successful update.
+ $mail_params = [
+ 'previous_version' => $installed_version,
+ 'updated_version' => $target_version,
+ ];
+ foreach ($this->statusCheckMailer->getRecipients() as $recipient => $langcode) {
+ $this->mailManager->mail('automatic_updates', 'cron_successful', $recipient, $langcode, $mail_params);
+ }
+ }
+ catch (\Throwable $e) {
+ $this->logger->error($e->getMessage());
+ }
+
+ // If any pre-destroy event subscribers raise validation errors, ensure they
+ // are formatted and logged. But if any pre- or post-destroy event
+ // subscribers throw another exception, don't bother catching it, since it
+ // will be caught and handled by the main cron service.
+ try {
+ $this->destroy();
+ }
+ catch (StageEventException $e) {
+ $this->logger->error($e->getMessage());
+ }
+
+ return new Response();
}
}
diff --git a/src/UnattendedUpdateStageBase.php b/src/UnattendedUpdateStageBase.php
new file mode 100644
index 0000000000..9fd0775c1e
--- /dev/null
+++ b/src/UnattendedUpdateStageBase.php
@@ -0,0 +1,140 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\automatic_updates;
+
+use Drupal\Component\Datetime\TimeInterface;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\TempStore\SharedTempStoreFactory;
+use Drupal\package_manager\ComposerInspector;
+use Drupal\package_manager\FailureMarker;
+use Drupal\package_manager\PathLocator;
+use Drupal\update\ProjectRelease;
+use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
+use PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface;
+use PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface;
+use PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+
+/**
+ * A base class for unattended updates.
+ */
+class UnattendedUpdateStageBase extends UpdateStage {
+
+ /**
+ * The current interface between PHP and the server.
+ *
+ * @var string
+ */
+ private static $serverApi = PHP_SAPI;
+
+ /**
+ * All automatic updates are disabled.
+ *
+ * @var string
+ */
+ public const DISABLED = 'disable';
+
+ /**
+ * Only perform automatic security updates.
+ *
+ * @var string
+ */
+ public const SECURITY = 'security';
+
+ /**
+ * All automatic updates are enabled.
+ *
+ * @var string
+ */
+ public const ALL = 'patch';
+
+ /**
+ * Constructs a UnattendedUpdateStageBase object.
+ *
+ * @param \Drupal\automatic_updates\ReleaseChooser $releaseChooser
+ * The cron release chooser service.
+ * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
+ * The config factory service.
+ * @param \Drupal\package_manager\ComposerInspector $composerInspector
+ * The Composer inspector service.
+ * @param \Drupal\package_manager\PathLocator $pathLocator
+ * The path locator service.
+ * @param \PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface $beginner
+ * The beginner service.
+ * @param \PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface $stager
+ * The stager service.
+ * @param \PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface $committer
+ * The committer service.
+ * @param \Drupal\Core\File\FileSystemInterface $fileSystem
+ * The file system service.
+ * @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $eventDispatcher
+ * The event dispatcher service.
+ * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempStoreFactory
+ * The shared tempstore factory.
+ * @param \Drupal\Component\Datetime\TimeInterface $time
+ * The time service.
+ * @param \PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface $pathFactory
+ * The path factory service.
+ * @param \Drupal\package_manager\FailureMarker $failureMarker
+ * The failure marker service.
+ */
+ public function __construct(
+ private readonly ReleaseChooser $releaseChooser,
+ protected readonly ConfigFactoryInterface $configFactory,
+ ComposerInspector $composerInspector,
+ PathLocator $pathLocator,
+ BeginnerInterface $beginner,
+ StagerInterface $stager,
+ CommitterInterface $committer,
+ FileSystemInterface $fileSystem,
+ EventDispatcherInterface $eventDispatcher,
+ SharedTempStoreFactory $tempStoreFactory,
+ TimeInterface $time,
+ PathFactoryInterface $pathFactory,
+ FailureMarker $failureMarker,
+ ) {
+ parent::__construct($composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
+ }
+
+ /**
+ * Gets the cron update mode.
+ *
+ * @return string
+ * The cron update mode. Will be one of the following constants:
+ * - \Drupal\automatic_updates\CronUpdateStage::DISABLED if updates during
+ * cron are entirely disabled.
+ * - \Drupal\automatic_updates\CronUpdateStage::SECURITY only security
+ * updates can be done during cron.
+ * - \Drupal\automatic_updates\CronUpdateStage::ALL if all updates are
+ * allowed during cron.
+ */
+ final public function getMode(): string {
+ $mode = $this->configFactory->get('automatic_updates.settings')->get('unattended.level');
+ return $mode ?: static::SECURITY;
+ }
+
+ /**
+ * Indicates if we are currently running at the command line.
+ *
+ * @return bool
+ * TRUE if we are running at the command line, otherwise FALSE.
+ */
+ final public static function isCommandLine(): bool {
+ return self::$serverApi === 'cli';
+ }
+
+ /**
+ * Returns the release of Drupal core to update to, if any.
+ *
+ * @return \Drupal\update\ProjectRelease|null
+ * The release of Drupal core to which we will update, or NULL if there is
+ * nothing to update to.
+ */
+ public function getTargetRelease(): ?ProjectRelease {
+ return $this->releaseChooser->getLatestInInstalledMinor($this);
+ }
+
+}
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index c4765f78e2..dc73f28ea9 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -115,15 +115,6 @@ class TestUpdateStage extends UpdateStage {
*/
class TestCronUpdateStage extends CronUpdateStage {
- /**
- * {@inheritdoc}
- */
- protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
- // Subrequests don't work in kernel tests, so just call the post-apply
- // handler directly.
- $this->handlePostApply($stage_id, $start_version, $target_version);
- }
-
/**
* {@inheritdoc}
*/
--
GitLab
From 0262f2b354682ea79c877b649328a19960019061 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 13 Jun 2023 14:35:06 -0400
Subject: [PATCH 002/142] more
---
automatic_updates.services.yml | 3 ---
src/DrushUpdateStage.php | 3 ++-
src/UnattendedUpdateStageBase.php | 2 +-
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 12 ++++++++++++
tests/src/Kernel/CronUpdateStageTest.php | 3 +++
5 files changed, 18 insertions(+), 5 deletions(-)
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 9b29fe9166..38bd8c4d9b 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -29,9 +29,6 @@ services:
- ['setLogger', ['@logger.channel.automatic_updates']]
arguments:
- '@automatic_updates.release_chooser'
- - '@plugin.manager.mail'
- - '@automatic_updates.status_check_mailer'
- - '@state'
- '@config.factory'
- '@package_manager.composer_inspector'
- '@package_manager.path_locator'
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index 5c792d79a1..be1346acec 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -116,7 +116,8 @@ final class DrushUpdateStage extends UnattendedUpdateStageBase {
* @return bool
* Returns TRUE if any update was attempted, otherwise FALSE.
*/
- protected function performUpdate(string $target_version, ?int $timeout): bool {
+ public function performUpdate(string $target_version, ?int $timeout): bool {
+ throw new \Exception("sopt here");
$project_info = new ProjectInfo('drupal');
$update_started = FALSE;
diff --git a/src/UnattendedUpdateStageBase.php b/src/UnattendedUpdateStageBase.php
index 9fd0775c1e..f252bad6ae 100644
--- a/src/UnattendedUpdateStageBase.php
+++ b/src/UnattendedUpdateStageBase.php
@@ -28,7 +28,7 @@ class UnattendedUpdateStageBase extends UpdateStage {
*
* @var string
*/
- private static $serverApi = PHP_SAPI;
+ protected static $serverApi = PHP_SAPI;
/**
* All automatic updates are disabled.
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index dc73f28ea9..631e1f98a6 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -4,7 +4,9 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
+use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
@@ -115,6 +117,16 @@ class TestUpdateStage extends UpdateStage {
*/
class TestCronUpdateStage extends CronUpdateStage {
+ /**
+ * @inheritDoc
+ */
+ public function runTerminalUpdateCommand(): void {
+ /** @var \Drupal\automatic_updates\DrushUpdateStage $commands */
+ $commands = \Drupal::service(DrushUpdateStage::class);
+ $commands->performUpdate('a', 300);
+ }
+
+
/**
* {@inheritdoc}
*/
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index b13e2d0ee3..7d1b63ffc1 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -25,6 +25,7 @@ use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
use Drupal\Tests\package_manager\Kernel\TestStage;
use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
+use Drush\TestTraits\DrushTestTrait;
use Prophecy\Argument;
use ColinODell\PsrTestLogger\TestLogger;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
@@ -37,6 +38,7 @@ use Symfony\Component\EventDispatcher\EventDispatcherInterface;
*/
class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
+ use DrushTestTrait;
use EmailNotificationsTestTrait;
use PackageManagerBypassTestTrait;
use UserCreationTrait;
@@ -447,6 +449,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
public function testEmailOnSuccess(): void {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
$this->container->get('cron')->run();
+ $this->drush('auto-update');
// Ensure we sent a success message to all recipients.
$expected_body = <<<END
--
GitLab
From bf8e06af43885b7fc5885d072762a4d19b09f8e7 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 13 Jun 2023 16:53:09 -0400
Subject: [PATCH 003/142] move drush kernel tests
---
src/Commands/AutomaticUpdatesCommands.php | 10 ++++++
src/DrushUpdateStage.php | 5 ++-
.../Kernel/AutomaticUpdatesKernelTestBase.php | 25 +++++++++++----
tests/src/Kernel/CronUpdateStageTest.php | 32 +++++++++++++++----
4 files changed, 55 insertions(+), 17 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 4646cde772..cf738a2050 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -8,7 +8,9 @@ use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\package_manager\DebuggerTrait;
use Drush\Commands\DrushCommands;
+use function Psy\debug;
/**
* Contains Drush commands for Automatic Updates.
@@ -20,6 +22,8 @@ use Drush\Commands\DrushCommands;
*/
final class AutomaticUpdatesCommands extends DrushCommands {
+ use DebuggerTrait;
+
/**
* Constructs a AutomaticUpdatesCommands object.
*
@@ -59,6 +63,9 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* --from-version, and --to-version options.
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL]) {
+ $this->debugOut(print_r($options, true), 0);
+ $out = "the package_manager_bypass exists:" . (\Drupal::moduleHandler()->moduleExists('package_manager_bypass') ? 'yes' : 'no');
+ $this->debugOut($out);
$io = $this->io();
// The second half of the update process (post-apply etc.) is done by this
@@ -78,17 +85,20 @@ final class AutomaticUpdatesCommands extends DrushCommands {
}
else {
if ($this->stage->getMode() === DrushUpdateStage::DISABLED) {
+ $this->debugOut("***disabled");
$io->error('Automatic updates are disabled.');
return;
}
$release = $this->stage->getTargetRelease();
if ($release) {
+ $this->debugOut("release is " . $release->getVersion());
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
$io->info($message);
$this->stage->performUpdate($release->getVersion(), 300);
}
else {
+ $this->debugOut("release none");
$io->info("There is no Drupal core update available.");
$this->runStatusChecks();
}
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index be1346acec..e6731653f4 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -29,7 +29,7 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
* An updater that runs via a Drush command.
*/
-final class DrushUpdateStage extends UnattendedUpdateStageBase {
+class DrushUpdateStage extends UnattendedUpdateStageBase {
/**
* Constructs a UnattendedUpdateStageBase object.
@@ -88,7 +88,7 @@ final class DrushUpdateStage extends UnattendedUpdateStageBase {
/**
* Runs the post apply command.
*/
- private function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
+ protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
$alias = Drush::aliasManager()->getSelf();
$output = Drush::processManager()
@@ -117,7 +117,6 @@ final class DrushUpdateStage extends UnattendedUpdateStageBase {
* Returns TRUE if any update was attempted, otherwise FALSE.
*/
public function performUpdate(string $target_version, ?int $timeout): bool {
- throw new \Exception("sopt here");
$project_info = new ProjectInfo('drupal');
$update_started = FALSE;
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 631e1f98a6..39fc940b46 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -11,6 +11,8 @@ use Drupal\automatic_updates\UpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
/**
* Base class for kernel tests of the Automatic Updates module.
@@ -83,6 +85,11 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
*/
public function register(ContainerBuilder $container) {
parent::register($container);
+ $drush_stage_definition = new Definition(TestDrushUpdateStage::class);
+ $drush_stage_definition->setAutowired(TRUE);
+ $drush_stage_definition->addMethodCall('setLogger', [new Reference('logger.channel.automatic_updates')]);
+ $drush_stage_definition->setPublic(TRUE);
+ $container->addDefinitions([DrushUpdateStage::class => $drush_stage_definition]);
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
@@ -118,20 +125,24 @@ class TestUpdateStage extends UpdateStage {
class TestCronUpdateStage extends CronUpdateStage {
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
- public function runTerminalUpdateCommand(): void {
- /** @var \Drupal\automatic_updates\DrushUpdateStage $commands */
- $commands = \Drupal::service(DrushUpdateStage::class);
- $commands->performUpdate('a', 300);
+ public function setMetadata(string $key, $data): void {
+ parent::setMetadata($key, $data);
}
+}
+
+/**
+ * A test-only version of the drush update stage to override and expose internals.
+ */
+class TestDrushUpdateStage extends DrushUpdateStage {
/**
* {@inheritdoc}
*/
- public function setMetadata(string $key, $data): void {
- parent::setMetadata($key, $data);
+ protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
+ $this->handlePostApply($stage_id, $start_version, $target_version);
}
}
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index 7d1b63ffc1..e716bf5ce5 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Logger\RfcLogLevel;
@@ -25,9 +26,12 @@ use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
use Drupal\Tests\package_manager\Kernel\TestStage;
use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
+use Drupal\update\ProjectRelease;
use Drush\TestTraits\DrushTestTrait;
use Prophecy\Argument;
use ColinODell\PsrTestLogger\TestLogger;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
@@ -305,7 +309,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertEmpty($this->logger->records);
$this->assertTrue($stage->isAvailable());
- $this->container->get('cron')->run();
+ $this->startDrushUpdate('9.8.1');
$logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) RfcLogLevel::ERROR);
// To check if the exception was logged by the main cron service, we need
@@ -357,7 +361,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
};
$this->addEventTestListener($listener, PostRequireEvent::class);
- $this->container->get('cron')->run();
+ $this->startDrushUpdate('9.8.1');
$this->assertIsString($cron_stage_dir);
$this->assertNotEquals($original_stage_directory, $cron_stage_dir);
$this->assertDirectoryDoesNotExist($cron_stage_dir);
@@ -392,7 +396,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
// Ensure the stage that is applying the operation is not the cron
// update stage.
$this->assertInstanceOf(TestStage::class, $event->stage);
- $this->container->get('cron')->run();
+ $this->startDrushUpdate('9.8.1');
// We do not actually want to apply this operation it was just invoked to
// allow cron to be attempted.
$event->addError([$stop_error]);
@@ -428,7 +432,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
// Trigger CronUpdateStage, the above should cause it to detect a stage that
// is applying.
- $this->container->get('cron')->run();
+ $this->startDrushUpdate('9.8.2');
$this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
$this->assertUpdateStagedTimes(1);
@@ -477,6 +481,8 @@ END;
/**
* Tests that regular cron does not run if an update is started.
*
+ * @todo This test can be remove or simplified because cron always run first.
+ *
* @param string $event_exception_class
* The event in which to throw the exception.
*
@@ -568,7 +574,7 @@ END;
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- $this->container->get('cron')->run();
+ $this->startDrushUpdate('9.8.2');
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -609,7 +615,7 @@ END;
TestSubscriber1::setTestResult([$error], $event_class);
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
- $this->container->get('cron')->run();
+ $this->startDrushUpdate('9.8.1');
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -637,7 +643,7 @@ END;
$error = new \LogicException('I drink your milkshake!');
LoggingCommitter::setException($error);
- $this->container->get('cron')->run();
+ $this->startDrushUpdate('9.8.1');
$expected_body = <<<END
Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
@@ -662,4 +668,16 @@ END;
$this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
}
+ /**
+ * @return void
+ * @throws \Exception
+ */
+ protected function startDrushUpdate(string $expected_version): void {
+ $drush_stage = $this->container->get(DrushUpdateStage::class);
+ $release = $drush_stage->getTargetRelease();
+ $this->assertInstanceOf(ProjectRelease::class, $release);
+ $this->assertSame($expected_version, $release->getVersion());
+ $drush_stage->performUpdate($release->getVersion(), 300);
+ }
+
}
--
GitLab
From fc72c0cd3c422a8f7328d6508ba42bb6ec4e48dc Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 09:42:29 -0400
Subject: [PATCH 004/142] debugging to be removed
---
package_manager/src/DebuggerTrait.php | 11 +
tests/src/Functional/CronUpdateStageTest.php | 653 +++++++++++++++++++
2 files changed, 664 insertions(+)
create mode 100644 package_manager/src/DebuggerTrait.php
create mode 100644 tests/src/Functional/CronUpdateStageTest.php
diff --git a/package_manager/src/DebuggerTrait.php b/package_manager/src/DebuggerTrait.php
new file mode 100644
index 0000000000..87155e1880
--- /dev/null
+++ b/package_manager/src/DebuggerTrait.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Drupal\package_manager;
+
+trait DebuggerTrait {
+
+ protected function debugOut($string, $flags = FILE_APPEND) {
+ file_put_contents("/Users/ted.bowman/sites/drush.txt", "\n" . $string, $flags);
+ }
+
+}
diff --git a/tests/src/Functional/CronUpdateStageTest.php b/tests/src/Functional/CronUpdateStageTest.php
new file mode 100644
index 0000000000..3378f8bbec
--- /dev/null
+++ b/tests/src/Functional/CronUpdateStageTest.php
@@ -0,0 +1,653 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\automatic_updates\Functional;
+
+use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Core\Logger\RfcLogLevel;
+use Drupal\Core\Url;
+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\StageEventException;
+use Drupal\package_manager\Exception\StageOwnershipException;
+use Drupal\package_manager\ValidationResult;
+use Drupal\package_manager_bypass\LoggingCommitter;
+use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
+use Drupal\Tests\package_manager\Kernel\TestStage;
+use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
+use Drupal\Tests\user\Traits\UserCreationTrait;
+use Drush\TestTraits\DrushTestTrait;
+use Prophecy\Argument;
+use ColinODell\PsrTestLogger\TestLogger;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+/**
+ * @covers \Drupal\automatic_updates\CronUpdateStage
+ * @covers \automatic_updates_test_cron_form_update_settings_alter
+ * @group automatic_updates
+ * @internal
+ */
+class CronUpdateStageTest extends AutomaticUpdatesFunctionalTestBase {
+
+ use DrushTestTrait;
+ use EmailNotificationsTestTrait;
+ use PackageManagerBypassTestTrait;
+ use UserCreationTrait;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $defaultTheme = 'stark';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected static $modules = [
+ 'automatic_updates',
+ 'automatic_updates_test',
+ 'user',
+ 'common_test_cron_helper',
+ 'dblog',
+ ];
+
+ /**
+ * The test logger.
+ *
+ * @var \ColinODell\PsrTestLogger\TestLogger
+ */
+ private $logger;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp(): void {
+ parent::setUp();
+
+ $this->logger = new TestLogger();
+
+ $this->setUpEmailRecipients();
+ $this->assertRegularCronRun(FALSE);
+ $this->drupalLogin($this->createUser(['access site reports']));
+
+ $this->mockActiveCoreVersion('9.8.0');
+ }
+ /**
+ * Data provider for testUpdateStageCalled().
+ *
+ * @return mixed[][]
+ * The test cases.
+ */
+ public function providerUpdateStageCalled(): array {
+ $fixture_dir = __DIR__ . '/../../../package_manager/tests/fixtures/release-history';
+
+ return [
+ 'disabled, normal release' => [
+ CronUpdateStage::DISABLED,
+ ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
+ FALSE,
+ ],
+ 'disabled, security release' => [
+ CronUpdateStage::DISABLED,
+ ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
+ FALSE,
+ ],
+ 'security only, security release' => [
+ CronUpdateStage::SECURITY,
+ ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
+ TRUE,
+ ],
+ 'security only, normal release' => [
+ CronUpdateStage::SECURITY,
+ ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
+ FALSE,
+ ],
+ 'enabled, normal release' => [
+ CronUpdateStage::ALL,
+ ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
+ TRUE,
+ ],
+ 'enabled, security release' => [
+ CronUpdateStage::ALL,
+ ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
+ TRUE,
+ ],
+ ];
+ }
+
+ /**
+ * Tests that the cron handler calls the update stage as expected.
+ *
+ * @param string $setting
+ * Whether automatic updates should be enabled during cron. Possible values
+ * are 'disable', 'security', and 'patch'.
+ * @param array $release_data
+ * If automatic updates are enabled, the path of the fake release metadata
+ * that should be served when fetching information on available updates,
+ * keyed by project name.
+ * @param bool $will_update
+ * Whether an update should be performed, given the previous two arguments.
+ *
+ * @dataProvider providerUpdateStageCalled
+ */
+ public function testUpdateStageCalled(string $setting, array $release_data, bool $will_update): void {
+ $version = strpos($release_data['drupal'], '9.8.2') ? '9.8.2' : '9.8.1';
+ if ($will_update) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion($version);
+ }
+ // 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);
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', $setting)
+ ->save();
+
+ // 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);
+ $event_dispatcher->dispatch(Argument::type('object'))->willReturnArgument(0);
+ $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, there will be at least two calls to the stager: one
+ // to change the runtime constraints in composer.json, and another to
+ // actually update the installed dependencies. If there are any core
+ // dev requirements (such as `drupal/core-dev`), the stager will also be
+ // called to update the dev constraints in composer.json.
+ $this->assertGreaterThanOrEqual($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 string[][]
+ * The test cases.
+ */
+ 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,
+ StageEventException::class,
+ ],
+ 'pre-require validation error' => [
+ PreRequireEvent::class,
+ StageEventException::class,
+ ],
+ 'pre-apply validation error' => [
+ PreApplyEvent::class,
+ StageEventException::class,
+ ],
+ 'pre-destroy validation error' => [
+ PreDestroyEvent::class,
+ StageEventException::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 {
+ // If the failure happens before the stage is even created, the stage
+ // fixture need not be manipulated.
+ if ($event_class !== PreCreateEvent::class) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ }
+ $this->installConfig('automatic_updates');
+ // @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::SECURITY)
+ ->save();
+ // Ensure that there is a security release to which we should update.
+ $this->setReleaseMetadata([
+ 'drupal' => __DIR__ . "/../../../package_manager/tests/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 update stage, 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);
+
+ /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
+ $stage = $this->container->get(CronUpdateStage::class);
+
+ // When the event specified by $event_class is dispatched, either throw an
+ // exception directly from the event subscriber, or prepare a
+ // StageEventException which will format the validation errors its own way.
+ if ($exception_class === StageEventException::class) {
+ $error = ValidationResult::createError([
+ t('Destroy the stage!'),
+ ]);
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $stage);
+ TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
+ }
+ 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);
+
+ $this->assertTrue($stage->isAvailable());
+ $this->container->get('cron')->run();
+
+ $logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) 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, (string) RfcLogLevel::ERROR);
+
+ // If a pre-destroy event flags a validation error, it's handled like any
+ // other event (logged by the cron update stage, but not the main cron
+ // service). But if a pre- or post-destroy event throws an exception, the
+ // cron update stage 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 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, $stage->isAvailable());
+ }
+ else {
+ $this->assertTrue($stage->isAvailable());
+ }
+ $this->assertTrue($logged_by_stage);
+ $this->assertFalse($logged_by_cron);
+ }
+
+ /**
+ * Tests stage is destroyed if not available and site is on insecure version.
+ */
+ public function testStageDestroyedIfNotAvailable(): void {
+ $stage = $this->createStage();
+ $stage_id = $stage->create();
+ $original_stage_directory = $stage->getStageDirectory();
+ $this->assertDirectoryExists($original_stage_directory);
+
+ $listener = function (PostRequireEvent $event) use (&$cron_stage_dir, $original_stage_directory): void {
+ $this->assertDirectoryDoesNotExist($original_stage_directory);
+ $cron_stage_dir = $this->container->get('package_manager.stager')->getInvocationArguments()[0][1]->resolve();
+ $this->assertSame($event->stage->getStageDirectory(), $cron_stage_dir);
+ $this->assertDirectoryExists($cron_stage_dir);
+ };
+ $this->addEventTestListener($listener, PostRequireEvent::class);
+
+ $this->container->get('cron')->run();
+ $this->assertIsString($cron_stage_dir);
+ $this->assertNotEquals($original_stage_directory, $cron_stage_dir);
+ $this->assertDirectoryDoesNotExist($cron_stage_dir);
+ $this->assertTrue($this->logger->hasRecord('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.', (string) RfcLogLevel::NOTICE));
+
+ $stage2 = $this->createStage();
+ $stage2->create();
+ $this->expectException(StageOwnershipException::class);
+ $this->expectExceptionMessage('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
+ $stage->claim($stage_id);
+ }
+
+ /**
+ * Tests stage is not destroyed if another update is applying.
+ */
+ public function testStageNotDestroyedIfApplying(): void {
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::ALL)
+ ->save();
+ $this->setReleaseMetadata([
+ 'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml",
+ ]);
+ $this->setCoreVersion('9.8.0');
+ $stage = $this->createStage();
+ $stage->create();
+ $stage->require(['drupal/core:9.8.1']);
+ $stop_error = t('Stopping stage from applying');
+
+ // Add a PreApplyEvent event listener so we can attempt to run cron when
+ // another stage is applying.
+ $this->addEventTestListener(function (PreApplyEvent $event) use ($stop_error) {
+ // Ensure the stage that is applying the operation is not the cron
+ // update stage.
+ $this->assertInstanceOf(TestStage::class, $event->stage);
+ $this->container->get('cron')->run();
+ // We do not actually want to apply this operation it was just invoked to
+ // allow cron to be attempted.
+ $event->addError([$stop_error]);
+ });
+
+ try {
+ $stage->apply();
+ $this->fail('Expected update to fail');
+ }
+ catch (StageEventException $exception) {
+ $this->assertExpectedResultsFromException([ValidationResult::createError([$stop_error])], $exception);
+ }
+
+ $this->assertTrue($this->logger->hasRecord("Cron will not perform any updates as an existing staged update is applying. The site is currently on an insecure version of Drupal core but will attempt to update to a secure version next time cron is run. This update may be applied manually at the <a href=\"%url\">update form</a>.", (string) RfcLogLevel::NOTICE));
+ $this->assertUpdateStagedTimes(1);
+ }
+
+ /**
+ * Tests stage is not destroyed if not available and site is on secure version.
+ */
+ public function testStageNotDestroyedIfSecure(): void {
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::ALL)
+ ->save();
+ $this->mockActiveCoreVersion('9.8.1');
+ $stage = $this->createStage();
+ $stage->create();
+ $stage->require(['drupal/random']);
+ $this->assertUpdateStagedTimes(1);
+
+ // Trigger CronUpdateStage, the above should cause it to detect a stage that
+ // is applying.
+ $this->container->get('cron')->run();
+
+ $this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
+ $this->assertUpdateStagedTimes(1);
+ }
+
+ /**
+ * Tests that CronUpdateStage::begin() unconditionally throws an exception.
+ */
+ public function testBeginThrowsException(): void {
+ $this->expectExceptionMessage(CronUpdateStage::class . '::begin() cannot be called directly.');
+ $this->container->get(CronUpdateStage::class)
+ ->begin(['drupal' => '9.8.0']);
+ }
+
+ /**
+ * Tests that email is sent when an unattended update succeeds.
+ */
+ public function testEmailOnSuccess(): void {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
+ $this->drush('auto-update');
+ $this->drupalGet('admin/reports/dblog');
+ file_put_contents("/Users/ted.bowman/sites/test.html", $this->getSession()->getPage()->getOuterHtml());
+
+ // Ensure we sent a success message to all recipients.
+ $expected_body = <<<END
+Congratulations!
+
+Drupal core was automatically updated from 9.8.0 to 9.8.2.
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent("Drupal core was successfully updated", $expected_body);
+ $this->assertRegularCronRun(FALSE);
+ }
+
+ /**
+ * Tests that regular cron runs if not update is available.
+ */
+ public function testNoUpdateAvailable(): void {
+ $this->setCoreVersion('9.8.2');
+ $this->container->get('cron')->run();
+ $this->assertRegularCronRun(TRUE);
+ }
+
+ /**
+ * Tests that regular cron does not run if an update is started.
+ *
+ * @param string $event_exception_class
+ * The event in which to throw the exception.
+ *
+ * @dataProvider providerRegularCronRuns
+ */
+ public function testRegularCronRuns(string $event_exception_class): void {
+ $this->addEventTestListener(
+ function (): void {
+ throw new \Exception('😜');
+ },
+ $event_exception_class
+ );
+ try {
+ $this->container->get('cron')->run();
+ }
+ catch (\Exception $e) {
+ if ($event_exception_class !== PostDestroyEvent::class && $event_exception_class !== PreDestroyEvent::class) {
+ // No other events should result in an exception.
+ throw $e;
+ }
+ $this->assertSame('😜', $e->getMessage());
+ }
+ $this->assertRegularCronRun($event_exception_class === PreCreateEvent::class);
+ }
+
+ /**
+ * Data provider for testStageDestroyedOnError().
+ *
+ * @return string[][]
+ * The test cases.
+ */
+ public function providerRegularCronRuns(): array {
+ return [
+ 'pre-create exception' => [PreCreateEvent::class],
+ 'post-create exception' => [PostCreateEvent::class],
+ 'pre-require exception' => [PreRequireEvent::class],
+ 'post-require exception' => [PostRequireEvent::class],
+ 'pre-apply exception' => [PreApplyEvent::class],
+ 'post-apply exception' => [PostApplyEvent::class],
+ 'pre-destroy exception' => [PreDestroyEvent::class],
+ 'post-destroy exception' => [PostDestroyEvent::class],
+ ];
+ }
+
+ /**
+ * Data provider for ::testEmailOnFailure().
+ *
+ * @return string[][]
+ * The test cases.
+ */
+ public function providerEmailOnFailure(): array {
+ return [
+ 'pre-create' => [
+ PreCreateEvent::class,
+ ],
+ 'pre-require' => [
+ PreRequireEvent::class,
+ ],
+ 'pre-apply' => [
+ PreApplyEvent::class,
+ ],
+ ];
+ }
+
+ /**
+ * Tests the failure e-mail when an unattended non-security update fails.
+ *
+ * @param string $event_class
+ * The event class that should trigger the failure.
+ *
+ * @dataProvider providerEmailOnFailure
+ */
+ public function testNonUrgentFailureEmail(string $event_class): void {
+ // If the failure happens before the stage is even created, the stage
+ // fixture need not be manipulated.
+ if ($event_class !== PreCreateEvent::class) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
+ }
+ $this->setReleaseMetadata([
+ 'drupal' => __DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml',
+ ]);
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::ALL)
+ ->save();
+
+ $error = ValidationResult::createError([
+ t('Error while updating!'),
+ ]);
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
+ TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
+
+ $this->container->get('cron')->run();
+
+ $url = Url::fromRoute('update.report_update')
+ ->setAbsolute()
+ ->toString();
+
+ $expected_body = <<<END
+Drupal core failed to update automatically from 9.8.0 to 9.8.2. The following error was logged:
+
+{$exception->getMessage()}
+
+No immediate action is needed, but it is recommended that you visit $url to perform the update, or at least check that everything still looks good.
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent("Drupal core update failed", $expected_body);
+ }
+
+ /**
+ * Tests the failure e-mail when an unattended security update fails.
+ *
+ * @param string $event_class
+ * The event class that should trigger the failure.
+ *
+ * @dataProvider providerEmailOnFailure
+ */
+ public function testSecurityUpdateFailureEmail(string $event_class): void {
+ // If the failure happens before the stage is even created, the stage
+ // fixture need not be manipulated.
+ if ($event_class !== PreCreateEvent::class) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ }
+
+ $error = ValidationResult::createError([
+ t('Error while updating!'),
+ ]);
+ TestSubscriber1::setTestResult([$error], $event_class);
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
+
+ $this->container->get('cron')->run();
+
+ $url = Url::fromRoute('update.report_update')
+ ->setAbsolute()
+ ->toString();
+
+ $expected_body = <<<END
+Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
+
+{$exception->getMessage()}
+
+Your site is running an insecure version of Drupal and should be updated as soon as possible. Visit $url to perform the update.
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent("URGENT: Drupal core update failed", $expected_body);
+ }
+
+ /**
+ * Tests the failure e-mail when an unattended update fails to apply.
+ */
+ public function testApplyFailureEmail(): void {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ $error = new \LogicException('I drink your milkshake!');
+ LoggingCommitter::setException($error);
+
+ $this->container->get('cron')->run();
+ $expected_body = <<<END
+Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
+
+Automatic updates failed to apply, and the site is in an indeterminate state. Consider restoring the code and database from a backup. Caused by LogicException, with this message: {$error->getMessage()}
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent('URGENT: Drupal core update failed', $expected_body);
+ }
+
+ /**
+ * Tests that setLogger is called on the cron update stage service.
+ */
+ public function testLoggerIsSetByContainer(): void {
+ $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_stage')->getMethodCalls();
+ $this->assertSame('setLogger', $stage_method_calls[0][0]);
+ }
+
+ private function assertRegularCronRun(bool $expected_cron_run) {
+ $this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
+ }
+
+}
--
GitLab
From 8854ca05c11e09604026c2300b1f866defb7973b Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 12:31:13 -0400
Subject: [PATCH 005/142] change test to DrushUpdateStageTest
---
src/DrushUpdateStage.php | 19 ++++++-----
src/Validator/VersionPolicyValidator.php | 11 +++---
...StageTest.php => DrushUpdateStageTest.php} | 34 ++++++++-----------
3 files changed, 32 insertions(+), 32 deletions(-)
rename tests/src/Kernel/{CronUpdateStageTest.php => DrushUpdateStageTest.php} (96%)
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index e6731653f4..69a218107d 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -107,16 +107,19 @@ class DrushUpdateStage extends UnattendedUpdateStageBase {
/**
* Performs the update.
*
- * @param string $target_version
- * The target version of Drupal core.
- * @param int|null $timeout
- * How long to allow the operation to run before timing out, in seconds, or
- * NULL to never time out.
- *
* @return bool
* Returns TRUE if any update was attempted, otherwise FALSE.
*/
- public function performUpdate(string $target_version, ?int $timeout): bool {
+ public function performUpdate(): bool {
+ if ($this->getMode() === static::DISABLED) {
+ return FALSE;
+ }
+
+ $next_release = $this->getTargetRelease();
+ if (!$next_release) {
+ return FALSE;
+ }
+ $target_version = $next_release->getVersion();
$project_info = new ProjectInfo('drupal');
$update_started = FALSE;
@@ -154,7 +157,7 @@ class DrushUpdateStage extends UnattendedUpdateStageBase {
try {
$update_started = TRUE;
// @see ::begin()
- $stage_id = parent::begin(['drupal' => $target_version], $timeout);
+ $stage_id = parent::begin(['drupal' => $target_version], 300);
$this->stage();
$this->apply();
}
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index 32866729c0..1e96eae550 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Component\Utility\NestedArray;
use Drupal\package_manager\ComposerInspector;
use Drupal\package_manager\Event\StatusCheckEvent;
@@ -85,10 +86,10 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
// If this is a cron update, we may need to do additional checks.
- if ($stage instanceof CronUpdateStage) {
+ if ($stage instanceof UnattendedUpdateStageBase) {
$mode = $stage->getMode();
- if ($mode !== CronUpdateStage::DISABLED) {
+ if ($mode !== UnattendedUpdateStageBase::DISABLED) {
// If cron updates are enabled, the installed version must be stable;
// no alphas, betas, or RCs.
$rules[] = StableReleaseInstalled::class;
@@ -104,7 +105,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
// If only security updates are allowed during cron, the target
// version must be a security release.
- if ($mode === CronUpdateStage::SECURITY) {
+ if ($mode === UnattendedUpdateStageBase::SECURITY) {
$rules[] = TargetSecurityRelease::class;
}
}
@@ -235,7 +236,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
}
elseif ($event instanceof StatusCheckEvent) {
- if ($stage instanceof CronUpdateStage) {
+ if ($stage instanceof UnattendedUpdateStageBase) {
$target_release = $stage->getTargetRelease();
if ($target_release) {
return $target_release->getVersion();
@@ -264,7 +265,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
$project_info = new ProjectInfo('drupal');
$available_releases = $project_info->getInstallableReleases() ?? [];
- if ($stage instanceof CronUpdateStage) {
+ if ($stage instanceof UnattendedUpdateStageBase) {
$available_releases = array_reverse($available_releases);
}
return $available_releases;
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
similarity index 96%
rename from tests/src/Kernel/CronUpdateStageTest.php
rename to tests/src/Kernel/DrushUpdateStageTest.php
index e716bf5ce5..37a3d14c11 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -35,14 +35,13 @@ use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
- * @covers \Drupal\automatic_updates\CronUpdateStage
+ * @covers \Drupal\automatic_updates\DrushUpdateStage
* @covers \automatic_updates_test_cron_form_update_settings_alter
* @group automatic_updates
* @internal
*/
-class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
+class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
- use DrushTestTrait;
use EmailNotificationsTestTrait;
use PackageManagerBypassTestTrait;
use UserCreationTrait;
@@ -173,9 +172,10 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$event_dispatcher->dispatch(Argument::type('object'))->willReturnArgument(0);
$this->container->set('event_dispatcher', $event_dispatcher->reveal());
+ $this->assertCount(0, $this->container->get('package_manager.beginner')->getInvocationArguments());
// Run cron and ensure that Package Manager's services were called or
// bypassed depending on configuration.
- $this->container->get('cron')->run();
+ $this->startDrushUpdate($version);
$will_update = (int) $will_update;
$this->assertCount($will_update, $this->container->get('package_manager.beginner')->getInvocationArguments());
@@ -309,7 +309,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertEmpty($this->logger->records);
$this->assertTrue($stage->isAvailable());
- $this->startDrushUpdate('9.8.1');
+ $this->startDrushUpdate();
$logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) RfcLogLevel::ERROR);
// To check if the exception was logged by the main cron service, we need
@@ -361,7 +361,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
};
$this->addEventTestListener($listener, PostRequireEvent::class);
- $this->startDrushUpdate('9.8.1');
+ $this->startDrushUpdate();
$this->assertIsString($cron_stage_dir);
$this->assertNotEquals($original_stage_directory, $cron_stage_dir);
$this->assertDirectoryDoesNotExist($cron_stage_dir);
@@ -396,7 +396,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
// Ensure the stage that is applying the operation is not the cron
// update stage.
$this->assertInstanceOf(TestStage::class, $event->stage);
- $this->startDrushUpdate('9.8.1');
+ $this->startDrushUpdate();
// We do not actually want to apply this operation it was just invoked to
// allow cron to be attempted.
$event->addError([$stop_error]);
@@ -432,7 +432,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
// Trigger CronUpdateStage, the above should cause it to detect a stage that
// is applying.
- $this->startDrushUpdate('9.8.2');
+ $this->startDrushUpdate();
$this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
$this->assertUpdateStagedTimes(1);
@@ -453,7 +453,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
public function testEmailOnSuccess(): void {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
$this->container->get('cron')->run();
- $this->drush('auto-update');
+ $this->startDrushUpdate();
// Ensure we sent a success message to all recipients.
$expected_body = <<<END
@@ -466,7 +466,6 @@ This e-mail was sent by the Automatic Updates module. Unattended updates are not
If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
END;
$this->assertMessagesSent("Drupal core was successfully updated", $expected_body);
- $this->assertRegularCronRun(FALSE);
}
/**
@@ -574,7 +573,7 @@ END;
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- $this->startDrushUpdate('9.8.2');
+ $this->startDrushUpdate();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -615,7 +614,7 @@ END;
TestSubscriber1::setTestResult([$error], $event_class);
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
- $this->startDrushUpdate('9.8.1');
+ $this->startDrushUpdate();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -643,7 +642,7 @@ END;
$error = new \LogicException('I drink your milkshake!');
LoggingCommitter::setException($error);
- $this->startDrushUpdate('9.8.1');
+ $this->startDrushUpdate();
$expected_body = <<<END
Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
@@ -672,12 +671,9 @@ END;
* @return void
* @throws \Exception
*/
- protected function startDrushUpdate(string $expected_version): void {
- $drush_stage = $this->container->get(DrushUpdateStage::class);
- $release = $drush_stage->getTargetRelease();
- $this->assertInstanceOf(ProjectRelease::class, $release);
- $this->assertSame($expected_version, $release->getVersion());
- $drush_stage->performUpdate($release->getVersion(), 300);
+ protected function startDrushUpdate(): void {
+ $drush_stage = $this->container->get(DrushUpdateStage::class);;
+ $drush_stage->performUpdate();
}
}
--
GitLab
From 5532c16e9f00bd413b1bdc00dc1d1518bc6aa03f Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 12:51:04 -0400
Subject: [PATCH 006/142] add simpler CronUpdateStageTest.php
---
tests/src/Kernel/CronUpdateStageTest.php | 662 +++++++++++++++++++++++
1 file changed, 662 insertions(+)
create mode 100644 tests/src/Kernel/CronUpdateStageTest.php
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
new file mode 100644
index 0000000000..b13e2d0ee3
--- /dev/null
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -0,0 +1,662 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\automatic_updates\Kernel;
+
+use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Core\Logger\RfcLogLevel;
+use Drupal\Core\Url;
+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\StageEventException;
+use Drupal\package_manager\Exception\StageOwnershipException;
+use Drupal\package_manager\ValidationResult;
+use Drupal\package_manager_bypass\LoggingCommitter;
+use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
+use Drupal\Tests\package_manager\Kernel\TestStage;
+use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
+use Drupal\Tests\user\Traits\UserCreationTrait;
+use Prophecy\Argument;
+use ColinODell\PsrTestLogger\TestLogger;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+/**
+ * @covers \Drupal\automatic_updates\CronUpdateStage
+ * @covers \automatic_updates_test_cron_form_update_settings_alter
+ * @group automatic_updates
+ * @internal
+ */
+class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
+
+ use EmailNotificationsTestTrait;
+ use PackageManagerBypassTestTrait;
+ use UserCreationTrait;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected static $modules = [
+ 'automatic_updates',
+ 'automatic_updates_test',
+ 'user',
+ 'common_test_cron_helper',
+ ];
+
+ /**
+ * The test logger.
+ *
+ * @var \ColinODell\PsrTestLogger\TestLogger
+ */
+ private $logger;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp(): void {
+ parent::setUp();
+
+ $this->logger = new TestLogger();
+ $this->container->get('logger.factory')
+ ->get('automatic_updates')
+ ->addLogger($this->logger);
+ $this->installEntitySchema('user');
+ $this->installSchema('user', ['users_data']);
+
+ $this->setUpEmailRecipients();
+ $this->assertRegularCronRun(FALSE);
+ }
+
+ /**
+ * {@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 testUpdateStageCalled().
+ *
+ * @return mixed[][]
+ * The test cases.
+ */
+ public function providerUpdateStageCalled(): array {
+ $fixture_dir = __DIR__ . '/../../../package_manager/tests/fixtures/release-history';
+
+ return [
+ 'disabled, normal release' => [
+ CronUpdateStage::DISABLED,
+ ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
+ FALSE,
+ ],
+ 'disabled, security release' => [
+ CronUpdateStage::DISABLED,
+ ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
+ FALSE,
+ ],
+ 'security only, security release' => [
+ CronUpdateStage::SECURITY,
+ ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
+ TRUE,
+ ],
+ 'security only, normal release' => [
+ CronUpdateStage::SECURITY,
+ ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
+ FALSE,
+ ],
+ 'enabled, normal release' => [
+ CronUpdateStage::ALL,
+ ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
+ TRUE,
+ ],
+ 'enabled, security release' => [
+ CronUpdateStage::ALL,
+ ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
+ TRUE,
+ ],
+ ];
+ }
+
+ /**
+ * Tests that the cron handler calls the update stage as expected.
+ *
+ * @param string $setting
+ * Whether automatic updates should be enabled during cron. Possible values
+ * are 'disable', 'security', and 'patch'.
+ * @param array $release_data
+ * If automatic updates are enabled, the path of the fake release metadata
+ * that should be served when fetching information on available updates,
+ * keyed by project name.
+ * @param bool $will_update
+ * Whether an update should be performed, given the previous two arguments.
+ *
+ * @dataProvider providerUpdateStageCalled
+ */
+ public function testUpdateStageCalled(string $setting, array $release_data, bool $will_update): void {
+ $version = strpos($release_data['drupal'], '9.8.2') ? '9.8.2' : '9.8.1';
+ if ($will_update) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion($version);
+ }
+ // 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);
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', $setting)
+ ->save();
+
+ // 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);
+ $event_dispatcher->dispatch(Argument::type('object'))->willReturnArgument(0);
+ $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, there will be at least two calls to the stager: one
+ // to change the runtime constraints in composer.json, and another to
+ // actually update the installed dependencies. If there are any core
+ // dev requirements (such as `drupal/core-dev`), the stager will also be
+ // called to update the dev constraints in composer.json.
+ $this->assertGreaterThanOrEqual($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 string[][]
+ * The test cases.
+ */
+ 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,
+ StageEventException::class,
+ ],
+ 'pre-require validation error' => [
+ PreRequireEvent::class,
+ StageEventException::class,
+ ],
+ 'pre-apply validation error' => [
+ PreApplyEvent::class,
+ StageEventException::class,
+ ],
+ 'pre-destroy validation error' => [
+ PreDestroyEvent::class,
+ StageEventException::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 {
+ // If the failure happens before the stage is even created, the stage
+ // fixture need not be manipulated.
+ if ($event_class !== PreCreateEvent::class) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ }
+ $this->installConfig('automatic_updates');
+ // @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::SECURITY)
+ ->save();
+ // Ensure that there is a security release to which we should update.
+ $this->setReleaseMetadata([
+ 'drupal' => __DIR__ . "/../../../package_manager/tests/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 update stage, 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);
+
+ /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
+ $stage = $this->container->get(CronUpdateStage::class);
+
+ // When the event specified by $event_class is dispatched, either throw an
+ // exception directly from the event subscriber, or prepare a
+ // StageEventException which will format the validation errors its own way.
+ if ($exception_class === StageEventException::class) {
+ $error = ValidationResult::createError([
+ t('Destroy the stage!'),
+ ]);
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $stage);
+ TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
+ }
+ 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);
+
+ $this->assertTrue($stage->isAvailable());
+ $this->container->get('cron')->run();
+
+ $logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) 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, (string) RfcLogLevel::ERROR);
+
+ // If a pre-destroy event flags a validation error, it's handled like any
+ // other event (logged by the cron update stage, but not the main cron
+ // service). But if a pre- or post-destroy event throws an exception, the
+ // cron update stage 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 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, $stage->isAvailable());
+ }
+ else {
+ $this->assertTrue($stage->isAvailable());
+ }
+ $this->assertTrue($logged_by_stage);
+ $this->assertFalse($logged_by_cron);
+ }
+
+ /**
+ * Tests stage is destroyed if not available and site is on insecure version.
+ */
+ public function testStageDestroyedIfNotAvailable(): void {
+ $stage = $this->createStage();
+ $stage_id = $stage->create();
+ $original_stage_directory = $stage->getStageDirectory();
+ $this->assertDirectoryExists($original_stage_directory);
+
+ $listener = function (PostRequireEvent $event) use (&$cron_stage_dir, $original_stage_directory): void {
+ $this->assertDirectoryDoesNotExist($original_stage_directory);
+ $cron_stage_dir = $this->container->get('package_manager.stager')->getInvocationArguments()[0][1]->resolve();
+ $this->assertSame($event->stage->getStageDirectory(), $cron_stage_dir);
+ $this->assertDirectoryExists($cron_stage_dir);
+ };
+ $this->addEventTestListener($listener, PostRequireEvent::class);
+
+ $this->container->get('cron')->run();
+ $this->assertIsString($cron_stage_dir);
+ $this->assertNotEquals($original_stage_directory, $cron_stage_dir);
+ $this->assertDirectoryDoesNotExist($cron_stage_dir);
+ $this->assertTrue($this->logger->hasRecord('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.', (string) RfcLogLevel::NOTICE));
+
+ $stage2 = $this->createStage();
+ $stage2->create();
+ $this->expectException(StageOwnershipException::class);
+ $this->expectExceptionMessage('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
+ $stage->claim($stage_id);
+ }
+
+ /**
+ * Tests stage is not destroyed if another update is applying.
+ */
+ public function testStageNotDestroyedIfApplying(): void {
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::ALL)
+ ->save();
+ $this->setReleaseMetadata([
+ 'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml",
+ ]);
+ $this->setCoreVersion('9.8.0');
+ $stage = $this->createStage();
+ $stage->create();
+ $stage->require(['drupal/core:9.8.1']);
+ $stop_error = t('Stopping stage from applying');
+
+ // Add a PreApplyEvent event listener so we can attempt to run cron when
+ // another stage is applying.
+ $this->addEventTestListener(function (PreApplyEvent $event) use ($stop_error) {
+ // Ensure the stage that is applying the operation is not the cron
+ // update stage.
+ $this->assertInstanceOf(TestStage::class, $event->stage);
+ $this->container->get('cron')->run();
+ // We do not actually want to apply this operation it was just invoked to
+ // allow cron to be attempted.
+ $event->addError([$stop_error]);
+ });
+
+ try {
+ $stage->apply();
+ $this->fail('Expected update to fail');
+ }
+ catch (StageEventException $exception) {
+ $this->assertExpectedResultsFromException([ValidationResult::createError([$stop_error])], $exception);
+ }
+
+ $this->assertTrue($this->logger->hasRecord("Cron will not perform any updates as an existing staged update is applying. The site is currently on an insecure version of Drupal core but will attempt to update to a secure version next time cron is run. This update may be applied manually at the <a href=\"%url\">update form</a>.", (string) RfcLogLevel::NOTICE));
+ $this->assertUpdateStagedTimes(1);
+ }
+
+ /**
+ * Tests stage is not destroyed if not available and site is on secure version.
+ */
+ public function testStageNotDestroyedIfSecure(): void {
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::ALL)
+ ->save();
+ $this->setReleaseMetadata([
+ 'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml",
+ ]);
+ $this->setCoreVersion('9.8.1');
+ $stage = $this->createStage();
+ $stage->create();
+ $stage->require(['drupal/random']);
+ $this->assertUpdateStagedTimes(1);
+
+ // Trigger CronUpdateStage, the above should cause it to detect a stage that
+ // is applying.
+ $this->container->get('cron')->run();
+
+ $this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
+ $this->assertUpdateStagedTimes(1);
+ }
+
+ /**
+ * Tests that CronUpdateStage::begin() unconditionally throws an exception.
+ */
+ public function testBeginThrowsException(): void {
+ $this->expectExceptionMessage(CronUpdateStage::class . '::begin() cannot be called directly.');
+ $this->container->get(CronUpdateStage::class)
+ ->begin(['drupal' => '9.8.1']);
+ }
+
+ /**
+ * Tests that email is sent when an unattended update succeeds.
+ */
+ public function testEmailOnSuccess(): void {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ $this->container->get('cron')->run();
+
+ // Ensure we sent a success message to all recipients.
+ $expected_body = <<<END
+Congratulations!
+
+Drupal core was automatically updated from 9.8.0 to 9.8.1.
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent("Drupal core was successfully updated", $expected_body);
+ $this->assertRegularCronRun(FALSE);
+ }
+
+ /**
+ * Tests that regular cron runs if not update is available.
+ */
+ public function testNoUpdateAvailable(): void {
+ $this->setCoreVersion('9.8.2');
+ $this->container->get('cron')->run();
+ $this->assertRegularCronRun(TRUE);
+ }
+
+ /**
+ * Tests that regular cron does not run if an update is started.
+ *
+ * @param string $event_exception_class
+ * The event in which to throw the exception.
+ *
+ * @dataProvider providerRegularCronRuns
+ */
+ public function testRegularCronRuns(string $event_exception_class): void {
+ $this->addEventTestListener(
+ function (): void {
+ throw new \Exception('😜');
+ },
+ $event_exception_class
+ );
+ try {
+ $this->container->get('cron')->run();
+ }
+ catch (\Exception $e) {
+ if ($event_exception_class !== PostDestroyEvent::class && $event_exception_class !== PreDestroyEvent::class) {
+ // No other events should result in an exception.
+ throw $e;
+ }
+ $this->assertSame('😜', $e->getMessage());
+ }
+ $this->assertRegularCronRun($event_exception_class === PreCreateEvent::class);
+ }
+
+ /**
+ * Data provider for testStageDestroyedOnError().
+ *
+ * @return string[][]
+ * The test cases.
+ */
+ public function providerRegularCronRuns(): array {
+ return [
+ 'pre-create exception' => [PreCreateEvent::class],
+ 'post-create exception' => [PostCreateEvent::class],
+ 'pre-require exception' => [PreRequireEvent::class],
+ 'post-require exception' => [PostRequireEvent::class],
+ 'pre-apply exception' => [PreApplyEvent::class],
+ 'post-apply exception' => [PostApplyEvent::class],
+ 'pre-destroy exception' => [PreDestroyEvent::class],
+ 'post-destroy exception' => [PostDestroyEvent::class],
+ ];
+ }
+
+ /**
+ * Data provider for ::testEmailOnFailure().
+ *
+ * @return string[][]
+ * The test cases.
+ */
+ public function providerEmailOnFailure(): array {
+ return [
+ 'pre-create' => [
+ PreCreateEvent::class,
+ ],
+ 'pre-require' => [
+ PreRequireEvent::class,
+ ],
+ 'pre-apply' => [
+ PreApplyEvent::class,
+ ],
+ ];
+ }
+
+ /**
+ * Tests the failure e-mail when an unattended non-security update fails.
+ *
+ * @param string $event_class
+ * The event class that should trigger the failure.
+ *
+ * @dataProvider providerEmailOnFailure
+ */
+ public function testNonUrgentFailureEmail(string $event_class): void {
+ // If the failure happens before the stage is even created, the stage
+ // fixture need not be manipulated.
+ if ($event_class !== PreCreateEvent::class) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
+ }
+ $this->setReleaseMetadata([
+ 'drupal' => __DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml',
+ ]);
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateStage::ALL)
+ ->save();
+
+ $error = ValidationResult::createError([
+ t('Error while updating!'),
+ ]);
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
+ TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
+
+ $this->container->get('cron')->run();
+
+ $url = Url::fromRoute('update.report_update')
+ ->setAbsolute()
+ ->toString();
+
+ $expected_body = <<<END
+Drupal core failed to update automatically from 9.8.0 to 9.8.2. The following error was logged:
+
+{$exception->getMessage()}
+
+No immediate action is needed, but it is recommended that you visit $url to perform the update, or at least check that everything still looks good.
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent("Drupal core update failed", $expected_body);
+ }
+
+ /**
+ * Tests the failure e-mail when an unattended security update fails.
+ *
+ * @param string $event_class
+ * The event class that should trigger the failure.
+ *
+ * @dataProvider providerEmailOnFailure
+ */
+ public function testSecurityUpdateFailureEmail(string $event_class): void {
+ // If the failure happens before the stage is even created, the stage
+ // fixture need not be manipulated.
+ if ($event_class !== PreCreateEvent::class) {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ }
+
+ $error = ValidationResult::createError([
+ t('Error while updating!'),
+ ]);
+ TestSubscriber1::setTestResult([$error], $event_class);
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
+
+ $this->container->get('cron')->run();
+
+ $url = Url::fromRoute('update.report_update')
+ ->setAbsolute()
+ ->toString();
+
+ $expected_body = <<<END
+Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
+
+{$exception->getMessage()}
+
+Your site is running an insecure version of Drupal and should be updated as soon as possible. Visit $url to perform the update.
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent("URGENT: Drupal core update failed", $expected_body);
+ }
+
+ /**
+ * Tests the failure e-mail when an unattended update fails to apply.
+ */
+ public function testApplyFailureEmail(): void {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ $error = new \LogicException('I drink your milkshake!');
+ LoggingCommitter::setException($error);
+
+ $this->container->get('cron')->run();
+ $expected_body = <<<END
+Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
+
+Automatic updates failed to apply, and the site is in an indeterminate state. Consider restoring the code and database from a backup. Caused by LogicException, with this message: {$error->getMessage()}
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent('URGENT: Drupal core update failed', $expected_body);
+ }
+
+ /**
+ * Tests that setLogger is called on the cron update stage service.
+ */
+ public function testLoggerIsSetByContainer(): void {
+ $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_stage')->getMethodCalls();
+ $this->assertSame('setLogger', $stage_method_calls[0][0]);
+ }
+
+ private function assertRegularCronRun(bool $expected_cron_run) {
+ $this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
+ }
+
+}
--
GitLab
From 77ca5744ea9fdb96c535825185dc1ecf034d7948 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 13:17:53 -0400
Subject: [PATCH 007/142] remove added functional test
---
tests/src/Functional/CronUpdateStageTest.php | 653 -------------------
1 file changed, 653 deletions(-)
delete mode 100644 tests/src/Functional/CronUpdateStageTest.php
diff --git a/tests/src/Functional/CronUpdateStageTest.php b/tests/src/Functional/CronUpdateStageTest.php
deleted file mode 100644
index 3378f8bbec..0000000000
--- a/tests/src/Functional/CronUpdateStageTest.php
+++ /dev/null
@@ -1,653 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\Tests\automatic_updates\Functional;
-
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
-use Drupal\Core\DependencyInjection\ContainerBuilder;
-use Drupal\Core\Logger\RfcLogLevel;
-use Drupal\Core\Url;
-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\StageEventException;
-use Drupal\package_manager\Exception\StageOwnershipException;
-use Drupal\package_manager\ValidationResult;
-use Drupal\package_manager_bypass\LoggingCommitter;
-use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
-use Drupal\Tests\package_manager\Kernel\TestStage;
-use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
-use Drupal\Tests\user\Traits\UserCreationTrait;
-use Drush\TestTraits\DrushTestTrait;
-use Prophecy\Argument;
-use ColinODell\PsrTestLogger\TestLogger;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-
-/**
- * @covers \Drupal\automatic_updates\CronUpdateStage
- * @covers \automatic_updates_test_cron_form_update_settings_alter
- * @group automatic_updates
- * @internal
- */
-class CronUpdateStageTest extends AutomaticUpdatesFunctionalTestBase {
-
- use DrushTestTrait;
- use EmailNotificationsTestTrait;
- use PackageManagerBypassTestTrait;
- use UserCreationTrait;
-
- /**
- * {@inheritdoc}
- */
- protected $defaultTheme = 'stark';
-
- /**
- * {@inheritdoc}
- */
- protected static $modules = [
- 'automatic_updates',
- 'automatic_updates_test',
- 'user',
- 'common_test_cron_helper',
- 'dblog',
- ];
-
- /**
- * The test logger.
- *
- * @var \ColinODell\PsrTestLogger\TestLogger
- */
- private $logger;
-
- /**
- * {@inheritdoc}
- */
- protected function setUp(): void {
- parent::setUp();
-
- $this->logger = new TestLogger();
-
- $this->setUpEmailRecipients();
- $this->assertRegularCronRun(FALSE);
- $this->drupalLogin($this->createUser(['access site reports']));
-
- $this->mockActiveCoreVersion('9.8.0');
- }
- /**
- * Data provider for testUpdateStageCalled().
- *
- * @return mixed[][]
- * The test cases.
- */
- public function providerUpdateStageCalled(): array {
- $fixture_dir = __DIR__ . '/../../../package_manager/tests/fixtures/release-history';
-
- return [
- 'disabled, normal release' => [
- CronUpdateStage::DISABLED,
- ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
- FALSE,
- ],
- 'disabled, security release' => [
- CronUpdateStage::DISABLED,
- ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
- FALSE,
- ],
- 'security only, security release' => [
- CronUpdateStage::SECURITY,
- ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
- TRUE,
- ],
- 'security only, normal release' => [
- CronUpdateStage::SECURITY,
- ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
- FALSE,
- ],
- 'enabled, normal release' => [
- CronUpdateStage::ALL,
- ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
- TRUE,
- ],
- 'enabled, security release' => [
- CronUpdateStage::ALL,
- ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
- TRUE,
- ],
- ];
- }
-
- /**
- * Tests that the cron handler calls the update stage as expected.
- *
- * @param string $setting
- * Whether automatic updates should be enabled during cron. Possible values
- * are 'disable', 'security', and 'patch'.
- * @param array $release_data
- * If automatic updates are enabled, the path of the fake release metadata
- * that should be served when fetching information on available updates,
- * keyed by project name.
- * @param bool $will_update
- * Whether an update should be performed, given the previous two arguments.
- *
- * @dataProvider providerUpdateStageCalled
- */
- public function testUpdateStageCalled(string $setting, array $release_data, bool $will_update): void {
- $version = strpos($release_data['drupal'], '9.8.2') ? '9.8.2' : '9.8.1';
- if ($will_update) {
- $this->getStageFixtureManipulator()->setCorePackageVersion($version);
- }
- // 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);
- $this->config('automatic_updates.settings')
- ->set('unattended.level', $setting)
- ->save();
-
- // 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);
- $event_dispatcher->dispatch(Argument::type('object'))->willReturnArgument(0);
- $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, there will be at least two calls to the stager: one
- // to change the runtime constraints in composer.json, and another to
- // actually update the installed dependencies. If there are any core
- // dev requirements (such as `drupal/core-dev`), the stager will also be
- // called to update the dev constraints in composer.json.
- $this->assertGreaterThanOrEqual($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 string[][]
- * The test cases.
- */
- 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,
- StageEventException::class,
- ],
- 'pre-require validation error' => [
- PreRequireEvent::class,
- StageEventException::class,
- ],
- 'pre-apply validation error' => [
- PreApplyEvent::class,
- StageEventException::class,
- ],
- 'pre-destroy validation error' => [
- PreDestroyEvent::class,
- StageEventException::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 {
- // If the failure happens before the stage is even created, the stage
- // fixture need not be manipulated.
- if ($event_class !== PreCreateEvent::class) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- }
- $this->installConfig('automatic_updates');
- // @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::SECURITY)
- ->save();
- // Ensure that there is a security release to which we should update.
- $this->setReleaseMetadata([
- 'drupal' => __DIR__ . "/../../../package_manager/tests/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 update stage, 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);
-
- /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
- $stage = $this->container->get(CronUpdateStage::class);
-
- // When the event specified by $event_class is dispatched, either throw an
- // exception directly from the event subscriber, or prepare a
- // StageEventException which will format the validation errors its own way.
- if ($exception_class === StageEventException::class) {
- $error = ValidationResult::createError([
- t('Destroy the stage!'),
- ]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $stage);
- TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- }
- 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);
-
- $this->assertTrue($stage->isAvailable());
- $this->container->get('cron')->run();
-
- $logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) 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, (string) RfcLogLevel::ERROR);
-
- // If a pre-destroy event flags a validation error, it's handled like any
- // other event (logged by the cron update stage, but not the main cron
- // service). But if a pre- or post-destroy event throws an exception, the
- // cron update stage 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 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, $stage->isAvailable());
- }
- else {
- $this->assertTrue($stage->isAvailable());
- }
- $this->assertTrue($logged_by_stage);
- $this->assertFalse($logged_by_cron);
- }
-
- /**
- * Tests stage is destroyed if not available and site is on insecure version.
- */
- public function testStageDestroyedIfNotAvailable(): void {
- $stage = $this->createStage();
- $stage_id = $stage->create();
- $original_stage_directory = $stage->getStageDirectory();
- $this->assertDirectoryExists($original_stage_directory);
-
- $listener = function (PostRequireEvent $event) use (&$cron_stage_dir, $original_stage_directory): void {
- $this->assertDirectoryDoesNotExist($original_stage_directory);
- $cron_stage_dir = $this->container->get('package_manager.stager')->getInvocationArguments()[0][1]->resolve();
- $this->assertSame($event->stage->getStageDirectory(), $cron_stage_dir);
- $this->assertDirectoryExists($cron_stage_dir);
- };
- $this->addEventTestListener($listener, PostRequireEvent::class);
-
- $this->container->get('cron')->run();
- $this->assertIsString($cron_stage_dir);
- $this->assertNotEquals($original_stage_directory, $cron_stage_dir);
- $this->assertDirectoryDoesNotExist($cron_stage_dir);
- $this->assertTrue($this->logger->hasRecord('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.', (string) RfcLogLevel::NOTICE));
-
- $stage2 = $this->createStage();
- $stage2->create();
- $this->expectException(StageOwnershipException::class);
- $this->expectExceptionMessage('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
- $stage->claim($stage_id);
- }
-
- /**
- * Tests stage is not destroyed if another update is applying.
- */
- public function testStageNotDestroyedIfApplying(): void {
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
- ->save();
- $this->setReleaseMetadata([
- 'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml",
- ]);
- $this->setCoreVersion('9.8.0');
- $stage = $this->createStage();
- $stage->create();
- $stage->require(['drupal/core:9.8.1']);
- $stop_error = t('Stopping stage from applying');
-
- // Add a PreApplyEvent event listener so we can attempt to run cron when
- // another stage is applying.
- $this->addEventTestListener(function (PreApplyEvent $event) use ($stop_error) {
- // Ensure the stage that is applying the operation is not the cron
- // update stage.
- $this->assertInstanceOf(TestStage::class, $event->stage);
- $this->container->get('cron')->run();
- // We do not actually want to apply this operation it was just invoked to
- // allow cron to be attempted.
- $event->addError([$stop_error]);
- });
-
- try {
- $stage->apply();
- $this->fail('Expected update to fail');
- }
- catch (StageEventException $exception) {
- $this->assertExpectedResultsFromException([ValidationResult::createError([$stop_error])], $exception);
- }
-
- $this->assertTrue($this->logger->hasRecord("Cron will not perform any updates as an existing staged update is applying. The site is currently on an insecure version of Drupal core but will attempt to update to a secure version next time cron is run. This update may be applied manually at the <a href=\"%url\">update form</a>.", (string) RfcLogLevel::NOTICE));
- $this->assertUpdateStagedTimes(1);
- }
-
- /**
- * Tests stage is not destroyed if not available and site is on secure version.
- */
- public function testStageNotDestroyedIfSecure(): void {
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
- ->save();
- $this->mockActiveCoreVersion('9.8.1');
- $stage = $this->createStage();
- $stage->create();
- $stage->require(['drupal/random']);
- $this->assertUpdateStagedTimes(1);
-
- // Trigger CronUpdateStage, the above should cause it to detect a stage that
- // is applying.
- $this->container->get('cron')->run();
-
- $this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
- $this->assertUpdateStagedTimes(1);
- }
-
- /**
- * Tests that CronUpdateStage::begin() unconditionally throws an exception.
- */
- public function testBeginThrowsException(): void {
- $this->expectExceptionMessage(CronUpdateStage::class . '::begin() cannot be called directly.');
- $this->container->get(CronUpdateStage::class)
- ->begin(['drupal' => '9.8.0']);
- }
-
- /**
- * Tests that email is sent when an unattended update succeeds.
- */
- public function testEmailOnSuccess(): void {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
- $this->drush('auto-update');
- $this->drupalGet('admin/reports/dblog');
- file_put_contents("/Users/ted.bowman/sites/test.html", $this->getSession()->getPage()->getOuterHtml());
-
- // Ensure we sent a success message to all recipients.
- $expected_body = <<<END
-Congratulations!
-
-Drupal core was automatically updated from 9.8.0 to 9.8.2.
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent("Drupal core was successfully updated", $expected_body);
- $this->assertRegularCronRun(FALSE);
- }
-
- /**
- * Tests that regular cron runs if not update is available.
- */
- public function testNoUpdateAvailable(): void {
- $this->setCoreVersion('9.8.2');
- $this->container->get('cron')->run();
- $this->assertRegularCronRun(TRUE);
- }
-
- /**
- * Tests that regular cron does not run if an update is started.
- *
- * @param string $event_exception_class
- * The event in which to throw the exception.
- *
- * @dataProvider providerRegularCronRuns
- */
- public function testRegularCronRuns(string $event_exception_class): void {
- $this->addEventTestListener(
- function (): void {
- throw new \Exception('😜');
- },
- $event_exception_class
- );
- try {
- $this->container->get('cron')->run();
- }
- catch (\Exception $e) {
- if ($event_exception_class !== PostDestroyEvent::class && $event_exception_class !== PreDestroyEvent::class) {
- // No other events should result in an exception.
- throw $e;
- }
- $this->assertSame('😜', $e->getMessage());
- }
- $this->assertRegularCronRun($event_exception_class === PreCreateEvent::class);
- }
-
- /**
- * Data provider for testStageDestroyedOnError().
- *
- * @return string[][]
- * The test cases.
- */
- public function providerRegularCronRuns(): array {
- return [
- 'pre-create exception' => [PreCreateEvent::class],
- 'post-create exception' => [PostCreateEvent::class],
- 'pre-require exception' => [PreRequireEvent::class],
- 'post-require exception' => [PostRequireEvent::class],
- 'pre-apply exception' => [PreApplyEvent::class],
- 'post-apply exception' => [PostApplyEvent::class],
- 'pre-destroy exception' => [PreDestroyEvent::class],
- 'post-destroy exception' => [PostDestroyEvent::class],
- ];
- }
-
- /**
- * Data provider for ::testEmailOnFailure().
- *
- * @return string[][]
- * The test cases.
- */
- public function providerEmailOnFailure(): array {
- return [
- 'pre-create' => [
- PreCreateEvent::class,
- ],
- 'pre-require' => [
- PreRequireEvent::class,
- ],
- 'pre-apply' => [
- PreApplyEvent::class,
- ],
- ];
- }
-
- /**
- * Tests the failure e-mail when an unattended non-security update fails.
- *
- * @param string $event_class
- * The event class that should trigger the failure.
- *
- * @dataProvider providerEmailOnFailure
- */
- public function testNonUrgentFailureEmail(string $event_class): void {
- // If the failure happens before the stage is even created, the stage
- // fixture need not be manipulated.
- if ($event_class !== PreCreateEvent::class) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
- }
- $this->setReleaseMetadata([
- 'drupal' => __DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml',
- ]);
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
- ->save();
-
- $error = ValidationResult::createError([
- t('Error while updating!'),
- ]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
- TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
-
- $this->container->get('cron')->run();
-
- $url = Url::fromRoute('update.report_update')
- ->setAbsolute()
- ->toString();
-
- $expected_body = <<<END
-Drupal core failed to update automatically from 9.8.0 to 9.8.2. The following error was logged:
-
-{$exception->getMessage()}
-
-No immediate action is needed, but it is recommended that you visit $url to perform the update, or at least check that everything still looks good.
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent("Drupal core update failed", $expected_body);
- }
-
- /**
- * Tests the failure e-mail when an unattended security update fails.
- *
- * @param string $event_class
- * The event class that should trigger the failure.
- *
- * @dataProvider providerEmailOnFailure
- */
- public function testSecurityUpdateFailureEmail(string $event_class): void {
- // If the failure happens before the stage is even created, the stage
- // fixture need not be manipulated.
- if ($event_class !== PreCreateEvent::class) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- }
-
- $error = ValidationResult::createError([
- t('Error while updating!'),
- ]);
- TestSubscriber1::setTestResult([$error], $event_class);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
-
- $this->container->get('cron')->run();
-
- $url = Url::fromRoute('update.report_update')
- ->setAbsolute()
- ->toString();
-
- $expected_body = <<<END
-Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
-
-{$exception->getMessage()}
-
-Your site is running an insecure version of Drupal and should be updated as soon as possible. Visit $url to perform the update.
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent("URGENT: Drupal core update failed", $expected_body);
- }
-
- /**
- * Tests the failure e-mail when an unattended update fails to apply.
- */
- public function testApplyFailureEmail(): void {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- $error = new \LogicException('I drink your milkshake!');
- LoggingCommitter::setException($error);
-
- $this->container->get('cron')->run();
- $expected_body = <<<END
-Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
-
-Automatic updates failed to apply, and the site is in an indeterminate state. Consider restoring the code and database from a backup. Caused by LogicException, with this message: {$error->getMessage()}
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent('URGENT: Drupal core update failed', $expected_body);
- }
-
- /**
- * Tests that setLogger is called on the cron update stage service.
- */
- public function testLoggerIsSetByContainer(): void {
- $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_stage')->getMethodCalls();
- $this->assertSame('setLogger', $stage_method_calls[0][0]);
- }
-
- private function assertRegularCronRun(bool $expected_cron_run) {
- $this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
- }
-
-}
--
GitLab
From a07159e1475b10d2f747d160c25dc309931fbffa Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 13:20:01 -0400
Subject: [PATCH 008/142] add kernel test for CronUpdateStage
---
src/Commands/AutomaticUpdatesCommands.php | 3 +-
src/Validator/VersionPolicyValidator.php | 1 -
.../Kernel/AutomaticUpdatesKernelTestBase.php | 18 +-
tests/src/Kernel/CronUpdateStageTest.php | 623 +-----------------
tests/src/Kernel/DrushUpdateStageTest.php | 89 +--
5 files changed, 39 insertions(+), 695 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index cf738a2050..8cac9f5b66 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -10,7 +10,6 @@ use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\package_manager\DebuggerTrait;
use Drush\Commands\DrushCommands;
-use function Psy\debug;
/**
* Contains Drush commands for Automatic Updates.
@@ -63,7 +62,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* --from-version, and --to-version options.
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL]) {
- $this->debugOut(print_r($options, true), 0);
+ $this->debugOut(print_r($options, TRUE), 0);
$out = "the package_manager_bypass exists:" . (\Drupal::moduleHandler()->moduleExists('package_manager_bypass') ? 'yes' : 'no');
$this->debugOut($out);
$io = $this->io();
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index 1e96eae550..3b08ef703f 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -4,7 +4,6 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Component\Utility\NestedArray;
use Drupal\package_manager\ComposerInspector;
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 39fc940b46..18772bd192 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -4,7 +4,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
@@ -124,6 +123,23 @@ class TestUpdateStage extends UpdateStage {
*/
class TestCronUpdateStage extends CronUpdateStage {
+ /**
+ * Determines whether an exception should be thrown.
+ *
+ * @var bool
+ */
+ public bool $throwExceptionOnTerminalCommand = FALSE;
+
+ /**
+ * {@inheritdoc}
+ */
+ public function runTerminalUpdateCommand(): void {
+ if ($this->throwExceptionOnTerminalCommand) {
+ throw new \Exception('Simulated process failure.');
+ }
+ parent::runTerminalUpdateCommand();
+ }
+
/**
* {@inheritdoc}
*/
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index b13e2d0ee3..152655b43a 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -5,29 +5,9 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
-use Drupal\Core\DependencyInjection\ContainerBuilder;
-use Drupal\Core\Logger\RfcLogLevel;
-use Drupal\Core\Url;
-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\StageEventException;
-use Drupal\package_manager\Exception\StageOwnershipException;
-use Drupal\package_manager\ValidationResult;
-use Drupal\package_manager_bypass\LoggingCommitter;
use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
-use Drupal\Tests\package_manager\Kernel\TestStage;
use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
-use Prophecy\Argument;
-use ColinODell\PsrTestLogger\TestLogger;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
* @covers \Drupal\automatic_updates\CronUpdateStage
@@ -52,607 +32,22 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
];
/**
- * The test logger.
- *
- * @var \ColinODell\PsrTestLogger\TestLogger
+ * Tests that regular cron always runs.
*/
- private $logger;
-
- /**
- * {@inheritdoc}
- */
- protected function setUp(): void {
- parent::setUp();
-
- $this->logger = new TestLogger();
- $this->container->get('logger.factory')
- ->get('automatic_updates')
- ->addLogger($this->logger);
- $this->installEntitySchema('user');
- $this->installSchema('user', ['users_data']);
-
- $this->setUpEmailRecipients();
+ public function testRegularCronRuns(): void {
+ /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
+ $cron_stage = $this->container->get(CronUpdateStage::class);
+ $cron_stage->throwExceptionOnTerminalCommand = TRUE;
$this->assertRegularCronRun(FALSE);
- }
-
- /**
- * {@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 testUpdateStageCalled().
- *
- * @return mixed[][]
- * The test cases.
- */
- public function providerUpdateStageCalled(): array {
- $fixture_dir = __DIR__ . '/../../../package_manager/tests/fixtures/release-history';
-
- return [
- 'disabled, normal release' => [
- CronUpdateStage::DISABLED,
- ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
- FALSE,
- ],
- 'disabled, security release' => [
- CronUpdateStage::DISABLED,
- ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
- FALSE,
- ],
- 'security only, security release' => [
- CronUpdateStage::SECURITY,
- ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
- TRUE,
- ],
- 'security only, normal release' => [
- CronUpdateStage::SECURITY,
- ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
- FALSE,
- ],
- 'enabled, normal release' => [
- CronUpdateStage::ALL,
- ['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
- TRUE,
- ],
- 'enabled, security release' => [
- CronUpdateStage::ALL,
- ['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
- TRUE,
- ],
- ];
- }
-
- /**
- * Tests that the cron handler calls the update stage as expected.
- *
- * @param string $setting
- * Whether automatic updates should be enabled during cron. Possible values
- * are 'disable', 'security', and 'patch'.
- * @param array $release_data
- * If automatic updates are enabled, the path of the fake release metadata
- * that should be served when fetching information on available updates,
- * keyed by project name.
- * @param bool $will_update
- * Whether an update should be performed, given the previous two arguments.
- *
- * @dataProvider providerUpdateStageCalled
- */
- public function testUpdateStageCalled(string $setting, array $release_data, bool $will_update): void {
- $version = strpos($release_data['drupal'], '9.8.2') ? '9.8.2' : '9.8.1';
- if ($will_update) {
- $this->getStageFixtureManipulator()->setCorePackageVersion($version);
- }
- // 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);
- $this->config('automatic_updates.settings')
- ->set('unattended.level', $setting)
- ->save();
-
- // 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);
- $event_dispatcher->dispatch(Argument::type('object'))->willReturnArgument(0);
- $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, there will be at least two calls to the stager: one
- // to change the runtime constraints in composer.json, and another to
- // actually update the installed dependencies. If there are any core
- // dev requirements (such as `drupal/core-dev`), the stager will also be
- // called to update the dev constraints in composer.json.
- $this->assertGreaterThanOrEqual($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 string[][]
- * The test cases.
- */
- 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,
- StageEventException::class,
- ],
- 'pre-require validation error' => [
- PreRequireEvent::class,
- StageEventException::class,
- ],
- 'pre-apply validation error' => [
- PreApplyEvent::class,
- StageEventException::class,
- ],
- 'pre-destroy validation error' => [
- PreDestroyEvent::class,
- StageEventException::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 {
- // If the failure happens before the stage is even created, the stage
- // fixture need not be manipulated.
- if ($event_class !== PreCreateEvent::class) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- }
- $this->installConfig('automatic_updates');
- // @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::SECURITY)
- ->save();
- // Ensure that there is a security release to which we should update.
- $this->setReleaseMetadata([
- 'drupal' => __DIR__ . "/../../../package_manager/tests/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 update stage, 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);
-
- /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
- $stage = $this->container->get(CronUpdateStage::class);
-
- // When the event specified by $event_class is dispatched, either throw an
- // exception directly from the event subscriber, or prepare a
- // StageEventException which will format the validation errors its own way.
- if ($exception_class === StageEventException::class) {
- $error = ValidationResult::createError([
- t('Destroy the stage!'),
- ]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $stage);
- TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- }
- 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);
-
- $this->assertTrue($stage->isAvailable());
- $this->container->get('cron')->run();
-
- $logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) 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, (string) RfcLogLevel::ERROR);
-
- // If a pre-destroy event flags a validation error, it's handled like any
- // other event (logged by the cron update stage, but not the main cron
- // service). But if a pre- or post-destroy event throws an exception, the
- // cron update stage 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 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, $stage->isAvailable());
- }
- else {
- $this->assertTrue($stage->isAvailable());
- }
- $this->assertTrue($logged_by_stage);
- $this->assertFalse($logged_by_cron);
- }
-
- /**
- * Tests stage is destroyed if not available and site is on insecure version.
- */
- public function testStageDestroyedIfNotAvailable(): void {
- $stage = $this->createStage();
- $stage_id = $stage->create();
- $original_stage_directory = $stage->getStageDirectory();
- $this->assertDirectoryExists($original_stage_directory);
-
- $listener = function (PostRequireEvent $event) use (&$cron_stage_dir, $original_stage_directory): void {
- $this->assertDirectoryDoesNotExist($original_stage_directory);
- $cron_stage_dir = $this->container->get('package_manager.stager')->getInvocationArguments()[0][1]->resolve();
- $this->assertSame($event->stage->getStageDirectory(), $cron_stage_dir);
- $this->assertDirectoryExists($cron_stage_dir);
- };
- $this->addEventTestListener($listener, PostRequireEvent::class);
-
- $this->container->get('cron')->run();
- $this->assertIsString($cron_stage_dir);
- $this->assertNotEquals($original_stage_directory, $cron_stage_dir);
- $this->assertDirectoryDoesNotExist($cron_stage_dir);
- $this->assertTrue($this->logger->hasRecord('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.', (string) RfcLogLevel::NOTICE));
-
- $stage2 = $this->createStage();
- $stage2->create();
- $this->expectException(StageOwnershipException::class);
- $this->expectExceptionMessage('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
- $stage->claim($stage_id);
- }
-
- /**
- * Tests stage is not destroyed if another update is applying.
- */
- public function testStageNotDestroyedIfApplying(): void {
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
- ->save();
- $this->setReleaseMetadata([
- 'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml",
- ]);
- $this->setCoreVersion('9.8.0');
- $stage = $this->createStage();
- $stage->create();
- $stage->require(['drupal/core:9.8.1']);
- $stop_error = t('Stopping stage from applying');
-
- // Add a PreApplyEvent event listener so we can attempt to run cron when
- // another stage is applying.
- $this->addEventTestListener(function (PreApplyEvent $event) use ($stop_error) {
- // Ensure the stage that is applying the operation is not the cron
- // update stage.
- $this->assertInstanceOf(TestStage::class, $event->stage);
- $this->container->get('cron')->run();
- // We do not actually want to apply this operation it was just invoked to
- // allow cron to be attempted.
- $event->addError([$stop_error]);
- });
-
- try {
- $stage->apply();
- $this->fail('Expected update to fail');
- }
- catch (StageEventException $exception) {
- $this->assertExpectedResultsFromException([ValidationResult::createError([$stop_error])], $exception);
- }
-
- $this->assertTrue($this->logger->hasRecord("Cron will not perform any updates as an existing staged update is applying. The site is currently on an insecure version of Drupal core but will attempt to update to a secure version next time cron is run. This update may be applied manually at the <a href=\"%url\">update form</a>.", (string) RfcLogLevel::NOTICE));
- $this->assertUpdateStagedTimes(1);
- }
-
- /**
- * Tests stage is not destroyed if not available and site is on secure version.
- */
- public function testStageNotDestroyedIfSecure(): void {
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
- ->save();
- $this->setReleaseMetadata([
- 'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml",
- ]);
- $this->setCoreVersion('9.8.1');
- $stage = $this->createStage();
- $stage->create();
- $stage->require(['drupal/random']);
- $this->assertUpdateStagedTimes(1);
-
- // Trigger CronUpdateStage, the above should cause it to detect a stage that
- // is applying.
- $this->container->get('cron')->run();
-
- $this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
- $this->assertUpdateStagedTimes(1);
- }
-
- /**
- * Tests that CronUpdateStage::begin() unconditionally throws an exception.
- */
- public function testBeginThrowsException(): void {
- $this->expectExceptionMessage(CronUpdateStage::class . '::begin() cannot be called directly.');
- $this->container->get(CronUpdateStage::class)
- ->begin(['drupal' => '9.8.1']);
- }
-
- /**
- * Tests that email is sent when an unattended update succeeds.
- */
- public function testEmailOnSuccess(): void {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- $this->container->get('cron')->run();
-
- // Ensure we sent a success message to all recipients.
- $expected_body = <<<END
-Congratulations!
-
-Drupal core was automatically updated from 9.8.0 to 9.8.1.
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent("Drupal core was successfully updated", $expected_body);
- $this->assertRegularCronRun(FALSE);
- }
-
- /**
- * Tests that regular cron runs if not update is available.
- */
- public function testNoUpdateAvailable(): void {
- $this->setCoreVersion('9.8.2');
- $this->container->get('cron')->run();
- $this->assertRegularCronRun(TRUE);
- }
-
- /**
- * Tests that regular cron does not run if an update is started.
- *
- * @param string $event_exception_class
- * The event in which to throw the exception.
- *
- * @dataProvider providerRegularCronRuns
- */
- public function testRegularCronRuns(string $event_exception_class): void {
- $this->addEventTestListener(
- function (): void {
- throw new \Exception('😜');
- },
- $event_exception_class
- );
try {
$this->container->get('cron')->run();
- }
- catch (\Exception $e) {
- if ($event_exception_class !== PostDestroyEvent::class && $event_exception_class !== PreDestroyEvent::class) {
- // No other events should result in an exception.
- throw $e;
- }
- $this->assertSame('😜', $e->getMessage());
- }
- $this->assertRegularCronRun($event_exception_class === PreCreateEvent::class);
- }
+ $this->fail('Expected cron exception');
- /**
- * Data provider for testStageDestroyedOnError().
- *
- * @return string[][]
- * The test cases.
- */
- public function providerRegularCronRuns(): array {
- return [
- 'pre-create exception' => [PreCreateEvent::class],
- 'post-create exception' => [PostCreateEvent::class],
- 'pre-require exception' => [PreRequireEvent::class],
- 'post-require exception' => [PostRequireEvent::class],
- 'pre-apply exception' => [PreApplyEvent::class],
- 'post-apply exception' => [PostApplyEvent::class],
- 'pre-destroy exception' => [PreDestroyEvent::class],
- 'post-destroy exception' => [PostDestroyEvent::class],
- ];
- }
-
- /**
- * Data provider for ::testEmailOnFailure().
- *
- * @return string[][]
- * The test cases.
- */
- public function providerEmailOnFailure(): array {
- return [
- 'pre-create' => [
- PreCreateEvent::class,
- ],
- 'pre-require' => [
- PreRequireEvent::class,
- ],
- 'pre-apply' => [
- PreApplyEvent::class,
- ],
- ];
- }
-
- /**
- * Tests the failure e-mail when an unattended non-security update fails.
- *
- * @param string $event_class
- * The event class that should trigger the failure.
- *
- * @dataProvider providerEmailOnFailure
- */
- public function testNonUrgentFailureEmail(string $event_class): void {
- // If the failure happens before the stage is even created, the stage
- // fixture need not be manipulated.
- if ($event_class !== PreCreateEvent::class) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
}
- $this->setReleaseMetadata([
- 'drupal' => __DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml',
- ]);
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
- ->save();
-
- $error = ValidationResult::createError([
- t('Error while updating!'),
- ]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
- TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
-
- $this->container->get('cron')->run();
-
- $url = Url::fromRoute('update.report_update')
- ->setAbsolute()
- ->toString();
-
- $expected_body = <<<END
-Drupal core failed to update automatically from 9.8.0 to 9.8.2. The following error was logged:
-
-{$exception->getMessage()}
-
-No immediate action is needed, but it is recommended that you visit $url to perform the update, or at least check that everything still looks good.
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent("Drupal core update failed", $expected_body);
- }
-
- /**
- * Tests the failure e-mail when an unattended security update fails.
- *
- * @param string $event_class
- * The event class that should trigger the failure.
- *
- * @dataProvider providerEmailOnFailure
- */
- public function testSecurityUpdateFailureEmail(string $event_class): void {
- // If the failure happens before the stage is even created, the stage
- // fixture need not be manipulated.
- if ($event_class !== PreCreateEvent::class) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ catch (\Exception $e) {
+ $this->assertSame('Simulated process failure.', $e->getMessage());
}
-
- $error = ValidationResult::createError([
- t('Error while updating!'),
- ]);
- TestSubscriber1::setTestResult([$error], $event_class);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
-
- $this->container->get('cron')->run();
-
- $url = Url::fromRoute('update.report_update')
- ->setAbsolute()
- ->toString();
-
- $expected_body = <<<END
-Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
-
-{$exception->getMessage()}
-
-Your site is running an insecure version of Drupal and should be updated as soon as possible. Visit $url to perform the update.
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent("URGENT: Drupal core update failed", $expected_body);
- }
-
- /**
- * Tests the failure e-mail when an unattended update fails to apply.
- */
- public function testApplyFailureEmail(): void {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- $error = new \LogicException('I drink your milkshake!');
- LoggingCommitter::setException($error);
-
- $this->container->get('cron')->run();
- $expected_body = <<<END
-Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
-
-Automatic updates failed to apply, and the site is in an indeterminate state. Consider restoring the code and database from a backup. Caused by LogicException, with this message: {$error->getMessage()}
-
-This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
-
-If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
-END;
- $this->assertMessagesSent('URGENT: Drupal core update failed', $expected_body);
- }
-
- /**
- * Tests that setLogger is called on the cron update stage service.
- */
- public function testLoggerIsSetByContainer(): void {
- $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_stage')->getMethodCalls();
- $this->assertSame('setLogger', $stage_method_calls[0][0]);
+ $this->assertRegularCronRun(TRUE);
}
private function assertRegularCronRun(bool $expected_cron_run) {
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 37a3d14c11..7d92c39d49 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -26,12 +26,8 @@ use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
use Drupal\Tests\package_manager\Kernel\TestStage;
use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
-use Drupal\update\ProjectRelease;
-use Drush\TestTraits\DrushTestTrait;
use Prophecy\Argument;
use ColinODell\PsrTestLogger\TestLogger;
-use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
@@ -175,7 +171,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertCount(0, $this->container->get('package_manager.beginner')->getInvocationArguments());
// Run cron and ensure that Package Manager's services were called or
// bypassed depending on configuration.
- $this->startDrushUpdate($version);
+ $this->performDrushUpdate();
$will_update = (int) $will_update;
$this->assertCount($will_update, $this->container->get('package_manager.beginner')->getInvocationArguments());
@@ -309,7 +305,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertEmpty($this->logger->records);
$this->assertTrue($stage->isAvailable());
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
$logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) RfcLogLevel::ERROR);
// To check if the exception was logged by the main cron service, we need
@@ -361,7 +357,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
};
$this->addEventTestListener($listener, PostRequireEvent::class);
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
$this->assertIsString($cron_stage_dir);
$this->assertNotEquals($original_stage_directory, $cron_stage_dir);
$this->assertDirectoryDoesNotExist($cron_stage_dir);
@@ -396,7 +392,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
// Ensure the stage that is applying the operation is not the cron
// update stage.
$this->assertInstanceOf(TestStage::class, $event->stage);
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
// We do not actually want to apply this operation it was just invoked to
// allow cron to be attempted.
$event->addError([$stop_error]);
@@ -432,7 +428,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
// Trigger CronUpdateStage, the above should cause it to detect a stage that
// is applying.
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
$this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
$this->assertUpdateStagedTimes(1);
@@ -452,8 +448,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
*/
public function testEmailOnSuccess(): void {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- $this->container->get('cron')->run();
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
// Ensure we sent a success message to all recipients.
$expected_body = <<<END
@@ -468,64 +463,6 @@ END;
$this->assertMessagesSent("Drupal core was successfully updated", $expected_body);
}
- /**
- * Tests that regular cron runs if not update is available.
- */
- public function testNoUpdateAvailable(): void {
- $this->setCoreVersion('9.8.2');
- $this->container->get('cron')->run();
- $this->assertRegularCronRun(TRUE);
- }
-
- /**
- * Tests that regular cron does not run if an update is started.
- *
- * @todo This test can be remove or simplified because cron always run first.
- *
- * @param string $event_exception_class
- * The event in which to throw the exception.
- *
- * @dataProvider providerRegularCronRuns
- */
- public function testRegularCronRuns(string $event_exception_class): void {
- $this->addEventTestListener(
- function (): void {
- throw new \Exception('😜');
- },
- $event_exception_class
- );
- try {
- $this->container->get('cron')->run();
- }
- catch (\Exception $e) {
- if ($event_exception_class !== PostDestroyEvent::class && $event_exception_class !== PreDestroyEvent::class) {
- // No other events should result in an exception.
- throw $e;
- }
- $this->assertSame('😜', $e->getMessage());
- }
- $this->assertRegularCronRun($event_exception_class === PreCreateEvent::class);
- }
-
- /**
- * Data provider for testStageDestroyedOnError().
- *
- * @return string[][]
- * The test cases.
- */
- public function providerRegularCronRuns(): array {
- return [
- 'pre-create exception' => [PreCreateEvent::class],
- 'post-create exception' => [PostCreateEvent::class],
- 'pre-require exception' => [PreRequireEvent::class],
- 'post-require exception' => [PostRequireEvent::class],
- 'pre-apply exception' => [PreApplyEvent::class],
- 'post-apply exception' => [PostApplyEvent::class],
- 'pre-destroy exception' => [PreDestroyEvent::class],
- 'post-destroy exception' => [PostDestroyEvent::class],
- ];
- }
-
/**
* Data provider for ::testEmailOnFailure().
*
@@ -573,7 +510,7 @@ END;
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -614,7 +551,7 @@ END;
TestSubscriber1::setTestResult([$error], $event_class);
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -642,7 +579,7 @@ END;
$error = new \LogicException('I drink your milkshake!');
LoggingCommitter::setException($error);
- $this->startDrushUpdate();
+ $this->performDrushUpdate();
$expected_body = <<<END
Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
@@ -668,12 +605,10 @@ END;
}
/**
- * @return void
- * @throws \Exception
+ * Performs an update using the drush update stage directly.
*/
- protected function startDrushUpdate(): void {
- $drush_stage = $this->container->get(DrushUpdateStage::class);;
- $drush_stage->performUpdate();
+ protected function performDrushUpdate(): void {
+ $this->container->get(DrushUpdateStage::class)->performUpdate();
}
}
--
GitLab
From e2f0da818b08261c5481dd38dfba755a66958d12 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 13:26:05 -0400
Subject: [PATCH 009/142] remove debug trait
---
package_manager/src/DebuggerTrait.php | 11 -----------
src/Commands/AutomaticUpdatesCommands.php | 9 ---------
2 files changed, 20 deletions(-)
delete mode 100644 package_manager/src/DebuggerTrait.php
diff --git a/package_manager/src/DebuggerTrait.php b/package_manager/src/DebuggerTrait.php
deleted file mode 100644
index 87155e1880..0000000000
--- a/package_manager/src/DebuggerTrait.php
+++ /dev/null
@@ -1,11 +0,0 @@
-<?php
-
-namespace Drupal\package_manager;
-
-trait DebuggerTrait {
-
- protected function debugOut($string, $flags = FILE_APPEND) {
- file_put_contents("/Users/ted.bowman/sites/drush.txt", "\n" . $string, $flags);
- }
-
-}
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 8cac9f5b66..4646cde772 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -8,7 +8,6 @@ use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\package_manager\DebuggerTrait;
use Drush\Commands\DrushCommands;
/**
@@ -21,8 +20,6 @@ use Drush\Commands\DrushCommands;
*/
final class AutomaticUpdatesCommands extends DrushCommands {
- use DebuggerTrait;
-
/**
* Constructs a AutomaticUpdatesCommands object.
*
@@ -62,9 +59,6 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* --from-version, and --to-version options.
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL]) {
- $this->debugOut(print_r($options, TRUE), 0);
- $out = "the package_manager_bypass exists:" . (\Drupal::moduleHandler()->moduleExists('package_manager_bypass') ? 'yes' : 'no');
- $this->debugOut($out);
$io = $this->io();
// The second half of the update process (post-apply etc.) is done by this
@@ -84,20 +78,17 @@ final class AutomaticUpdatesCommands extends DrushCommands {
}
else {
if ($this->stage->getMode() === DrushUpdateStage::DISABLED) {
- $this->debugOut("***disabled");
$io->error('Automatic updates are disabled.');
return;
}
$release = $this->stage->getTargetRelease();
if ($release) {
- $this->debugOut("release is " . $release->getVersion());
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
$io->info($message);
$this->stage->performUpdate($release->getVersion(), 300);
}
else {
- $this->debugOut("release none");
$io->info("There is no Drupal core update available.");
$this->runStatusChecks();
}
--
GitLab
From 046921e80a0701a3f48018949f0775c7ba7d3888 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 13:46:32 -0400
Subject: [PATCH 010/142] use UnattendedUpdateStageBase constants instead
---
automatic_updates.install | 4 +-
automatic_updates.module | 13 ++--
src/UnattendedUpdateStageBase.php | 6 +-
src/Validation/AdminStatusCheckMessages.php | 3 +-
src/Validation/StatusChecker.php | 3 +-
src/Validator/CronFrequencyValidator.php | 6 +-
.../automatic_updates_test_cron.module | 8 +--
.../AutomatedCronDisabledValidatorTest.php | 4 +-
.../AutomaticUpdatesFunctionalTestBase.php | 4 +-
tests/src/Functional/StatusCheckTest.php | 6 +-
.../UpdateSettingsFormTest.php | 10 +--
.../Kernel/AutomaticUpdatesKernelTestBase.php | 3 +-
tests/src/Kernel/DrushUpdateStageTest.php | 21 ++++---
.../CronFrequencyValidatorTest.php | 6 +-
.../StatusCheck/CronServerValidatorTest.php | 30 ++++-----
.../PhpExtensionsValidatorTest.php | 8 +--
.../StatusCheckFailureEmailTest.php | 8 +--
.../Kernel/StatusCheck/StatusCheckerTest.php | 3 +-
.../VersionPolicyValidatorTest.php | 63 ++++++++++---------
19 files changed, 108 insertions(+), 101 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index 2a0c7900c9..e2a04c7df4 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -7,7 +7,7 @@
declare(strict_types = 1);
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates\Validation\StatusCheckRequirements;
use Drupal\system\SystemManager;
@@ -30,7 +30,7 @@ function automatic_updates_requirements($phase) {
// Check that site has cron updates enabled or not.
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
- if (\Drupal::configFactory()->get('automatic_updates.settings')->get('unattended.level') !== CronUpdateStage::DISABLED) {
+ if (\Drupal::configFactory()->get('automatic_updates.settings')->get('unattended.level') !== UnattendedUpdateStageBase::DISABLED) {
$requirements['automatic_updates_cron'] = [
'title' => t('Cron installs updates automatically'),
'severity' => SystemManager::REQUIREMENT_WARNING,
diff --git a/automatic_updates.module b/automatic_updates.module
index 450dbb3d4e..8455aa1cac 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -9,6 +9,7 @@ declare(strict_types = 1);
use Drupal\automatic_updates\BatchProcessor;
use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates\Validator\AutomatedCronDisabledValidator;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
@@ -199,7 +200,7 @@ function automatic_updates_cron() {
// Only try to send failure notifications if unattended updates are enabled.
/** @var \Drupal\automatic_updates\CronUpdateStage $stage */
$stage = \Drupal::service('automatic_updates.cron_update_stage');
- if ($stage->getMode() !== CronUpdateStage::DISABLED) {
+ if ($stage->getMode() !== UnattendedUpdateStageBase::DISABLED) {
\Drupal::service('automatic_updates.status_check_mailer')
->sendFailureNotifications($last_results, $status_checker->getResults());
}
@@ -219,7 +220,7 @@ function automatic_updates_modules_installed($modules) {
// If cron updates are disabled status check messages will not be displayed on
// admin pages. Therefore, after installing the module the user will not be
// alerted to any problems until they access the status report page.
- if ($stage->getMode() === CronUpdateStage::DISABLED) {
+ if ($stage->getMode() === UnattendedUpdateStageBase::DISABLED) {
/** @var \Drupal\automatic_updates\Validation\AdminStatusCheckMessages $status_check_messages */
$status_check_messages = \Drupal::classResolver(AdminStatusCheckMessages::class);
$status_check_messages->displayResultSummary();
@@ -260,9 +261,9 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
'#type' => 'radios',
'#title' => t('Unattended background updates'),
'#options' => [
- CronUpdateStage::DISABLED => t('Disabled'),
- CronUpdateStage::SECURITY => t('Security updates only'),
- CronUpdateStage::ALL => t('All patch releases'),
+ UnattendedUpdateStageBase::DISABLED => t('Disabled'),
+ UnattendedUpdateStageBase::SECURITY => t('Security updates only'),
+ UnattendedUpdateStageBase::ALL => t('All patch releases'),
],
'#default_value' => $config->get('unattended.level'),
];
@@ -277,7 +278,7 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
'#states' => [
'invisible' => [
'input[name="unattended_level"]' => [
- 'value' => CronUpdateStage::DISABLED,
+ 'value' => UnattendedUpdateStageBase::DISABLED,
],
],
],
diff --git a/src/UnattendedUpdateStageBase.php b/src/UnattendedUpdateStageBase.php
index f252bad6ae..c3f8f78af5 100644
--- a/src/UnattendedUpdateStageBase.php
+++ b/src/UnattendedUpdateStageBase.php
@@ -104,11 +104,11 @@ class UnattendedUpdateStageBase extends UpdateStage {
*
* @return string
* The cron update mode. Will be one of the following constants:
- * - \Drupal\automatic_updates\CronUpdateStage::DISABLED if updates during
+ * - \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED if updates during
* cron are entirely disabled.
- * - \Drupal\automatic_updates\CronUpdateStage::SECURITY only security
+ * - \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY only security
* updates can be done during cron.
- * - \Drupal\automatic_updates\CronUpdateStage::ALL if all updates are
+ * - \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL if all updates are
* allowed during cron.
*/
final public function getMode(): string {
diff --git a/src/Validation/AdminStatusCheckMessages.php b/src/Validation/AdminStatusCheckMessages.php
index 4e0d9df309..5059f8ab8f 100644
--- a/src/Validation/AdminStatusCheckMessages.php
+++ b/src/Validation/AdminStatusCheckMessages.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validation;
use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Messenger\MessengerInterface;
@@ -120,7 +121,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
protected function displayResultsOnCurrentPage(): bool {
// If updates will not run during cron then we don't need to show the
// status checks on admin pages.
- if ($this->stage->getMode() === CronUpdateStage::DISABLED) {
+ if ($this->stage->getMode() === UnattendedUpdateStageBase::DISABLED) {
return FALSE;
}
diff --git a/src/Validation/StatusChecker.php b/src/Validation/StatusChecker.php
index c69d463c38..d342e5203b 100644
--- a/src/Validation/StatusChecker.php
+++ b/src/Validation/StatusChecker.php
@@ -6,6 +6,7 @@ namespace Drupal\automatic_updates\Validation;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
use Drupal\package_manager\StatusCheckTrait;
@@ -66,7 +67,7 @@ final class StatusChecker implements EventSubscriberInterface {
// If updates will run during cron, use the cron update stage service
// provided by this module. This will allow validators to run specific
// validation for conditions that only affect cron updates.
- if ($this->cronUpdateStage->getMode() === CronUpdateStage::DISABLED) {
+ if ($this->cronUpdateStage->getMode() === UnattendedUpdateStageBase::DISABLED) {
$stage = $this->updateStage;
}
else {
diff --git a/src/Validator/CronFrequencyValidator.php b/src/Validator/CronFrequencyValidator.php
index 2b1e3a0e8b..9b82925d4a 100644
--- a/src/Validator/CronFrequencyValidator.php
+++ b/src/Validator/CronFrequencyValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Lock\LockBackendInterface;
@@ -79,12 +79,12 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
*/
public function validateLastCronRun(StatusCheckEvent $event): void {
// We only want to do this check if the stage belongs to Automatic Updates.
- if (!$event->stage instanceof CronUpdateStage) {
+ if (!$event->stage instanceof UnattendedUpdateStageBase) {
return;
}
// If automatic updates are disabled during cron, there's nothing we need
// to validate.
- if ($event->stage->getMode() === CronUpdateStage::DISABLED) {
+ if ($event->stage->getMode() === UnattendedUpdateStageBase::DISABLED) {
return;
}
// If cron is running right now, cron is clearly being run recently enough!
diff --git a/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module b/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module
index 901db03a19..bff8af8d18 100644
--- a/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module
+++ b/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module
@@ -10,8 +10,8 @@
declare(strict_types=1);
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\package_manager\ProjectInfo;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\Core\Extension\ExtensionVersion;
use Drupal\Core\Form\FormStateInterface;
use Drupal\update\ProjectSecurityData;
@@ -33,9 +33,9 @@ function automatic_updates_test_cron_form_update_settings_alter(array &$form, Fo
'#type' => 'radios',
'#title' => t('Automatically update Drupal core'),
'#options' => [
- CronUpdateStage::DISABLED => t('Disabled'),
- CronUpdateStage::ALL => t('All supported updates'),
- CronUpdateStage::SECURITY => t('Security updates only'),
+ UnattendedUpdateStageBase::DISABLED => t('Disabled'),
+ UnattendedUpdateStageBase::ALL => t('All supported updates'),
+ UnattendedUpdateStageBase::SECURITY => t('Security updates only'),
],
'#default_value' => \Drupal::config('automatic_updates.settings')->get('unattended.level'),
'#description' => t(
diff --git a/tests/src/Functional/AutomatedCronDisabledValidatorTest.php b/tests/src/Functional/AutomatedCronDisabledValidatorTest.php
index 41567a3bc7..8c2b31f6f1 100644
--- a/tests/src/Functional/AutomatedCronDisabledValidatorTest.php
+++ b/tests/src/Functional/AutomatedCronDisabledValidatorTest.php
@@ -2,7 +2,7 @@
namespace Drupal\Tests\automatic_updates\Functional;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
/**
* Tests that updates are not run by Automated Cron.
@@ -37,7 +37,7 @@ class AutomatedCronDisabledValidatorTest extends AutomaticUpdatesFunctionalTestB
// Delete the last cron run time, to ensure that Automated Cron will run.
$this->container->get('state')->delete('system.cron_last');
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
+ ->set('unattended.level', UnattendedUpdateStageBase::ALL)
->save();
$this->drupalGet('user');
diff --git a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
index f518f16a8d..95f5376026 100644
--- a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
+++ b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\fixture_manipulator\StageFixtureManipulator;
use Drupal\package_manager\PathLocator;
use Drupal\Tests\BrowserTestBase;
@@ -40,7 +40,7 @@ abstract class AutomaticUpdatesFunctionalTestBase extends BrowserTestBase {
$this->useFixtureDirectoryAsActive(__DIR__ . '/../../../package_manager/tests/fixtures/fake_site');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::SECURITY)
+ ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
->save();
}
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index e934646bd6..51e609f138 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -5,8 +5,8 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
use Behat\Mink\Element\NodeElement;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\automatic_updates_test_status_checker\EventSubscriber\TestSubscriber2;
@@ -375,7 +375,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// Confirm status check messages are not displayed when cron updates are
// disabled.
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::DISABLED)
+ ->set('unattended.level', UnattendedUpdateStageBase::DISABLED)
->save();
$this->drupalGet('admin/structure');
$this->checkForMetaRefresh();
@@ -399,7 +399,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->container->get('module_installer')->install(['automatic_updates', 'automatic_updates_test']);
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::SECURITY)
+ ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
->save();
$this->drupalGet('admin/reports/status');
$this->assertNoErrors(TRUE);
diff --git a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
index a6b45191d9..35cb0a688b 100644
--- a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
+++ b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
@@ -2,7 +2,7 @@
namespace Drupal\Tests\automatic_updates\FunctionalJavascript;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
/**
@@ -31,14 +31,14 @@ class UpdateSettingsFormTest extends WebDriverTestBase {
// The default values should be reflected.
$assert_session = $this->assertSession();
$assert_session->fieldValueEquals('unattended_method', 'web');
- $assert_session->fieldValueEquals('unattended_level', CronUpdateStage::DISABLED);
+ $assert_session->fieldValueEquals('unattended_level', UnattendedUpdateStageBase::DISABLED);
// Since unattended updates are disabled, the method radio buttons should be
// hidden.
$this->assertFalse($assert_session->fieldExists('unattended_method')->isVisible());
// Enabling unattended updates should reveal the method radio buttons.
$page = $this->getSession()->getPage();
- $page->selectFieldOption('unattended_level', CronUpdateStage::SECURITY);
+ $page->selectFieldOption('unattended_level', UnattendedUpdateStageBase::SECURITY);
$this->assertNotEmpty($assert_session->waitForElementVisible('named', ['field', 'unattended_method']));
$assert_session->elementAttributeContains('named', ['link', 'ensure cron is set up correctly'], 'href', 'http://drupal.org/docs/user_guide/en/security-cron.html');
// Change the method, to ensure it is properly saved in config.
@@ -47,10 +47,10 @@ class UpdateSettingsFormTest extends WebDriverTestBase {
// Ensure the changes are reflected in config.
$page->pressButton('Save configuration');
$config = $this->config('automatic_updates.settings');
- $this->assertSame(CronUpdateStage::SECURITY, $config->get('unattended.level'));
+ $this->assertSame(UnattendedUpdateStageBase::SECURITY, $config->get('unattended.level'));
$this->assertSame('console', $config->get('unattended.method'));
// Our saved changes should be reflected in the form too.
- $assert_session->fieldValueEquals('unattended_level', CronUpdateStage::SECURITY);
+ $assert_session->fieldValueEquals('unattended_level', UnattendedUpdateStageBase::SECURITY);
$assert_session->fieldValueEquals('unattended_method', 'console');
}
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 18772bd192..9d845b8733 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -6,6 +6,7 @@ namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates\UpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
@@ -57,7 +58,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
$this->config('automatic_updates.settings')
->set('unattended', [
'method' => 'web',
- 'level' => CronUpdateStage::SECURITY,
+ 'level' => UnattendedUpdateStageBase::SECURITY,
])
->save();
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 7d92c39d49..56ed800cc9 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -6,6 +6,7 @@ namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Logger\RfcLogLevel;
@@ -100,32 +101,32 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
return [
'disabled, normal release' => [
- CronUpdateStage::DISABLED,
+ UnattendedUpdateStageBase::DISABLED,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
FALSE,
],
'disabled, security release' => [
- CronUpdateStage::DISABLED,
+ UnattendedUpdateStageBase::DISABLED,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
FALSE,
],
'security only, security release' => [
- CronUpdateStage::SECURITY,
+ UnattendedUpdateStageBase::SECURITY,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
TRUE,
],
'security only, normal release' => [
- CronUpdateStage::SECURITY,
+ UnattendedUpdateStageBase::SECURITY,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
FALSE,
],
'enabled, normal release' => [
- CronUpdateStage::ALL,
+ UnattendedUpdateStageBase::ALL,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
TRUE,
],
'enabled, security release' => [
- CronUpdateStage::ALL,
+ UnattendedUpdateStageBase::ALL,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
TRUE,
],
@@ -265,7 +266,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->installConfig('automatic_updates');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::SECURITY)
+ ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
->save();
// Ensure that there is a security release to which we should update.
$this->setReleaseMetadata([
@@ -375,7 +376,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
*/
public function testStageNotDestroyedIfApplying(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
+ ->set('unattended.level', UnattendedUpdateStageBase::ALL)
->save();
$this->setReleaseMetadata([
'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml",
@@ -415,7 +416,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
*/
public function testStageNotDestroyedIfSecure(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
+ ->set('unattended.level', UnattendedUpdateStageBase::ALL)
->save();
$this->setReleaseMetadata([
'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml",
@@ -501,7 +502,7 @@ END;
'drupal' => __DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml',
]);
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
+ ->set('unattended.level', UnattendedUpdateStageBase::ALL)
->save();
$error = ValidationResult::createError([
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 4d9a8337df..9d9b2d5266 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
@@ -39,14 +39,14 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
*/
public function testNoValidationIfCronDisabled(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::DISABLED)
+ ->set('unattended.level', UnattendedUpdateStageBase::DISABLED)
->save();
$state = $this->container->get('state');
$state->delete('system.cron_last');
$state->delete('install_time');
$this->assertCheckerResultsFromManager([], TRUE);
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::ALL)
+ ->set('unattended.level', UnattendedUpdateStageBase::ALL)
->save();
$error = ValidationResult::createError([
t('Cron has not run recently. For more information, see the online handbook entry for <a href="https://www.drupal.org/cron">configuring cron jobs</a> to run at least every 3 hours.'),
diff --git a/tests/src/Kernel/StatusCheck/CronServerValidatorTest.php b/tests/src/Kernel/StatusCheck/CronServerValidatorTest.php
index 9c7fa9026c..cdf4cdc8fc 100644
--- a/tests/src/Kernel/StatusCheck/CronServerValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronServerValidatorTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates\Validator\CronServerValidator;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\Core\Url;
@@ -39,7 +39,7 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
]);
// Add all the test cases where there no expected results for all cron
// modes.
- foreach ([CronUpdateStage::DISABLED, CronUpdateStage::SECURITY, CronUpdateStage::ALL] as $cron_mode) {
+ foreach ([UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL] as $cron_mode) {
$test_cases["PHP server with alternate port, cron $cron_mode"] = [
TRUE,
'cli-server',
@@ -61,7 +61,7 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
}
// If the PHP server is used with the same port and cron is enabled an error
// will be flagged.
- foreach ([CronUpdateStage::SECURITY, CronUpdateStage::ALL] as $cron_mode) {
+ foreach ([UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL] as $cron_mode) {
$test_cases["PHP server with same port, cron $cron_mode"] = [
FALSE,
'cli-server',
@@ -72,7 +72,7 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
$test_cases["PHP server with same port, cron disabled"] = [
FALSE,
'cli-server',
- CronUpdateStage::DISABLED,
+ UnattendedUpdateStageBase::DISABLED,
[],
];
return $test_cases;
@@ -87,9 +87,9 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
* The value of the PHP_SAPI constant, as known to the validator.
* @param string $cron_mode
* The cron mode to test with. Can be any of
- * \Drupal\automatic_updates\CronUpdateStage::DISABLED,
- * \Drupal\automatic_updates\CronUpdateStage::SECURITY, or
- * \Drupal\automatic_updates\CronUpdateStage::ALL.
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, or
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
* @param \Drupal\package_manager\ValidationResult[] $expected_results
* The expected validation results.
*
@@ -99,7 +99,7 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
// If CronUpdateStage is disabled, a stage will never be created; nor will
// it if validation results happen before the stage is even created: in
// either case the stage fixture need not be manipulated.
- if ($cron_mode !== CronUpdateStage::DISABLED && empty($expected_results)) {
+ if ($cron_mode !== UnattendedUpdateStageBase::DISABLED && empty($expected_results)) {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
}
$request = $this->container->get('request_stack')->getCurrentRequest();
@@ -145,9 +145,9 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
* The value of the PHP_SAPI constant, as known to the validator.
* @param string $cron_mode
* The cron mode to test with. Can be any of
- * \Drupal\automatic_updates\CronUpdateStage::DISABLED,
- * \Drupal\automatic_updates\CronUpdateStage::SECURITY, or
- * \Drupal\automatic_updates\CronUpdateStage::ALL.
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, or
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
* @param \Drupal\package_manager\ValidationResult[] $expected_results
* The expected validation results.
*
@@ -156,7 +156,7 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
public function testCronServerValidationDuringPreApply(bool $alternate_port, string $server_api, string $cron_mode, array $expected_results): void {
// If CronUpdateStage is disabled, a stage will never be created, hence
// stage fixture need not be manipulated.
- if ($cron_mode !== CronUpdateStage::DISABLED) {
+ if ($cron_mode !== UnattendedUpdateStageBase::DISABLED) {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
}
$request = $this->container->get('request_stack')->getCurrentRequest();
@@ -206,9 +206,9 @@ class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
* The value of the PHP_SAPI constant, as known to the validator.
* @param string $cron_mode
* The cron mode to test with. Can contain be of
- * \Drupal\automatic_updates\CronUpdateStage::DISABLED,
- * \Drupal\automatic_updates\CronUpdateStage::SECURITY, or
- * \Drupal\automatic_updates\CronUpdateStage::ALL.
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, or
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
* @param \Drupal\package_manager\ValidationResult[] $expected_results
* The expected validation results.
*
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index c8917b7a36..bf5add5b40 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
@@ -44,12 +44,12 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
// If unattended updates are disabled, we should only see a warning from
// Package Manager.
- $config->set('unattended.level', CronUpdateStage::DISABLED)->save();
+ $config->set('unattended.level', UnattendedUpdateStageBase::DISABLED)->save();
$this->assertCheckerResultsFromManager([$warning_result], TRUE);
// The parent class' setUp() method simulates an available security update,
// so ensure that the cron update stage will try to update to it.
- $config->set('unattended.level', CronUpdateStage::SECURITY)->save();
+ $config->set('unattended.level', UnattendedUpdateStageBase::SECURITY)->save();
// If unattended updates are enabled, we should see an error from Automatic
// Updates.
@@ -77,7 +77,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
// The parent class' setUp() method simulates an available security
// update, so ensure that the cron update stage will try to update to it.
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::SECURITY)
+ ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
->save();
$logger = new TestLogger();
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
index 25ff4cdeaa..2322cba550 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
@@ -4,8 +4,8 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\Url;
@@ -55,7 +55,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesKernelTestBase {
$this->installConfig('automatic_updates');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::SECURITY)
+ ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
->save();
$this->setUpEmailRecipients();
@@ -214,7 +214,7 @@ END;
// If we disable unattended updates entirely and flag a new error, they
// should not be e-mailed.
- $config->set('unattended.level', CronUpdateStage::DISABLED)->save();
+ $config->set('unattended.level', UnattendedUpdateStageBase::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
$this->runCron();
@@ -222,7 +222,7 @@ END;
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
- $config->set('unattended.level', CronUpdateStage::ALL)->save();
+ $config->set('unattended.level', UnattendedUpdateStageBase::ALL)->save();
$this->runCron();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
index ba2f79a055..d1ef5c71cc 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates\UpdateStage;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\automatic_updates\Validator\StagedProjectsValidator;
@@ -211,7 +212,7 @@ class StatusCheckerTest extends AutomaticUpdatesKernelTestBase {
// By default, updates will be enabled on cron.
$this->assertInstanceOf(CronUpdateStage::class, $stage);
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateStage::DISABLED)
+ ->set('unattended.level', UnattendedUpdateStageBase::DISABLED)
->save();
$this->container->get(StatusChecker::class)->run();
$this->assertInstanceOf(UpdateStage::class, $stage);
diff --git a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
index a8e64641e8..2e0b5591dc 100644
--- a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates\UpdateStage;
use Drupal\fixture_manipulator\ActiveFixtureManipulator;
use Drupal\package_manager\Event\PreCreateEvent;
@@ -45,7 +46,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.1',
NULL,
"$metadata_dir/drupal.9.8.2.xml",
- [CronUpdateStage::DISABLED, CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[],
],
// These three cases prove that updating from an unsupported minor version
@@ -58,14 +59,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[],
],
'update from unsupported minor, cron enabled, minor updates forbidden' => [
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('See the <a href="/admin/reports/updates">available updates page</a> for available updates.'),
@@ -75,7 +76,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('Use the <a href="/admin/modules/update">update form</a> to update to a supported version.'),
@@ -102,7 +103,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::DISABLED, CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[],
],
// This case proves that updating from a dev snapshot is never allowed,
@@ -111,7 +112,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-dev',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::DISABLED, CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('Drupal cannot be automatically updated from the installed version, 9.8.0-dev, because automatic updates from a dev version to any other version are not supported.'),
],
@@ -122,14 +123,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-alpha1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[],
],
'alpha installed, cron enabled' => [
'9.8.0-alpha1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-alpha1, because it is not a stable version.'),
],
@@ -138,14 +139,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-beta2',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[],
],
'beta installed, cron enabled' => [
'9.8.0-beta2',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-beta2, because it is not a stable version.'),
],
@@ -154,14 +155,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-rc3',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[],
],
'rc installed, cron enabled' => [
'9.8.0-rc3',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-rc3, because it is not a stable version.'),
],
@@ -180,9 +181,9 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
* The path of the core release metadata to serve to the update system.
* @param string[] $cron_modes
* The modes for unattended updates. Can contain any of
- * \Drupal\automatic_updates\CronUpdateStage::DISABLED,
- * \Drupal\automatic_updates\CronUpdateStage::SECURITY, and
- * \Drupal\automatic_updates\CronUpdateStage::ALL.
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, and
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $expected_validation_messages
* The expected validation messages.
* @param bool $allow_minor_updates
@@ -229,21 +230,21 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[],
],
'update to beta, cron disabled' => [
'9.8.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[],
],
'update to rc, cron disabled' => [
'9.8.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[],
],
// This case proves that, if a stable release is installed, there is an
@@ -254,7 +255,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.1',
'9.8.2',
"$metadata_dir/drupal.9.8.2.xml",
- [CronUpdateStage::SECURITY],
+ [UnattendedUpdateStageBase::SECURITY],
[
t('Drupal cannot be automatically updated during cron from 9.8.1 to 9.8.2 because 9.8.2 is not a security release.'),
],
@@ -266,7 +267,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::SECURITY],
+ [UnattendedUpdateStageBase::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-alpha1, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-alpha1 because 9.8.1-alpha1 is not a security release.'),
@@ -276,7 +277,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::SECURITY],
+ [UnattendedUpdateStageBase::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-beta2, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-beta2 because 9.8.1-beta2 is not a security release.'),
@@ -286,7 +287,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::SECURITY],
+ [UnattendedUpdateStageBase::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-rc3, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-rc3 because 9.8.1-rc3 is not a security release.'),
@@ -299,7 +300,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::SECURITY],
+ [UnattendedUpdateStageBase::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-alpha1, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-alpha1 because automatic updates from one minor version to another are not supported during cron.'),
@@ -310,7 +311,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::SECURITY],
+ [UnattendedUpdateStageBase::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-beta2, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-beta2 because automatic updates from one minor version to another are not supported during cron.'),
@@ -321,7 +322,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateStage::SECURITY],
+ [UnattendedUpdateStageBase::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-rc3, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-rc3 because automatic updates from one minor version to another are not supported during cron.'),
@@ -339,7 +340,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::DISABLED],
+ [UnattendedUpdateStageBase::DISABLED],
[
t('Drupal cannot be automatically updated from 9.7.1 to 9.8.1 because automatic updates from one minor version to another are not supported.'),
],
@@ -348,7 +349,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('See the <a href="/admin/reports/updates">available updates page</a> for available updates.'),
@@ -359,7 +360,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
+ [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('Use the <a href="/admin/modules/update">update form</a> to update to a supported version.'),
@@ -381,9 +382,9 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
* The path of the core release metadata to serve to the update system.
* @param string[] $cron_modes
* The modes for unattended updates. Can contain any of
- * \Drupal\automatic_updates\CronUpdateStage::DISABLED,
- * \Drupal\automatic_updates\CronUpdateStage::SECURITY, and
- * \Drupal\automatic_updates\CronUpdateStage::ALL.
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, and
+ * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $expected_validation_messages
* The expected validation messages.
* @param bool $allow_minor_updates
--
GitLab
From 19a036e9b90708670e8c6071bf3acd8f30a39628 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 14:29:32 -0400
Subject: [PATCH 011/142] no longer need CronServerValidator
---
automatic_updates.module | 5 -
automatic_updates.services.yml | 4 -
src/Validator/CronServerValidator.php | 115 ---------
.../StatusCheck/CronServerValidatorTest.php | 235 ------------------
4 files changed, 359 deletions(-)
delete mode 100644 src/Validator/CronServerValidator.php
delete mode 100644 tests/src/Kernel/StatusCheck/CronServerValidatorTest.php
diff --git a/automatic_updates.module b/automatic_updates.module
index 8455aa1cac..87c511b76d 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -35,11 +35,6 @@ function automatic_updates_help($route_name, RouteMatchInterface $route_match) {
$output .= '<p>' . t('Additionally, Automatic Updates periodically runs checks to ensure that updates can be installed, and will warn site administrators if problems are detected.') . '</p>';
$output .= '<h3>' . t('Requirements') . '</h3>';
$output .= '<p>' . t('Automatic Updates requires a Composer executable whose version satisfies <code>@version</code>, and PHP must have permission to run it. The path to the executable may be set in the <code>package_manager.settings:executables.composer</code> config setting, or it will be automatically detected.', ['@version' => ComposerInspector::SUPPORTED_VERSION]) . '</p>';
- $output .= '<p id="cron-alternate-port">' . t('If your site is running on the built-in PHP web server, unattended (i.e., cron) updates may not work without one of the following workarounds:') . '</p>';
- $output .= '<ul>';
- $output .= '<li>' . t('Use a multithreaded web server, such as Apache, NGINX, or on Windows, IIS.') . '</li>';
- $output .= '<li>' . t('Run another instance of the built-in PHP web server on a different port and configure automatic updates accordingly: <code>$config["automatic_updates.settings"]["cron_port"] = $alternate_port_number;</code>') . '</li>';
- $output .= '</ul>';
$output .= '<p>' . t('For more information, see the <a href=":automatic-updates-documentation">online documentation for the Automatic Updates module</a>.', [':automatic-updates-documentation' => 'https://www.drupal.org/docs/8/update/automatic-updates']) . '</p>';
$output .= '<h3 id="minor-update">' . t('Updating to another minor version of Drupal') . '</h3>';
$output .= '<p>';
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 38bd8c4d9b..834c83b9c1 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -76,10 +76,6 @@ services:
tags:
- { name: event_subscriber }
Drupal\automatic_updates\Validator\VersionPolicyValidator: '@automatic_updates.validator.version_policy'
- automatic_updates.validator.cron_server:
- class: Drupal\automatic_updates\Validator\CronServerValidator
- tags:
- - { name: event_subscriber }
logger.channel.automatic_updates:
parent: logger.channel_base
arguments: ['automatic_updates']
diff --git a/src/Validator/CronServerValidator.php b/src/Validator/CronServerValidator.php
deleted file mode 100644
index 8f72078677..0000000000
--- a/src/Validator/CronServerValidator.php
+++ /dev/null
@@ -1,115 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\automatic_updates\Validator;
-
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\Extension\ModuleHandlerInterface;
-use Drupal\Core\StringTranslation\StringTranslationTrait;
-use Drupal\Core\Url;
-use Drupal\package_manager\Event\PreApplyEvent;
-use Drupal\package_manager\Event\PreCreateEvent;
-use Drupal\package_manager\Event\PreOperationStageEvent;
-use Drupal\package_manager\Event\StatusCheckEvent;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\HttpFoundation\RequestStack;
-
-/**
- * Validates that the current server configuration can run cron updates.
- *
- * @internal
- * This is an internal part of Automatic Updates and may be changed or removed
- * at any time without warning. External code should not interact with this
- * class.
- */
-final class CronServerValidator implements EventSubscriberInterface {
-
- use StringTranslationTrait;
-
- /**
- * The current request.
- *
- * @var \Symfony\Component\HttpFoundation\Request
- */
- protected $request;
-
- /**
- * The type of interface between the web server and the PHP runtime.
- *
- * @var string
- *
- * @see php_sapi_name()
- * @see https://www.php.net/manual/en/reserved.constants.php
- */
- protected static $serverApi = PHP_SAPI;
-
- /**
- * Constructs a CronServerValidator object.
- *
- * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
- * The request stack service.
- * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
- * The config factory service.
- * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
- * The module handler service.
- */
- public function __construct(
- RequestStack $request_stack,
- private readonly ConfigFactoryInterface $configFactory,
- private readonly ModuleHandlerInterface $moduleHandler,
- ) {
- $this->request = $request_stack->getCurrentRequest();
- }
-
- /**
- * Checks that the server is configured correctly to run cron updates.
- *
- * @param \Drupal\package_manager\Event\PreOperationStageEvent $event
- * The event object.
- */
- public function checkServer(PreOperationStageEvent $event): void {
- if (!$event->stage instanceof CronUpdateStage) {
- return;
- }
-
- $current_port = (int) $this->request->getPort();
-
- $alternate_port = $this->configFactory->get('automatic_updates.settings')
- ->get('cron_port');
- // If no alternate port is configured, it's the same as the current port.
- $alternate_port = intval($alternate_port) ?: $current_port;
-
- if (static::$serverApi === 'cli-server' && $current_port === $alternate_port) {
- $message = $this->t('Your site appears to be running on the built-in PHP web server on port @port. Drupal cannot be automatically updated with this configuration unless the site can also be reached on an alternate port.', [
- '@port' => $current_port,
- ]);
- if ($this->moduleHandler->moduleExists('help')) {
- $url = Url::fromRoute('help.page')
- ->setRouteParameter('name', 'automatic_updates')
- ->setOption('fragment', 'cron-alternate-port')
- ->toString();
-
- $message = $this->t('@message See <a href=":url">the Automatic Updates help page</a> for more information on how to resolve this.', [
- '@message' => $message,
- ':url' => $url,
- ]);
- }
-
- $event->addError([$message]);
- }
- }
-
- /**
- * {@inheritdoc}
- */
- public static function getSubscribedEvents(): array {
- return [
- PreCreateEvent::class => 'checkServer',
- PreApplyEvent::class => 'checkServer',
- StatusCheckEvent::class => 'checkServer',
- ];
- }
-
-}
diff --git a/tests/src/Kernel/StatusCheck/CronServerValidatorTest.php b/tests/src/Kernel/StatusCheck/CronServerValidatorTest.php
deleted file mode 100644
index cdf4cdc8fc..0000000000
--- a/tests/src/Kernel/StatusCheck/CronServerValidatorTest.php
+++ /dev/null
@@ -1,235 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
-use Drupal\automatic_updates\Validator\CronServerValidator;
-use Drupal\Core\Logger\RfcLogLevel;
-use Drupal\Core\Url;
-use Drupal\package_manager\ValidationResult;
-use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
-use ColinODell\PsrTestLogger\TestLogger;
-use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
-
-/**
- * @covers \Drupal\automatic_updates\Validator\CronServerValidator
- * @group automatic_updates
- * @internal
- */
-class CronServerValidatorTest extends AutomaticUpdatesKernelTestBase {
-
- use PackageManagerBypassTestTrait;
-
- /**
- * {@inheritdoc}
- */
- protected static $modules = ['automatic_updates'];
-
- /**
- * Data provider for ::testCronServerValidation().
- *
- * @return array[]
- * Sets of arguments to pass to the test method.
- */
- public function providerCronServerValidation(): array {
- $error = ValidationResult::createError([
- t('Your site appears to be running on the built-in PHP web server on port 80. Drupal cannot be automatically updated with this configuration unless the site can also be reached on an alternate port.'),
- ]);
- // Add all the test cases where there no expected results for all cron
- // modes.
- foreach ([UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL] as $cron_mode) {
- $test_cases["PHP server with alternate port, cron $cron_mode"] = [
- TRUE,
- 'cli-server',
- $cron_mode,
- [],
- ];
- $test_cases[" 'other server with alternate port, cron $cron_mode"] = [
- TRUE,
- 'nginx',
- $cron_mode,
- [],
- ];
- $test_cases["other server with same port, cron $cron_mode"] = [
- FALSE,
- 'nginx',
- $cron_mode,
- [],
- ];
- }
- // If the PHP server is used with the same port and cron is enabled an error
- // will be flagged.
- foreach ([UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL] as $cron_mode) {
- $test_cases["PHP server with same port, cron $cron_mode"] = [
- FALSE,
- 'cli-server',
- $cron_mode,
- [$error],
- ];
- }
- $test_cases["PHP server with same port, cron disabled"] = [
- FALSE,
- 'cli-server',
- UnattendedUpdateStageBase::DISABLED,
- [],
- ];
- return $test_cases;
- }
-
- /**
- * Tests server validation during pre-create for unattended updates.
- *
- * @param bool $alternate_port
- * Whether or not an alternate port should be set.
- * @param string $server_api
- * The value of the PHP_SAPI constant, as known to the validator.
- * @param string $cron_mode
- * The cron mode to test with. Can be any of
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, or
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
- * @param \Drupal\package_manager\ValidationResult[] $expected_results
- * The expected validation results.
- *
- * @dataProvider providerCronServerValidation
- */
- public function testCronServerValidationDuringPreCreate(bool $alternate_port, string $server_api, string $cron_mode, array $expected_results): void {
- // If CronUpdateStage is disabled, a stage will never be created; nor will
- // it if validation results happen before the stage is even created: in
- // either case the stage fixture need not be manipulated.
- if ($cron_mode !== UnattendedUpdateStageBase::DISABLED && empty($expected_results)) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- }
- $request = $this->container->get('request_stack')->getCurrentRequest();
- $this->assertNotEmpty($request);
- $this->assertSame(80, $request->getPort());
-
- $property = new \ReflectionProperty(CronServerValidator::class, 'serverApi');
- $property->setAccessible(TRUE);
- $property->setValue(NULL, $server_api);
-
- $this->config('automatic_updates.settings')
- ->set('unattended.level', $cron_mode)
- ->set('cron_port', $alternate_port ? 2501 : 0)
- ->save();
-
- $this->assertCheckerResultsFromManager($expected_results, TRUE);
-
- $logger = new TestLogger();
- $this->container->get('logger.factory')
- ->get('automatic_updates')
- ->addLogger($logger);
-
- // If errors were expected, cron should not have run.
- $this->container->get('cron')->run();
- if ($expected_results) {
- // Assert the update was not staged to ensure the error was flagged in
- // PreCreateEvent and not PreApplyEvent.
- $this->assertUpdateStagedTimes(0);
- $error = $this->createStageEventExceptionFromResults($expected_results);
- $this->assertTrue($logger->hasRecord($error->getMessage(), (string) RfcLogLevel::ERROR));
- }
- else {
- $this->assertFalse($logger->hasRecords((string) RfcLogLevel::ERROR));
- }
- }
-
- /**
- * Tests server validation during pre-apply for unattended updates.
- *
- * @param bool $alternate_port
- * Whether or not an alternate port should be set.
- * @param string $server_api
- * The value of the PHP_SAPI constant, as known to the validator.
- * @param string $cron_mode
- * The cron mode to test with. Can be any of
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, or
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
- * @param \Drupal\package_manager\ValidationResult[] $expected_results
- * The expected validation results.
- *
- * @dataProvider providerCronServerValidation
- */
- public function testCronServerValidationDuringPreApply(bool $alternate_port, string $server_api, string $cron_mode, array $expected_results): void {
- // If CronUpdateStage is disabled, a stage will never be created, hence
- // stage fixture need not be manipulated.
- if ($cron_mode !== UnattendedUpdateStageBase::DISABLED) {
- $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- }
- $request = $this->container->get('request_stack')->getCurrentRequest();
- $this->assertNotEmpty($request);
- $this->assertSame(80, $request->getPort());
-
- $logger = new TestLogger();
- $this->container->get('logger.factory')
- ->get('automatic_updates')
- ->addLogger($logger);
-
- $this->config('automatic_updates.settings')
- ->set('unattended.level', $cron_mode)
- ->save();
-
- // Add a listener to change the $server_api and $alternate_port settings
- // during PreApplyEvent. We set $cron_mode above because this determines
- // whether updates will actually be run in cron.
- $this->addEventTestListener(
- function () use ($alternate_port, $server_api): void {
- $property = new \ReflectionProperty(CronServerValidator::class, 'serverApi');
- $property->setAccessible(TRUE);
- $property->setValue(NULL, $server_api);
- $this->config('automatic_updates.settings')
- ->set('cron_port', $alternate_port ? 2501 : 0)
- ->save();
- }
- );
- // If errors were expected, cron should not have run.
- $this->container->get('cron')->run();
- if ($expected_results) {
- $this->assertUpdateStagedTimes(1);
- $error = $this->createStageEventExceptionFromResults($expected_results);
- $this->assertTrue($logger->hasRecord($error->getMessage(), (string) RfcLogLevel::ERROR));
- }
- else {
- $this->assertFalse($logger->hasRecords((string) RfcLogLevel::ERROR));
- }
- }
-
- /**
- * Tests server validation for unattended updates with Help enabled.
- *
- * @param bool $alternate_port
- * Whether or not an alternate port should be set.
- * @param string $server_api
- * The value of the PHP_SAPI constant, as known to the validator.
- * @param string $cron_mode
- * The cron mode to test with. Can contain be of
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, or
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
- * @param \Drupal\package_manager\ValidationResult[] $expected_results
- * The expected validation results.
- *
- * @dataProvider providerCronServerValidation
- */
- public function testHelpLink(bool $alternate_port, string $server_api, string $cron_mode, array $expected_results): void {
- $this->enableModules(['help']);
-
- $url = Url::fromRoute('help.page')
- ->setRouteParameter('name', 'automatic_updates')
- ->setOption('fragment', 'cron-alternate-port')
- ->toString();
-
- foreach ($expected_results as $i => $result) {
- $messages = [];
- foreach ($result->messages as $message) {
- $messages[] = t('@message See <a href=":url">the Automatic Updates help page</a> for more information on how to resolve this.', ['@message' => $message, ':url' => $url]);
- }
- $expected_results[$i] = ValidationResult::createError($messages);
- }
- $this->testCronServerValidationDuringPreApply($alternate_port, $server_api, $cron_mode, $expected_results);
- }
-
-}
--
GitLab
From 9b67db9f2476a9776b36c5f4a3a9fc4e8865513a Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 14 Jun 2023 14:48:49 -0400
Subject: [PATCH 012/142] remove hook_cron
---
automatic_updates.module | 44 ----------------------------------------
1 file changed, 44 deletions(-)
diff --git a/automatic_updates.module b/automatic_updates.module
index 87c511b76d..9235d8e1d6 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -157,50 +157,6 @@ function automatic_updates_module_implements_alter(&$implementations, $hook) {
}
}
-/**
- * Implements hook_cron().
- */
-function automatic_updates_cron() {
- // @todo Refactor this after https://www.drupal.org/project/drupal/issues/2538292
- // @todo Remove this after https://www.drupal.org/project/drupal/issues/3318964
- // We don't want to run status checks if we're on the command line, because
- // if unattended updates are configured to run via the web, running status
- // checks on the command line could cause invalid results to get cached.
- if (defined('MAINTENANCE_MODE') || stripos($_SERVER['PHP_SELF'], 'update.php') !== FALSE || CronUpdateStage::isCommandLine()) {
- return;
- }
-
- /** @var \Drupal\automatic_updates\Validator\AutomatedCronDisabledValidator $automated_cron_validator */
- $automated_cron_validator = \Drupal::service(AutomatedCronDisabledValidator::class);
- if ($automated_cron_validator->hasTerminateBeenCalled()) {
- // Running updates and status checks will not work during kernel
- // termination.
- \Drupal::logger('automatic_updates')
- ->info('Unattended automatic updates were triggered by Automated Cron, which is not supported. No update was performed. See the <a href=":url">status report</a> for more information.', [
- ':url' => Url::fromRoute('system.status')->toString(),
- ]);
- return;
- }
-
- /** @var \Drupal\automatic_updates\Validation\StatusChecker $status_checker */
- $status_checker = \Drupal::service('automatic_updates.status_checker');
- $last_results = $status_checker->getResults();
- $last_run_time = $status_checker->getLastRunTime();
- // Do not run status checks more than once an hour unless there are no results
- // available.
- if ($last_results === NULL || !$last_run_time || \Drupal::time()->getRequestTime() - $last_run_time > 3600) {
- $status_checker->run();
- }
-
- // Only try to send failure notifications if unattended updates are enabled.
- /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
- $stage = \Drupal::service('automatic_updates.cron_update_stage');
- if ($stage->getMode() !== UnattendedUpdateStageBase::DISABLED) {
- \Drupal::service('automatic_updates.status_check_mailer')
- ->sendFailureNotifications($last_results, $status_checker->getResults());
- }
-}
-
/**
* Implements hook_modules_installed().
*/
--
GitLab
From d09658382fcf626a80a3f8b1768e29667a118ec7 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 15 Jun 2023 13:33:11 -0400
Subject: [PATCH 013/142] remove hook_cron reorder
---
automatic_updates.module | 5 -----
1 file changed, 5 deletions(-)
diff --git a/automatic_updates.module b/automatic_updates.module
index 9235d8e1d6..8c35642e44 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -150,11 +150,6 @@ function automatic_updates_module_implements_alter(&$implementations, $hook) {
// own routes to avoid these messages while an update is in progress.
unset($implementations['update']);
}
- if ($hook === 'cron') {
- $hook = $implementations['automatic_updates'];
- unset($implementations['automatic_updates']);
- $implementations['automatic_updates'] = $hook;
- }
}
/**
--
GitLab
From 4845c64d58b123c28c7fa0d99c0f5671273828c9 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 15 Jun 2023 13:33:45 -0400
Subject: [PATCH 014/142] more debug
---
package_manager/src/Debugger.php | 22 +++++++++++++++++++
.../src/Build/TemplateProjectTestBase.php | 11 ++++++++--
src/Commands/AutomaticUpdatesCommands.php | 8 ++++++-
src/CronUpdateStage.php | 16 ++++++++++++--
tests/src/Build/CoreUpdateTest.php | 8 ++++++-
5 files changed, 59 insertions(+), 6 deletions(-)
create mode 100644 package_manager/src/Debugger.php
diff --git a/package_manager/src/Debugger.php b/package_manager/src/Debugger.php
new file mode 100644
index 0000000000..097e3e808f
--- /dev/null
+++ b/package_manager/src/Debugger.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Drupal\package_manager;
+
+class Debugger {
+
+ public static function debugOutput($value, $label = NULL, $flags = FILE_APPEND) {
+ if (is_bool($value)) {
+ $value = $value ? 'TRUE' : 'FALSE';
+ }
+ elseif ($value instanceof \Throwable) {
+ $value = 'Msg: ' . $value->getMessage() . '- trace ' . $value->getTraceAsString();
+ }
+ else {
+ $value = print_r($value, TRUE);
+ }
+ if ($label) {
+ $value = "$label: $value";
+ }
+ file_put_contents("/Users/ted.bowman/sites/debug.txt", "\n$value", $flags);
+ }
+}
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index 317a8173da..f06e70667c 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -559,7 +559,7 @@ END;
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
- protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL): void {
+ protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL, bool $allow_additional_events = FALSE): void {
if ($expected_events === NULL) {
$expected_events = [
PreCreateEvent::class,
@@ -584,6 +584,7 @@ END;
$page = $this->getMink()->getSession()->getPage();
$this->visit('/admin/reports/dblog');
$assert_session->statusCodeEquals(200);
+ file_put_contents("/Users/ted.bowman/sites/dblog.html", $page->getContent());
$page->selectFieldOption('Type', 'package_manager_test_event_logger');
$page->pressButton('Filter');
$assert_session->statusCodeEquals(200);
@@ -601,7 +602,13 @@ END;
foreach ($expected_events as $event) {
$expected_titles[] = "package_manager_test_event_logger-start: Event: $event, Stage instance of: $expected_stage_class:package_manager_test_event_logger-end";
}
- $this->assertSame($expected_titles, $actual_titles, $message ?? '');
+ if (!$allow_additional_events) {
+ $this->assertSame($expected_titles, $actual_titles, $message ?? '');
+ }
+ else {
+ $this->assertEmpty(array_diff($expected_titles, $actual_titles), $message ?? '');
+ }
+
}
/**
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 4646cde772..f40084ff49 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -8,6 +8,7 @@ use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\package_manager\Debugger;
use Drush\Commands\DrushCommands;
/**
@@ -60,6 +61,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL]) {
$io = $this->io();
+ Debugger::debugOutput('Drush command started');
// The second half of the update process (post-apply etc.) is done by this
// exact same command, with some additional flags, in a separate process to
@@ -79,16 +81,20 @@ final class AutomaticUpdatesCommands extends DrushCommands {
else {
if ($this->stage->getMode() === DrushUpdateStage::DISABLED) {
$io->error('Automatic updates are disabled.');
+ Debugger::debugOutput('disabled');
return;
}
$release = $this->stage->getTargetRelease();
if ($release) {
+ Debugger::debugOutput('release -' . $release->getVersion());
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
$io->info($message);
- $this->stage->performUpdate($release->getVersion(), 300);
+ $this->stage->performUpdate();
+ Debugger::debugOutput('peformed');
}
else {
+ Debugger::debugOutput('no update');
$io->info("There is no Drupal core update available.");
$this->runStatusChecks();
}
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index efa604d1fd..d4e33e9814 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -11,12 +11,14 @@ use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\TempStore\SharedTempStoreFactory;
use Drupal\Core\Utility\Error;
use Drupal\package_manager\ComposerInspector;
+use Drupal\package_manager\Debugger;
use Drupal\package_manager\FailureMarker;
use Drupal\package_manager\PathLocator;
use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
use PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface;
use PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface;
use PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface;
+use Symfony\Component\Process\PhpExecutableFinder;
use Symfony\Component\Process\Process;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
@@ -91,13 +93,21 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// @todo Replace drush call with Symfony console command in
// https://www.drupal.org/i/3360485
$drush_path = $this->pathLocator->getVendorDirectory() . '/bin/drush';
- $process = new Process([$drush_path, 'auto-update']);
+ $phpBinaryFinder = new PhpExecutableFinder();
+ $process = new Process([$phpBinaryFinder->find(), $drush_path, 'auto-update', '&']);
+ $process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
+ $process->disableOutput();
+ $process->setTimeout(0);
try {
+ Debugger::debugOutput('start process');
$process->start();
+ sleep(5);
+ Debugger::debugOutput('process started');
}
catch (\Throwable $throwable) {
// @todo Does this work 10.0.x?
Error::logException($this->logger, $throwable, 'Could not perform background update.');
+ Debugger::debugOutput($throwable, 'Could not perform background update.');
}
}
@@ -124,12 +134,14 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// Always run the cron service before we trigger the update terminal
// command.
$inner_success = $this->inner->run();
+ Debugger::debugOutput('ran cron');
// If we are configured to run updates via the web, and we're actually being
// accessed via the web (i.e., anything that isn't the command line), go
// ahead and try to do the update. In all other circumstances, just run the
// normal cron handler.
- if ($this->getMode() !== self::DISABLED && $method === 'web' && !self::isCommandLine()) {
+ if ($this->getMode() !== self::DISABLED && $method === 'web') {
+ Debugger::debugOutput('running terminal');
$this->runTerminalUpdateCommand();
}
return $inner_success;
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 8bffd57934..eb4c7ffda8 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -17,6 +17,7 @@ use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Event\PreDestroyEvent;
use Drupal\package_manager\Event\PreRequireEvent;
use Drupal\Tests\WebAssert;
+use Drush\Drush;
use Symfony\Component\Process\Process;
/**
@@ -172,6 +173,7 @@ class CoreUpdateTest extends UpdateTestBase {
*/
public function testCron(string $template): void {
$this->createTestProject($template);
+ $this->runComposer('composer require drush/drush', 'project');
$this->visit('/admin/reports/status');
$mink = $this->getMink();
@@ -179,7 +181,11 @@ class CoreUpdateTest extends UpdateTestBase {
$assert_session = $mink->assertSession();
$page->clickLink('Run cron');
$cron_run_status_code = $mink->getSession()->getStatusCode();
- $this->assertExpectedStageEventsFired(CronUpdateStage::class);
+ // Wait for update to start.
+ sleep(2);
+ $this->visit('/admin/reports/dblog');
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class, [PreCreateEvent::class], 'Update has not started after a wait.', TRUE);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class);
$this->assertSame(200, $cron_run_status_code);
// There should be log messages, but no errors or warnings should have been
--
GitLab
From 7858e6804740350e4d9393490a5a602a96a6831e Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 15 Jun 2023 14:40:41 -0400
Subject: [PATCH 015/142] run process directly and wait for testing
---
package_manager/src/Debugger.php | 1 +
src/CronUpdateStage.php | 12 ++++++------
tests/src/Build/CoreUpdateTest.php | 2 ++
3 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/package_manager/src/Debugger.php b/package_manager/src/Debugger.php
index 097e3e808f..492f88faf1 100644
--- a/package_manager/src/Debugger.php
+++ b/package_manager/src/Debugger.php
@@ -5,6 +5,7 @@ namespace Drupal\package_manager;
class Debugger {
public static function debugOutput($value, $label = NULL, $flags = FILE_APPEND) {
+ file_put_contents("/Users/ted.bowman/sites/debug.txt", "\n***", $flags);
if (is_bool($value)) {
$value = $value ? 'TRUE' : 'FALSE';
}
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index d4e33e9814..ef39feb459 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -92,21 +92,21 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// background updates.
// @todo Replace drush call with Symfony console command in
// https://www.drupal.org/i/3360485
- $drush_path = $this->pathLocator->getVendorDirectory() . '/bin/drush';
+ // @todo Why isn't it in vendor bin?
+ $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
$phpBinaryFinder = new PhpExecutableFinder();
$process = new Process([$phpBinaryFinder->find(), $drush_path, 'auto-update', '&']);
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- $process->disableOutput();
+ //$process->disableOutput();
$process->setTimeout(0);
try {
- Debugger::debugOutput('start process');
- $process->start();
- sleep(5);
- Debugger::debugOutput('process started');
+ $process->mustRun();
}
catch (\Throwable $throwable) {
// @todo Does this work 10.0.x?
Error::logException($this->logger, $throwable, 'Could not perform background update.');
+ Debugger::debugOutput($process->getErrorOutput(), 'process error');
+ Debugger::debugOutput($process->getOutput(), 'process output');
Debugger::debugOutput($throwable, 'Could not perform background update.');
}
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index eb4c7ffda8..9a2b7ef4e6 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -28,6 +28,8 @@ use Symfony\Component\Process\Process;
*/
class CoreUpdateTest extends UpdateTestBase {
+ protected $destroyBuild = FALSE;
+
/**
* WebAssert object.
*
--
GitLab
From 41a5535db80bd91da0e7af3a432cbfd87d7263f0 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 16 Jun 2023 15:39:42 -0400
Subject: [PATCH 016/142] very rough but able to do manual background update
---
automatic_updates.module | 2 --
package_manager/src/Debugger.php | 5 ++--
src/Commands/AutomaticUpdatesCommands.php | 20 ++++++++++++-
src/CronUpdateStage.php | 13 +++++----
.../automatic_updates_test_api.routing.yml | 9 ++++++
.../src/ApiController.php | 29 +++++++++++++++++++
tests/src/Build/CoreUpdateTest.php | 2 --
7 files changed, 68 insertions(+), 12 deletions(-)
diff --git a/automatic_updates.module b/automatic_updates.module
index 8c35642e44..2e3120d330 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -8,9 +8,7 @@
declare(strict_types = 1);
use Drupal\automatic_updates\BatchProcessor;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\UnattendedUpdateStageBase;
-use Drupal\automatic_updates\Validator\AutomatedCronDisabledValidator;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\automatic_updates\Validation\AdminStatusCheckMessages;
diff --git a/package_manager/src/Debugger.php b/package_manager/src/Debugger.php
index 492f88faf1..8ac143de18 100644
--- a/package_manager/src/Debugger.php
+++ b/package_manager/src/Debugger.php
@@ -5,7 +5,7 @@ namespace Drupal\package_manager;
class Debugger {
public static function debugOutput($value, $label = NULL, $flags = FILE_APPEND) {
- file_put_contents("/Users/ted.bowman/sites/debug.txt", "\n***", $flags);
+ file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n***", $flags);
if (is_bool($value)) {
$value = $value ? 'TRUE' : 'FALSE';
}
@@ -18,6 +18,7 @@ class Debugger {
if ($label) {
$value = "$label: $value";
}
- file_put_contents("/Users/ted.bowman/sites/debug.txt", "\n$value", $flags);
+ file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n$value", $flags);
}
+
}
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index f40084ff49..6964cfeece 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -61,7 +61,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL]) {
$io = $this->io();
- Debugger::debugOutput('Drush command started');
+ Debugger::debugOutput('Drush command started2');
// The second half of the update process (post-apply etc.) is done by this
// exact same command, with some additional flags, in a separate process to
@@ -116,4 +116,22 @@ final class AutomaticUpdatesCommands extends DrushCommands {
}
}
+ /**
+ * Temp test to confirm the detached process would still run.
+ *
+ * @usage test-process
+ * Automatically updates Drupal core, if any updates are available.
+ *
+ * @command test-process
+ */
+ public function testProcess() {
+ $c = 0;
+ while ($c < 10) {
+ $c++;
+ Debugger::debugOutput("output $c");
+ sleep(1);
+ }
+ Debugger::debugOutput("output done");
+ }
+
}
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index ef39feb459..d449642cc8 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -95,18 +95,21 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// @todo Why isn't it in vendor bin?
$drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
$phpBinaryFinder = new PhpExecutableFinder();
- $process = new Process([$phpBinaryFinder->find(), $drush_path, 'auto-update', '&']);
- $process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- //$process->disableOutput();
+ $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
+ // Temporary command to test detached process still runs after response.
+ // $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path test-process &");
+ $process->setworkingdirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
+ $process->disableOutput();
$process->setTimeout(0);
try {
- $process->mustRun();
+ Debugger::debugOutput('before start:' . $process->getCommandLine());
+ $process->start();
+ Debugger::debugOutput('after start');
}
catch (\Throwable $throwable) {
// @todo Does this work 10.0.x?
Error::logException($this->logger, $throwable, 'Could not perform background update.');
Debugger::debugOutput($process->getErrorOutput(), 'process error');
- Debugger::debugOutput($process->getOutput(), 'process output');
Debugger::debugOutput($throwable, 'Could not perform background update.');
}
}
diff --git a/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml b/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
index 821c91b431..5871d29662 100644
--- a/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
+++ b/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
@@ -12,3 +12,12 @@ automatic_updates_test_api.finish:
_controller: 'Drupal\automatic_updates_test_api\ApiController::finish'
requirements:
_access: 'TRUE'
+automatic_updates_test_api.test:
+ path: '/tester-drush'
+ defaults:
+ _controller: 'Drupal\automatic_updates_test_api\ApiController::testProcess'
+ requirements:
+ _access: 'TRUE'
+ options:
+ _maintenance_access: TRUE
+ no_cache: TRUE
diff --git a/tests/modules/automatic_updates_test_api/src/ApiController.php b/tests/modules/automatic_updates_test_api/src/ApiController.php
index 5790f3adeb..c924a5641f 100644
--- a/tests/modules/automatic_updates_test_api/src/ApiController.php
+++ b/tests/modules/automatic_updates_test_api/src/ApiController.php
@@ -4,9 +4,12 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates_test_api;
+use Drupal\package_manager\Debugger;
use Drupal\package_manager_test_api\ApiController as PackageManagerApiController;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Process\PhpExecutableFinder;
+use Symfony\Component\Process\Process;
class ApiController extends PackageManagerApiController {
@@ -35,4 +38,30 @@ class ApiController extends PackageManagerApiController {
return $id;
}
+ public function testProcess(): array {
+ $path_locator = \Drupal::service('package_manager.path_locator');
+ $drush_path = $path_locator->getVendorDirectory() . '/drush/drush/drush';
+ $phpBinaryFinder = new PhpExecutableFinder();
+ sleep(5);
+ $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
+ // $process = new Process([$phpBinaryFinder->find(), $drush_path, 'auto-update', '&']);
+ $process->setWorkingDirectory($path_locator->getProjectRoot() . DIRECTORY_SEPARATOR . $path_locator->getWebRoot());
+ $process->disableOutput();
+ $process->setTimeout(0);
+ try {
+ $process->start();
+ }
+ catch (\Throwable $throwable) {
+ // @todo Does this work 10.0.x?
+ watchdog_exception('auto_updates', $throwable, 'Could not perform background update.');
+ Debugger::debugOutput($process->getErrorOutput(), 'process error');
+ Debugger::debugOutput($process->getOutput(), 'process output');
+ Debugger::debugOutput($throwable, 'Could not perform background update.');
+ }
+ return [
+ '#type' => 'markup',
+ '#markup' => time(),
+ ];
+ }
+
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 9a2b7ef4e6..7b522ee6a4 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -6,7 +6,6 @@ namespace Drupal\Tests\automatic_updates\Build;
use Behat\Mink\Element\DocumentElement;
use Drupal\automatic_updates\DrushUpdateStage;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
@@ -17,7 +16,6 @@ use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Event\PreDestroyEvent;
use Drupal\package_manager\Event\PreRequireEvent;
use Drupal\Tests\WebAssert;
-use Drush\Drush;
use Symfony\Component\Process\Process;
/**
--
GitLab
From 388a0caec9757848f68650f7e66311122e1d88a8 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 20 Jun 2023 09:13:18 -0400
Subject: [PATCH 017/142] more debugging
---
tests/src/Build/CoreUpdateTest.php | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 7b522ee6a4..0982f1a2fe 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -7,6 +7,7 @@ namespace Drupal\Tests\automatic_updates\Build;
use Behat\Mink\Element\DocumentElement;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
+use Drupal\package_manager\Debugger;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
use Drupal\package_manager\Event\PostDestroyEvent;
@@ -179,12 +180,17 @@ class CoreUpdateTest extends UpdateTestBase {
$mink = $this->getMink();
$page = $mink->getSession()->getPage();
$assert_session = $mink->assertSession();
+ touch("/Users/ted.bowman/sites/stop.txt");
+ while(file_exists("/Users/ted.bowman/sites/stop.txt")) {
+ Debugger::debugOutput('wait deleting 88');
+ sleep(1);
+ }
$page->clickLink('Run cron');
$cron_run_status_code = $mink->getSession()->getStatusCode();
// Wait for update to start.
- sleep(2);
- $this->visit('/admin/reports/dblog');
- $this->assertExpectedStageEventsFired(DrushUpdateStage::class, [PreCreateEvent::class], 'Update has not started after a wait.', TRUE);
+ Debugger::debugOutput('sleeing 180');
+ sleep(180);
+ Debugger::debugOutput('slept 180');
$this->assertExpectedStageEventsFired(DrushUpdateStage::class);
$this->assertSame(200, $cron_run_status_code);
--
GitLab
From 539ecc6964530926f1651738ea7d3f8c815d9451 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 20 Jun 2023 11:51:31 -0400
Subject: [PATCH 018/142] watchdog_exception to be bc
---
src/CronUpdateStage.php | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index d449642cc8..07b71e9df1 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -107,8 +107,7 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
Debugger::debugOutput('after start');
}
catch (\Throwable $throwable) {
- // @todo Does this work 10.0.x?
- Error::logException($this->logger, $throwable, 'Could not perform background update.');
+ watchdog_exception('automatic_updates', $throwable, 'affff');
Debugger::debugOutput($process->getErrorOutput(), 'process error');
Debugger::debugOutput($throwable, 'Could not perform background update.');
}
--
GitLab
From 4f0902af1fb48722e5f850f66389ca7951404de3 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 20 Jun 2023 13:27:27 -0400
Subject: [PATCH 019/142] wait for process to start
---
src/CronUpdateStage.php | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 07b71e9df1..b60e3f9c30 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -104,6 +104,11 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
try {
Debugger::debugOutput('before start:' . $process->getCommandLine());
$process->start();
+ sleep(1);
+ $wait_till = time() + 5;
+ // Wait for the process to start.
+ while (is_null($process->getPid()) && $wait_till > time()) {
+ }
Debugger::debugOutput('after start');
}
catch (\Throwable $throwable) {
--
GitLab
From 97a7eccbd7ffe3a8e3aae922359cacaba050d1bb Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Mon, 26 Jun 2023 15:02:09 -0400
Subject: [PATCH 020/142] git repair
---
src/CronUpdateStage.php | 273 +++-------------------
src/DrushUpdateStage.php | 34 +--
tests/src/Kernel/DrushUpdateStageTest.php | 34 ++-
3 files changed, 86 insertions(+), 255 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 9d43a84792..afa46475cb 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -9,7 +9,6 @@ use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\TempStore\SharedTempStoreFactory;
-use Drupal\Core\Utility\Error;
use Drupal\package_manager\ComposerInspector;
use Drupal\package_manager\Debugger;
use Drupal\package_manager\FailureMarker;
@@ -95,22 +94,47 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// @todo Why isn't it in vendor bin?
$drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
$phpBinaryFinder = new PhpExecutableFinder();
+ // Test generic drush output
+ $drush_check = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path");
+ $cwd = $this->pathLocator->getProjectRoot();
+
+ if ($web_root = $this->pathLocator->getWebRoot()) {
+ $cwd .= DIRECTORY_SEPARATOR . $web_root;
+ }
+
+ $cwd .= DIRECTORY_SEPARATOR . 'sites/default';
+ $drush_check->setWorkingDirectory($cwd);
+ Debugger::debugOutput('drush check cmd: ' . $drush_check->getCommandLine());
+
+ try {
+ $drush_check->mustRun();
+ Debugger::debugOutput("drush check: " . $drush_check->getOutput());
+ }
+ catch (\Throwable $throwable) {
+ Debugger::debugOutput('drush check throw: ' . $throwable->getMessage() . " - " . $throwable->getTraceAsString());
+ Debugger::debugOutput("drush check error: " . $drush_check->getErrorOutput());
+ Debugger::debugOutput("drush check error output: " . $drush_check->getOutput());
+ }
+
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
// Temporary command to test detached process still runs after response.
- // $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path test-process &");
+ //$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path test-process &");
$process->setworkingdirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- $process->disableOutput();
+ //$process->disableOutput();
$process->setTimeout(0);
+
try {
Debugger::debugOutput('before start:' . $process->getCommandLine());
$process->start();
+ Debugger::debugOutput('Process out: ' . $process->getOutput());
sleep(1);
$wait_till = time() + 5;
- // Wait for the process to start.
+ //Wait for the process to start.
while (is_null($process->getPid()) && $wait_till > time()) {
}
Debugger::debugOutput('after start');
}
+
catch (\Throwable $throwable) {
watchdog_exception('automatic_updates', $throwable, 'affff');
Debugger::debugOutput($process->getErrorOutput(), 'process error');
@@ -133,236 +157,6 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
}
/**
-<<<<<<< HEAD
-=======
- * Performs the update.
- *
- * @param string $target_version
- * The target version of Drupal core.
- * @param int|null $timeout
- * How long to allow the operation to run before timing out, in seconds, or
- * NULL to never time out.
- *
- * @return bool
- * Returns TRUE if any update was attempted, otherwise FALSE.
- */
- protected function performUpdate(string $target_version, ?int $timeout): bool {
- $project_info = new ProjectInfo('drupal');
- $update_started = FALSE;
-
- if (!$this->isAvailable()) {
- if ($project_info->isInstalledVersionSafe() && !$this->isApplying()) {
- $this->logger->notice('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.');
- return $update_started;
- }
- if (!$project_info->isInstalledVersionSafe() && $this->isApplying()) {
- $this->logger->notice(
- 'Cron will not perform any updates as an existing staged update is applying. The site is currently on an insecure version of Drupal core but will attempt to update to a secure version next time cron is run. This update may be applied manually at the <a href="%url">update form</a>.',
- ['%url' => Url::fromRoute('update.report_update')->setAbsolute()->toString()],
- );
- return $update_started;
- }
- }
-
- // Delete the existing staging area if not available and the site is
- // currently on an insecure version.
- if (!$project_info->isInstalledVersionSafe() && !$this->isAvailable() && !$this->isApplying()) {
- $destroy_message = $this->t('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
- $this->destroy(TRUE, $destroy_message);
- $this->logger->notice($destroy_message->getUntranslatedString());
- }
-
- $installed_version = $project_info->getInstalledVersion();
- if (empty($installed_version)) {
- $this->logger->error('Unable to determine the current version of Drupal core.');
- return $update_started;
- }
-
- // Do the bulk of the update in its own try-catch structure, so that we can
- // handle any exceptions or validation errors consistently, and destroy the
- // stage regardless of whether the update succeeds.
- try {
- $update_started = TRUE;
- // @see ::begin()
- $stage_id = parent::begin(['drupal' => $target_version], $timeout);
- $this->stage();
- $this->apply();
- }
- catch (\Throwable $e) {
- if ($e instanceof StageEventException && $e->event instanceof PreCreateEvent) {
- // If the error happened during PreCreateEvent then the update did not
- // really start.
- $update_started = FALSE;
- }
- // Send notifications about the failed update.
- $mail_params = [
- 'previous_version' => $installed_version,
- 'target_version' => $target_version,
- 'error_message' => $e->getMessage(),
- ];
- // Omit the backtrace in e-mails. That will be visible on the site, and is
- // also stored in the failure marker.
- if ($e instanceof StageFailureMarkerException || $e instanceof ApplyFailedException) {
- $mail_params['error_message'] = $this->failureMarker->getMessage(FALSE);
- }
- if ($e instanceof ApplyFailedException) {
- $mail_params['urgent'] = TRUE;
- $key = 'cron_failed_apply';
- }
- elseif (!$project_info->isInstalledVersionSafe()) {
- $mail_params['urgent'] = TRUE;
- $key = 'cron_failed_insecure';
- }
- else {
- $mail_params['urgent'] = FALSE;
- $key = 'cron_failed';
- }
-
- foreach ($this->statusCheckMailer->getRecipients() as $email => $langcode) {
- $this->mailManager->mail('automatic_updates', $key, $email, $langcode, $mail_params);
- }
- $this->logger->error($e->getMessage());
-
- // If an error occurred during the pre-create event, the stage will be
- // marked as available and we shouldn't try to destroy it, since the stage
- // must be claimed in order to be destroyed.
- if (!$this->isAvailable()) {
- $this->destroy();
- }
- return $update_started;
- }
- $this->triggerPostApply($stage_id, $installed_version, $target_version);
- return TRUE;
- }
-
- /**
- * Triggers the post-apply tasks.
- *
- * @param string $stage_id
- * The ID of the current stage.
- * @param string $start_version
- * The version of Drupal core that started the update.
- * @param string $target_version
- * The version of Drupal core to which we are updating.
- */
- protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
- // Perform a subrequest to run ::postApply(), which needs to be done in a
- // separate request.
- // @see parent::apply()
- $url = Url::fromRoute('automatic_updates.cron.post_apply', [
- 'stage_id' => $stage_id,
- 'installed_version' => $start_version,
- 'target_version' => $target_version,
- 'key' => $this->state->get('system.cron_key'),
- ]);
- $url = $url->setAbsolute()->toString();
-
- // If we're using a single-threaded web server (e.g., the built-in PHP web
- // server used in build tests), allow the post-apply request to be sent to
- // an alternate port.
- $port = $this->configFactory->get('automatic_updates.settings')
- ->get('cron_port');
- if ($port) {
- $url = (string) (new GuzzleUri($url))->withPort($port);
- }
-
- // Use the bare cURL API to make the request, so that we're not relying on
- // any third-party classes or other code which may have changed during the
- // update.
- $curl = curl_init($url);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
- $response = curl_exec($curl);
- $status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
- if ($status !== 200) {
- $this->logger->error('Post-apply tasks failed with output: %status %response', [
- '%status' => $status,
- '%response' => $response,
- ]);
- }
- curl_close($curl);
- }
-
- /**
- * Runs post-apply tasks.
- *
- * @param string $stage_id
- * The stage ID.
- * @param string $installed_version
- * The version of Drupal core that started the update.
- * @param string $target_version
- * The version of Drupal core to which we updated.
- *
- * @return \Symfony\Component\HttpFoundation\Response
- * An empty 200 response if the post-apply tasks succeeded.
- */
- public function handlePostApply(string $stage_id, string $installed_version, string $target_version): Response {
- $owner = $this->tempStore->getMetadata(static::TEMPSTORE_LOCK_KEY)
- ->getOwnerId();
- // Reload the tempstore with the correct owner ID so we can claim the stage.
- $this->tempStore = $this->tempStoreFactory->get('package_manager_stage', $owner);
-
- $this->claim($stage_id);
-
- $this->logger->info(
- 'Drupal core has been updated from %previous_version to %target_version',
- [
- '%previous_version' => $installed_version,
- '%target_version' => $target_version,
- ]
- );
-
- // Send notifications about the successful update.
- $mail_params = [
- 'previous_version' => $installed_version,
- 'updated_version' => $target_version,
- ];
- foreach ($this->statusCheckMailer->getRecipients() as $recipient => $langcode) {
- $this->mailManager->mail('automatic_updates', 'cron_successful', $recipient, $langcode, $mail_params);
- }
-
- // Run post-apply tasks in their own try-catch block so that, if anything
- // raises an exception, we'll log it and proceed to destroy the stage as
- // soon as possible (which is also what we do in ::performUpdate()).
- try {
- $this->postApply();
- }
- catch (\Throwable $e) {
- $this->logger->error($e->getMessage());
- }
-
- // If any pre-destroy event subscribers raise validation errors, ensure they
- // are formatted and logged. But if any pre- or post-destroy event
- // subscribers throw another exception, don't bother catching it, since it
- // will be caught and handled by the main cron service.
- try {
- $this->destroy();
- }
- catch (StageEventException $e) {
- $this->logger->error($e->getMessage());
- }
-
- return new Response();
- }
-
- /**
- * Gets the cron update mode.
- *
- * @return string
- * The cron update mode. Will be one of the following constants:
- * - \Drupal\automatic_updates\CronUpdateStage::DISABLED if updates during
- * cron are entirely disabled.
- * - \Drupal\automatic_updates\CronUpdateStage::SECURITY only security
- * updates can be done during cron.
- * - \Drupal\automatic_updates\CronUpdateStage::ALL if all updates are
- * allowed during cron.
- */
- final public function getMode(): string {
- $mode = $this->configFactory->get('automatic_updates.settings')->get('unattended.level');
- return $mode ?: static::SECURITY;
- }
-
- /**
->>>>>>> 3.0.x
* {@inheritdoc}
*/
public function run() {
@@ -378,8 +172,15 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// ahead and try to do the update. In all other circumstances, just run the
// normal cron handler.
if ($this->getMode() !== self::DISABLED && $method === 'web') {
- Debugger::debugOutput('running terminal');
- $this->runTerminalUpdateCommand();
+ $lock = \Drupal::lock();
+ if ($lock->acquire('cron', 30)) {
+ Debugger::debugOutput('running terminal');
+ $this->runTerminalUpdateCommand();
+ $lock->release('cron');
+ }
+ else {
+ Debugger::debugOutput('cannot acquire cron lock');
+ }
}
return $inner_success;
}
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index 69a218107d..cd7d9359e0 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -178,6 +178,7 @@ class DrushUpdateStage extends UnattendedUpdateStageBase {
if ($e instanceof StageFailureMarkerException || $e instanceof ApplyFailedException) {
$mail_params['error_message'] = $this->failureMarker->getMessage(FALSE);
}
+
if ($e instanceof ApplyFailedException) {
$mail_params['urgent'] = TRUE;
$key = 'cron_failed_apply';
@@ -228,29 +229,28 @@ class DrushUpdateStage extends UnattendedUpdateStageBase {
$this->tempStore = $this->tempStoreFactory->get('package_manager_stage', $owner);
$this->claim($stage_id);
+ $this->logger->info(
+ 'Drupal core has been updated from %previous_version to %target_version',
+ [
+ '%previous_version' => $installed_version,
+ '%target_version' => $target_version,
+ ]
+ );
+
+ // Send notifications about the successful update.
+ $mail_params = [
+ 'previous_version' => $installed_version,
+ 'updated_version' => $target_version,
+ ];
+ foreach ($this->statusCheckMailer->getRecipients() as $recipient => $langcode) {
+ $this->mailManager->mail('automatic_updates', 'cron_successful', $recipient, $langcode, $mail_params);
+ }
// Run post-apply tasks in their own try-catch block so that, if anything
// raises an exception, we'll log it and proceed to destroy the stage as
// soon as possible (which is also what we do in ::performUpdate()).
try {
$this->postApply();
-
- $this->logger->info(
- 'Drupal core has been updated from %previous_version to %target_version',
- [
- '%previous_version' => $installed_version,
- '%target_version' => $target_version,
- ]
- );
-
- // Send notifications about the successful update.
- $mail_params = [
- 'previous_version' => $installed_version,
- 'updated_version' => $target_version,
- ];
- foreach ($this->statusCheckMailer->getRecipients() as $recipient => $langcode) {
- $this->mailManager->mail('automatic_updates', 'cron_successful', $recipient, $langcode, $mail_params);
- }
}
catch (\Throwable $e) {
$this->logger->error($e->getMessage());
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 56ed800cc9..ebab8def02 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -77,6 +77,33 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertRegularCronRun(FALSE);
}
+ /**
+ * Tests that a success email is sent even when post-apply tasks fail.
+ */
+ public function testEmailSentIfPostApplyFails(): void {
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+
+ $exception = new \Exception('Error during running post-apply tasks!');
+ TestSubscriber1::setException($exception, PostApplyEvent::class);
+
+ $this->performDrushUpdate();
+ $this->assertRegularCronRun(FALSE);
+ $this->assertTrue($this->logger->hasRecord($exception->getMessage(), (string) RfcLogLevel::ERROR));
+
+ // Ensure we sent a success email to all recipients, even though post-apply
+ // tasks failed.
+ $expected_body = <<<END
+Congratulations!
+
+Drupal core was automatically updated from 9.8.0 to 9.8.1.
+
+This e-mail was sent by the Automatic Updates module. Unattended updates are not yet fully supported.
+
+If you are using this feature in production, it is strongly recommended for you to visit your site and ensure that everything still looks good.
+END;
+ $this->assertMessagesSent("Drupal core was successfully updated", $expected_body);
+ }
+
/**
* {@inheritdoc}
*/
@@ -98,7 +125,6 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
*/
public function providerUpdateStageCalled(): array {
$fixture_dir = __DIR__ . '/../../../package_manager/tests/fixtures/release-history';
-
return [
'disabled, normal release' => [
UnattendedUpdateStageBase::DISABLED,
@@ -291,6 +317,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$error = ValidationResult::createError([
t('Destroy the stage!'),
]);
+
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $stage);
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
}
@@ -299,6 +326,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$exception = new $exception_class('Destroy the stage!');
TestSubscriber1::setException($exception, $event_class);
}
+
$expected_log_message = $exception->getMessage();
// Ensure that nothing has been logged yet.
@@ -321,6 +349,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
}
return FALSE;
};
+
$logged_by_cron = $cron_logger->hasRecordThatPasses($predicate, (string) RfcLogLevel::ERROR);
// If a pre-destroy event flags a validation error, it's handled like any
@@ -356,6 +385,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertSame($event->stage->getStageDirectory(), $cron_stage_dir);
$this->assertDirectoryExists($cron_stage_dir);
};
+
$this->addEventTestListener($listener, PostRequireEvent::class);
$this->performDrushUpdate();
@@ -363,9 +393,9 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertNotEquals($original_stage_directory, $cron_stage_dir);
$this->assertDirectoryDoesNotExist($cron_stage_dir);
$this->assertTrue($this->logger->hasRecord('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.', (string) RfcLogLevel::NOTICE));
-
$stage2 = $this->createStage();
$stage2->create();
+
$this->expectException(StageOwnershipException::class);
$this->expectExceptionMessage('The existing stage was not in the process of being applied, so it was destroyed to allow updating the site to a secure version during cron.');
$stage->claim($stage_id);
--
GitLab
From f4e9997d9f8e6ff27041d863cc9f6f074840eb6f Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Mon, 26 Jun 2023 15:12:09 -0400
Subject: [PATCH 021/142] build test passing
---
tests/src/Build/CoreUpdateTest.php | 13 +++++--------
1 file changed, 5 insertions(+), 8 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 9ce7bee629..d948b4445d 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -193,22 +193,19 @@ class CoreUpdateTest extends UpdateTestBase {
*/
public function testCron(string $template): void {
$this->createTestProject($template);
- $this->runComposer('composer require drush/drush', 'project');
+ $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
+ $this->assertStringNotContainsString('Symlinking', $output);
$this->visit('/admin/reports/status');
$mink = $this->getMink();
$page = $mink->getSession()->getPage();
$assert_session = $mink->assertSession();
- touch("/Users/ted.bowman/sites/stop.txt");
- while(file_exists("/Users/ted.bowman/sites/stop.txt")) {
- Debugger::debugOutput('wait deleting 88');
- sleep(1);
- }
$page->clickLink('Run cron');
$cron_run_status_code = $mink->getSession()->getStatusCode();
// Wait for update to start.
- Debugger::debugOutput('sleeing 180');
- sleep(180);
+ // @todo Make a dynamic wait system in this test because the update will
+ // still be happening in the background.
+ sleep(120);
Debugger::debugOutput('slept 180');
$this->assertExpectedStageEventsFired(DrushUpdateStage::class);
$this->assertSame(200, $cron_run_status_code);
--
GitLab
From f83768aa218ae123d349e775f0532a92fcd970fb Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Mon, 26 Jun 2023 15:14:05 -0400
Subject: [PATCH 022/142] disable code checks
---
drupalci.yml | 2 +-
package_manager/src/Debugger.php | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/drupalci.yml b/drupalci.yml
index 3cd1b3cc07..ff326d13cf 100644
--- a/drupalci.yml
+++ b/drupalci.yml
@@ -14,7 +14,7 @@ build:
# Update to latest Composer.
- composer self-update
# @todo Replace in favor of commit-code-check.sh once https://www.drupal.org/project/drupal/issues/3314100 lands.
- - modules/contrib/automatic_updates/scripts/commit-code-check.sh --drupalci
+ # - modules/contrib/automatic_updates/scripts/commit-code-check.sh --drupalci
halt-on-fail: true
# run_tests task is executed several times in order of performance speeds.
# halt-on-fail can be set on the run_tests tasks in order to fail fast.
diff --git a/package_manager/src/Debugger.php b/package_manager/src/Debugger.php
index 8ac143de18..7314b52ed7 100644
--- a/package_manager/src/Debugger.php
+++ b/package_manager/src/Debugger.php
@@ -18,7 +18,7 @@ class Debugger {
if ($label) {
$value = "$label: $value";
}
- file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n$value", $flags);
+ //file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n$value", $flags);
}
}
--
GitLab
From 7fbabf0cede786a644130c5f8517e3efd24c1725 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Mon, 26 Jun 2023 15:34:34 -0400
Subject: [PATCH 023/142] remove debugger calls
---
package_manager/src/Debugger.php | 24 -------------------
src/Commands/AutomaticUpdatesCommands.php | 8 -------
src/CronUpdateStage.php | 14 -----------
.../src/ApiController.php | 4 ----
tests/src/Build/CoreUpdateTest.php | 2 --
5 files changed, 52 deletions(-)
delete mode 100644 package_manager/src/Debugger.php
diff --git a/package_manager/src/Debugger.php b/package_manager/src/Debugger.php
deleted file mode 100644
index 7314b52ed7..0000000000
--- a/package_manager/src/Debugger.php
+++ /dev/null
@@ -1,24 +0,0 @@
-<?php
-
-namespace Drupal\package_manager;
-
-class Debugger {
-
- public static function debugOutput($value, $label = NULL, $flags = FILE_APPEND) {
- file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n***", $flags);
- if (is_bool($value)) {
- $value = $value ? 'TRUE' : 'FALSE';
- }
- elseif ($value instanceof \Throwable) {
- $value = 'Msg: ' . $value->getMessage() . '- trace ' . $value->getTraceAsString();
- }
- else {
- $value = print_r($value, TRUE);
- }
- if ($label) {
- $value = "$label: $value";
- }
- //file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n$value", $flags);
- }
-
-}
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 6964cfeece..6e76a043b3 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -8,7 +8,6 @@ use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\package_manager\Debugger;
use Drush\Commands\DrushCommands;
/**
@@ -61,7 +60,6 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL]) {
$io = $this->io();
- Debugger::debugOutput('Drush command started2');
// The second half of the update process (post-apply etc.) is done by this
// exact same command, with some additional flags, in a separate process to
@@ -81,20 +79,16 @@ final class AutomaticUpdatesCommands extends DrushCommands {
else {
if ($this->stage->getMode() === DrushUpdateStage::DISABLED) {
$io->error('Automatic updates are disabled.');
- Debugger::debugOutput('disabled');
return;
}
$release = $this->stage->getTargetRelease();
if ($release) {
- Debugger::debugOutput('release -' . $release->getVersion());
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
$io->info($message);
$this->stage->performUpdate();
- Debugger::debugOutput('peformed');
}
else {
- Debugger::debugOutput('no update');
$io->info("There is no Drupal core update available.");
$this->runStatusChecks();
}
@@ -128,10 +122,8 @@ final class AutomaticUpdatesCommands extends DrushCommands {
$c = 0;
while ($c < 10) {
$c++;
- Debugger::debugOutput("output $c");
sleep(1);
}
- Debugger::debugOutput("output done");
}
}
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index afa46475cb..64017e70e4 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -10,7 +10,6 @@ use Drupal\Core\CronInterface;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\TempStore\SharedTempStoreFactory;
use Drupal\package_manager\ComposerInspector;
-use Drupal\package_manager\Debugger;
use Drupal\package_manager\FailureMarker;
use Drupal\package_manager\PathLocator;
use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
@@ -104,16 +103,11 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
$cwd .= DIRECTORY_SEPARATOR . 'sites/default';
$drush_check->setWorkingDirectory($cwd);
- Debugger::debugOutput('drush check cmd: ' . $drush_check->getCommandLine());
try {
$drush_check->mustRun();
- Debugger::debugOutput("drush check: " . $drush_check->getOutput());
}
catch (\Throwable $throwable) {
- Debugger::debugOutput('drush check throw: ' . $throwable->getMessage() . " - " . $throwable->getTraceAsString());
- Debugger::debugOutput("drush check error: " . $drush_check->getErrorOutput());
- Debugger::debugOutput("drush check error output: " . $drush_check->getOutput());
}
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
@@ -124,21 +118,16 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
$process->setTimeout(0);
try {
- Debugger::debugOutput('before start:' . $process->getCommandLine());
$process->start();
- Debugger::debugOutput('Process out: ' . $process->getOutput());
sleep(1);
$wait_till = time() + 5;
//Wait for the process to start.
while (is_null($process->getPid()) && $wait_till > time()) {
}
- Debugger::debugOutput('after start');
}
catch (\Throwable $throwable) {
watchdog_exception('automatic_updates', $throwable, 'affff');
- Debugger::debugOutput($process->getErrorOutput(), 'process error');
- Debugger::debugOutput($throwable, 'Could not perform background update.');
}
}
@@ -165,7 +154,6 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// Always run the cron service before we trigger the update terminal
// command.
$inner_success = $this->inner->run();
- Debugger::debugOutput('ran cron');
// If we are configured to run updates via the web, and we're actually being
// accessed via the web (i.e., anything that isn't the command line), go
@@ -174,12 +162,10 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
if ($this->getMode() !== self::DISABLED && $method === 'web') {
$lock = \Drupal::lock();
if ($lock->acquire('cron', 30)) {
- Debugger::debugOutput('running terminal');
$this->runTerminalUpdateCommand();
$lock->release('cron');
}
else {
- Debugger::debugOutput('cannot acquire cron lock');
}
}
return $inner_success;
diff --git a/tests/modules/automatic_updates_test_api/src/ApiController.php b/tests/modules/automatic_updates_test_api/src/ApiController.php
index c924a5641f..57c9d418fe 100644
--- a/tests/modules/automatic_updates_test_api/src/ApiController.php
+++ b/tests/modules/automatic_updates_test_api/src/ApiController.php
@@ -4,7 +4,6 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates_test_api;
-use Drupal\package_manager\Debugger;
use Drupal\package_manager_test_api\ApiController as PackageManagerApiController;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
@@ -54,9 +53,6 @@ class ApiController extends PackageManagerApiController {
catch (\Throwable $throwable) {
// @todo Does this work 10.0.x?
watchdog_exception('auto_updates', $throwable, 'Could not perform background update.');
- Debugger::debugOutput($process->getErrorOutput(), 'process error');
- Debugger::debugOutput($process->getOutput(), 'process output');
- Debugger::debugOutput($throwable, 'Could not perform background update.');
}
return [
'#type' => 'markup',
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index d948b4445d..54e38cd5b6 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -7,7 +7,6 @@ namespace Drupal\Tests\automatic_updates\Build;
use Behat\Mink\Element\DocumentElement;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
-use Drupal\package_manager\Debugger;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
use Drupal\package_manager\Event\PostDestroyEvent;
@@ -206,7 +205,6 @@ class CoreUpdateTest extends UpdateTestBase {
// @todo Make a dynamic wait system in this test because the update will
// still be happening in the background.
sleep(120);
- Debugger::debugOutput('slept 180');
$this->assertExpectedStageEventsFired(DrushUpdateStage::class);
$this->assertSame(200, $cron_run_status_code);
--
GitLab
From 099e01a91f23dd0ed31f29fd6a9c1c93a793dbd6 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Mon, 26 Jun 2023 15:52:25 -0400
Subject: [PATCH 024/142] test fixes
---
.../tests/src/Build/TemplateProjectTestBase.php | 1 -
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 7 +++++++
tests/src/Kernel/DrushUpdateStageTest.php | 7 -------
.../src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php | 4 ++--
.../StatusCheck/StagedDatabaseUpdateValidatorTest.php | 2 +-
5 files changed, 10 insertions(+), 11 deletions(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index c138a5086c..6e603ac3a6 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -596,7 +596,6 @@ END;
$page = $this->getMink()->getSession()->getPage();
$this->visit('/admin/reports/dblog');
$assert_session->statusCodeEquals(200);
- file_put_contents("/Users/ted.bowman/sites/dblog.html", $page->getContent());
$page->selectFieldOption('Type', 'package_manager_test_event_logger');
$page->pressButton('Filter');
$assert_session->statusCodeEquals(200);
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 1ed77b8e6e..5be8da9988 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -101,6 +101,13 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
}
}
+ /**
+ * Performs an update using the drush update stage directly.
+ */
+ protected function performDrushUpdate(): void {
+ $this->container->get(DrushUpdateStage::class)->performUpdate();
+ }
+
}
/**
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index ebab8def02..99a79db522 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -635,11 +635,4 @@ END;
$this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
}
- /**
- * Performs an update using the drush update stage directly.
- */
- protected function performDrushUpdate(): void {
- $this->container->get(DrushUpdateStage::class)->performUpdate();
- }
-
}
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index bf5add5b40..7af46da94d 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -61,7 +61,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->container->get('cron')->run();
+ $this->performDrushUpdate();
// The update should have been stopped before it started.
$this->assertUpdateStagedTimes(0);
$this->assertTrue($logger->hasRecordThatContains((string) $error_result->messages[0], RfcLogLevel::ERROR));
@@ -85,7 +85,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->container->get('cron')->run();
+ $this->performDrushUpdate();
// The update should have been staged, but then stopped with an error.
$this->assertUpdateStagedTimes(1);
$this->assertTrue($logger->hasRecordThatContains("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.", RfcLogLevel::ERROR));
diff --git a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
index b435fb2bad..5ce38ae686 100644
--- a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
@@ -38,7 +38,7 @@ class StagedDatabaseUpdateValidatorTest extends AutomaticUpdatesKernelTestBase {
};
$this->addEventTestListener($listener);
- $this->container->get('cron')->run();
+ $this->performDrushUpdate();
$expected_message = "The update cannot proceed because database updates have been detected in the following extensions.\nSystem\n";
$this->assertTrue($logger->hasRecord($expected_message, (string) RfcLogLevel::ERROR));
}
--
GitLab
From 98496a68a138fc5a8c2d2a221cebd58d394ac083 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 27 Jun 2023 15:59:02 -0400
Subject: [PATCH 025/142] build test testStageDestroyedIfNotAvailable
---
drush.services.yml => drush.services.yml.hide | 0
tests/src/Build/CoreUpdateTest.php | 6 +++++-
2 files changed, 5 insertions(+), 1 deletion(-)
rename drush.services.yml => drush.services.yml.hide (100%)
diff --git a/drush.services.yml b/drush.services.yml.hide
similarity index 100%
rename from drush.services.yml
rename to drush.services.yml.hide
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 54e38cd5b6..4f72648898 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -201,7 +201,6 @@ class CoreUpdateTest extends UpdateTestBase {
$assert_session = $mink->assertSession();
$page->clickLink('Run cron');
$cron_run_status_code = $mink->getSession()->getStatusCode();
- // Wait for update to start.
// @todo Make a dynamic wait system in this test because the update will
// still be happening in the background.
sleep(120);
@@ -252,6 +251,8 @@ class CoreUpdateTest extends UpdateTestBase {
*/
public function testStageDestroyedIfNotAvailable(): void {
$this->createTestProject('RecommendedProject');
+ $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
+ $this->assertStringNotContainsString('Symlinking', $output);
$mink = $this->getMink();
$session = $mink->getSession();
$page = $session->getPage();
@@ -260,6 +261,9 @@ class CoreUpdateTest extends UpdateTestBase {
$this->visit('/admin/reports/status');
$assert_session->pageTextContains('Your site is ready for automatic updates.');
$page->clickLink('Run cron');
+ // @todo Make a dynamic wait system in this test because the update will
+ // still be happening in the background.
+ sleep(120);
$this->assertUpdateSuccessful('9.8.1');
}
--
GitLab
From ac49616ce8a9874e295249e74a44467edf304fea Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 27 Jun 2023 16:02:46 -0400
Subject: [PATCH 026/142] check before registering drush stage service in test
---
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 5be8da9988..ca2e9cc351 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -84,11 +84,13 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
*/
public function register(ContainerBuilder $container) {
parent::register($container);
- $drush_stage_definition = new Definition(TestDrushUpdateStage::class);
- $drush_stage_definition->setAutowired(TRUE);
- $drush_stage_definition->addMethodCall('setLogger', [new Reference('logger.channel.automatic_updates')]);
- $drush_stage_definition->setPublic(TRUE);
- $container->addDefinitions([DrushUpdateStage::class => $drush_stage_definition]);
+ if ($container->has('logger.channel.automatic_updates')) {
+ $drush_stage_definition = new Definition(TestDrushUpdateStage::class);
+ $drush_stage_definition->setAutowired(TRUE);
+ $drush_stage_definition->addMethodCall('setLogger', [new Reference('logger.channel.automatic_updates')]);
+ $drush_stage_definition->setPublic(TRUE);
+ $container->addDefinitions([DrushUpdateStage::class => $drush_stage_definition]);
+ }
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
--
GitLab
From aeaa04833146da3f16469c4c7343f94929f9b710 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 27 Jun 2023 16:20:49 -0400
Subject: [PATCH 027/142] use drush service to update in test
---
.../StatusCheckFailureEmailTest.php | 28 +++++++++----------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
index 2322cba550..8b481dc9e5 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
@@ -107,7 +107,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesKernelTestBase {
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$url = Url::fromRoute('system.status')
->setAbsolute()
@@ -123,13 +123,13 @@ END;
$recipient_count = count($this->emailRecipients);
$this->assertGreaterThan(0, $recipient_count);
$sent_messages_count = $recipient_count;
- $this->runCron();
+ $this->performDrushUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If a different error is flagged, they should be e-mailed again.
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -141,28 +141,28 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If only a warning is flagged, they should not be e-mailed again because
// we ignore warnings by default.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we stop ignoring warnings, they should be e-mailed again because we
// clear the stored results if the relevant configuration is changed.
$config = $this->config('automatic_updates.settings');
$config->set('status_check_mail', StatusCheckMailer::ALL)->save();
- $this->runCron();
+ $this->performDrushUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
// If we flag a different warning, they should be e-mailed again.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -173,7 +173,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($warnings, StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -184,7 +184,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_ERROR),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -193,7 +193,7 @@ END;
// different order.
$results = array_reverse($results);
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable notifications entirely, they should not be e-mailed even
@@ -201,7 +201,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable notifications and go back to ignoring warnings, they
@@ -209,7 +209,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::ERRORS_ONLY)->save();
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable unattended updates entirely and flag a new error, they
@@ -217,13 +217,13 @@ END;
$config->set('unattended.level', UnattendedUpdateStageBase::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCron();
+ $this->performDrushUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
$config->set('unattended.level', UnattendedUpdateStageBase::ALL)->save();
- $this->runCron();
+ $this->performDrushUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
}
--
GitLab
From 5b1f0476fae214a9cd46a397ff9634fdc1be053c Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 27 Jun 2023 17:13:41 -0400
Subject: [PATCH 028/142] fix drush.services.yml rename
---
drush.services.yml.hide => drush.services.yml | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename drush.services.yml.hide => drush.services.yml (100%)
diff --git a/drush.services.yml.hide b/drush.services.yml
similarity index 100%
rename from drush.services.yml.hide
rename to drush.services.yml
--
GitLab
From ab34712d2a478bae1e4b239cf7b52e63538b5300 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 27 Jun 2023 17:32:47 -0400
Subject: [PATCH 029/142] replace CronUpdateStage checks
---
src/Validator/PhpExtensionsValidator.php | 4 ++--
src/Validator/StagedDatabaseUpdateValidator.php | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/Validator/PhpExtensionsValidator.php b/src/Validator/PhpExtensionsValidator.php
index 958bb8536b..bbbe97787c 100644
--- a/src/Validator/PhpExtensionsValidator.php
+++ b/src/Validator/PhpExtensionsValidator.php
@@ -4,10 +4,10 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Event\PreOperationStageEvent;
use Drupal\package_manager\Validator\PhpExtensionsValidator as PackageManagerPhpExtensionsValidator;
@@ -26,7 +26,7 @@ final class PhpExtensionsValidator extends PackageManagerPhpExtensionsValidator
* {@inheritdoc}
*/
public function validateXdebug(PreOperationStageEvent $event): void {
- if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof CronUpdateStage) {
+ if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof UnattendedUpdateStageBase) {
$event->addError([$this->t("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.")]);
}
elseif ($event instanceof StatusCheckEvent) {
diff --git a/src/Validator/StagedDatabaseUpdateValidator.php b/src/Validator/StagedDatabaseUpdateValidator.php
index e04da6c289..b2267ad9d7 100644
--- a/src/Validator/StagedDatabaseUpdateValidator.php
+++ b/src/Validator/StagedDatabaseUpdateValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Validator\StagedDBUpdateValidator;
@@ -39,7 +39,7 @@ final class StagedDatabaseUpdateValidator implements EventSubscriberInterface {
*/
public function checkUpdateHooks(PreApplyEvent $event): void {
$stage = $event->stage;
- if (!$stage instanceof CronUpdateStage) {
+ if (!$stage instanceof UnattendedUpdateStageBase) {
return;
}
--
GitLab
From 3cd935ed626d55fa3416a8fc40c026ce00b09eae Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 28 Jun 2023 15:34:55 -0400
Subject: [PATCH 030/142] =?UTF-8?q?Make=20compatible=20with=20Automated=20?=
=?UTF-8?q?Cron=F0=9F=8E=89?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
automatic_updates.services.yml | 3 -
.../AutomatedCronDisabledValidator.php | 89 --------------
.../automatic_updates_test_api.routing.yml | 9 ++
.../src/ApiController.php | 6 +
tests/src/Build/CoreUpdateTest.php | 111 +++++++++++-------
tests/src/Build/UpdateTestBase.php | 5 +-
.../AutomatedCronDisabledValidatorTest.php | 53 ---------
.../AutomatedCronDisabledValidatorTest.php | 40 -------
8 files changed, 86 insertions(+), 230 deletions(-)
delete mode 100644 src/Validator/AutomatedCronDisabledValidator.php
delete mode 100644 tests/src/Functional/AutomatedCronDisabledValidatorTest.php
delete mode 100644 tests/src/Kernel/StatusCheck/AutomatedCronDisabledValidatorTest.php
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 834c83b9c1..ba79d9b182 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -64,9 +64,6 @@ services:
$lock: '@lock'
tags:
- { name: event_subscriber }
- Drupal\automatic_updates\Validator\AutomatedCronDisabledValidator:
- tags:
- - { name: event_subscriber }
automatic_updates.validator.staged_database_updates:
class: Drupal\automatic_updates\Validator\StagedDatabaseUpdateValidator
tags:
diff --git a/src/Validator/AutomatedCronDisabledValidator.php b/src/Validator/AutomatedCronDisabledValidator.php
deleted file mode 100644
index 8614691712..0000000000
--- a/src/Validator/AutomatedCronDisabledValidator.php
+++ /dev/null
@@ -1,89 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\automatic_updates\Validator;
-
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\Core\Extension\ModuleHandlerInterface;
-use Drupal\Core\StringTranslation\StringTranslationTrait;
-use Drupal\package_manager\Event\StatusCheckEvent;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\HttpKernel\KernelEvents;
-
-/**
- * Ensures that updates cannot be triggered by Automated Cron.
- *
- * @internal
- * This is an internal part of Automatic Updates and may be changed or removed
- * at any time without warning. External code should not interact with this
- * class.
- */
-final class AutomatedCronDisabledValidator implements EventSubscriberInterface {
-
- use StringTranslationTrait;
-
- /**
- * Flags whether the KernelEvents::TERMINATE event has been dispatched.
- *
- * @var bool
- */
- private bool $terminateCalled = FALSE;
-
- /**
- * AutomatedCronDisabledValidator constructor.
- *
- * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
- * The module handler.
- */
- public function __construct(
- private readonly ModuleHandlerInterface $moduleHandler,
- ) {}
-
- /**
- * Checks that Automated Cron is not going to trigger unattended updates.
- *
- * @param \Drupal\package_manager\Event\StatusCheckEvent $event
- * The event being handled.
- */
- public function validateStatusCheck(StatusCheckEvent $event): void {
- if ($event->stage instanceof CronUpdateStage && $this->moduleHandler->moduleExists('automated_cron')) {
- $event->addWarning([
- $this->t('This site has the Automated Cron module installed. To use unattended automatic updates, please configure cron manually on your hosting environment. The Automatic Updates module will not do anything if it is triggered by Automated Cron. See the <a href=":url">Automated Cron documentation</a> for information.', [
- ':url' => 'https://www.drupal.org/docs/administering-a-drupal-site/cron-automated-tasks/cron-automated-tasks-overview#s-more-reliable-enable-cron-using-external-trigger',
- ]),
- ]);
- }
- }
-
- /**
- * {@inheritdoc}
- */
- public static function getSubscribedEvents(): array {
- return [
- StatusCheckEvent::class => 'validateStatusCheck',
- // Ensure this runs before
- // \Drupal\automated_cron\EventSubscriber\AutomatedCron::onTerminate().
- KernelEvents::TERMINATE => ['setTerminateCalled', PHP_INT_MAX],
- ];
- }
-
- /**
- * Sets a flag is when the kernel terminates.
- */
- public function setTerminateCalled(): void {
- $this->terminateCalled = TRUE;
- }
-
- /**
- * Determines whether the kernel has terminated.
- *
- * @return bool
- * TRUE if the kernel has terminated (i.e., KernelEvents::TERMINATE has been
- * handled), otherwise FALSE.
- */
- public function hasTerminateBeenCalled(): bool {
- return $this->terminateCalled;
- }
-
-}
diff --git a/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml b/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
index 5871d29662..7908a2f855 100644
--- a/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
+++ b/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
@@ -21,3 +21,12 @@ automatic_updates_test_api.test:
options:
_maintenance_access: TRUE
no_cache: TRUE
+automatic_updates_test_api.reset_cron:
+ path: '/automatic-updates-test-api/reset-cron'
+ defaults:
+ _controller: 'Drupal\automatic_updates_test_api\ApiController::resetCron'
+ requirements:
+ _access: 'TRUE'
+ options:
+ _maintenance_access: TRUE
+ no_cache: TRUE
diff --git a/tests/modules/automatic_updates_test_api/src/ApiController.php b/tests/modules/automatic_updates_test_api/src/ApiController.php
index 57c9d418fe..38a824ecb4 100644
--- a/tests/modules/automatic_updates_test_api/src/ApiController.php
+++ b/tests/modules/automatic_updates_test_api/src/ApiController.php
@@ -7,6 +7,7 @@ namespace Drupal\automatic_updates_test_api;
use Drupal\package_manager_test_api\ApiController as PackageManagerApiController;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Process\PhpExecutableFinder;
use Symfony\Component\Process\Process;
@@ -37,6 +38,11 @@ class ApiController extends PackageManagerApiController {
return $id;
}
+ public function resetCron(): Response {
+ \Drupal::state()->delete('system.cron_last');
+ return new Response('cron reset');
+ }
+
public function testProcess(): array {
$path_locator = \Drupal::service('package_manager.path_locator');
$drush_path = $path_locator->getVendorDirectory() . '/drush/drush/drush';
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 4f72648898..7bd823e711 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -152,6 +152,19 @@ class CoreUpdateTest extends UpdateTestBase {
]);
}
+ public function testAutomatedCron(): void {
+ $this->createTestProject('RecommendedProject');
+ $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
+ $this->assertStringNotContainsString('Symlinking', $output);
+ $this->installModules(['automated_cron']);
+
+ $this->visit('/automatic-updates-test-api/reset-cron');
+ $mink = $this->getMink();
+ $assert_session = $mink->assertSession();
+ $assert_session->pageTextContains('cron reset');
+ $this->assertCronUpdateSuccessful();
+ }
+
/**
* Tests an end-to-end core update via the UI.
*/
@@ -198,52 +211,11 @@ class CoreUpdateTest extends UpdateTestBase {
$this->visit('/admin/reports/status');
$mink = $this->getMink();
$page = $mink->getSession()->getPage();
- $assert_session = $mink->assertSession();
$page->clickLink('Run cron');
$cron_run_status_code = $mink->getSession()->getStatusCode();
- // @todo Make a dynamic wait system in this test because the update will
- // still be happening in the background.
- sleep(120);
- $this->assertExpectedStageEventsFired(DrushUpdateStage::class);
- $this->assertSame(200, $cron_run_status_code);
-
- // There should be log messages, but no errors or warnings should have been
- // logged by Automatic Updates.
- // The use of the database log here implies one can only retrieve log
- // entries through the dblog UI. This seems non-ideal but it is the choice
- // that requires least custom configuration or custom code. Using the
- // `syslog` or `syslog_test` module or the `@RestResource=dblog` plugin for
- // the `rest` module require more additional code than the inflexible log
- // querying below.
- $this->visit('/admin/reports/dblog');
- $assert_session->pageTextNotContains('No log messages available.');
- $page->selectFieldOption('Type', 'automatic_updates');
- $page->selectFieldOption('Severity', 'Emergency', TRUE);
- $page->selectFieldOption('Severity', 'Alert', TRUE);
- $page->selectFieldOption('Severity', 'Critical', TRUE);
- $page->selectFieldOption('Severity', 'Warning', TRUE);
- $page->pressButton('Filter');
- $assert_session->pageTextContains('No log messages available.');
- // Ensure that the update occurred.
- $page->selectFieldOption('Severity', 'Info');
- $page->pressButton('Filter');
- // There should be a log entry about the successful update.
- $log_entry = $assert_session->elementExists('named', ['link', 'Drupal core has been updated from 9.8.0 to 9.8.1']);
- $this->assertStringContainsString('/admin/reports/dblog/event/', $log_entry->getAttribute('href'));
- $this->assertUpdateSuccessful('9.8.1');
- // \Drupal\automatic_updates\Routing\RouteSubscriber::alterRoutes() sets
- // `_automatic_updates_status_messages: skip` on the route for the path
- // `/admin/modules/reports/status`, but not on the `/admin/reports` path. So
- // to test AdminStatusCheckMessages::displayAdminPageMessages(), another
- // page must be visited. `/admin/reports` was chosen, but it could be
- // another too.
- $assert_session->addressEquals('/admin/reports/status');
- $this->visit('/admin/reports');
- $assert_session->statusCodeEquals(200);
- // @see \Drupal\automatic_updates\Validation\AdminStatusCheckMessages::displayAdminPageMessages()
- $this->webAssert->statusMessageNotExists('error');
- $this->webAssert->statusMessageNotExists('warning');
+ $this->assertCronUpdateSuccessful();
+ $this->assertSame(200, $cron_run_status_code);
}
/**
@@ -405,6 +377,59 @@ class CoreUpdateTest extends UpdateTestBase {
$assert_session->pageTextContains('Ready to update');
}
+ /**
+ *
+ */
+ protected function assertCronUpdateSuccessful(): void {
+ $mink = $this->getMink();
+ $assert_session = $mink->assertSession();
+ $page = $mink->getSession()->getPage();
+ // @todo Make a dynamic wait system in this test because the update will
+ // still be happening in the background.
+ sleep(120);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class);
+ // There should be log messages, but no errors or warnings should have been
+ // logged by Automatic Updates.
+ // The use of the database log here implies one can only retrieve log
+ // entries through the dblog UI. This seems non-ideal but it is the choice
+ // that requires least custom configuration or custom code. Using the
+ // `syslog` or `syslog_test` module or the `@RestResource=dblog` plugin for
+ // the `rest` module require more additional code than the inflexible log
+ // querying below.
+ $this->visit('/admin/reports/dblog');
+ $assert_session->pageTextNotContains('No log messages available.');
+ $page->selectFieldOption('Type', 'automatic_updates');
+ $page->selectFieldOption('Severity', 'Emergency', TRUE);
+ $page->selectFieldOption('Severity', 'Alert', TRUE);
+ $page->selectFieldOption('Severity', 'Critical', TRUE);
+ $page->selectFieldOption('Severity', 'Warning', TRUE);
+ $page->pressButton('Filter');
+ $assert_session->pageTextContains('No log messages available.');
+
+ // Ensure that the update occurred.
+ $page->selectFieldOption('Severity', 'Info');
+ $page->pressButton('Filter');
+ // There should be a log entry about the successful update.
+ $log_entry = $assert_session->elementExists('named', [
+ 'link',
+ 'Drupal core has been updated from 9.8.0 to 9.8.1'
+ ]);
+ $this->assertStringContainsString('/admin/reports/dblog/event/', $log_entry->getAttribute('href'));
+ $this->assertUpdateSuccessful('9.8.1');
+ // \Drupal\automatic_updates\Routing\RouteSubscriber::alterRoutes() sets
+ // `_automatic_updates_status_messages: skip` on the route for the path
+ // `/admin/modules/reports/status`, but not on the `/admin/reports` path. So
+ // to test AdminStatusCheckMessages::displayAdminPageMessages(), another
+ // page must be visited. `/admin/reports` was chosen, but it could be
+ // another too.
+ $assert_session->addressEquals('/admin/reports/status');
+ $this->visit('/admin/reports');
+ $assert_session->statusCodeEquals(200);
+ // @see \Drupal\automatic_updates\Validation\AdminStatusCheckMessages::displayAdminPageMessages()
+ $this->webAssert->statusMessageNotExists('error');
+ $this->webAssert->statusMessageNotExists('warning');
+ }
+
// BEGIN: DELETE FROM CORE MERGE REQUEST
/**
diff --git a/tests/src/Build/UpdateTestBase.php b/tests/src/Build/UpdateTestBase.php
index 7a960713f9..de359a56cd 100644
--- a/tests/src/Build/UpdateTestBase.php
+++ b/tests/src/Build/UpdateTestBase.php
@@ -30,11 +30,12 @@ END;
'automatic_updates_test_api',
]);
- // Uninstall Automated Cron, which is not supported by Automatic Updates.
+ // Uninstall Automated Cron because this will run cron updates on most
+ // requests making it difficult to test other forms of updating.
// Also uninstall Big Pipe, since it may cause page elements to be rendered
// in the background and replaced with JavaScript, which isn't supported in
// build tests.
- // @see \Drupal\automatic_updates\Validator\AutomatedCronDisabledValidator
+ // @see \Drupal\Tests\automatic_updates\Build\CoreUpdateTest::testAutomatedCron
$page = $this->getMink()->getSession()->getPage();
$this->visit('/admin/modules/uninstall');
$page->checkField("uninstall[automated_cron]");
diff --git a/tests/src/Functional/AutomatedCronDisabledValidatorTest.php b/tests/src/Functional/AutomatedCronDisabledValidatorTest.php
deleted file mode 100644
index 8c2b31f6f1..0000000000
--- a/tests/src/Functional/AutomatedCronDisabledValidatorTest.php
+++ /dev/null
@@ -1,53 +0,0 @@
-<?php
-
-namespace Drupal\Tests\automatic_updates\Functional;
-
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
-
-/**
- * Tests that updates are not run by Automated Cron.
- *
- * @covers \Drupal\automatic_updates\Validator\AutomatedCronDisabledValidator
- * @group automatic_updates
- */
-class AutomatedCronDisabledValidatorTest extends AutomaticUpdatesFunctionalTestBase {
-
- /**
- * {@inheritdoc}
- */
- protected $defaultTheme = 'stark';
-
- /**
- * {@inheritdoc}
- */
- protected static $modules = ['dblog', 'automated_cron'];
-
- /**
- * {@inheritdoc}
- */
- protected function setUp(): void {
- parent::setUp();
- $this->drupalLogin($this->createUser(['access site reports']));
- }
-
- /**
- * Tests that automatic updates are not triggered by Automated Cron.
- */
- public function testAutomatedCronUpdate() {
- // Delete the last cron run time, to ensure that Automated Cron will run.
- $this->container->get('state')->delete('system.cron_last');
- $this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::ALL)
- ->save();
-
- $this->drupalGet('user');
- // The `drupalGet()` will not wait for the HTTP kernel to terminate (i.e.,
- // the `KernelEvents::TERMINATE` event) to complete. Although this event
- // will likely already be completed, wait 1 second to avoid random test
- // failures.
- sleep(1);
- $this->drupalGet('admin/reports/dblog');
- $this->assertSession()->elementAttributeContains('css', 'a[title^="Unattended"]', 'title', 'Unattended automatic updates were triggered by Automated Cron, which is not supported. No update was performed. See the status report for more information.');
- }
-
-}
diff --git a/tests/src/Kernel/StatusCheck/AutomatedCronDisabledValidatorTest.php b/tests/src/Kernel/StatusCheck/AutomatedCronDisabledValidatorTest.php
deleted file mode 100644
index fdccdeabaf..0000000000
--- a/tests/src/Kernel/StatusCheck/AutomatedCronDisabledValidatorTest.php
+++ /dev/null
@@ -1,40 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-
-use Drupal\package_manager\ValidationResult;
-use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
-
-/**
- * @covers \Drupal\automatic_updates\Validator\AutomatedCronDisabledValidator
- * @group automatic_updates
- * @internal
- */
-class AutomatedCronDisabledValidatorTest extends AutomaticUpdatesKernelTestBase {
-
- /**
- * {@inheritdoc}
- */
- protected static $modules = ['automatic_updates', 'automated_cron'];
-
- /**
- * Tests that cron updates are not allowed if Automated Cron is enabled.
- */
- public function testCronUpdateNotAllowed(): void {
- $expected_results = [
- ValidationResult::createWarning([
- t('This site has the Automated Cron module installed. To use unattended automatic updates, please configure cron manually on your hosting environment. The Automatic Updates module will not do anything if it is triggered by Automated Cron. See the <a href=":url">Automated Cron documentation</a> for information.', [
- ':url' => 'https://www.drupal.org/docs/administering-a-drupal-site/cron-automated-tasks/cron-automated-tasks-overview#s-more-reliable-enable-cron-using-external-trigger',
- ]),
- ]),
- ];
- $this->assertCheckerResultsFromManager($expected_results, TRUE);
-
- // Even after a cron run, we should have the same results.
- $this->container->get('cron')->run();
- $this->assertCheckerResultsFromManager($expected_results);
- }
-
-}
--
GitLab
From 435b752765eca2a3f89b5d51b274c4c7c99d86d0 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 28 Jun 2023 15:50:30 -0400
Subject: [PATCH 031/142] code cleanup
---
drupalci.yml | 2 +-
.../tests/src/Build/TemplateProjectTestBase.php | 10 ++--------
src/CronUpdateStage.php | 10 +++++-----
tests/src/Build/CoreUpdateTest.php | 4 ++--
tests/src/Kernel/DrushUpdateStageTest.php | 1 -
5 files changed, 10 insertions(+), 17 deletions(-)
diff --git a/drupalci.yml b/drupalci.yml
index ff326d13cf..3cd1b3cc07 100644
--- a/drupalci.yml
+++ b/drupalci.yml
@@ -14,7 +14,7 @@ build:
# Update to latest Composer.
- composer self-update
# @todo Replace in favor of commit-code-check.sh once https://www.drupal.org/project/drupal/issues/3314100 lands.
- # - modules/contrib/automatic_updates/scripts/commit-code-check.sh --drupalci
+ - modules/contrib/automatic_updates/scripts/commit-code-check.sh --drupalci
halt-on-fail: true
# run_tests task is executed several times in order of performance speeds.
# halt-on-fail can be set on the run_tests tasks in order to fail fast.
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index 6e603ac3a6..1863c8b275 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -571,7 +571,7 @@ END;
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
- protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL, bool $allow_additional_events = FALSE): void {
+ protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL): void {
if ($expected_events === NULL) {
$expected_events = [
PreCreateEvent::class,
@@ -613,13 +613,7 @@ END;
foreach ($expected_events as $event) {
$expected_titles[] = "package_manager_test_event_logger-start: Event: $event, Stage instance of: $expected_stage_class:package_manager_test_event_logger-end";
}
- if (!$allow_additional_events) {
- $this->assertSame($expected_titles, $actual_titles, $message ?? '');
- }
- else {
- $this->assertEmpty(array_diff($expected_titles, $actual_titles), $message ?? '');
- }
-
+ $this->assertSame($expected_titles, $actual_titles, $message ?? '');
}
/**
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 64017e70e4..019b2f73a3 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -112,22 +112,22 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
// Temporary command to test detached process still runs after response.
- //$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path test-process &");
- $process->setworkingdirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- //$process->disableOutput();
+ // $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path test-process &");
+ $process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
+ // $process->disableOutput();
$process->setTimeout(0);
try {
$process->start();
sleep(1);
$wait_till = time() + 5;
- //Wait for the process to start.
+ // Wait for the process to start.
while (is_null($process->getPid()) && $wait_till > time()) {
}
}
catch (\Throwable $throwable) {
- watchdog_exception('automatic_updates', $throwable, 'affff');
+ watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
}
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 7bd823e711..50342ae47b 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -378,7 +378,7 @@ class CoreUpdateTest extends UpdateTestBase {
}
/**
- *
+ * Assert a cron update ran successfully.
*/
protected function assertCronUpdateSuccessful(): void {
$mink = $this->getMink();
@@ -412,7 +412,7 @@ class CoreUpdateTest extends UpdateTestBase {
// There should be a log entry about the successful update.
$log_entry = $assert_session->elementExists('named', [
'link',
- 'Drupal core has been updated from 9.8.0 to 9.8.1'
+ 'Drupal core has been updated from 9.8.0 to 9.8.1',
]);
$this->assertStringContainsString('/admin/reports/dblog/event/', $log_entry->getAttribute('href'));
$this->assertUpdateSuccessful('9.8.1');
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 99a79db522..0ad1049406 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -5,7 +5,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
--
GitLab
From 434a8c29afe6afe1b074954c2e428de52677ee37 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 28 Jun 2023 15:55:27 -0400
Subject: [PATCH 032/142] remove temp drush command to test a dettached process
---
src/Commands/AutomaticUpdatesCommands.php | 16 ----------
src/CronUpdateStage.php | 22 +------------
.../automatic_updates_test_api.routing.yml | 9 ------
.../src/ApiController.php | 31 ++++---------------
4 files changed, 7 insertions(+), 71 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 6e76a043b3..90a0461ce4 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -110,20 +110,4 @@ final class AutomaticUpdatesCommands extends DrushCommands {
}
}
- /**
- * Temp test to confirm the detached process would still run.
- *
- * @usage test-process
- * Automatically updates Drupal core, if any updates are available.
- *
- * @command test-process
- */
- public function testProcess() {
- $c = 0;
- while ($c < 10) {
- $c++;
- sleep(1);
- }
- }
-
}
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 019b2f73a3..704949d40c 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -90,29 +90,11 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
// background updates.
// @todo Replace drush call with Symfony console command in
// https://www.drupal.org/i/3360485
- // @todo Why isn't it in vendor bin?
+ // @todo Why isn't it in vendor bin in build tests?
$drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
$phpBinaryFinder = new PhpExecutableFinder();
- // Test generic drush output
- $drush_check = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path");
- $cwd = $this->pathLocator->getProjectRoot();
-
- if ($web_root = $this->pathLocator->getWebRoot()) {
- $cwd .= DIRECTORY_SEPARATOR . $web_root;
- }
-
- $cwd .= DIRECTORY_SEPARATOR . 'sites/default';
- $drush_check->setWorkingDirectory($cwd);
-
- try {
- $drush_check->mustRun();
- }
- catch (\Throwable $throwable) {
- }
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
- // Temporary command to test detached process still runs after response.
- // $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path test-process &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
// $process->disableOutput();
$process->setTimeout(0);
@@ -165,8 +147,6 @@ class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface
$this->runTerminalUpdateCommand();
$lock->release('cron');
}
- else {
- }
}
return $inner_success;
}
diff --git a/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml b/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
index 7908a2f855..b7cd7895f2 100644
--- a/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
+++ b/tests/modules/automatic_updates_test_api/automatic_updates_test_api.routing.yml
@@ -12,15 +12,6 @@ automatic_updates_test_api.finish:
_controller: 'Drupal\automatic_updates_test_api\ApiController::finish'
requirements:
_access: 'TRUE'
-automatic_updates_test_api.test:
- path: '/tester-drush'
- defaults:
- _controller: 'Drupal\automatic_updates_test_api\ApiController::testProcess'
- requirements:
- _access: 'TRUE'
- options:
- _maintenance_access: TRUE
- no_cache: TRUE
automatic_updates_test_api.reset_cron:
path: '/automatic-updates-test-api/reset-cron'
defaults:
diff --git a/tests/modules/automatic_updates_test_api/src/ApiController.php b/tests/modules/automatic_updates_test_api/src/ApiController.php
index 38a824ecb4..18003aabf1 100644
--- a/tests/modules/automatic_updates_test_api/src/ApiController.php
+++ b/tests/modules/automatic_updates_test_api/src/ApiController.php
@@ -8,8 +8,6 @@ use Drupal\package_manager_test_api\ApiController as PackageManagerApiController
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Process\PhpExecutableFinder;
-use Symfony\Component\Process\Process;
class ApiController extends PackageManagerApiController {
@@ -38,32 +36,15 @@ class ApiController extends PackageManagerApiController {
return $id;
}
+ /**
+ * Resets cron.
+ *
+ * @return \Symfony\Component\HttpFoundation\Response
+ * The response.
+ */
public function resetCron(): Response {
\Drupal::state()->delete('system.cron_last');
return new Response('cron reset');
}
- public function testProcess(): array {
- $path_locator = \Drupal::service('package_manager.path_locator');
- $drush_path = $path_locator->getVendorDirectory() . '/drush/drush/drush';
- $phpBinaryFinder = new PhpExecutableFinder();
- sleep(5);
- $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
- // $process = new Process([$phpBinaryFinder->find(), $drush_path, 'auto-update', '&']);
- $process->setWorkingDirectory($path_locator->getProjectRoot() . DIRECTORY_SEPARATOR . $path_locator->getWebRoot());
- $process->disableOutput();
- $process->setTimeout(0);
- try {
- $process->start();
- }
- catch (\Throwable $throwable) {
- // @todo Does this work 10.0.x?
- watchdog_exception('auto_updates', $throwable, 'Could not perform background update.');
- }
- return [
- '#type' => 'markup',
- '#markup' => time(),
- ];
- }
-
}
--
GitLab
From a4787b621138ba8f7898375191d5dea69fca189d Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 28 Jun 2023 16:06:14 -0400
Subject: [PATCH 033/142] add build test comment
---
tests/src/Build/CoreUpdateTest.php | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 50342ae47b..cb9853e362 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -26,8 +26,6 @@ use Symfony\Component\Process\Process;
*/
class CoreUpdateTest extends UpdateTestBase {
- protected $destroyBuild = FALSE;
-
/**
* WebAssert object.
*
@@ -152,6 +150,9 @@ class CoreUpdateTest extends UpdateTestBase {
]);
}
+ /**
+ * Tests updating during cron using the Automated Cron module.
+ */
public function testAutomatedCron(): void {
$this->createTestProject('RecommendedProject');
$output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
--
GitLab
From c57688036d911a421d4cd2cb161d26808d4297fd Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 29 Jun 2023 08:32:37 -0400
Subject: [PATCH 034/142] change to CronUpdateRunner working on it
---
automatic_updates.install | 3 +-
automatic_updates.module | 15 +-
automatic_updates.services.yml | 19 +--
src/CronUpdateRunner.php | 136 ++++++++++++++++
src/CronUpdateStage.php | 154 ------------------
src/DrushUpdateStage.php | 29 +++-
src/UnattendedUpdateStageBase.php | 140 ----------------
src/Validation/AdminStatusCheckMessages.php | 13 +-
src/Validation/StatusChecker.php | 15 +-
src/Validator/CronFrequencyValidator.php | 8 +-
src/Validator/PhpExtensionsValidator.php | 4 +-
.../StagedDatabaseUpdateValidator.php | 4 +-
src/Validator/VersionPolicyValidator.php | 9 +-
.../automatic_updates_test_cron.module | 8 +-
.../AutomaticUpdatesFunctionalTestBase.php | 3 +-
tests/src/Functional/StatusCheckTest.php | 5 +-
.../UpdateSettingsFormTest.php | 9 +-
.../Kernel/AutomaticUpdatesKernelTestBase.php | 16 +-
tests/src/Kernel/CronUpdateStageTest.php | 8 +-
tests/src/Kernel/DrushUpdateStageTest.php | 37 ++---
tests/src/Kernel/ReleaseChooserTest.php | 14 +-
.../CronFrequencyValidatorTest.php | 5 +-
.../PhpExtensionsValidatorTest.php | 9 +-
.../StatusCheckFailureEmailTest.php | 7 +-
.../Kernel/StatusCheck/StatusCheckerTest.php | 8 +-
.../VersionPolicyValidatorTest.php | 69 ++++----
26 files changed, 288 insertions(+), 459 deletions(-)
create mode 100644 src/CronUpdateRunner.php
delete mode 100644 src/CronUpdateStage.php
delete mode 100644 src/UnattendedUpdateStageBase.php
diff --git a/automatic_updates.install b/automatic_updates.install
index e2a04c7df4..5d37e1dabd 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -7,7 +7,6 @@
declare(strict_types = 1);
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates\Validation\StatusCheckRequirements;
use Drupal\system\SystemManager;
@@ -30,7 +29,7 @@ function automatic_updates_requirements($phase) {
// Check that site has cron updates enabled or not.
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
- if (\Drupal::configFactory()->get('automatic_updates.settings')->get('unattended.level') !== UnattendedUpdateStageBase::DISABLED) {
+ if (\Drupal::configFactory()->get('automatic_updates.settings')->get('unattended.level') !== CronUpdateRunner::DISABLED) {
$requirements['automatic_updates_cron'] = [
'title' => t('Cron installs updates automatically'),
'severity' => SystemManager::REQUIREMENT_WARNING,
diff --git a/automatic_updates.module b/automatic_updates.module
index 2e3120d330..12c9a58089 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -8,7 +8,6 @@
declare(strict_types = 1);
use Drupal\automatic_updates\BatchProcessor;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\automatic_updates\Validation\AdminStatusCheckMessages;
@@ -159,12 +158,12 @@ function automatic_updates_modules_installed($modules) {
/** @var \Drupal\automatic_updates\Validation\StatusChecker $status_checker */
$status_checker = \Drupal::service('automatic_updates.status_checker');
$status_checker->run();
- /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
- $stage = \Drupal::service('automatic_updates.cron_update_stage');
+ /** @var \Drupal\automatic_updates\CronUpdateRunner $stage */
+ $stage = \Drupal::service('automatic_updates.cron_update_runner');
// If cron updates are disabled status check messages will not be displayed on
// admin pages. Therefore, after installing the module the user will not be
// alerted to any problems until they access the status report page.
- if ($stage->getMode() === UnattendedUpdateStageBase::DISABLED) {
+ if ($stage->getMode() === CronUpdateRunner::DISABLED) {
/** @var \Drupal\automatic_updates\Validation\AdminStatusCheckMessages $status_check_messages */
$status_check_messages = \Drupal::classResolver(AdminStatusCheckMessages::class);
$status_check_messages->displayResultSummary();
@@ -205,9 +204,9 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
'#type' => 'radios',
'#title' => t('Unattended background updates'),
'#options' => [
- UnattendedUpdateStageBase::DISABLED => t('Disabled'),
- UnattendedUpdateStageBase::SECURITY => t('Security updates only'),
- UnattendedUpdateStageBase::ALL => t('All patch releases'),
+ CronUpdateRunner::DISABLED => t('Disabled'),
+ CronUpdateRunner::SECURITY => t('Security updates only'),
+ CronUpdateRunner::ALL => t('All patch releases'),
],
'#default_value' => $config->get('unattended.level'),
];
@@ -222,7 +221,7 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
'#states' => [
'invisible' => [
'input[name="unattended_level"]' => [
- 'value' => UnattendedUpdateStageBase::DISABLED,
+ 'value' => CronUpdateRunner::DISABLED,
],
],
],
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index ba79d9b182..eca6f98198 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -23,27 +23,16 @@ services:
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
Drupal\automatic_updates\UpdateStage: '@automatic_updates.update_stage'
- automatic_updates.cron_update_stage:
- class: Drupal\automatic_updates\CronUpdateStage
+ automatic_updates.cron_update_runner:
+ class: Drupal\automatic_updates\CronUpdateRunner
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
arguments:
- - '@automatic_updates.release_chooser'
- '@config.factory'
- - '@package_manager.composer_inspector'
- '@package_manager.path_locator'
- - '@PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface'
- - '@PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface'
- - '@PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface'
- - '@file_system'
- - '@event_dispatcher'
- - '@tempstore.shared'
- - '@datetime.time'
- - '@PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface'
- - '@package_manager.failure_marker'
- - '@automatic_updates.cron_update_stage.inner'
+ - '@automatic_updates.cron_update_runner.inner'
decorates: 'cron'
- Drupal\automatic_updates\CronUpdateStage: '@automatic_updates.cron_update_stage'
+ Drupal\automatic_updates\CronUpdateRunner: '@automatic_updates.cron_update_runner'
automatic_updates.requested_update_validator:
class: Drupal\automatic_updates\Validator\RequestedUpdateValidator
tags:
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
new file mode 100644
index 0000000000..0d848e26b9
--- /dev/null
+++ b/src/CronUpdateRunner.php
@@ -0,0 +1,136 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\automatic_updates;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\CronInterface;
+use Drupal\package_manager\PathLocator;
+use Psr\Log\LoggerAwareTrait;
+use Symfony\Component\Process\PhpExecutableFinder;
+use Symfony\Component\Process\Process;
+
+/**
+ * Defines a service that updates via cron.
+ *
+ * @internal
+ * This class implements logic specific to Automatic Updates' cron hook
+ * implementation and may be changed or removed at any time without warning.
+ * It should not be called directly, and external code should not interact
+ * with it.
+ */
+class CronUpdateRunner implements CronInterface {
+
+ use LoggerAwareTrait;
+
+ /**
+ * All automatic updates are disabled.
+ *
+ * @var string
+ */
+ public const DISABLED = 'disable';
+
+ /**
+ * Only perform automatic security updates.
+ *
+ * @var string
+ */
+ public const SECURITY = 'security';
+
+ /**
+ * All automatic updates are enabled.
+ *
+ * @var string
+ */
+ public const ALL = 'patch';
+
+ /**
+ * Constructs a CronUpdateRunner object.
+ *
+ * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
+ * The config factory service.
+ * @param \Drupal\package_manager\PathLocator $pathLocator
+ * The path locator service.
+ * @param \Drupal\Core\CronInterface $inner
+ * The decorated cron service.
+ */
+ public function __construct(
+ private readonly ConfigFactoryInterface $configFactory,
+ private readonly PathLocator $pathLocator,
+ private readonly CronInterface $inner
+ ) {}
+
+ /**
+ * Runs the terminal update command.
+ */
+ public function runTerminalUpdateCommand(): void {
+ // @todo Make a validator to ensure this path exists if settings select
+ // background updates.
+ // @todo Replace drush call with Symfony console command in
+ // https://www.drupal.org/i/3360485
+ // @todo Why isn't it in vendor bin in build tests?
+ $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
+ $phpBinaryFinder = new PhpExecutableFinder();
+
+ $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
+ $process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
+ // $process->disableOutput();
+ $process->setTimeout(0);
+
+ try {
+ $process->start();
+ sleep(1);
+ $wait_till = time() + 5;
+ // Wait for the process to start.
+ while (is_null($process->getPid()) && $wait_till > time()) {
+ }
+ }
+
+ catch (\Throwable $throwable) {
+ watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function run() {
+ $method = $this->configFactory->get('automatic_updates.settings')
+ ->get('unattended.method');
+ // Always run the cron service before we trigger the update terminal
+ // command.
+ $inner_success = $this->inner->run();
+
+ // If we are configured to run updates via the web, and we're actually being
+ // accessed via the web (i.e., anything that isn't the command line), go
+ // ahead and try to do the update. In all other circumstances, just run the
+ // normal cron handler.
+ if ($this->getMode() !== self::DISABLED && $method === 'web') {
+ $lock = \Drupal::lock();
+ if ($lock->acquire('cron', 30)) {
+ $this->runTerminalUpdateCommand();
+ $lock->release('cron');
+ }
+ }
+ return $inner_success;
+ }
+
+ /**
+ * Gets the cron update mode.
+ *
+ * @return string
+ * The cron update mode. Will be one of the following constants:
+ * - self::DISABLED if updates during
+ * cron are entirely disabled.
+ * - self::SECURITY only security
+ * updates can be done during cron.
+ * - self::ALL if all updates are
+ * allowed during cron.
+ */
+ final public function getMode(): string {
+ $mode = $this->configFactory->get('automatic_updates.settings')->get('unattended.level');
+ return $mode ?: static::SECURITY;
+ }
+
+}
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
deleted file mode 100644
index 704949d40c..0000000000
--- a/src/CronUpdateStage.php
+++ /dev/null
@@ -1,154 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\automatic_updates;
-
-use Drupal\Component\Datetime\TimeInterface;
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\CronInterface;
-use Drupal\Core\File\FileSystemInterface;
-use Drupal\Core\TempStore\SharedTempStoreFactory;
-use Drupal\package_manager\ComposerInspector;
-use Drupal\package_manager\FailureMarker;
-use Drupal\package_manager\PathLocator;
-use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
-use PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface;
-use PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface;
-use PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface;
-use Symfony\Component\Process\PhpExecutableFinder;
-use Symfony\Component\Process\Process;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
-
-/**
- * Defines a service that updates via cron.
- *
- * @internal
- * This class implements logic specific to Automatic Updates' cron hook
- * implementation and may be changed or removed at any time without warning.
- * It should not be called directly, and external code should not interact
- * with it.
- */
-class CronUpdateStage extends UnattendedUpdateStageBase implements CronInterface {
-
- /**
- * Constructs a CronUpdateStage object.
- *
- * @param \Drupal\automatic_updates\ReleaseChooser $releaseChooser
- * The cron release chooser service.
- * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
- * The config factory service.
- * @param \Drupal\package_manager\ComposerInspector $composerInspector
- * The Composer inspector service.
- * @param \Drupal\package_manager\PathLocator $pathLocator
- * The path locator service.
- * @param \PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface $beginner
- * The beginner service.
- * @param \PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface $stager
- * The stager service.
- * @param \PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface $committer
- * The committer service.
- * @param \Drupal\Core\File\FileSystemInterface $fileSystem
- * The file system service.
- * @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $eventDispatcher
- * The event dispatcher service.
- * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempStoreFactory
- * The shared tempstore factory.
- * @param \Drupal\Component\Datetime\TimeInterface $time
- * The time service.
- * @param \PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface $pathFactory
- * The path factory service.
- * @param \Drupal\package_manager\FailureMarker $failureMarker
- * The failure marker service.
- * @param \Drupal\Core\CronInterface $inner
- * The decorated cron service.
- */
- public function __construct(
- ReleaseChooser $releaseChooser,
- ConfigFactoryInterface $configFactory,
- ComposerInspector $composerInspector,
- PathLocator $pathLocator,
- BeginnerInterface $beginner,
- StagerInterface $stager,
- CommitterInterface $committer,
- FileSystemInterface $fileSystem,
- EventDispatcherInterface $eventDispatcher,
- SharedTempStoreFactory $tempStoreFactory,
- TimeInterface $time,
- PathFactoryInterface $pathFactory,
- FailureMarker $failureMarker,
- private readonly CronInterface $inner
- ) {
- parent::__construct($releaseChooser, $configFactory, $composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
- }
-
- /**
- * Runs the terminal update command.
- */
- public function runTerminalUpdateCommand(): void {
- // @todo Make a validator to ensure this path exists if settings select
- // background updates.
- // @todo Replace drush call with Symfony console command in
- // https://www.drupal.org/i/3360485
- // @todo Why isn't it in vendor bin in build tests?
- $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
- $phpBinaryFinder = new PhpExecutableFinder();
-
- $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
- $process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- // $process->disableOutput();
- $process->setTimeout(0);
-
- try {
- $process->start();
- sleep(1);
- $wait_till = time() + 5;
- // Wait for the process to start.
- while (is_null($process->getPid()) && $wait_till > time()) {
- }
- }
-
- catch (\Throwable $throwable) {
- watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
- }
- }
-
- /**
- * {@inheritdoc}
- */
- final public function begin(array $project_versions, ?int $timeout = 300): never {
- // Unattended updates should never be started using this method. They should
- // only be done by ::handleCron(), which has a strong opinion about which
- // release to update to. Throwing an exception here is just to enforce this
- // boundary. To update to a specific version of core, use
- // \Drupal\automatic_updates\UpdateStage::begin() (which is called in
- // ::performUpdate() to start the update to the target version of core
- // chosen by ::handleCron()).
- throw new \BadMethodCallException(__METHOD__ . '() cannot be called directly.');
- }
-
- /**
- * {@inheritdoc}
- */
- public function run() {
- $method = $this->configFactory->get('automatic_updates.settings')
- ->get('unattended.method');
- // Always run the cron service before we trigger the update terminal
- // command.
- $inner_success = $this->inner->run();
-
- // If we are configured to run updates via the web, and we're actually being
- // accessed via the web (i.e., anything that isn't the command line), go
- // ahead and try to do the update. In all other circumstances, just run the
- // normal cron handler.
- if ($this->getMode() !== self::DISABLED && $method === 'web') {
- $lock = \Drupal::lock();
- if ($lock->acquire('cron', 30)) {
- $this->runTerminalUpdateCommand();
- $lock->release('cron');
- }
- }
- return $inner_success;
- }
-
-}
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index cd7d9359e0..3d73026816 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -5,7 +5,6 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates;
use Drupal\Component\Datetime\TimeInterface;
-use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Mail\MailManagerInterface;
use Drupal\Core\TempStore\SharedTempStoreFactory;
@@ -18,6 +17,7 @@ use Drupal\package_manager\Exception\StageFailureMarkerException;
use Drupal\package_manager\FailureMarker;
use Drupal\package_manager\PathLocator;
use Drupal\package_manager\ProjectInfo;
+use Drupal\update\ProjectRelease;
use Drush\Drush;
use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
use PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface;
@@ -29,19 +29,19 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
* An updater that runs via a Drush command.
*/
-class DrushUpdateStage extends UnattendedUpdateStageBase {
+class DrushUpdateStage extends UpdateStage {
/**
- * Constructs a UnattendedUpdateStageBase object.
+ * Constructs a DrushUpdateStage object.
*
+ * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * The cron update runner service.
* @param \Drupal\Core\Mail\MailManagerInterface $mailManager
* The mail manager service.
* @param \Drupal\automatic_updates\StatusCheckMailer $statusCheckMailer
* The status check mailer service.
* @param \Drupal\automatic_updates\ReleaseChooser $releaseChooser
* The cron release chooser service.
- * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
- * The config factory service.
* @param \Drupal\package_manager\ComposerInspector $composerInspector
* The Composer inspector service.
* @param \Drupal\package_manager\PathLocator $pathLocator
@@ -66,10 +66,10 @@ class DrushUpdateStage extends UnattendedUpdateStageBase {
* The failure marker service.
*/
public function __construct(
+ private readonly CronUpdateRunner $cronUpdateRunner,
private readonly MailManagerInterface $mailManager,
private readonly StatusCheckMailer $statusCheckMailer,
- ReleaseChooser $releaseChooser,
- ConfigFactoryInterface $configFactory,
+ private readonly ReleaseChooser $releaseChooser,
ComposerInspector $composerInspector,
PathLocator $pathLocator,
BeginnerInterface $beginner,
@@ -82,7 +82,18 @@ class DrushUpdateStage extends UnattendedUpdateStageBase {
PathFactoryInterface $pathFactory,
FailureMarker $failureMarker,
) {
- parent::__construct($releaseChooser, $configFactory, $composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
+ parent::__construct($composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
+ }
+
+ /**
+ * Returns the release of Drupal core to update to, if any.
+ *
+ * @return \Drupal\update\ProjectRelease|null
+ * The release of Drupal core to which we will update, or NULL if there is
+ * nothing to update to.
+ */
+ public function getTargetRelease(): ?ProjectRelease {
+ return $this->releaseChooser->getLatestInInstalledMinor($this);
}
/**
@@ -111,7 +122,7 @@ class DrushUpdateStage extends UnattendedUpdateStageBase {
* Returns TRUE if any update was attempted, otherwise FALSE.
*/
public function performUpdate(): bool {
- if ($this->getMode() === static::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
return FALSE;
}
diff --git a/src/UnattendedUpdateStageBase.php b/src/UnattendedUpdateStageBase.php
deleted file mode 100644
index c3f8f78af5..0000000000
--- a/src/UnattendedUpdateStageBase.php
+++ /dev/null
@@ -1,140 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\automatic_updates;
-
-use Drupal\Component\Datetime\TimeInterface;
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\File\FileSystemInterface;
-use Drupal\Core\TempStore\SharedTempStoreFactory;
-use Drupal\package_manager\ComposerInspector;
-use Drupal\package_manager\FailureMarker;
-use Drupal\package_manager\PathLocator;
-use Drupal\update\ProjectRelease;
-use PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface;
-use PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface;
-use PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface;
-use PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
-
-/**
- * A base class for unattended updates.
- */
-class UnattendedUpdateStageBase extends UpdateStage {
-
- /**
- * The current interface between PHP and the server.
- *
- * @var string
- */
- protected static $serverApi = PHP_SAPI;
-
- /**
- * All automatic updates are disabled.
- *
- * @var string
- */
- public const DISABLED = 'disable';
-
- /**
- * Only perform automatic security updates.
- *
- * @var string
- */
- public const SECURITY = 'security';
-
- /**
- * All automatic updates are enabled.
- *
- * @var string
- */
- public const ALL = 'patch';
-
- /**
- * Constructs a UnattendedUpdateStageBase object.
- *
- * @param \Drupal\automatic_updates\ReleaseChooser $releaseChooser
- * The cron release chooser service.
- * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
- * The config factory service.
- * @param \Drupal\package_manager\ComposerInspector $composerInspector
- * The Composer inspector service.
- * @param \Drupal\package_manager\PathLocator $pathLocator
- * The path locator service.
- * @param \PhpTuf\ComposerStager\Domain\Core\Beginner\BeginnerInterface $beginner
- * The beginner service.
- * @param \PhpTuf\ComposerStager\Domain\Core\Stager\StagerInterface $stager
- * The stager service.
- * @param \PhpTuf\ComposerStager\Domain\Core\Committer\CommitterInterface $committer
- * The committer service.
- * @param \Drupal\Core\File\FileSystemInterface $fileSystem
- * The file system service.
- * @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $eventDispatcher
- * The event dispatcher service.
- * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempStoreFactory
- * The shared tempstore factory.
- * @param \Drupal\Component\Datetime\TimeInterface $time
- * The time service.
- * @param \PhpTuf\ComposerStager\Infrastructure\Factory\Path\PathFactoryInterface $pathFactory
- * The path factory service.
- * @param \Drupal\package_manager\FailureMarker $failureMarker
- * The failure marker service.
- */
- public function __construct(
- private readonly ReleaseChooser $releaseChooser,
- protected readonly ConfigFactoryInterface $configFactory,
- ComposerInspector $composerInspector,
- PathLocator $pathLocator,
- BeginnerInterface $beginner,
- StagerInterface $stager,
- CommitterInterface $committer,
- FileSystemInterface $fileSystem,
- EventDispatcherInterface $eventDispatcher,
- SharedTempStoreFactory $tempStoreFactory,
- TimeInterface $time,
- PathFactoryInterface $pathFactory,
- FailureMarker $failureMarker,
- ) {
- parent::__construct($composerInspector, $pathLocator, $beginner, $stager, $committer, $fileSystem, $eventDispatcher, $tempStoreFactory, $time, $pathFactory, $failureMarker);
- }
-
- /**
- * Gets the cron update mode.
- *
- * @return string
- * The cron update mode. Will be one of the following constants:
- * - \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED if updates during
- * cron are entirely disabled.
- * - \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY only security
- * updates can be done during cron.
- * - \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL if all updates are
- * allowed during cron.
- */
- final public function getMode(): string {
- $mode = $this->configFactory->get('automatic_updates.settings')->get('unattended.level');
- return $mode ?: static::SECURITY;
- }
-
- /**
- * Indicates if we are currently running at the command line.
- *
- * @return bool
- * TRUE if we are running at the command line, otherwise FALSE.
- */
- final public static function isCommandLine(): bool {
- return self::$serverApi === 'cli';
- }
-
- /**
- * Returns the release of Drupal core to update to, if any.
- *
- * @return \Drupal\update\ProjectRelease|null
- * The release of Drupal core to which we will update, or NULL if there is
- * nothing to update to.
- */
- public function getTargetRelease(): ?ProjectRelease {
- return $this->releaseChooser->getLatestInInstalledMinor($this);
- }
-
-}
diff --git a/src/Validation/AdminStatusCheckMessages.php b/src/Validation/AdminStatusCheckMessages.php
index a53709afc2..97faa3f760 100644
--- a/src/Validation/AdminStatusCheckMessages.php
+++ b/src/Validation/AdminStatusCheckMessages.php
@@ -4,8 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validation;
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Messenger\MessengerInterface;
@@ -47,8 +46,8 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
* The current user.
* @param \Drupal\Core\Routing\CurrentRouteMatch $currentRouteMatch
* The current route match.
- * @param \Drupal\automatic_updates\CronUpdateStage $stage
- * The cron update stage service.
+ * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * The cron update runner service.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
@@ -59,7 +58,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
private readonly AdminContext $adminContext,
private readonly AccountProxyInterface $currentUser,
private readonly CurrentRouteMatch $currentRouteMatch,
- private readonly CronUpdateStage $stage,
+ private readonly CronUpdateRunner $cronUpdateRunner,
private readonly RendererInterface $renderer,
private readonly ConfigFactoryInterface $configFactory
) {}
@@ -73,7 +72,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
$container->get('router.admin_context'),
$container->get('current_user'),
$container->get('current_route_match'),
- $container->get('automatic_updates.cron_update_stage'),
+ $container->get('automatic_updates.cron_update_runner'),
$container->get('renderer'),
$container->get('config.factory')
);
@@ -121,7 +120,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
protected function displayResultsOnCurrentPage(): bool {
// If updates will not run during cron then we don't need to show the
// status checks on admin pages.
- if ($this->stage->getMode() === UnattendedUpdateStageBase::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
return FALSE;
}
diff --git a/src/Validation/StatusChecker.php b/src/Validation/StatusChecker.php
index d342e5203b..5c3c6b2c4b 100644
--- a/src/Validation/StatusChecker.php
+++ b/src/Validation/StatusChecker.php
@@ -4,9 +4,9 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validation;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
use Drupal\package_manager\StatusCheckTrait;
@@ -42,7 +42,7 @@ final class StatusChecker implements EventSubscriberInterface {
* The event dispatcher service.
* @param \Drupal\automatic_updates\UpdateStage $updateStage
* The update stage service.
- * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateStage
+ * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
* The cron update stage service.
* @param int $resultsTimeToLive
* The number of hours to store results.
@@ -52,7 +52,8 @@ final class StatusChecker implements EventSubscriberInterface {
private readonly TimeInterface $time,
private readonly EventDispatcherInterface $eventDispatcher,
private readonly UpdateStage $updateStage,
- private readonly CronUpdateStage $cronUpdateStage,
+ private readonly DrushUpdateStage $unattendedUpdateStage,
+ private readonly CronUpdateRunner $cronUpdateRunner,
private readonly int $resultsTimeToLive,
) {
$this->keyValueExpirable = $key_value_expirable_factory->get('automatic_updates');
@@ -64,14 +65,14 @@ final class StatusChecker implements EventSubscriberInterface {
* @return $this
*/
public function run(): self {
- // If updates will run during cron, use the cron update stage service
+ // If updates will run during cron, use the unattended update stage service
// provided by this module. This will allow validators to run specific
// validation for conditions that only affect cron updates.
- if ($this->cronUpdateStage->getMode() === UnattendedUpdateStageBase::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
$stage = $this->updateStage;
}
else {
- $stage = $this->cronUpdateStage;
+ $stage = $this->unattendedUpdateStage;
}
$results = $this->runStatusCheck($stage, $this->eventDispatcher);
diff --git a/src/Validator/CronFrequencyValidator.php b/src/Validator/CronFrequencyValidator.php
index 9b82925d4a..33d484d983 100644
--- a/src/Validator/CronFrequencyValidator.php
+++ b/src/Validator/CronFrequencyValidator.php
@@ -4,7 +4,8 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Lock\LockBackendInterface;
@@ -65,6 +66,7 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
* The lock service.
*/
public function __construct(
+ private readonly CronUpdateRunner $cronUpdateRunner,
private readonly ConfigFactoryInterface $configFactory,
private readonly StateInterface $state,
private readonly TimeInterface $time,
@@ -79,12 +81,12 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
*/
public function validateLastCronRun(StatusCheckEvent $event): void {
// We only want to do this check if the stage belongs to Automatic Updates.
- if (!$event->stage instanceof UnattendedUpdateStageBase) {
+ if (!$event->stage instanceof DrushUpdateStage) {
return;
}
// If automatic updates are disabled during cron, there's nothing we need
// to validate.
- if ($event->stage->getMode() === UnattendedUpdateStageBase::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
return;
}
// If cron is running right now, cron is clearly being run recently enough!
diff --git a/src/Validator/PhpExtensionsValidator.php b/src/Validator/PhpExtensionsValidator.php
index bbbe97787c..9885146661 100644
--- a/src/Validator/PhpExtensionsValidator.php
+++ b/src/Validator/PhpExtensionsValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -26,7 +26,7 @@ final class PhpExtensionsValidator extends PackageManagerPhpExtensionsValidator
* {@inheritdoc}
*/
public function validateXdebug(PreOperationStageEvent $event): void {
- if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof UnattendedUpdateStageBase) {
+ if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof DrushUpdateStage) {
$event->addError([$this->t("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.")]);
}
elseif ($event instanceof StatusCheckEvent) {
diff --git a/src/Validator/StagedDatabaseUpdateValidator.php b/src/Validator/StagedDatabaseUpdateValidator.php
index b2267ad9d7..e2998ddb5d 100644
--- a/src/Validator/StagedDatabaseUpdateValidator.php
+++ b/src/Validator/StagedDatabaseUpdateValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Validator\StagedDBUpdateValidator;
@@ -39,7 +39,7 @@ final class StagedDatabaseUpdateValidator implements EventSubscriberInterface {
*/
public function checkUpdateHooks(PreApplyEvent $event): void {
$stage = $event->stage;
- if (!$stage instanceof UnattendedUpdateStageBase) {
+ if (!$stage instanceof DrushUpdateStage) {
return;
}
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index 3b08ef703f..3f3f2c6338 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Component\Utility\NestedArray;
use Drupal\package_manager\ComposerInspector;
use Drupal\package_manager\Event\StatusCheckEvent;
@@ -49,6 +49,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
* The Composer inspector service.
*/
public function __construct(
+ private readonly DrushUpdateStage $drushUpdateStage,
private readonly ClassResolverInterface $classResolver,
private readonly PathLocator $pathLocator,
private readonly ComposerInspector $composerInspector,
@@ -85,10 +86,10 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
// If this is a cron update, we may need to do additional checks.
- if ($stage instanceof UnattendedUpdateStageBase) {
+ if ($stage instanceof DrushUpdateStage) {
$mode = $stage->getMode();
- if ($mode !== UnattendedUpdateStageBase::DISABLED) {
+ if ($mode !== CronUpdateRunner::DISABLED) {
// If cron updates are enabled, the installed version must be stable;
// no alphas, betas, or RCs.
$rules[] = StableReleaseInstalled::class;
@@ -104,7 +105,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
// If only security updates are allowed during cron, the target
// version must be a security release.
- if ($mode === UnattendedUpdateStageBase::SECURITY) {
+ if ($mode === CronUpdateRunner::SECURITY) {
$rules[] = TargetSecurityRelease::class;
}
}
diff --git a/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module b/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module
index bff8af8d18..258761a05e 100644
--- a/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module
+++ b/tests/modules/automatic_updates_test_cron/automatic_updates_test_cron.module
@@ -10,7 +10,7 @@
declare(strict_types=1);
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\package_manager\ProjectInfo;
use Drupal\Core\Extension\ExtensionVersion;
use Drupal\Core\Form\FormStateInterface;
@@ -33,9 +33,9 @@ function automatic_updates_test_cron_form_update_settings_alter(array &$form, Fo
'#type' => 'radios',
'#title' => t('Automatically update Drupal core'),
'#options' => [
- UnattendedUpdateStageBase::DISABLED => t('Disabled'),
- UnattendedUpdateStageBase::ALL => t('All supported updates'),
- UnattendedUpdateStageBase::SECURITY => t('Security updates only'),
+ CronUpdateRunner::DISABLED => t('Disabled'),
+ CronUpdateRunner::ALL => t('All supported updates'),
+ CronUpdateRunner::SECURITY => t('Security updates only'),
],
'#default_value' => \Drupal::config('automatic_updates.settings')->get('unattended.level'),
'#description' => t(
diff --git a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
index 95f5376026..da516a4d06 100644
--- a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
+++ b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
@@ -4,7 +4,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\fixture_manipulator\StageFixtureManipulator;
use Drupal\package_manager\PathLocator;
use Drupal\Tests\BrowserTestBase;
@@ -40,7 +39,7 @@ abstract class AutomaticUpdatesFunctionalTestBase extends BrowserTestBase {
$this->useFixtureDirectoryAsActive(__DIR__ . '/../../../package_manager/tests/fixtures/fake_site');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
+ ->set('unattended.level', CronUpdateRunner::SECURITY)
->save();
}
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 51e609f138..42d4a94089 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -6,7 +6,6 @@ namespace Drupal\Tests\automatic_updates\Functional;
use Behat\Mink\Element\NodeElement;
use Drupal\automatic_updates\StatusCheckMailer;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\automatic_updates_test_status_checker\EventSubscriber\TestSubscriber2;
@@ -375,7 +374,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// Confirm status check messages are not displayed when cron updates are
// disabled.
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::DISABLED)
+ ->set('unattended.level', CronUpdateRunner::DISABLED)
->save();
$this->drupalGet('admin/structure');
$this->checkForMetaRefresh();
@@ -399,7 +398,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->container->get('module_installer')->install(['automatic_updates', 'automatic_updates_test']);
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
+ ->set('unattended.level', CronUpdateRunner::SECURITY)
->save();
$this->drupalGet('admin/reports/status');
$this->assertNoErrors(TRUE);
diff --git a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
index 35cb0a688b..8a8533847b 100644
--- a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
+++ b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
@@ -2,7 +2,6 @@
namespace Drupal\Tests\automatic_updates\FunctionalJavascript;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
/**
@@ -31,14 +30,14 @@ class UpdateSettingsFormTest extends WebDriverTestBase {
// The default values should be reflected.
$assert_session = $this->assertSession();
$assert_session->fieldValueEquals('unattended_method', 'web');
- $assert_session->fieldValueEquals('unattended_level', UnattendedUpdateStageBase::DISABLED);
+ $assert_session->fieldValueEquals('unattended_level', CronUpdateRunner::DISABLED);
// Since unattended updates are disabled, the method radio buttons should be
// hidden.
$this->assertFalse($assert_session->fieldExists('unattended_method')->isVisible());
// Enabling unattended updates should reveal the method radio buttons.
$page = $this->getSession()->getPage();
- $page->selectFieldOption('unattended_level', UnattendedUpdateStageBase::SECURITY);
+ $page->selectFieldOption('unattended_level', CronUpdateRunner::SECURITY);
$this->assertNotEmpty($assert_session->waitForElementVisible('named', ['field', 'unattended_method']));
$assert_session->elementAttributeContains('named', ['link', 'ensure cron is set up correctly'], 'href', 'http://drupal.org/docs/user_guide/en/security-cron.html');
// Change the method, to ensure it is properly saved in config.
@@ -47,10 +46,10 @@ class UpdateSettingsFormTest extends WebDriverTestBase {
// Ensure the changes are reflected in config.
$page->pressButton('Save configuration');
$config = $this->config('automatic_updates.settings');
- $this->assertSame(UnattendedUpdateStageBase::SECURITY, $config->get('unattended.level'));
+ $this->assertSame(CronUpdateRunner::SECURITY, $config->get('unattended.level'));
$this->assertSame('console', $config->get('unattended.method'));
// Our saved changes should be reflected in the form too.
- $assert_session->fieldValueEquals('unattended_level', UnattendedUpdateStageBase::SECURITY);
+ $assert_session->fieldValueEquals('unattended_level', CronUpdateRunner::SECURITY);
$assert_session->fieldValueEquals('unattended_method', 'console');
}
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index ca2e9cc351..d07ad47389 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -4,9 +4,8 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\DrushUpdateStage;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
@@ -57,7 +56,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
$this->config('automatic_updates.settings')
->set('unattended', [
'method' => 'web',
- 'level' => UnattendedUpdateStageBase::SECURITY,
+ 'level' => CronUpdateRunner::SECURITY,
])
->save();
@@ -70,13 +69,6 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
// from a sane state.
// @see \Drupal\automatic_updates\Validator\CronFrequencyValidator
$this->container->get('state')->set('system.cron_last', time());
-
- // Cron updates are not done when running at the command line, so override
- // our cron handler's PHP_SAPI constant to a valid value that isn't `cli`.
- // The choice of `cgi-fcgi` is arbitrary; see
- // https://www.php.net/php_sapi_name for some valid values of PHP_SAPI.
- $property = new \ReflectionProperty(CronUpdateStage::class, 'serverApi');
- $property->setValue(NULL, 'cgi-fcgi');
}
/**
@@ -94,7 +86,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
- 'automatic_updates.cron_update_stage' => TestCronUpdateStage::class,
+ 'automatic_updates.cron_update_runner' => TestCronUpdateRunner::class,
];
foreach ($overrides as $service_id => $class) {
if ($container->hasDefinition($service_id)) {
@@ -115,7 +107,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
/**
* A test-only version of the cron update stage to override and expose internals.
*/
-class TestCronUpdateStage extends CronUpdateStage {
+class TestCronUpdateRunner extends CronUpdateRunner {
/**
* Determines whether an exception should be thrown.
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index 7802b0fe1d..534d02ec79 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -4,13 +4,13 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
/**
- * @covers \Drupal\automatic_updates\CronUpdateStage
+ * @covers \Drupal\automatic_updates\CronUpdateRunner
* @covers \automatic_updates_test_cron_form_update_settings_alter
* @group automatic_updates
* @internal
@@ -35,8 +35,8 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
* Tests that regular cron always runs.
*/
public function testRegularCronRuns(): void {
- /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
- $cron_stage = $this->container->get(CronUpdateStage::class);
+ /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateRunner $cron_stage */
+ $cron_stage = $this->container->get(CronUpdateRunner::class);
$cron_stage->throwExceptionOnTerminalCommand = TRUE;
$this->assertRegularCronRun(FALSE);
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 0ad1049406..40e0e3a60f 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -4,8 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Logger\RfcLogLevel;
@@ -126,32 +125,32 @@ END;
$fixture_dir = __DIR__ . '/../../../package_manager/tests/fixtures/release-history';
return [
'disabled, normal release' => [
- UnattendedUpdateStageBase::DISABLED,
+ CronUpdateRunner::DISABLED,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
FALSE,
],
'disabled, security release' => [
- UnattendedUpdateStageBase::DISABLED,
+ CronUpdateRunner::DISABLED,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
FALSE,
],
'security only, security release' => [
- UnattendedUpdateStageBase::SECURITY,
+ CronUpdateRunner::SECURITY,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
TRUE,
],
'security only, normal release' => [
- UnattendedUpdateStageBase::SECURITY,
+ CronUpdateRunner::SECURITY,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
FALSE,
],
'enabled, normal release' => [
- UnattendedUpdateStageBase::ALL,
+ CronUpdateRunner::ALL,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
TRUE,
],
'enabled, security release' => [
- UnattendedUpdateStageBase::ALL,
+ CronUpdateRunner::ALL,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
TRUE,
],
@@ -291,7 +290,7 @@ END;
$this->installConfig('automatic_updates');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
+ ->set('unattended.level', CronUpdateRunner::SECURITY)
->save();
// Ensure that there is a security release to which we should update.
$this->setReleaseMetadata([
@@ -306,8 +305,8 @@ END;
->get('cron')
->addLogger($cron_logger);
- /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
- $stage = $this->container->get(CronUpdateStage::class);
+ /** @var \Drupal\automatic_updates\CronUpdateRunner $stage */
+ $stage = $this->container->get(CronUpdateRunner::class);
// When the event specified by $event_class is dispatched, either throw an
// exception directly from the event subscriber, or prepare a
@@ -405,7 +404,7 @@ END;
*/
public function testStageNotDestroyedIfApplying(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::ALL)
+ ->set('unattended.level', CronUpdateRunner::ALL)
->save();
$this->setReleaseMetadata([
'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml",
@@ -445,7 +444,7 @@ END;
*/
public function testStageNotDestroyedIfSecure(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::ALL)
+ ->set('unattended.level', CronUpdateRunner::ALL)
->save();
$this->setReleaseMetadata([
'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml",
@@ -468,8 +467,8 @@ END;
* Tests that CronUpdateStage::begin() unconditionally throws an exception.
*/
public function testBeginThrowsException(): void {
- $this->expectExceptionMessage(CronUpdateStage::class . '::begin() cannot be called directly.');
- $this->container->get(CronUpdateStage::class)
+ $this->expectExceptionMessage(CronUpdateRunner::class . '::begin() cannot be called directly.');
+ $this->container->get(CronUpdateRunner::class)
->begin(['drupal' => '9.8.1']);
}
@@ -531,13 +530,13 @@ END;
'drupal' => __DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml',
]);
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::ALL)
+ ->set('unattended.level', CronUpdateRunner::ALL)
->save();
$error = ValidationResult::createError([
t('Error while updating!'),
]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateRunner::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
$this->performDrushUpdate();
@@ -579,7 +578,7 @@ END;
t('Error while updating!'),
]);
TestSubscriber1::setTestResult([$error], $event_class);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateStage::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateRunner::class));
$this->performDrushUpdate();
@@ -626,7 +625,7 @@ END;
* Tests that setLogger is called on the cron update stage service.
*/
public function testLoggerIsSetByContainer(): void {
- $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_stage')->getMethodCalls();
+ $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_runner')->getMethodCalls();
$this->assertSame('setLogger', $stage_method_calls[0][0]);
}
diff --git a/tests/src/Kernel/ReleaseChooserTest.php b/tests/src/Kernel/ReleaseChooserTest.php
index c354980813..4e2f7d153a 100644
--- a/tests/src/Kernel/ReleaseChooserTest.php
+++ b/tests/src/Kernel/ReleaseChooserTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\ReleaseChooser;
use Drupal\automatic_updates\UpdateStage;
use Drupal\Core\Extension\ExtensionVersion;
@@ -83,42 +83,42 @@ class ReleaseChooserTest extends AutomaticUpdatesKernelTestBase {
'next_minor' => '9.8.2',
],
'cron, installed 9.8.0, no minor support' => [
- 'stage' => CronUpdateStage::class,
+ 'stage' => CronUpdateRunner::class,
'minor_support' => FALSE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.8.0, minor support' => [
- 'stage' => CronUpdateStage::class,
+ 'stage' => CronUpdateRunner::class,
'minor_support' => TRUE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, no minor support' => [
- 'stage' => CronUpdateStage::class,
+ 'stage' => CronUpdateRunner::class,
'minor_support' => FALSE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, minor support' => [
- 'stage' => CronUpdateStage::class,
+ 'stage' => CronUpdateRunner::class,
'minor_support' => TRUE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.2, no minor support' => [
- 'stage' => CronUpdateStage::class,
+ 'stage' => CronUpdateRunner::class,
'minor_support' => FALSE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
'next_minor' => NULL,
],
'cron, installed 9.7.2, minor support' => [
- 'stage' => CronUpdateStage::class,
+ 'stage' => CronUpdateRunner::class,
'minor_support' => TRUE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 9d9b2d5266..4eca2e4d1e 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -4,7 +4,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
@@ -39,14 +38,14 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
*/
public function testNoValidationIfCronDisabled(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::DISABLED)
+ ->set('unattended.level', CronUpdateRunner::DISABLED)
->save();
$state = $this->container->get('state');
$state->delete('system.cron_last');
$state->delete('install_time');
$this->assertCheckerResultsFromManager([], TRUE);
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::ALL)
+ ->set('unattended.level', CronUpdateRunner::ALL)
->save();
$error = ValidationResult::createError([
t('Cron has not run recently. For more information, see the online handbook entry for <a href="https://www.drupal.org/cron">configuring cron jobs</a> to run at least every 3 hours.'),
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index 7af46da94d..4ad047c36c 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -4,7 +4,8 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\CronUpdateRunner;
+
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
@@ -44,12 +45,12 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
// If unattended updates are disabled, we should only see a warning from
// Package Manager.
- $config->set('unattended.level', UnattendedUpdateStageBase::DISABLED)->save();
+ $config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
$this->assertCheckerResultsFromManager([$warning_result], TRUE);
// The parent class' setUp() method simulates an available security update,
// so ensure that the cron update stage will try to update to it.
- $config->set('unattended.level', UnattendedUpdateStageBase::SECURITY)->save();
+ $config->set('unattended.level', CronUpdateRunner::SECURITY)->save();
// If unattended updates are enabled, we should see an error from Automatic
// Updates.
@@ -77,7 +78,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
// The parent class' setUp() method simulates an available security
// update, so ensure that the cron update stage will try to update to it.
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
+ ->set('unattended.level', CronUpdateRunner::SECURITY)
->save();
$logger = new TestLogger();
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
index 8b481dc9e5..15eac448db 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
@@ -5,7 +5,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\StatusCheckMailer;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\Url;
@@ -55,7 +54,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesKernelTestBase {
$this->installConfig('automatic_updates');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::SECURITY)
+ ->set('unattended.level', CronUpdateRunner::SECURITY)
->save();
$this->setUpEmailRecipients();
@@ -214,7 +213,7 @@ END;
// If we disable unattended updates entirely and flag a new error, they
// should not be e-mailed.
- $config->set('unattended.level', UnattendedUpdateStageBase::DISABLED)->save();
+ $config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
$this->performDrushUpdate();
@@ -222,7 +221,7 @@ END;
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
- $config->set('unattended.level', UnattendedUpdateStageBase::ALL)->save();
+ $config->set('unattended.level', CronUpdateRunner::ALL)->save();
$this->performDrushUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
index d1ef5c71cc..2ae0ca352c 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
@@ -4,8 +4,8 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\automatic_updates\Validator\StagedProjectsValidator;
@@ -210,9 +210,9 @@ class StatusCheckerTest extends AutomaticUpdatesKernelTestBase {
$this->addEventTestListener($listener, StatusCheckEvent::class);
$this->container->get(StatusChecker::class)->run();
// By default, updates will be enabled on cron.
- $this->assertInstanceOf(CronUpdateStage::class, $stage);
+ $this->assertInstanceOf(DrushUpdateStage::class, $stage);
$this->config('automatic_updates.settings')
- ->set('unattended.level', UnattendedUpdateStageBase::DISABLED)
+ ->set('unattended.level', CronUpdateRunner::DISABLED)
->save();
$this->container->get(StatusChecker::class)->run();
$this->assertInstanceOf(UpdateStage::class, $stage);
diff --git a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
index 2e0b5591dc..0a7d955157 100644
--- a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
@@ -4,8 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\UnattendedUpdateStageBase;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\UpdateStage;
use Drupal\fixture_manipulator\ActiveFixtureManipulator;
use Drupal\package_manager\Event\PreCreateEvent;
@@ -46,7 +45,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.1',
NULL,
"$metadata_dir/drupal.9.8.2.xml",
- [UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::DISABLED, CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[],
],
// These three cases prove that updating from an unsupported minor version
@@ -59,14 +58,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[],
],
'update from unsupported minor, cron enabled, minor updates forbidden' => [
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('See the <a href="/admin/reports/updates">available updates page</a> for available updates.'),
@@ -76,7 +75,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('Use the <a href="/admin/modules/update">update form</a> to update to a supported version.'),
@@ -103,7 +102,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::DISABLED, CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[],
],
// This case proves that updating from a dev snapshot is never allowed,
@@ -112,7 +111,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-dev',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::DISABLED, UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::DISABLED, CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('Drupal cannot be automatically updated from the installed version, 9.8.0-dev, because automatic updates from a dev version to any other version are not supported.'),
],
@@ -123,14 +122,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-alpha1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[],
],
'alpha installed, cron enabled' => [
'9.8.0-alpha1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-alpha1, because it is not a stable version.'),
],
@@ -139,14 +138,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-beta2',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[],
],
'beta installed, cron enabled' => [
'9.8.0-beta2',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-beta2, because it is not a stable version.'),
],
@@ -155,14 +154,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-rc3',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[],
],
'rc installed, cron enabled' => [
'9.8.0-rc3',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-rc3, because it is not a stable version.'),
],
@@ -181,9 +180,9 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
* The path of the core release metadata to serve to the update system.
* @param string[] $cron_modes
* The modes for unattended updates. Can contain any of
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, and
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
+ * \Drupal\automatic_updates\CronUpdateRunner::DISABLED,
+ * \Drupal\automatic_updates\CronUpdateRunner::SECURITY, and
+ * \Drupal\automatic_updates\CronUpdateRunner::ALL.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $expected_validation_messages
* The expected validation messages.
* @param bool $allow_minor_updates
@@ -230,21 +229,21 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[],
],
'update to beta, cron disabled' => [
'9.8.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[],
],
'update to rc, cron disabled' => [
'9.8.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[],
],
// This case proves that, if a stable release is installed, there is an
@@ -255,7 +254,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.1',
'9.8.2',
"$metadata_dir/drupal.9.8.2.xml",
- [UnattendedUpdateStageBase::SECURITY],
+ [CronUpdateRunner::SECURITY],
[
t('Drupal cannot be automatically updated during cron from 9.8.1 to 9.8.2 because 9.8.2 is not a security release.'),
],
@@ -267,7 +266,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::SECURITY],
+ [CronUpdateRunner::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-alpha1, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-alpha1 because 9.8.1-alpha1 is not a security release.'),
@@ -277,7 +276,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::SECURITY],
+ [CronUpdateRunner::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-beta2, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-beta2 because 9.8.1-beta2 is not a security release.'),
@@ -287,7 +286,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::SECURITY],
+ [CronUpdateRunner::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-rc3, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-rc3 because 9.8.1-rc3 is not a security release.'),
@@ -300,7 +299,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::SECURITY],
+ [CronUpdateRunner::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-alpha1, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-alpha1 because automatic updates from one minor version to another are not supported during cron.'),
@@ -311,7 +310,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::SECURITY],
+ [CronUpdateRunner::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-beta2, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-beta2 because automatic updates from one minor version to another are not supported during cron.'),
@@ -322,7 +321,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [UnattendedUpdateStageBase::SECURITY],
+ [CronUpdateRunner::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-rc3, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-rc3 because automatic updates from one minor version to another are not supported during cron.'),
@@ -340,7 +339,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::DISABLED],
+ [CronUpdateRunner::DISABLED],
[
t('Drupal cannot be automatically updated from 9.7.1 to 9.8.1 because automatic updates from one minor version to another are not supported.'),
],
@@ -349,7 +348,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('See the <a href="/admin/reports/updates">available updates page</a> for available updates.'),
@@ -360,7 +359,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [UnattendedUpdateStageBase::SECURITY, UnattendedUpdateStageBase::ALL],
+ [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('Use the <a href="/admin/modules/update">update form</a> to update to a supported version.'),
@@ -382,9 +381,9 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
* The path of the core release metadata to serve to the update system.
* @param string[] $cron_modes
* The modes for unattended updates. Can contain any of
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::DISABLED,
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::SECURITY, and
- * \Drupal\automatic_updates\UnattendedUpdateStageBase::ALL.
+ * \Drupal\automatic_updates\CronUpdateRunner::DISABLED,
+ * \Drupal\automatic_updates\CronUpdateRunner::SECURITY, and
+ * \Drupal\automatic_updates\CronUpdateRunner::ALL.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $expected_validation_messages
* The expected validation messages.
* @param bool $allow_minor_updates
@@ -405,7 +404,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
// that would get executed after pre-create.
// @see \Drupal\automatic_updates\Validator\VersionPolicyValidator::validateVersion()
$this->addEventTestListener(function (PreCreateEvent $event) use ($target_version): void {
- /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $stage */
+ /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateRunner $stage */
$stage = $event->stage;
$stage->setMetadata('packages', [
'production' => [
@@ -425,7 +424,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
->set('allow_core_minor_updates', $allow_minor_updates)
->save();
- $stage = $this->container->get(CronUpdateStage::class);
+ $stage = $this->container->get(CronUpdateRunner::class);
try {
$stage->create();
// If we did not get an exception, ensure we didn't expect any results.
--
GitLab
From 4acf17d1a6aeb67b99f2812f3492de165a16a3c0 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 29 Jun 2023 12:33:50 -0400
Subject: [PATCH 035/142] Add todos to remove or deprecate drush integration
when we add a symfony console command
---
src/Commands/AutomaticUpdatesCommands.php | 3 +++
src/DrushUpdateStage.php | 16 ++++++++++++++++
2 files changed, 19 insertions(+)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 90a0461ce4..d6fd009aeb 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -17,6 +17,9 @@ use Drush\Commands\DrushCommands;
* This is an internal part of Automatic Updates and may be changed or removed
* at any time without warning. It should not be called directly, and external
* code should not interact with it.
+ *
+ * @todo Either remove this command completely or make it just call the new
+ * Symfony Console command that will be added in https://drupal.org/i/3360485.
*/
final class AutomaticUpdatesCommands extends DrushCommands {
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index 3d73026816..1eda371cf9 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -28,6 +28,8 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
* An updater that runs via a Drush command.
+ *
+ * @todo Make this class a generic console stage in https://drupal.org/i/3360485
*/
class DrushUpdateStage extends UpdateStage {
@@ -96,6 +98,20 @@ class DrushUpdateStage extends UpdateStage {
return $this->releaseChooser->getLatestInInstalledMinor($this);
}
+ /**
+ * {@inheritdoc}
+ */
+ final public function begin(array $project_versions, ?int $timeout = 300): never {
+ // Unattended updates should never be started using this method. They should
+ // only be done by ::handleCron(), which has a strong opinion about which
+ // release to update to. Throwing an exception here is just to enforce this
+ // boundary. To update to a specific version of core, use
+ // \Drupal\automatic_updates\UpdateStage::begin() (which is called in
+ // ::performUpdate() to start the update to the target version of core
+ // chosen by ::handleCron()).
+ throw new \BadMethodCallException(__METHOD__ . '() cannot be called directly.');
+ }
+
/**
* Runs the post apply command.
*/
--
GitLab
From a78229cf2b56f254cc158b3a539cbae3958a3a89 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 29 Jun 2023 12:44:27 -0400
Subject: [PATCH 036/142] Change CronUpdateStage into CronUpdateRunner becaue
it no longer extends StageBase
---
automatic_updates.install | 1 +
automatic_updates.module | 5 +++--
automatic_updates.services.yml | 3 +++
drush.services.yml | 3 ---
src/Validator/VersionPolicyValidator.php | 9 +++++----
.../AutomaticUpdatesFunctionalTestBase.php | 1 +
tests/src/Functional/StatusCheckTest.php | 1 +
.../FunctionalJavascript/UpdateSettingsFormTest.php | 1 +
tests/src/Kernel/DrushUpdateStageTest.php | 13 +++++++------
tests/src/Kernel/ReleaseChooserTest.php | 13 +++++++------
.../StatusCheck/CronFrequencyValidatorTest.php | 1 +
.../StatusCheck/StatusCheckFailureEmailTest.php | 1 +
.../StatusCheck/VersionPolicyValidatorTest.php | 5 +++--
13 files changed, 34 insertions(+), 23 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index 5d37e1dabd..50a33c21b3 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -7,6 +7,7 @@
declare(strict_types = 1);
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\Validation\StatusCheckRequirements;
use Drupal\system\SystemManager;
diff --git a/automatic_updates.module b/automatic_updates.module
index 12c9a58089..53eb96e06f 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -8,6 +8,7 @@
declare(strict_types = 1);
use Drupal\automatic_updates\BatchProcessor;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\automatic_updates\Validation\AdminStatusCheckMessages;
@@ -159,11 +160,11 @@ function automatic_updates_modules_installed($modules) {
$status_checker = \Drupal::service('automatic_updates.status_checker');
$status_checker->run();
/** @var \Drupal\automatic_updates\CronUpdateRunner $stage */
- $stage = \Drupal::service('automatic_updates.cron_update_runner');
+ $cron_update_runner = \Drupal::service('automatic_updates.cron_update_runner');
// If cron updates are disabled status check messages will not be displayed on
// admin pages. Therefore, after installing the module the user will not be
// alerted to any problems until they access the status report page.
- if ($stage->getMode() === CronUpdateRunner::DISABLED) {
+ if ($cron_update_runner->getMode() === CronUpdateRunner::DISABLED) {
/** @var \Drupal\automatic_updates\Validation\AdminStatusCheckMessages $status_check_messages */
$status_check_messages = \Drupal::classResolver(AdminStatusCheckMessages::class);
$status_check_messages->displayResultSummary();
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index eca6f98198..bbd70d3feb 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -65,3 +65,6 @@ services:
logger.channel.automatic_updates:
parent: logger.channel_base
arguments: ['automatic_updates']
+ Drupal\automatic_updates\DrushUpdateStage:
+ calls:
+ - [ 'setLogger', [ '@logger.channel.automatic_updates' ] ]
diff --git a/drush.services.yml b/drush.services.yml
index 8119ead091..ff72efa89c 100644
--- a/drush.services.yml
+++ b/drush.services.yml
@@ -4,6 +4,3 @@ services:
Drupal\automatic_updates\Commands\AutomaticUpdatesCommands:
tags:
- { name: drush.command }
- Drupal\automatic_updates\DrushUpdateStage:
- calls:
- - ['setLogger', ['@logger.channel.automatic_updates']]
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index 3f3f2c6338..3e654ca115 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -4,6 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Component\Utility\NestedArray;
use Drupal\package_manager\ComposerInspector;
@@ -49,7 +50,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
* The Composer inspector service.
*/
public function __construct(
- private readonly DrushUpdateStage $drushUpdateStage,
+ private readonly CronUpdateRunner $cronUpdateRunner,
private readonly ClassResolverInterface $classResolver,
private readonly PathLocator $pathLocator,
private readonly ComposerInspector $composerInspector,
@@ -87,7 +88,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
// If this is a cron update, we may need to do additional checks.
if ($stage instanceof DrushUpdateStage) {
- $mode = $stage->getMode();
+ $mode = $this->cronUpdateRunner->getMode();
if ($mode !== CronUpdateRunner::DISABLED) {
// If cron updates are enabled, the installed version must be stable;
@@ -236,7 +237,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
}
elseif ($event instanceof StatusCheckEvent) {
- if ($stage instanceof UnattendedUpdateStageBase) {
+ if ($stage instanceof DrushUpdateStage) {
$target_release = $stage->getTargetRelease();
if ($target_release) {
return $target_release->getVersion();
@@ -265,7 +266,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
$project_info = new ProjectInfo('drupal');
$available_releases = $project_info->getInstallableReleases() ?? [];
- if ($stage instanceof UnattendedUpdateStageBase) {
+ if ($stage instanceof DrushUpdateStage) {
$available_releases = array_reverse($available_releases);
}
return $available_releases;
diff --git a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
index da516a4d06..a0e18faa70 100644
--- a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
+++ b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
@@ -4,6 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\fixture_manipulator\StageFixtureManipulator;
use Drupal\package_manager\PathLocator;
use Drupal\Tests\BrowserTestBase;
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 42d4a94089..058334f84d 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
use Behat\Mink\Element\NodeElement;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
diff --git a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
index 8a8533847b..32aef05524 100644
--- a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
+++ b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
@@ -2,6 +2,7 @@
namespace Drupal\Tests\automatic_updates\FunctionalJavascript;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
/**
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 40e0e3a60f..a2ef6af455 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Logger\RfcLogLevel;
@@ -305,8 +306,8 @@ END;
->get('cron')
->addLogger($cron_logger);
- /** @var \Drupal\automatic_updates\CronUpdateRunner $stage */
- $stage = $this->container->get(CronUpdateRunner::class);
+ /** @var \Drupal\automatic_updates\DrushUpdateStage $stage */
+ $stage = $this->container->get(DrushUpdateStage::class);
// When the event specified by $event_class is dispatched, either throw an
// exception directly from the event subscriber, or prepare a
@@ -467,8 +468,8 @@ END;
* Tests that CronUpdateStage::begin() unconditionally throws an exception.
*/
public function testBeginThrowsException(): void {
- $this->expectExceptionMessage(CronUpdateRunner::class . '::begin() cannot be called directly.');
- $this->container->get(CronUpdateRunner::class)
+ $this->expectExceptionMessage(DrushUpdateStage::class . '::begin() cannot be called directly.');
+ $this->container->get(DrushUpdateStage::class)
->begin(['drupal' => '9.8.1']);
}
@@ -536,7 +537,7 @@ END;
$error = ValidationResult::createError([
t('Error while updating!'),
]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateRunner::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
$this->performDrushUpdate();
@@ -578,7 +579,7 @@ END;
t('Error while updating!'),
]);
TestSubscriber1::setTestResult([$error], $event_class);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(CronUpdateRunner::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
$this->performDrushUpdate();
diff --git a/tests/src/Kernel/ReleaseChooserTest.php b/tests/src/Kernel/ReleaseChooserTest.php
index 4e2f7d153a..17174ccc98 100644
--- a/tests/src/Kernel/ReleaseChooserTest.php
+++ b/tests/src/Kernel/ReleaseChooserTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\ReleaseChooser;
use Drupal\automatic_updates\UpdateStage;
use Drupal\Core\Extension\ExtensionVersion;
@@ -83,42 +84,42 @@ class ReleaseChooserTest extends AutomaticUpdatesKernelTestBase {
'next_minor' => '9.8.2',
],
'cron, installed 9.8.0, no minor support' => [
- 'stage' => CronUpdateRunner::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.8.0, minor support' => [
- 'stage' => CronUpdateRunner::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, no minor support' => [
- 'stage' => CronUpdateRunner::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, minor support' => [
- 'stage' => CronUpdateRunner::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.2, no minor support' => [
- 'stage' => CronUpdateRunner::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
'next_minor' => NULL,
],
'cron, installed 9.7.2, minor support' => [
- 'stage' => CronUpdateRunner::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 4eca2e4d1e..600f9713c4 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -4,6 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
index 15eac448db..de97a44896 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
@@ -4,6 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
diff --git a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
index 0a7d955157..582cdc9dad 100644
--- a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\fixture_manipulator\ActiveFixtureManipulator;
use Drupal\package_manager\Event\PreCreateEvent;
@@ -404,7 +405,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
// that would get executed after pre-create.
// @see \Drupal\automatic_updates\Validator\VersionPolicyValidator::validateVersion()
$this->addEventTestListener(function (PreCreateEvent $event) use ($target_version): void {
- /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateRunner $stage */
+ /** @var \Drupal\automatic_updates\DrushUpdateStage $stage */
$stage = $event->stage;
$stage->setMetadata('packages', [
'production' => [
@@ -424,7 +425,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
->set('allow_core_minor_updates', $allow_minor_updates)
->save();
- $stage = $this->container->get(CronUpdateRunner::class);
+ $stage = $this->container->get(DrushUpdateStage::class);
try {
$stage->create();
// If we did not get an exception, ensure we didn't expect any results.
--
GitLab
From a761fb61d04cf2a93f92390b1f42806e24ccec58 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 29 Jun 2023 13:09:24 -0400
Subject: [PATCH 037/142] clean up
---
src/Commands/AutomaticUpdatesCommands.php | 6 +++++-
src/Validation/StatusChecker.php | 6 ++++--
src/Validator/CronFrequencyValidator.php | 2 ++
src/Validator/VersionPolicyValidator.php | 2 ++
tests/src/Kernel/ReleaseChooserTest.php | 1 -
5 files changed, 13 insertions(+), 4 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index d6fd009aeb..196fd7ada0 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -4,6 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Commands;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
@@ -26,6 +27,8 @@ final class AutomaticUpdatesCommands extends DrushCommands {
/**
* Constructs a AutomaticUpdatesCommands object.
*
+ * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * The cron update runner service.
* @param \Drupal\automatic_updates\DrushUpdateStage $stage
* The console cron updater service.
* @param \Drupal\automatic_updates\Validation\StatusChecker $statusChecker
@@ -36,6 +39,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* The config factory service.
*/
public function __construct(
+ private readonly CronUpdateRunner $cronUpdateRunner,
private readonly DrushUpdateStage $stage,
private readonly StatusChecker $statusChecker,
private readonly StatusCheckMailer $statusCheckMailer,
@@ -80,7 +84,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
$this->runStatusChecks();
}
else {
- if ($this->stage->getMode() === DrushUpdateStage::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
$io->error('Automatic updates are disabled.');
return;
}
diff --git a/src/Validation/StatusChecker.php b/src/Validation/StatusChecker.php
index 5c3c6b2c4b..1077d321c5 100644
--- a/src/Validation/StatusChecker.php
+++ b/src/Validation/StatusChecker.php
@@ -42,6 +42,8 @@ final class StatusChecker implements EventSubscriberInterface {
* The event dispatcher service.
* @param \Drupal\automatic_updates\UpdateStage $updateStage
* The update stage service.
+ * @param \Drupal\automatic_updates\DrushUpdateStage $drushUpdateStage
+ * The drush update stage service.
* @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
* The cron update stage service.
* @param int $resultsTimeToLive
@@ -52,7 +54,7 @@ final class StatusChecker implements EventSubscriberInterface {
private readonly TimeInterface $time,
private readonly EventDispatcherInterface $eventDispatcher,
private readonly UpdateStage $updateStage,
- private readonly DrushUpdateStage $unattendedUpdateStage,
+ private readonly DrushUpdateStage $drushUpdateStage,
private readonly CronUpdateRunner $cronUpdateRunner,
private readonly int $resultsTimeToLive,
) {
@@ -72,7 +74,7 @@ final class StatusChecker implements EventSubscriberInterface {
$stage = $this->updateStage;
}
else {
- $stage = $this->unattendedUpdateStage;
+ $stage = $this->drushUpdateStage;
}
$results = $this->runStatusCheck($stage, $this->eventDispatcher);
diff --git a/src/Validator/CronFrequencyValidator.php b/src/Validator/CronFrequencyValidator.php
index 33d484d983..26b4d4acea 100644
--- a/src/Validator/CronFrequencyValidator.php
+++ b/src/Validator/CronFrequencyValidator.php
@@ -56,6 +56,8 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
/**
* CronFrequencyValidator constructor.
*
+ * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * The cron update runner service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
* The config factory service.
* @param \Drupal\Core\State\StateInterface $state
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index 3e654ca115..0e14484440 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -42,6 +42,8 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
/**
* Constructs a VersionPolicyValidator object.
*
+ * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * The cron update runner service.
* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $classResolver
* The class resolver service.
* @param \Drupal\package_manager\PathLocator $pathLocator
diff --git a/tests/src/Kernel/ReleaseChooserTest.php b/tests/src/Kernel/ReleaseChooserTest.php
index 17174ccc98..552dd77c31 100644
--- a/tests/src/Kernel/ReleaseChooserTest.php
+++ b/tests/src/Kernel/ReleaseChooserTest.php
@@ -4,7 +4,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\ReleaseChooser;
use Drupal\automatic_updates\UpdateStage;
--
GitLab
From c82ea667290e879c681237d746209ac931dec764 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 29 Jun 2023 13:36:57 -0400
Subject: [PATCH 038/142] rename DrushUpdateStage to ConsoleUpdateStage
---
automatic_updates.services.yml | 2 +-
src/Commands/AutomaticUpdatesCommands.php | 6 +--
...UpdateStage.php => ConsoleUpdateStage.php} | 2 +-
src/Validation/StatusChecker.php | 10 ++---
src/Validator/CronFrequencyValidator.php | 4 +-
src/Validator/PhpExtensionsValidator.php | 4 +-
.../StagedDatabaseUpdateValidator.php | 4 +-
src/Validator/VersionPolicyValidator.php | 8 ++--
tests/src/Build/CoreUpdateTest.php | 6 +--
.../Kernel/AutomaticUpdatesKernelTestBase.php | 20 +++-------
...ageTest.php => ConsoleUpdateStageTest.php} | 38 +++++++++----------
tests/src/Kernel/ReleaseChooserTest.php | 14 +++----
.../PhpExtensionsValidatorTest.php | 4 +-
.../StagedDatabaseUpdateValidatorTest.php | 2 +-
.../StatusCheckFailureEmailTest.php | 28 +++++++-------
.../Kernel/StatusCheck/StatusCheckerTest.php | 4 +-
.../VersionPolicyValidatorTest.php | 6 +--
17 files changed, 77 insertions(+), 85 deletions(-)
rename src/{DrushUpdateStage.php => ConsoleUpdateStage.php} (99%)
rename tests/src/Kernel/{DrushUpdateStageTest.php => ConsoleUpdateStageTest.php} (96%)
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index bbd70d3feb..9cca8eeaf2 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -65,6 +65,6 @@ services:
logger.channel.automatic_updates:
parent: logger.channel_base
arguments: ['automatic_updates']
- Drupal\automatic_updates\DrushUpdateStage:
+ Drupal\automatic_updates\ConsoleUpdateStage:
calls:
- [ 'setLogger', [ '@logger.channel.automatic_updates' ] ]
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 196fd7ada0..5ca04eeb8d 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Commands;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
@@ -29,7 +29,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*
* @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
* The cron update runner service.
- * @param \Drupal\automatic_updates\DrushUpdateStage $stage
+ * @param \Drupal\automatic_updates\ConsoleUpdateStage $stage
* The console cron updater service.
* @param \Drupal\automatic_updates\Validation\StatusChecker $statusChecker
* The status checker service.
@@ -40,7 +40,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*/
public function __construct(
private readonly CronUpdateRunner $cronUpdateRunner,
- private readonly DrushUpdateStage $stage,
+ private readonly ConsoleUpdateStage $stage,
private readonly StatusChecker $statusChecker,
private readonly StatusCheckMailer $statusCheckMailer,
private readonly ConfigFactoryInterface $configFactory,
diff --git a/src/DrushUpdateStage.php b/src/ConsoleUpdateStage.php
similarity index 99%
rename from src/DrushUpdateStage.php
rename to src/ConsoleUpdateStage.php
index 1eda371cf9..b44163efd7 100644
--- a/src/DrushUpdateStage.php
+++ b/src/ConsoleUpdateStage.php
@@ -31,7 +31,7 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
*
* @todo Make this class a generic console stage in https://drupal.org/i/3360485
*/
-class DrushUpdateStage extends UpdateStage {
+class ConsoleUpdateStage extends UpdateStage {
/**
* Constructs a DrushUpdateStage object.
diff --git a/src/Validation/StatusChecker.php b/src/Validation/StatusChecker.php
index 1077d321c5..f73e90e5cc 100644
--- a/src/Validation/StatusChecker.php
+++ b/src/Validation/StatusChecker.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validation;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
@@ -42,8 +42,8 @@ final class StatusChecker implements EventSubscriberInterface {
* The event dispatcher service.
* @param \Drupal\automatic_updates\UpdateStage $updateStage
* The update stage service.
- * @param \Drupal\automatic_updates\DrushUpdateStage $drushUpdateStage
- * The drush update stage service.
+ * @param \Drupal\automatic_updates\ConsoleUpdateStage $consoleUpdateStage
+ * The console update stage service.
* @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
* The cron update stage service.
* @param int $resultsTimeToLive
@@ -54,7 +54,7 @@ final class StatusChecker implements EventSubscriberInterface {
private readonly TimeInterface $time,
private readonly EventDispatcherInterface $eventDispatcher,
private readonly UpdateStage $updateStage,
- private readonly DrushUpdateStage $drushUpdateStage,
+ private readonly ConsoleUpdateStage $consoleUpdateStage,
private readonly CronUpdateRunner $cronUpdateRunner,
private readonly int $resultsTimeToLive,
) {
@@ -74,7 +74,7 @@ final class StatusChecker implements EventSubscriberInterface {
$stage = $this->updateStage;
}
else {
- $stage = $this->drushUpdateStage;
+ $stage = $this->consoleUpdateStage;
}
$results = $this->runStatusCheck($stage, $this->eventDispatcher);
diff --git a/src/Validator/CronFrequencyValidator.php b/src/Validator/CronFrequencyValidator.php
index 26b4d4acea..169aabedad 100644
--- a/src/Validator/CronFrequencyValidator.php
+++ b/src/Validator/CronFrequencyValidator.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Lock\LockBackendInterface;
@@ -83,7 +83,7 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
*/
public function validateLastCronRun(StatusCheckEvent $event): void {
// We only want to do this check if the stage belongs to Automatic Updates.
- if (!$event->stage instanceof DrushUpdateStage) {
+ if (!$event->stage instanceof ConsoleUpdateStage) {
return;
}
// If automatic updates are disabled during cron, there's nothing we need
diff --git a/src/Validator/PhpExtensionsValidator.php b/src/Validator/PhpExtensionsValidator.php
index 9885146661..38ea624140 100644
--- a/src/Validator/PhpExtensionsValidator.php
+++ b/src/Validator/PhpExtensionsValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -26,7 +26,7 @@ final class PhpExtensionsValidator extends PackageManagerPhpExtensionsValidator
* {@inheritdoc}
*/
public function validateXdebug(PreOperationStageEvent $event): void {
- if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof DrushUpdateStage) {
+ if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof ConsoleUpdateStage) {
$event->addError([$this->t("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.")]);
}
elseif ($event instanceof StatusCheckEvent) {
diff --git a/src/Validator/StagedDatabaseUpdateValidator.php b/src/Validator/StagedDatabaseUpdateValidator.php
index e2998ddb5d..ac9892080e 100644
--- a/src/Validator/StagedDatabaseUpdateValidator.php
+++ b/src/Validator/StagedDatabaseUpdateValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Validator\StagedDBUpdateValidator;
@@ -39,7 +39,7 @@ final class StagedDatabaseUpdateValidator implements EventSubscriberInterface {
*/
public function checkUpdateHooks(PreApplyEvent $event): void {
$stage = $event->stage;
- if (!$stage instanceof DrushUpdateStage) {
+ if (!$stage instanceof ConsoleUpdateStage) {
return;
}
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index 0e14484440..c3f8082659 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Component\Utility\NestedArray;
use Drupal\package_manager\ComposerInspector;
use Drupal\package_manager\Event\StatusCheckEvent;
@@ -89,7 +89,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
// If this is a cron update, we may need to do additional checks.
- if ($stage instanceof DrushUpdateStage) {
+ if ($stage instanceof ConsoleUpdateStage) {
$mode = $this->cronUpdateRunner->getMode();
if ($mode !== CronUpdateRunner::DISABLED) {
@@ -239,7 +239,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
}
elseif ($event instanceof StatusCheckEvent) {
- if ($stage instanceof DrushUpdateStage) {
+ if ($stage instanceof ConsoleUpdateStage) {
$target_release = $stage->getTargetRelease();
if ($target_release) {
return $target_release->getVersion();
@@ -268,7 +268,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
$project_info = new ProjectInfo('drupal');
$available_releases = $project_info->getInstallableReleases() ?? [];
- if ($stage instanceof DrushUpdateStage) {
+ if ($stage instanceof ConsoleUpdateStage) {
$available_releases = array_reverse($available_releases);
}
return $available_releases;
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index cb9853e362..7b9cadb929 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Build;
use Behat\Mink\Element\DocumentElement;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
@@ -388,7 +388,7 @@ class CoreUpdateTest extends UpdateTestBase {
// @todo Make a dynamic wait system in this test because the update will
// still be happening in the background.
sleep(120);
- $this->assertExpectedStageEventsFired(DrushUpdateStage::class);
+ $this->assertExpectedStageEventsFired(ConsoleUpdateStage::class);
// There should be log messages, but no errors or warnings should have been
// logged by Automatic Updates.
// The use of the database log here implies one can only retrieve log
@@ -457,7 +457,7 @@ class CoreUpdateTest extends UpdateTestBase {
$this->assertStringContainsString('Drupal core was successfully updated to 9.8.1!', $output);
$this->assertStringContainsString('Running post-apply tasks and final clean-up...', $output);
$this->assertUpdateSuccessful('9.8.1');
- $this->assertExpectedStageEventsFired(DrushUpdateStage::class);
+ $this->assertExpectedStageEventsFired(ConsoleUpdateStage::class);
// Rerunning the command should exit with a message that no newer version
// is available.
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index d07ad47389..80d2756fa0 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -5,12 +5,10 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
-use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
/**
* Base class for kernel tests of the Automatic Updates module.
@@ -76,17 +74,11 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
*/
public function register(ContainerBuilder $container) {
parent::register($container);
- if ($container->has('logger.channel.automatic_updates')) {
- $drush_stage_definition = new Definition(TestDrushUpdateStage::class);
- $drush_stage_definition->setAutowired(TRUE);
- $drush_stage_definition->addMethodCall('setLogger', [new Reference('logger.channel.automatic_updates')]);
- $drush_stage_definition->setPublic(TRUE);
- $container->addDefinitions([DrushUpdateStage::class => $drush_stage_definition]);
- }
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
'automatic_updates.cron_update_runner' => TestCronUpdateRunner::class,
+ ConsoleUpdateStage::class => TestConsoleUpdateStage::class,
];
foreach ($overrides as $service_id => $class) {
if ($container->hasDefinition($service_id)) {
@@ -96,10 +88,10 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
}
/**
- * Performs an update using the drush update stage directly.
+ * Performs an update using the console update stage directly.
*/
- protected function performDrushUpdate(): void {
- $this->container->get(DrushUpdateStage::class)->performUpdate();
+ protected function performConsoleUpdate(): void {
+ $this->container->get(ConsoleUpdateStage::class)->performUpdate();
}
}
@@ -131,7 +123,7 @@ class TestCronUpdateRunner extends CronUpdateRunner {
/**
* A test-only version of the drush update stage to override and expose internals.
*/
-class TestDrushUpdateStage extends DrushUpdateStage {
+class TestConsoleUpdateStage extends ConsoleUpdateStage {
/**
* {@inheritdoc}
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/ConsoleUpdateStageTest.php
similarity index 96%
rename from tests/src/Kernel/DrushUpdateStageTest.php
rename to tests/src/Kernel/ConsoleUpdateStageTest.php
index a2ef6af455..a26da93e0b 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/ConsoleUpdateStageTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Logger\RfcLogLevel;
@@ -31,12 +31,12 @@ use ColinODell\PsrTestLogger\TestLogger;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
- * @covers \Drupal\automatic_updates\DrushUpdateStage
+ * @covers \Drupal\automatic_updates\ConsoleUpdateStage
* @covers \automatic_updates_test_cron_form_update_settings_alter
* @group automatic_updates
* @internal
*/
-class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
+class ConsoleUpdateStageTest extends AutomaticUpdatesKernelTestBase {
use EmailNotificationsTestTrait;
use PackageManagerBypassTestTrait;
@@ -85,7 +85,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$exception = new \Exception('Error during running post-apply tasks!');
TestSubscriber1::setException($exception, PostApplyEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertRegularCronRun(FALSE);
$this->assertTrue($this->logger->hasRecord($exception->getMessage(), (string) RfcLogLevel::ERROR));
@@ -197,7 +197,7 @@ END;
$this->assertCount(0, $this->container->get('package_manager.beginner')->getInvocationArguments());
// Run cron and ensure that Package Manager's services were called or
// bypassed depending on configuration.
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$will_update = (int) $will_update;
$this->assertCount($will_update, $this->container->get('package_manager.beginner')->getInvocationArguments());
@@ -306,8 +306,8 @@ END;
->get('cron')
->addLogger($cron_logger);
- /** @var \Drupal\automatic_updates\DrushUpdateStage $stage */
- $stage = $this->container->get(DrushUpdateStage::class);
+ /** @var \Drupal\automatic_updates\ConsoleUpdateStage $stage */
+ $stage = $this->container->get(ConsoleUpdateStage::class);
// When the event specified by $event_class is dispatched, either throw an
// exception directly from the event subscriber, or prepare a
@@ -333,7 +333,7 @@ END;
$this->assertEmpty($this->logger->records);
$this->assertTrue($stage->isAvailable());
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) RfcLogLevel::ERROR);
// To check if the exception was logged by the main cron service, we need
@@ -387,7 +387,7 @@ END;
$this->addEventTestListener($listener, PostRequireEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertIsString($cron_stage_dir);
$this->assertNotEquals($original_stage_directory, $cron_stage_dir);
$this->assertDirectoryDoesNotExist($cron_stage_dir);
@@ -422,7 +422,7 @@ END;
// Ensure the stage that is applying the operation is not the cron
// update stage.
$this->assertInstanceOf(TestStage::class, $event->stage);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
// We do not actually want to apply this operation it was just invoked to
// allow cron to be attempted.
$event->addError([$stop_error]);
@@ -458,7 +458,7 @@ END;
// Trigger CronUpdateStage, the above should cause it to detect a stage that
// is applying.
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
$this->assertUpdateStagedTimes(1);
@@ -468,8 +468,8 @@ END;
* Tests that CronUpdateStage::begin() unconditionally throws an exception.
*/
public function testBeginThrowsException(): void {
- $this->expectExceptionMessage(DrushUpdateStage::class . '::begin() cannot be called directly.');
- $this->container->get(DrushUpdateStage::class)
+ $this->expectExceptionMessage(ConsoleUpdateStage::class . '::begin() cannot be called directly.');
+ $this->container->get(ConsoleUpdateStage::class)
->begin(['drupal' => '9.8.1']);
}
@@ -478,7 +478,7 @@ END;
*/
public function testEmailOnSuccess(): void {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
// Ensure we sent a success message to all recipients.
$expected_body = <<<END
@@ -537,10 +537,10 @@ END;
$error = ValidationResult::createError([
t('Error while updating!'),
]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(ConsoleUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -579,9 +579,9 @@ END;
t('Error while updating!'),
]);
TestSubscriber1::setTestResult([$error], $event_class);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(ConsoleUpdateStage::class));
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -609,7 +609,7 @@ END;
$error = new \LogicException('I drink your milkshake!');
LoggingCommitter::setException($error);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$expected_body = <<<END
Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
diff --git a/tests/src/Kernel/ReleaseChooserTest.php b/tests/src/Kernel/ReleaseChooserTest.php
index 552dd77c31..c9839081ef 100644
--- a/tests/src/Kernel/ReleaseChooserTest.php
+++ b/tests/src/Kernel/ReleaseChooserTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\ReleaseChooser;
use Drupal\automatic_updates\UpdateStage;
use Drupal\Core\Extension\ExtensionVersion;
@@ -83,42 +83,42 @@ class ReleaseChooserTest extends AutomaticUpdatesKernelTestBase {
'next_minor' => '9.8.2',
],
'cron, installed 9.8.0, no minor support' => [
- 'stage' => DrushUpdateStage::class,
+ 'stage' => ConsoleUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.8.0, minor support' => [
- 'stage' => DrushUpdateStage::class,
+ 'stage' => ConsoleUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, no minor support' => [
- 'stage' => DrushUpdateStage::class,
+ 'stage' => ConsoleUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, minor support' => [
- 'stage' => DrushUpdateStage::class,
+ 'stage' => ConsoleUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.2, no minor support' => [
- 'stage' => DrushUpdateStage::class,
+ 'stage' => ConsoleUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
'next_minor' => NULL,
],
'cron, installed 9.7.2, minor support' => [
- 'stage' => DrushUpdateStage::class,
+ 'stage' => ConsoleUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index 4ad047c36c..e4fb08f948 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -62,7 +62,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
// The update should have been stopped before it started.
$this->assertUpdateStagedTimes(0);
$this->assertTrue($logger->hasRecordThatContains((string) $error_result->messages[0], RfcLogLevel::ERROR));
@@ -86,7 +86,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
// The update should have been staged, but then stopped with an error.
$this->assertUpdateStagedTimes(1);
$this->assertTrue($logger->hasRecordThatContains("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.", RfcLogLevel::ERROR));
diff --git a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
index 5ce38ae686..d60982bdf4 100644
--- a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
@@ -38,7 +38,7 @@ class StagedDatabaseUpdateValidatorTest extends AutomaticUpdatesKernelTestBase {
};
$this->addEventTestListener($listener);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$expected_message = "The update cannot proceed because database updates have been detected in the following extensions.\nSystem\n";
$this->assertTrue($logger->hasRecord($expected_message, (string) RfcLogLevel::ERROR));
}
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
index de97a44896..cd19c13a0e 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
@@ -107,7 +107,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesKernelTestBase {
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$url = Url::fromRoute('system.status')
->setAbsolute()
@@ -123,13 +123,13 @@ END;
$recipient_count = count($this->emailRecipients);
$this->assertGreaterThan(0, $recipient_count);
$sent_messages_count = $recipient_count;
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If a different error is flagged, they should be e-mailed again.
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -141,28 +141,28 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If only a warning is flagged, they should not be e-mailed again because
// we ignore warnings by default.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we stop ignoring warnings, they should be e-mailed again because we
// clear the stored results if the relevant configuration is changed.
$config = $this->config('automatic_updates.settings');
$config->set('status_check_mail', StatusCheckMailer::ALL)->save();
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
// If we flag a different warning, they should be e-mailed again.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -173,7 +173,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($warnings, StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -184,7 +184,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_ERROR),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -193,7 +193,7 @@ END;
// different order.
$results = array_reverse($results);
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable notifications entirely, they should not be e-mailed even
@@ -201,7 +201,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable notifications and go back to ignoring warnings, they
@@ -209,7 +209,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::ERRORS_ONLY)->save();
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable unattended updates entirely and flag a new error, they
@@ -217,13 +217,13 @@ END;
$config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
$config->set('unattended.level', CronUpdateRunner::ALL)->save();
- $this->performDrushUpdate();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
}
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
index 2ae0ca352c..0f24bc7a9a 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\automatic_updates\Validator\StagedProjectsValidator;
@@ -210,7 +210,7 @@ class StatusCheckerTest extends AutomaticUpdatesKernelTestBase {
$this->addEventTestListener($listener, StatusCheckEvent::class);
$this->container->get(StatusChecker::class)->run();
// By default, updates will be enabled on cron.
- $this->assertInstanceOf(DrushUpdateStage::class, $stage);
+ $this->assertInstanceOf(ConsoleUpdateStage::class, $stage);
$this->config('automatic_updates.settings')
->set('unattended.level', CronUpdateRunner::DISABLED)
->save();
diff --git a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
index 582cdc9dad..c19a7fc380 100644
--- a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\DrushUpdateStage;
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\fixture_manipulator\ActiveFixtureManipulator;
use Drupal\package_manager\Event\PreCreateEvent;
@@ -405,7 +405,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
// that would get executed after pre-create.
// @see \Drupal\automatic_updates\Validator\VersionPolicyValidator::validateVersion()
$this->addEventTestListener(function (PreCreateEvent $event) use ($target_version): void {
- /** @var \Drupal\automatic_updates\DrushUpdateStage $stage */
+ /** @var \Drupal\automatic_updates\ConsoleUpdateStage $stage */
$stage = $event->stage;
$stage->setMetadata('packages', [
'production' => [
@@ -425,7 +425,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
->set('allow_core_minor_updates', $allow_minor_updates)
->save();
- $stage = $this->container->get(DrushUpdateStage::class);
+ $stage = $this->container->get(ConsoleUpdateStage::class);
try {
$stage->create();
// If we did not get an exception, ensure we didn't expect any results.
--
GitLab
From ff67783091a4d0b27ed9dcf073c572ca47aadd51 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 29 Jun 2023 15:41:03 -0400
Subject: [PATCH 039/142] store process id to determine when I background
update is in process
---
automatic_updates.install | 13 ++++++
src/Commands/AutomaticUpdatesCommands.php | 2 +-
src/ConsoleUpdateStage.php | 49 ++++++++++++++++++++++-
tests/src/Build/CoreUpdateTest.php | 17 ++++++--
4 files changed, 76 insertions(+), 5 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index 50a33c21b3..d27d01225b 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -7,6 +7,7 @@
declare(strict_types = 1);
+use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\Validation\StatusCheckRequirements;
use Drupal\system\SystemManager;
@@ -37,6 +38,18 @@ function automatic_updates_requirements($phase) {
'value' => t('Enabled. This is NOT an officially supported feature of the Automatic Updates module at this time. Use at your own risk.'),
];
}
+ /** @var \Drupal\automatic_updates\ConsoleUpdateStage $console_stage */
+ $console_stage = Drupal::service(ConsoleUpdateStage::class);
+ if ($console_update_status = $console_stage->getProcessStatus()) {
+ $requirements['automatic_updates_console_update_status'] = [
+ 'title' => t('Automatic background updates'),
+ 'severity' => SystemManager::REQUIREMENT_OK,
+ 'value' => t(
+ 'There is currently a background update running to update to Drupal core to %version',
+ ['%version' => $console_update_status['target_version']]
+ ),
+ ];
+ }
return $requirements;
}
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 5ca04eeb8d..bada03c9fb 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -71,7 +71,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
// The second half of the update process (post-apply etc.) is done by this
// exact same command, with some additional flags, in a separate process to
// ensure that the system is in a consistent state.
- // @see \Drupal\automatic_updates\DrushUpdateStage::triggerPostApply()
+ // @see \Drupal\automatic_updates\ConsoleUpdateStage::triggerPostApply()
if ($options['post-apply']) {
if (empty($options['stage-id']) || empty($options['from-version']) || empty($options['to-version'])) {
throw new \LogicException("The post-apply option is for internal use only. It should never be passed directly.");
diff --git a/src/ConsoleUpdateStage.php b/src/ConsoleUpdateStage.php
index b44163efd7..955413ab4c 100644
--- a/src/ConsoleUpdateStage.php
+++ b/src/ConsoleUpdateStage.php
@@ -7,6 +7,7 @@ namespace Drupal\automatic_updates;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Mail\MailManagerInterface;
+use Drupal\Core\State\StateInterface;
use Drupal\Core\TempStore\SharedTempStoreFactory;
use Drupal\Core\Url;
use Drupal\package_manager\ComposerInspector;
@@ -34,8 +35,10 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
class ConsoleUpdateStage extends UpdateStage {
/**
- * Constructs a DrushUpdateStage object.
+ * Constructs a ConsoleUpdateStage object.
*
+ * @param \Drupal\Core\State\StateInterface $state
+ * The state service.
* @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\Core\Mail\MailManagerInterface $mailManager
@@ -68,6 +71,7 @@ class ConsoleUpdateStage extends UpdateStage {
* The failure marker service.
*/
public function __construct(
+ private readonly StateInterface $state,
private readonly CronUpdateRunner $cronUpdateRunner,
private readonly MailManagerInterface $mailManager,
private readonly StatusCheckMailer $statusCheckMailer,
@@ -183,6 +187,7 @@ class ConsoleUpdateStage extends UpdateStage {
// stage regardless of whether the update succeeds.
try {
$update_started = TRUE;
+ $this->setProcessStatus($installed_version, $target_version);
// @see ::begin()
$stage_id = parent::begin(['drupal' => $target_version], 300);
$this->stage();
@@ -297,4 +302,46 @@ class ConsoleUpdateStage extends UpdateStage {
return new Response();
}
+ /**
+ * Gets the update process status.
+ *
+ * @return array|null
+ * The update process status, or NULL if no update process is active. If the
+ * update process is active the array keys will be:
+ * - (int) pid: The process ID.
+ * - (string) start_version: The start version of the update.
+ * - (string) target_version: The target version of the update.
+ */
+ public function getProcessStatus(): ?array {
+ $process_status = $this->state->get('automatic_updates.console_stage_status');
+ if ($process_status) {
+ $process_group = posix_getpgid($process_status['pid']);
+ if (is_int($process_group)) {
+ return $process_status;
+ }
+ $this->state->delete('automatic_updates.console_stage_status');
+ }
+ return NULL;
+ }
+
+ /**
+ * Sets the update process status.
+ *
+ * @param string $start_version
+ * The start version.
+ * @param string $target_version
+ * The target version.
+ */
+ private function setProcessStatus(string $start_version, string $target_version): void {
+ $pid = getmypid();
+ $this->state->set(
+ 'automatic_updates.console_stage_status',
+ [
+ 'pid' => $pid,
+ 'start_version' => $start_version,
+ 'target_version' => $target_version,
+ ],
+ );
+ }
+
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 7b9cadb929..ed0c924539 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -385,9 +385,20 @@ class CoreUpdateTest extends UpdateTestBase {
$mink = $this->getMink();
$assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
- // @todo Make a dynamic wait system in this test because the update will
- // still be happening in the background.
- sleep(120);
+
+ // Wait for console update process to start.
+ sleep(5);
+ $this->visit('/admin/reports/status');
+ // Ensure the console update process has started.
+ $current_update_requirement_text = 'There is currently a background update running to update to Drupal core to 9.8.1';
+ $assert_session->pageTextContains($current_update_requirement_text);
+ $max_wait = time() + 360;
+ // Wait a maximum of 6 minutes for the console update process to finish.
+ while ($max_wait > time() && str_contains($page->getText(), $current_update_requirement_text)) {
+ sleep(5);
+ $this->visit('/admin/reports/status');
+ }
+
$this->assertExpectedStageEventsFired(ConsoleUpdateStage::class);
// There should be log messages, but no errors or warnings should have been
// logged by Automatic Updates.
--
GitLab
From 17087288452ef19cdc09580f46feee4e6b8bdb6f Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 10:48:32 -0400
Subject: [PATCH 040/142] only run updates via cron if from web
---
src/CronUpdateRunner.php | 19 ++++++++++++++++++-
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index 0d848e26b9..eb5acf4047 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -24,6 +24,13 @@ class CronUpdateRunner implements CronInterface {
use LoggerAwareTrait;
+ /**
+ * The current interface between PHP and the server.
+ *
+ * @var string
+ */
+ private static $serverApi = PHP_SAPI;
+
/**
* All automatic updates are disabled.
*
@@ -92,6 +99,16 @@ class CronUpdateRunner implements CronInterface {
}
}
+ /**
+ * Indicates if we are currently running at the command line.
+ *
+ * @return bool
+ * TRUE if we are running at the command line, otherwise FALSE.
+ */
+ final public static function isCommandLine(): bool {
+ return self::$serverApi === 'cli';
+ }
+
/**
* {@inheritdoc}
*/
@@ -106,7 +123,7 @@ class CronUpdateRunner implements CronInterface {
// accessed via the web (i.e., anything that isn't the command line), go
// ahead and try to do the update. In all other circumstances, just run the
// normal cron handler.
- if ($this->getMode() !== self::DISABLED && $method === 'web') {
+ if ($this->getMode() !== self::DISABLED && $method === 'web' && !self::isCommandLine()) {
$lock = \Drupal::lock();
if ($lock->acquire('cron', 30)) {
$this->runTerminalUpdateCommand();
--
GitLab
From 80453aa172a68b0b0bad89f90f96a71ac607668e Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 10:51:14 -0400
Subject: [PATCH 041/142] change form message to mention automated cron
---
automatic_updates.module | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/automatic_updates.module b/automatic_updates.module
index 53eb96e06f..4617d16233 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -215,7 +215,7 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
'#type' => 'radios',
'#title' => t('How unattended updates should be run'),
'#options' => [
- 'web' => t('By a request to /system/cron'),
+ 'web' => t('By using the Automated Cron module or a request to /system/cron'),
'console' => t('By the <code>auto-update</code> Drush command'),
],
'#default_value' => $config->get('unattended.method'),
--
GitLab
From 436541cf8cc11199c9291fab2d057c6e12ab2b02 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 12:45:24 -0400
Subject: [PATCH 042/142] workign on functional drush test
---
src/Commands/AutomaticUpdatesCommands.php | 13 +-
src/ConsoleUpdateStage.php | 7 +-
src/CronUpdateRunner.php | 2 +-
.../StatusCheckFailureEmailTest.php | 239 ++++++++++++++++++
.../Kernel/AutomaticUpdatesKernelTestBase.php | 22 +-
5 files changed, 270 insertions(+), 13 deletions(-)
create mode 100644 tests/src/Functional/StatusCheckFailureEmailTest.php
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index bada03c9fb..5165ef27f1 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -58,6 +58,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* @option $stage-id Internal use only.
* @option $from-version Internal use only.
* @option $to-version Internal use only.
+ * @option $is-from-web Whether the request was triggered from the web.
*
* @command auto-update
*
@@ -65,7 +66,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* If the --post-apply option is provided without the --stage-id,
* --from-version, and --to-version options.
*/
- public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL]) {
+ public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL, 'is-from-web' => FALSE]) {
$io = $this->io();
// The second half of the update process (post-apply etc.) is done by this
@@ -81,7 +82,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
$io->info('Running post-apply tasks and final clean-up...');
$this->stage->handlePostApply($options['stage-id'], $options['from-version'], $options['to-version']);
- $this->runStatusChecks();
+ $this->runStatusChecks($options['is-from-web']);
}
else {
if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
@@ -93,11 +94,11 @@ final class AutomaticUpdatesCommands extends DrushCommands {
if ($release) {
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
$io->info($message);
- $this->stage->performUpdate();
+ $this->stage->performUpdate($options['is-from-web']);
}
else {
$io->info("There is no Drupal core update available.");
- $this->runStatusChecks();
+ $this->runStatusChecks($options['is-from-web']);
}
}
}
@@ -105,13 +106,13 @@ final class AutomaticUpdatesCommands extends DrushCommands {
/**
* Runs status checks, and sends failure notifications if necessary.
*/
- private function runStatusChecks(): void {
+ private function runStatusChecks(bool $is_from_web): void {
$method = $this->configFactory->get('automatic_updates.settings')
->get('unattended.method');
// To ensure consistent results, only run the status checks if we're
// explicitly configured to do unattended updates on the command line.
- if ($method === 'console') {
+ if (($method === 'web' && $is_from_web) || $method === 'console') {
$last_results = $this->statusChecker->getResults();
$this->statusCheckMailer->sendFailureNotifications($last_results, $this->statusChecker->run()->getResults());
}
diff --git a/src/ConsoleUpdateStage.php b/src/ConsoleUpdateStage.php
index 955413ab4c..0c3d0739a5 100644
--- a/src/ConsoleUpdateStage.php
+++ b/src/ConsoleUpdateStage.php
@@ -119,7 +119,7 @@ class ConsoleUpdateStage extends UpdateStage {
/**
* Runs the post apply command.
*/
- protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
+ protected function triggerPostApply(string $stage_id, string $start_version, string $target_version, bool $is_from_web): void {
$alias = Drush::aliasManager()->getSelf();
$output = Drush::processManager()
@@ -128,6 +128,7 @@ class ConsoleUpdateStage extends UpdateStage {
'stage-id' => $stage_id,
'from-version' => $start_version,
'to-version' => $target_version,
+ 'is-from-web' => $is_from_web,
])
->mustRun()
->getOutput();
@@ -141,7 +142,7 @@ class ConsoleUpdateStage extends UpdateStage {
* @return bool
* Returns TRUE if any update was attempted, otherwise FALSE.
*/
- public function performUpdate(): bool {
+ public function performUpdate(bool $is_from_web = FALSE): bool {
if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
return FALSE;
}
@@ -237,7 +238,7 @@ class ConsoleUpdateStage extends UpdateStage {
}
return $update_started;
}
- $this->triggerPostApply($stage_id, $installed_version, $target_version);
+ $this->triggerPostApply($stage_id, $installed_version, $target_version, $is_from_web);
return TRUE;
}
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index eb5acf4047..e30e82e595 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -80,7 +80,7 @@ class CronUpdateRunner implements CronInterface {
$drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
$phpBinaryFinder = new PhpExecutableFinder();
- $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update &");
+ $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
// $process->disableOutput();
$process->setTimeout(0);
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
new file mode 100644
index 0000000000..e9362aaf39
--- /dev/null
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -0,0 +1,239 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\automatic_updates\Functional;
+
+use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\StatusCheckMailer;
+use Drupal\automatic_updates_test\Datetime\TestTime;
+use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
+use Drupal\Core\Url;
+use Drupal\package_manager\Event\StatusCheckEvent;
+use Drupal\system\SystemManager;
+use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
+use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
+use Drush\TestTraits\DrushTestTrait;
+
+/**
+ * Tests status check failure notification emails during cron runs.
+ *
+ * @group automatic_updates
+ * @covers \Drupal\automatic_updates\StatusCheckMailer
+ * @internal
+ */
+class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
+
+ use EmailNotificationsTestTrait;
+ use DrushTestTrait;
+ use ValidationTestTrait;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $defaultTheme = 'stark';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected static $modules = [
+ 'automatic_updates',
+ 'automatic_updates_test',
+ 'package_manager_test_validation',
+ 'user',
+ ];
+
+ /**
+ * The number of times cron has been run.
+ *
+ * @var int
+ */
+ private $cronRunCount = 0;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp(): void {
+ parent::setUp();
+ // Simulate that we're already fully up to date.
+ $this->mockActiveCoreVersion('9.8.1');
+ // @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
+ $this->config('automatic_updates.settings')
+ ->set('unattended.level', CronUpdateRunner::SECURITY)
+ ->save();
+ $this->setUpEmailRecipients();
+
+ // Allow stored available update data to live for a very, very long time.
+ // By default, the data expires after one day, but this test runs cron many
+ // times, with a simulated two hour interval between each run (see
+ // ::runCron()). Without this long grace period, all the cron runs in this
+ // test would need to run on the same "day", to prevent certain validators
+ // from breaking this test due to available update data being irretrievable.
+ $this->config('update.settings')
+ ->set('check.interval_days', 30)
+ ->save();
+ }
+
+ /**
+ * Runs cron, simulating a two-hour interval since the previous run.
+ *
+ * We need to simulate that at least an hour has passed since the previous
+ * run, so that our cron hook will run status checks again.
+ *
+ * @see automatic_updates_cron()
+ */
+ private function runCron(): void {
+ $offset = $this->cronRunCount * 2;
+ $this->cronRunCount++;
+ TestTime::setFakeTimeByOffset("+$offset hours");
+ $this->container->get('cron')->run();
+ }
+
+ /**
+ * Asserts that a certain number of failure notifications has been sent.
+ *
+ * @param int $expected_count
+ * The expected number of failure notifications that should have been sent.
+ */
+ private function assertSentMessagesCount(int $expected_count): void {
+ $sent_messages = $this->getMails([
+ 'id' => 'automatic_updates_status_check_failed',
+ ]);
+ $this->assertCount($expected_count, $sent_messages);
+ }
+
+ /**
+ * Tests that status check failures will trigger e-mails in some situations.
+ */
+ public function testFailureNotifications(): void {
+ // No messages should have been sent yet.
+ $this->assertSentMessagesCount(0);
+
+ $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
+ TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+
+ $url = Url::fromRoute('system.status')
+ ->setAbsolute()
+ ->toString();
+
+ $expected_body = <<<END
+Your site has failed some readiness checks for automatic updates and may not be able to receive automatic updates until further action is taken. Please visit $url for more information.
+END;
+ $this->assertMessagesSent('Automatic updates readiness checks failed', $expected_body);
+
+ // Running cron again should not trigger another e-mail (i.e., each
+ // recipient has only been e-mailed once) since the results are unchanged.
+ $recipient_count = count($this->emailRecipients);
+ $this->assertGreaterThan(0, $recipient_count);
+ $sent_messages_count = $recipient_count;
+ $this->performConsoleUpdate();
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If a different error is flagged, they should be e-mailed again.
+ $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
+ TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $sent_messages_count += $recipient_count;
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we flag the same error, but a new warning, they should not be e-mailed
+ // again because we ignore warnings by default, and they've already been
+ // e-mailed about this error.
+ $results = [
+ $error,
+ $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
+ ];
+ TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If only a warning is flagged, they should not be e-mailed again because
+ // we ignore warnings by default.
+ $warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
+ TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we stop ignoring warnings, they should be e-mailed again because we
+ // clear the stored results if the relevant configuration is changed.
+ $config = $this->config('automatic_updates.settings');
+ $config->set('status_check_mail', StatusCheckMailer::ALL)->save();
+ $this->performConsoleUpdate();
+ $sent_messages_count += $recipient_count;
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we flag a different warning, they should be e-mailed again.
+ $warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
+ TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $sent_messages_count += $recipient_count;
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we flag multiple warnings, they should be e-mailed again because the
+ // number of results has changed, even if the severity hasn't.
+ $warnings = [
+ $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
+ $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
+ ];
+ TestSubscriber1::setTestResult($warnings, StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $sent_messages_count += $recipient_count;
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we flag an error and a warning, they should be e-mailed again because
+ // the severity has changed, even if the number of results hasn't.
+ $results = [
+ $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
+ $this->createValidationResult(SystemManager::REQUIREMENT_ERROR),
+ ];
+ TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $sent_messages_count += $recipient_count;
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we change the order of the results, they should not be e-mailed again
+ // because we are handling the possibility of the results being in a
+ // different order.
+ $results = array_reverse($results);
+ TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we disable notifications entirely, they should not be e-mailed even
+ // if a different error is flagged.
+ $config->set('status_check_mail', StatusCheckMailer::DISABLED)->save();
+ $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
+ TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we re-enable notifications and go back to ignoring warnings, they
+ // should not be e-mailed if a new warning is flagged.
+ $config->set('status_check_mail', StatusCheckMailer::ERRORS_ONLY)->save();
+ $warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
+ TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we disable unattended updates entirely and flag a new error, they
+ // should not be e-mailed.
+ $config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
+ $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
+ TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
+ $this->performConsoleUpdate();
+ $this->assertSentMessagesCount($sent_messages_count);
+
+ // If we re-enable unattended updates, they should be emailed again, even if
+ // the results haven't changed.
+ $config->set('unattended.level', CronUpdateRunner::ALL)->save();
+ $this->performConsoleUpdate();
+ $sent_messages_count += $recipient_count;
+ $this->assertSentMessagesCount($sent_messages_count);
+ }
+
+ private function performConsoleUpdate() {
+ $this->drush('auto-update', [], ['is-from-web']);
+ }
+
+}
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 80d2756fa0..6b933faaa2 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -4,11 +4,16 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
+use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
/**
* Base class for kernel tests of the Automatic Updates module.
@@ -75,6 +80,14 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
public function register(ContainerBuilder $container) {
parent::register($container);
+ if ($container->has('logger.channel.automatic_updates')) {
+ $commands_definition = new Definition(AutomaticUpdatesCommands::class);
+ $commands_definition->setAutowired(TRUE);
+ $commands_definition->setPublic(TRUE);
+ $container->addDefinitions([AutomaticUpdatesCommands::class => $commands_definition]);
+ }
+
+
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
'automatic_updates.cron_update_runner' => TestCronUpdateRunner::class,
@@ -90,8 +103,11 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
/**
* Performs an update using the console update stage directly.
*/
- protected function performConsoleUpdate(): void {
- $this->container->get(ConsoleUpdateStage::class)->performUpdate();
+ protected function performConsoleUpdate(bool $is_from_web = TRUE): void {
+ $commands = $this->container->get(AutomaticUpdatesCommands::class);
+ $commands->setInput($this->prophesize(InputInterface::class)->reveal());
+ $commands->setOutput($this->prophesize(OutputInterface::class)->reveal());
+ $commands->autoUpdate(['is-from-web' => $is_from_web]);
}
}
@@ -128,7 +144,7 @@ class TestConsoleUpdateStage extends ConsoleUpdateStage {
/**
* {@inheritdoc}
*/
- protected function triggerPostApply(string $stage_id, string $start_version, string $target_version): void {
+ protected function triggerPostApply(string $stage_id, string $start_version, string $target_version, bool $is_from_web): void {
$this->handlePostApply($stage_id, $start_version, $target_version);
}
--
GitLab
From cf80b6fb4a636f84fa31d7374cf888a03dce2bd7 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 16:32:39 -0400
Subject: [PATCH 043/142] change to /StatusCheckFailureEmailTest as function
test to run drush
---
.../StatusCheckFailureEmailTest.php | 18 +-
.../StatusCheckFailureEmailTest.php | 231 ------------------
.../Traits/EmailNotificationsTestTrait.php | 12 +
3 files changed, 27 insertions(+), 234 deletions(-)
delete mode 100644 tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index e9362aaf39..b014d01fd7 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -55,6 +55,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
*/
protected function setUp(): void {
parent::setUp();
+ $this->useTestMailCollector();
// Simulate that we're already fully up to date.
$this->mockActiveCoreVersion('9.8.1');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
@@ -96,6 +97,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
* The expected number of failure notifications that should have been sent.
*/
private function assertSentMessagesCount(int $expected_count): void {
+ $this->container->get('state')->resetCache();
$sent_messages = $this->getMails([
'id' => 'automatic_updates_status_check_failed',
]);
@@ -106,6 +108,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
* Tests that status check failures will trigger e-mails in some situations.
*/
public function testFailureNotifications(): void {
+ //$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
// No messages should have been sent yet.
$this->assertSentMessagesCount(0);
@@ -117,9 +120,16 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
->setAbsolute()
->toString();
+ $base = Url::fromUserInput('/')->setAbsolute()->toString();
+ $url = str_replace($base, 'http://' . str_replace('test', '', $this->databasePrefix) . '/', $url);
+
$expected_body = <<<END
-Your site has failed some readiness checks for automatic updates and may not be able to receive automatic updates until further action is taken. Please visit $url for more information.
+Your site has failed some readiness checks for automatic updates and may not
+be able to receive automatic updates until further action is taken. Please
+visit $url for more information.
+
END;
+ $this->container->get('state')->resetCache();
$this->assertMessagesSent('Automatic updates readiness checks failed', $expected_body);
// Running cron again should not trigger another e-mail (i.e., each
@@ -226,14 +236,16 @@ END;
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
- $config->set('unattended.level', CronUpdateRunner::ALL)->save();
+ $config->set('unattended.level', CronUpdateRunner::SECURITY)->save();
$this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
}
private function performConsoleUpdate() {
- $this->drush('auto-update', [], ['is-from-web']);
+ $cd = $this->siteDirectory;
+ $cd = __DIR__ . '/../../../../../' . $cd;
+ $this->drush('auto-update', [], ['is-from-web' => NULL], NULL, $cd);
}
}
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php b/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
deleted file mode 100644
index cd19c13a0e..0000000000
--- a/tests/src/Kernel/StatusCheck/StatusCheckFailureEmailTest.php
+++ /dev/null
@@ -1,231 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-
-use Drupal\automatic_updates\CronUpdateRunner;
-use Drupal\automatic_updates\StatusCheckMailer;
-use Drupal\automatic_updates_test\Datetime\TestTime;
-use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
-use Drupal\Core\Url;
-use Drupal\package_manager\Event\StatusCheckEvent;
-use Drupal\system\SystemManager;
-use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
-use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
-
-/**
- * Tests status check failure notification emails during cron runs.
- *
- * @group automatic_updates
- * @covers \Drupal\automatic_updates\StatusCheckMailer
- * @internal
- */
-class StatusCheckFailureEmailTest extends AutomaticUpdatesKernelTestBase {
-
- use EmailNotificationsTestTrait;
-
- /**
- * {@inheritdoc}
- */
- protected static $modules = [
- 'automatic_updates',
- 'automatic_updates_test',
- 'package_manager_test_validation',
- 'user',
- ];
-
- /**
- * The number of times cron has been run.
- *
- * @var int
- */
- private $cronRunCount = 0;
-
- /**
- * {@inheritdoc}
- */
- protected function setUp(): void {
- parent::setUp();
- // Simulate that we're already fully up to date.
- $this->setCoreVersion('9.8.1');
- $this->installEntitySchema('user');
- $this->installSchema('user', ['users_data']);
-
- $this->installConfig('automatic_updates');
- // @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
- $this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::SECURITY)
- ->save();
- $this->setUpEmailRecipients();
-
- // Allow stored available update data to live for a very, very long time.
- // By default, the data expires after one day, but this test runs cron many
- // times, with a simulated two hour interval between each run (see
- // ::runCron()). Without this long grace period, all the cron runs in this
- // test would need to run on the same "day", to prevent certain validators
- // from breaking this test due to available update data being irretrievable.
- $this->config('update.settings')
- ->set('check.interval_days', 30)
- ->save();
- }
-
- /**
- * Runs cron, simulating a two-hour interval since the previous run.
- *
- * We need to simulate that at least an hour has passed since the previous
- * run, so that our cron hook will run status checks again.
- *
- * @see automatic_updates_cron()
- */
- private function runCron(): void {
- $offset = $this->cronRunCount * 2;
- $this->cronRunCount++;
- TestTime::setFakeTimeByOffset("+$offset hours");
- $this->container->get('cron')->run();
- }
-
- /**
- * Asserts that a certain number of failure notifications has been sent.
- *
- * @param int $expected_count
- * The expected number of failure notifications that should have been sent.
- */
- private function assertSentMessagesCount(int $expected_count): void {
- $sent_messages = $this->getMails([
- 'id' => 'automatic_updates_status_check_failed',
- ]);
- $this->assertCount($expected_count, $sent_messages);
- }
-
- /**
- * Tests that status check failures will trigger e-mails in some situations.
- */
- public function testFailureNotifications(): void {
- // No messages should have been sent yet.
- $this->assertSentMessagesCount(0);
-
- $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
- TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
-
- $url = Url::fromRoute('system.status')
- ->setAbsolute()
- ->toString();
-
- $expected_body = <<<END
-Your site has failed some readiness checks for automatic updates and may not be able to receive automatic updates until further action is taken. Please visit $url for more information.
-END;
- $this->assertMessagesSent('Automatic updates readiness checks failed', $expected_body);
-
- // Running cron again should not trigger another e-mail (i.e., each
- // recipient has only been e-mailed once) since the results are unchanged.
- $recipient_count = count($this->emailRecipients);
- $this->assertGreaterThan(0, $recipient_count);
- $sent_messages_count = $recipient_count;
- $this->performConsoleUpdate();
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If a different error is flagged, they should be e-mailed again.
- $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
- TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $sent_messages_count += $recipient_count;
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we flag the same error, but a new warning, they should not be e-mailed
- // again because we ignore warnings by default, and they've already been
- // e-mailed about this error.
- $results = [
- $error,
- $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
- ];
- TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If only a warning is flagged, they should not be e-mailed again because
- // we ignore warnings by default.
- $warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
- TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we stop ignoring warnings, they should be e-mailed again because we
- // clear the stored results if the relevant configuration is changed.
- $config = $this->config('automatic_updates.settings');
- $config->set('status_check_mail', StatusCheckMailer::ALL)->save();
- $this->performConsoleUpdate();
- $sent_messages_count += $recipient_count;
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we flag a different warning, they should be e-mailed again.
- $warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
- TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $sent_messages_count += $recipient_count;
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we flag multiple warnings, they should be e-mailed again because the
- // number of results has changed, even if the severity hasn't.
- $warnings = [
- $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
- $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
- ];
- TestSubscriber1::setTestResult($warnings, StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $sent_messages_count += $recipient_count;
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we flag an error and a warning, they should be e-mailed again because
- // the severity has changed, even if the number of results hasn't.
- $results = [
- $this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
- $this->createValidationResult(SystemManager::REQUIREMENT_ERROR),
- ];
- TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $sent_messages_count += $recipient_count;
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we change the order of the results, they should not be e-mailed again
- // because we are handling the possibility of the results being in a
- // different order.
- $results = array_reverse($results);
- TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we disable notifications entirely, they should not be e-mailed even
- // if a different error is flagged.
- $config->set('status_check_mail', StatusCheckMailer::DISABLED)->save();
- $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
- TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we re-enable notifications and go back to ignoring warnings, they
- // should not be e-mailed if a new warning is flagged.
- $config->set('status_check_mail', StatusCheckMailer::ERRORS_ONLY)->save();
- $warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
- TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we disable unattended updates entirely and flag a new error, they
- // should not be e-mailed.
- $config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
- $error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
- TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
- $this->assertSentMessagesCount($sent_messages_count);
-
- // If we re-enable unattended updates, they should be emailed again, even if
- // the results haven't changed.
- $config->set('unattended.level', CronUpdateRunner::ALL)->save();
- $this->performConsoleUpdate();
- $sent_messages_count += $recipient_count;
- $this->assertSentMessagesCount($sent_messages_count);
- }
-
-}
diff --git a/tests/src/Traits/EmailNotificationsTestTrait.php b/tests/src/Traits/EmailNotificationsTestTrait.php
index 3c34a90189..70a55c85fb 100644
--- a/tests/src/Traits/EmailNotificationsTestTrait.php
+++ b/tests/src/Traits/EmailNotificationsTestTrait.php
@@ -29,6 +29,18 @@ trait EmailNotificationsTestTrait {
*/
protected $emailRecipients = [];
+ /**
+ * Helper to set the test mail collector in settings.php.
+ */
+ protected function useTestMailCollector() {
+ // Set up an override.
+ $settings['config']['system.mail']['interface']['default'] = (object) [
+ 'value' => 'test_mail_collector',
+ 'required' => TRUE,
+ ];
+ $this->writeSettings($settings);
+ }
+
/**
* Prepares the recipient list for e-mails related to Automatic Updates.
*/
--
GitLab
From 6ff8d27bc1f74029e902eb293c170f9eaf876a97 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 16:35:24 -0400
Subject: [PATCH 044/142] phpcbf
---
tests/src/Functional/StatusCheckFailureEmailTest.php | 1 -
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 2 --
2 files changed, 3 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index b014d01fd7..dad084b5f5 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -108,7 +108,6 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
* Tests that status check failures will trigger e-mails in some situations.
*/
public function testFailureNotifications(): void {
- //$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.2');
// No messages should have been sent yet.
$this->assertSentMessagesCount(0);
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 6b933faaa2..7cd83ef98a 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -13,7 +13,6 @@ use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
/**
* Base class for kernel tests of the Automatic Updates module.
@@ -87,7 +86,6 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
$container->addDefinitions([AutomaticUpdatesCommands::class => $commands_definition]);
}
-
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
'automatic_updates.cron_update_runner' => TestCronUpdateRunner::class,
--
GitLab
From 3c5c4ab1c6156907afe5f3f5c49ab357eef741a1 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 16:41:40 -0400
Subject: [PATCH 045/142] unneeded email config
---
tests/src/Functional/StatusCheckFailureEmailTest.php | 1 -
tests/src/Traits/EmailNotificationsTestTrait.php | 12 ------------
2 files changed, 13 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index dad084b5f5..715adcf683 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -55,7 +55,6 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
*/
protected function setUp(): void {
parent::setUp();
- $this->useTestMailCollector();
// Simulate that we're already fully up to date.
$this->mockActiveCoreVersion('9.8.1');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
diff --git a/tests/src/Traits/EmailNotificationsTestTrait.php b/tests/src/Traits/EmailNotificationsTestTrait.php
index 70a55c85fb..3c34a90189 100644
--- a/tests/src/Traits/EmailNotificationsTestTrait.php
+++ b/tests/src/Traits/EmailNotificationsTestTrait.php
@@ -29,18 +29,6 @@ trait EmailNotificationsTestTrait {
*/
protected $emailRecipients = [];
- /**
- * Helper to set the test mail collector in settings.php.
- */
- protected function useTestMailCollector() {
- // Set up an override.
- $settings['config']['system.mail']['interface']['default'] = (object) [
- 'value' => 'test_mail_collector',
- 'required' => TRUE,
- ];
- $this->writeSettings($settings);
- }
-
/**
* Prepares the recipient list for e-mails related to Automatic Updates.
*/
--
GitLab
From 8ea22c4ea74970b873f90a1eeb237f8197424099 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 16:51:45 -0400
Subject: [PATCH 046/142] don't run in kernel test
---
.../src/Kernel/AutomaticUpdatesKernelTestBase.php | 14 ++------------
1 file changed, 2 insertions(+), 12 deletions(-)
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 7cd83ef98a..9d3cbe38b4 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -79,13 +79,6 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
public function register(ContainerBuilder $container) {
parent::register($container);
- if ($container->has('logger.channel.automatic_updates')) {
- $commands_definition = new Definition(AutomaticUpdatesCommands::class);
- $commands_definition->setAutowired(TRUE);
- $commands_definition->setPublic(TRUE);
- $container->addDefinitions([AutomaticUpdatesCommands::class => $commands_definition]);
- }
-
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
'automatic_updates.cron_update_runner' => TestCronUpdateRunner::class,
@@ -101,11 +94,8 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
/**
* Performs an update using the console update stage directly.
*/
- protected function performConsoleUpdate(bool $is_from_web = TRUE): void {
- $commands = $this->container->get(AutomaticUpdatesCommands::class);
- $commands->setInput($this->prophesize(InputInterface::class)->reveal());
- $commands->setOutput($this->prophesize(OutputInterface::class)->reveal());
- $commands->autoUpdate(['is-from-web' => $is_from_web]);
+ protected function performConsoleUpdate(): void {
+ $this->container->get(ConsoleUpdateStage::class)->performUpdate();
}
}
--
GitLab
From 1872254f091093566c4e25edf14e7559a2004f9b Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 16:54:08 -0400
Subject: [PATCH 047/142] do not run cron updates from command line
---
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 9d3cbe38b4..3bc7119ea7 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -7,6 +7,7 @@ namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
@@ -71,6 +72,13 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
// from a sane state.
// @see \Drupal\automatic_updates\Validator\CronFrequencyValidator
$this->container->get('state')->set('system.cron_last', time());
+
+ // Cron updates are not done when running at the command line, so override
+ // our cron handler's PHP_SAPI constant to a valid value that isn't `cli`.
+ // The choice of `cgi-fcgi` is arbitrary; see
+ // https://www.php.net/php_sapi_name for some valid values of PHP_SAPI.
+ $property = new \ReflectionProperty(CronUpdateRunner::class, 'serverApi');
+ $property->setValue(NULL, 'cgi-fcgi');
}
/**
--
GitLab
From a9107a1fd742767d868076d0a675ba963e72bdec Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 30 Jun 2023 16:55:41 -0400
Subject: [PATCH 048/142] phpcbf
---
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 5 -----
1 file changed, 5 deletions(-)
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 3bc7119ea7..c99b46aac7 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -4,16 +4,11 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\ConsoleUpdateStage;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\DependencyInjection\Definition;
/**
* Base class for kernel tests of the Automatic Updates module.
--
GitLab
From 55c3848a890859e326dcc5ebd0eca398ce622d01 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 5 Jul 2023 10:54:04 -0400
Subject: [PATCH 049/142] don't change working dir
---
tests/src/Functional/StatusCheckFailureEmailTest.php | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 715adcf683..6bc07e82a7 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -241,9 +241,8 @@ END;
}
private function performConsoleUpdate() {
- $cd = $this->siteDirectory;
- $cd = __DIR__ . '/../../../../../' . $cd;
- $this->drush('auto-update', [], ['is-from-web' => NULL], NULL, $cd);
+ // @todo Should we change working directory?
+ $this->drush('auto-update', [], ['is-from-web' => NULL]);
}
}
--
GitLab
From 32af5afcfc46a0ee391668e7044af87e5f77f828 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 11:14:46 -0400
Subject: [PATCH 050/142] resolve() changed to resolved()
---
tests/src/Kernel/ConsoleUpdateStageTest.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tests/src/Kernel/ConsoleUpdateStageTest.php b/tests/src/Kernel/ConsoleUpdateStageTest.php
index a26da93e0b..0fdf661f47 100644
--- a/tests/src/Kernel/ConsoleUpdateStageTest.php
+++ b/tests/src/Kernel/ConsoleUpdateStageTest.php
@@ -380,7 +380,7 @@ END;
$listener = function (PostRequireEvent $event) use (&$cron_stage_dir, $original_stage_directory): void {
$this->assertDirectoryDoesNotExist($original_stage_directory);
- $cron_stage_dir = $this->container->get('package_manager.stager')->getInvocationArguments()[0][1]->resolve();
+ $cron_stage_dir = $this->container->get('package_manager.stager')->getInvocationArguments()[0][1]->resolved();
$this->assertSame($event->stage->getStageDirectory(), $cron_stage_dir);
$this->assertDirectoryExists($cron_stage_dir);
};
--
GitLab
From a61c66b0cbef9bc5e15f18cdd4a537c82e2a18af Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 17:13:51 -0400
Subject: [PATCH 051/142] create getCommandPath()
---
src/CronUpdateRunner.php | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index e30e82e595..b130cbff50 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -72,12 +72,7 @@ class CronUpdateRunner implements CronInterface {
* Runs the terminal update command.
*/
public function runTerminalUpdateCommand(): void {
- // @todo Make a validator to ensure this path exists if settings select
- // background updates.
- // @todo Replace drush call with Symfony console command in
- // https://www.drupal.org/i/3360485
- // @todo Why isn't it in vendor bin in build tests?
- $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
+ $drush_path = $this->getCommandPath();
$phpBinaryFinder = new PhpExecutableFinder();
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
@@ -150,4 +145,19 @@ class CronUpdateRunner implements CronInterface {
return $mode ?: static::SECURITY;
}
+ /**
+ * Gets the update command path.
+ *
+ * @return string
+ * The absolute path of the update command.
+ */
+ protected function getCommandPath(): string {
+ // @todo Make a validator to ensure this path exists if settings select
+ // background updates.
+ // @todo Replace drush call with Symfony console command in
+ // https://www.drupal.org/i/3360485
+ // @todo Why isn't it in vendor bin in build tests?
+ return $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
+ }
+
}
--
GitLab
From c9a92e56074a11dbe6be7ca1e53a29206cb5e416 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 17:42:20 -0400
Subject: [PATCH 052/142] copy real drush for test
---
tests/src/Functional/StatusCheckTest.php | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 058334f84d..48474de2de 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
use Behat\Mink\Element\NodeElement;
+use Composer\Autoload\ClassLoader;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates_test\Datetime\TestTime;
@@ -17,6 +18,7 @@ use Drupal\package_manager_test_validation\EventSubscriber\TestSubscriber;
use Drupal\system\SystemManager;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\Traits\Core\CronRunTrait;
+use Symfony\Component\Filesystem\Filesystem;
/**
* Tests status checks.
@@ -256,6 +258,12 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
*/
public function testStatusChecksOnAdminPages(string $admin_route): void {
$assert = $this->assertSession();
+ $loaders = ClassLoader::getRegisteredLoaders();
+ $this->assertCount(1, $loaders);
+ $vendor_path = array_keys($loaders)[0];
+ $drush_path = $vendor_path . '/drush/drush/drush';
+ (new Filesystem())->copy($drush_path, $this->container->get('package_manager.path_locator')->getVendorDirectory() . '/drush/drush/drush');
+
$messages_section_selector = '[data-drupal-messages]';
$this->container->get('module_installer')->install(['automatic_updates', 'automatic_updates_test']);
--
GitLab
From 3824d8f2a808b028a0e370d205885ec753e8dcf9 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 18:24:13 -0400
Subject: [PATCH 053/142] use TestCronUpdateRunner to change drush path
---
src/CronUpdateRunner.php | 4 +--
.../AutomaticUpdatesTestServiceProvider.php | 28 +++++++++++++++++++
.../src/TestCronUpdateRunner.php | 22 +++++++++++++++
tests/src/Functional/StatusCheckTest.php | 10 +++----
4 files changed, 57 insertions(+), 7 deletions(-)
create mode 100644 tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
create mode 100644 tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index b130cbff50..f674b81e72 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -75,13 +75,13 @@ class CronUpdateRunner implements CronInterface {
$drush_path = $this->getCommandPath();
$phpBinaryFinder = new PhpExecutableFinder();
- $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
+ $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
// $process->disableOutput();
$process->setTimeout(0);
try {
- $process->start();
+ $process->mustRun();
sleep(1);
$wait_till = time() + 5;
// Wait for the process to start.
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
new file mode 100644
index 0000000000..a48218b4ae
--- /dev/null
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\automatic_updates_test;
+
+use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Core\DependencyInjection\ServiceProviderBase;
+
+class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public function alter(ContainerBuilder $container) {
+ parent::alter($container);
+ if (defined(self::class . '-test-runner') && $container->hasDefinition('automatic_updates.cron_update_runner')) {
+ $container->getDefinition('automatic_updates.cron_update_runner')->setClass(TestCronUpdateRunner::class);
+ }
+ }
+
+ public static function useTestCronUpdateRunner(bool $use = TRUE) {
+ \Drupal::state()->set(self::class . '-runner', $use);
+ \Drupal::cache()->invalidateAll();
+ }
+
+}
diff --git a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
new file mode 100644
index 0000000000..dd64aaceeb
--- /dev/null
+++ b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Drupal\automatic_updates_test;
+
+use Composer\Autoload\ClassLoader;
+use Drupal\automatic_updates\CronUpdateRunner;
+use function PHPUnit\Framework\assertCount;
+
+class TestCronUpdateRunner extends CronUpdateRunner {
+
+ /**
+ * @inheritDoc
+ */
+ protected function getCommandPath(): string {
+ // Return the real path of Drush.
+ $loaders = ClassLoader::getRegisteredLoaders();
+ assertCount(1, $loaders);
+ $vendor_path = array_keys($loaders)[0];
+ return $vendor_path . '/drush/drush/drush';
+ }
+
+}
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 48474de2de..f4bb83ff49 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -8,6 +8,7 @@ use Behat\Mink\Element\NodeElement;
use Composer\Autoload\ClassLoader;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\StatusCheckMailer;
+use Drupal\automatic_updates_test\AutomaticUpdatesTestServiceProvider;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\automatic_updates_test_status_checker\EventSubscriber\TestSubscriber2;
@@ -62,12 +63,14 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
*/
protected static $modules = [
'package_manager_test_validation',
+ 'automatic_updates_test',
];
/**
* {@inheritdoc}
*/
protected function setUp(): void {
+ define(AutomaticUpdatesTestServiceProvider::class . '-test-runner', TRUE);
parent::setUp();
$this->setReleaseMetadata(__DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml');
$this->mockActiveCoreVersion('9.8.1');
@@ -257,12 +260,9 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
* @dataProvider providerAdminRoutes
*/
public function testStatusChecksOnAdminPages(string $admin_route): void {
+
$assert = $this->assertSession();
- $loaders = ClassLoader::getRegisteredLoaders();
- $this->assertCount(1, $loaders);
- $vendor_path = array_keys($loaders)[0];
- $drush_path = $vendor_path . '/drush/drush/drush';
- (new Filesystem())->copy($drush_path, $this->container->get('package_manager.path_locator')->getVendorDirectory() . '/drush/drush/drush');
+
$messages_section_selector = '[data-drupal-messages]';
--
GitLab
From f23032e525acf58b589eabc4cca4f3caae626d01 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 18:26:18 -0400
Subject: [PATCH 054/142] revert runner debug changes
---
src/CronUpdateRunner.php | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index f674b81e72..b130cbff50 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -75,13 +75,13 @@ class CronUpdateRunner implements CronInterface {
$drush_path = $this->getCommandPath();
$phpBinaryFinder = new PhpExecutableFinder();
- $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web");
+ $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
// $process->disableOutput();
$process->setTimeout(0);
try {
- $process->mustRun();
+ $process->start();
sleep(1);
$wait_till = time() + 5;
// Wait for the process to start.
--
GitLab
From fcfd3c8968102b62c7fa9bbf7def190b2d35a203 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 21:38:34 -0400
Subject: [PATCH 055/142] try to wait
---
tests/src/Functional/StatusCheckTest.php | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index f4bb83ff49..f31ed8366d 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -307,7 +307,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
TestSubscriber1::setTestResult($expected_results, StatusCheckEvent::class);
// Confirm a new message is displayed if the cron is run after an hour.
$this->delayRequestTime();
- $this->cronRun();
+ $this->runCronAndWait();
$this->drupalGet(Url::fromRoute($admin_route));
$assert->pageTextContainsOnce(static::$errorsExplanation);
// Confirm on admin pages that the summary will be displayed.
@@ -327,7 +327,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
];
TestSubscriber1::setTestResult($unexpected_results, StatusCheckEvent::class);
$this->delayRequestTime(30);
- $this->cronRun();
+ $this->runCronAndWait();
$this->drupalGet(Url::fromRoute($admin_route));
$assert->pageTextNotContains($unexpected_results['2 errors']->summary);
$assert->pageTextContainsOnce((string) $expected_results['1 error']->summary);
@@ -336,13 +336,18 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// Confirm that is if cron is run over an hour after the checkers were
// previously run the checkers will be run again.
- $this->delayRequestTime(31);
- $this->cronRun();
+ $this->delayRequestTime(60);
+ $this->runCronAndWait();
+ $original_expected_results = $expected_results;
$expected_results = $unexpected_results;
+ $unexpected_results = $original_expected_results;
$this->drupalGet(Url::fromRoute($admin_route));
// Confirm on admin pages only the error summary will be displayed if there
// is more than 1 error.
$this->assertSame(SystemManager::REQUIREMENT_ERROR, $expected_results['2 errors']->severity);
+ file_put_contents("/Users/ted.bowman/sites/test.html", $this->getSession()->getPage()->getOuterHtml());
+ $assert->pageTextNotContains((string) $unexpected_results['1 error']->summary);
+ $assert->pageTextNotContains($expected_results['1 warning']->messages[0]);
$assert->pageTextNotContains($expected_results['2 errors']->messages[0]);
$assert->pageTextNotContains($expected_results['2 errors']->messages[1]);
$assert->pageTextContainsOnce($expected_results['2 errors']->summary);
@@ -356,7 +361,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$expected_results = [$this->createValidationResult(SystemManager::REQUIREMENT_WARNING, 2)];
TestSubscriber1::setTestResult($expected_results, StatusCheckEvent::class);
$this->delayRequestTime();
- $this->cronRun();
+ $this->runCronAndWait();
$this->drupalGet(Url::fromRoute($admin_route));
// Confirm that the warnings summary is displayed on admin pages if there
// are no errors.
@@ -370,7 +375,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$expected_results = [$this->createValidationResult(SystemManager::REQUIREMENT_WARNING)];
TestSubscriber1::setTestResult($expected_results, StatusCheckEvent::class);
$this->delayRequestTime();
- $this->cronRun();
+ $this->runCronAndWait();
$this->drupalGet(Url::fromRoute($admin_route));
$assert->pageTextNotContains(static::$errorsExplanation);
// Confirm that a single warning is displayed and not the summary on admin
@@ -780,4 +785,9 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
TestTime::setFakeTimeByOffset("+$total_delay minutes");
}
+ private function runCronAndWait(): void {
+ $this->cronRun();
+ sleep(5);
+ }
+
}
--
GitLab
From cb6629b71ea9093a3e577e895fe9e399484c58f3 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 22:54:24 -0400
Subject: [PATCH 056/142] debug
---
package_manager/src/Debugger.php | 25 +++++++++++++++++++
src/Commands/AutomaticUpdatesCommands.php | 7 ++++++
src/CronUpdateRunner.php | 7 ++++++
.../AutomaticUpdatesTestServiceProvider.php | 4 +--
tests/src/Functional/StatusCheckTest.php | 15 ++++++++++-
5 files changed, 55 insertions(+), 3 deletions(-)
create mode 100644 package_manager/src/Debugger.php
diff --git a/package_manager/src/Debugger.php b/package_manager/src/Debugger.php
new file mode 100644
index 0000000000..20d5be6a69
--- /dev/null
+++ b/package_manager/src/Debugger.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Drupal\package_manager;
+
+class Debugger {
+
+ public static function debugOutput($value, $label = NULL, $flags = FILE_APPEND) {
+ file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n***", $flags);
+ if (is_bool($value)) {
+ $value = $value ? 'TRUE' : 'FALSE';
+ }
+ elseif ($value instanceof \Throwable) {
+ $value = 'Msg: ' . $value->getMessage() . '- trace ' . $value->getTraceAsString();
+ }
+ else {
+ $value = print_r($value, TRUE);
+ }
+ if ($label) {
+ $value = "$label: $value";
+ }
+ $value = date("D M d, Y G:i") . "- $value";
+ file_put_contents("/Users/ted.bowman/sites/debug3.txt", "\n$value", $flags);
+ }
+
+}
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 5165ef27f1..77379af1bb 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -9,6 +9,7 @@ use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\package_manager\Debugger;
use Drush\Commands\DrushCommands;
/**
@@ -68,6 +69,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL, 'is-from-web' => FALSE]) {
$io = $this->io();
+ Debugger::debugOutput($options, 'autoUpdate');
// The second half of the update process (post-apply etc.) is done by this
// exact same command, with some additional flags, in a separate process to
@@ -87,16 +89,19 @@ final class AutomaticUpdatesCommands extends DrushCommands {
else {
if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
$io->error('Automatic updates are disabled.');
+ Debugger::debugOutput('disabled');
return;
}
$release = $this->stage->getTargetRelease();
if ($release) {
+ Debugger::debugOutput($release->getVersion(), 'release');
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
$io->info($message);
$this->stage->performUpdate($options['is-from-web']);
}
else {
+ Debugger::debugOutput('no release');
$io->info("There is no Drupal core update available.");
$this->runStatusChecks($options['is-from-web']);
}
@@ -107,12 +112,14 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* Runs status checks, and sends failure notifications if necessary.
*/
private function runStatusChecks(bool $is_from_web): void {
+ Debugger::debugOutput($is_from_web, 'runStatusChecks');
$method = $this->configFactory->get('automatic_updates.settings')
->get('unattended.method');
// To ensure consistent results, only run the status checks if we're
// explicitly configured to do unattended updates on the command line.
if (($method === 'web' && $is_from_web) || $method === 'console') {
+ Debugger::debugOutput('running status checks');
$last_results = $this->statusChecker->getResults();
$this->statusCheckMailer->sendFailureNotifications($last_results, $this->statusChecker->run()->getResults());
}
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index b130cbff50..bc9351ab45 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -6,6 +6,7 @@ namespace Drupal\automatic_updates;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
+use Drupal\package_manager\Debugger;
use Drupal\package_manager\PathLocator;
use Psr\Log\LoggerAwareTrait;
use Symfony\Component\Process\PhpExecutableFinder;
@@ -81,7 +82,9 @@ class CronUpdateRunner implements CronInterface {
$process->setTimeout(0);
try {
+ Debugger::debugOutput($process->getCommandLine(), 'starting');
$process->start();
+ Debugger::debugOutput('started');
sleep(1);
$wait_till = time() + 5;
// Wait for the process to start.
@@ -90,6 +93,7 @@ class CronUpdateRunner implements CronInterface {
}
catch (\Throwable $throwable) {
+ Debugger::debugOutput($throwable, 'Thrown');
watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
}
}
@@ -108,6 +112,7 @@ class CronUpdateRunner implements CronInterface {
* {@inheritdoc}
*/
public function run() {
+ Debugger::debugOutput('cron');
$method = $this->configFactory->get('automatic_updates.settings')
->get('unattended.method');
// Always run the cron service before we trigger the update terminal
@@ -120,7 +125,9 @@ class CronUpdateRunner implements CronInterface {
// normal cron handler.
if ($this->getMode() !== self::DISABLED && $method === 'web' && !self::isCommandLine()) {
$lock = \Drupal::lock();
+ Debugger::debugOutput('about to lock');
if ($lock->acquire('cron', 30)) {
+ Debugger::debugOutput('locked');
$this->runTerminalUpdateCommand();
$lock->release('cron');
}
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
index a48218b4ae..2cbcf72e80 100644
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -15,14 +15,14 @@ class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
*/
public function alter(ContainerBuilder $container) {
parent::alter($container);
- if (defined(self::class . '-test-runner') && $container->hasDefinition('automatic_updates.cron_update_runner')) {
+ if (\Drupal::state()->get(self::class . '-runner') && $container->hasDefinition('automatic_updates.cron_update_runner')) {
$container->getDefinition('automatic_updates.cron_update_runner')->setClass(TestCronUpdateRunner::class);
}
}
public static function useTestCronUpdateRunner(bool $use = TRUE) {
\Drupal::state()->set(self::class . '-runner', $use);
- \Drupal::cache()->invalidateAll();
+
}
}
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index f31ed8366d..56a36c913d 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -19,6 +19,7 @@ use Drupal\package_manager_test_validation\EventSubscriber\TestSubscriber;
use Drupal\system\SystemManager;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\Traits\Core\CronRunTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Filesystem\Filesystem;
/**
@@ -89,6 +90,18 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->drupalLogin($this->reportViewerUser);
}
+ /**
+ * @inheritDoc
+ */
+ protected function installModulesFromClassProperty(ContainerInterface $container): void {
+ $container->get('module_installer')->install([
+ 'system',
+ ]);
+ AutomaticUpdatesTestServiceProvider::useTestCronUpdateRunner();
+ parent::installModulesFromClassProperty($container);
+ }
+
+
/**
* Tests status checks are displayed after Automatic Updates is installed.
*
@@ -260,7 +273,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
* @dataProvider providerAdminRoutes
*/
public function testStatusChecksOnAdminPages(string $admin_route): void {
-
+ AutomaticUpdatesTestServiceProvider::useTestCronUpdateRunner();
$assert = $this->assertSession();
--
GitLab
From d501bc8e7ca4541b5a0e4c7bacd66c5256c34efa Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 12 Jul 2023 23:52:22 -0400
Subject: [PATCH 057/142] testStatusChecksOnAdminPages passing
---
src/Commands/AutomaticUpdatesCommands.php | 46 +++++++++++++----------
src/CronUpdateRunner.php | 2 +-
tests/src/Functional/StatusCheckTest.php | 3 +-
3 files changed, 29 insertions(+), 22 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 77379af1bb..9811d2d84b 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -6,6 +6,7 @@ namespace Drupal\automatic_updates\Commands;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
@@ -87,24 +88,21 @@ final class AutomaticUpdatesCommands extends DrushCommands {
$this->runStatusChecks($options['is-from-web']);
}
else {
- if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
- $io->error('Automatic updates are disabled.');
- Debugger::debugOutput('disabled');
- return;
+ if ($this->cronUpdateRunner->getMode() !== CronUpdateRunner::DISABLED) {
+ $release = $this->stage->getTargetRelease();
+ if ($release) {
+ Debugger::debugOutput($release->getVersion(), 'release');
+ $message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
+ $io->info($message);
+ $this->stage->performUpdate($options['is-from-web']);
+ return;
+ }
+ else {
+ $io->info("There is no Drupal core update available.");
+ }
}
- $release = $this->stage->getTargetRelease();
- if ($release) {
- Debugger::debugOutput($release->getVersion(), 'release');
- $message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
- $io->info($message);
- $this->stage->performUpdate($options['is-from-web']);
- }
- else {
- Debugger::debugOutput('no release');
- $io->info("There is no Drupal core update available.");
- $this->runStatusChecks($options['is-from-web']);
- }
+ $this->runStatusChecks($options['is-from-web']);
}
}
@@ -116,12 +114,22 @@ final class AutomaticUpdatesCommands extends DrushCommands {
$method = $this->configFactory->get('automatic_updates.settings')
->get('unattended.method');
+ $last_results = $this->statusChecker->getResults();
+ $last_run_time = $this->statusChecker->getLastRunTime();
+ // Do not run status checks more than once an hour unless there are no results
+ // available.
+ $needs_run = $last_results === NULL || !$last_run_time || \Drupal::time()->getRequestTime() - $last_run_time > 3600;
+
// To ensure consistent results, only run the status checks if we're
// explicitly configured to do unattended updates on the command line.
- if (($method === 'web' && $is_from_web) || $method === 'console') {
+ if ($needs_run && ($method === 'web' && $is_from_web) || $method === 'console') {
Debugger::debugOutput('running status checks');
- $last_results = $this->statusChecker->getResults();
- $this->statusCheckMailer->sendFailureNotifications($last_results, $this->statusChecker->run()->getResults());
+ $this->statusChecker->run();
+ // Only try to send failure notifications if unattended updates are
+ // enabled.
+ if ($this->cronUpdateRunner->getMode() !== CronUpdateRunner::DISABLED) {
+ $this->statusCheckMailer->sendFailureNotifications($last_results, $this->statusChecker->getResults());
+ }
}
}
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index bc9351ab45..bd38aad5b3 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -123,7 +123,7 @@ class CronUpdateRunner implements CronInterface {
// accessed via the web (i.e., anything that isn't the command line), go
// ahead and try to do the update. In all other circumstances, just run the
// normal cron handler.
- if ($this->getMode() !== self::DISABLED && $method === 'web' && !self::isCommandLine()) {
+ if ($method === 'web' && !self::isCommandLine()) {
$lock = \Drupal::lock();
Debugger::debugOutput('about to lock');
if ($lock->acquire('cron', 30)) {
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 56a36c913d..55aeee0948 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -349,7 +349,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// Confirm that is if cron is run over an hour after the checkers were
// previously run the checkers will be run again.
- $this->delayRequestTime(60);
+ $this->delayRequestTime(31);
$this->runCronAndWait();
$original_expected_results = $expected_results;
$expected_results = $unexpected_results;
@@ -360,7 +360,6 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->assertSame(SystemManager::REQUIREMENT_ERROR, $expected_results['2 errors']->severity);
file_put_contents("/Users/ted.bowman/sites/test.html", $this->getSession()->getPage()->getOuterHtml());
$assert->pageTextNotContains((string) $unexpected_results['1 error']->summary);
- $assert->pageTextNotContains($expected_results['1 warning']->messages[0]);
$assert->pageTextNotContains($expected_results['2 errors']->messages[0]);
$assert->pageTextNotContains($expected_results['2 errors']->messages[1]);
$assert->pageTextContainsOnce($expected_results['2 errors']->summary);
--
GitLab
From 7bf42cff8a387cc8b886652ef97dcf80ad9bbe9e Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 00:08:12 -0400
Subject: [PATCH 058/142] testFailureNotifications passed
---
src/Commands/AutomaticUpdatesCommands.php | 1 -
.../AutomaticUpdatesTestServiceProvider.php | 1 -
.../src/TestCronUpdateRunner.php | 2 +-
.../StatusCheckFailureEmailTest.php | 48 ++++++++++++-------
tests/src/Functional/StatusCheckTest.php | 6 +--
5 files changed, 34 insertions(+), 24 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 9811d2d84b..942e983636 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -6,7 +6,6 @@ namespace Drupal\automatic_updates\Commands;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\ConsoleUpdateStage;
-use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
index 2cbcf72e80..363f3d70be 100644
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -4,7 +4,6 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates_test;
-use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\DependencyInjection\ServiceProviderBase;
diff --git a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
index dd64aaceeb..82cd493b7f 100644
--- a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
+++ b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
@@ -9,7 +9,7 @@ use function PHPUnit\Framework\assertCount;
class TestCronUpdateRunner extends CronUpdateRunner {
/**
- * @inheritDoc
+ * {}
*/
protected function getCommandPath(): string {
// Return the real path of Drush.
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 6bc07e82a7..3c40c7a2a3 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -6,6 +6,7 @@ namespace Drupal\Tests\automatic_updates\Functional;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\StatusCheckMailer;
+use Drupal\automatic_updates_test\AutomaticUpdatesTestServiceProvider;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\Url;
@@ -13,7 +14,9 @@ use Drupal\package_manager\Event\StatusCheckEvent;
use Drupal\system\SystemManager;
use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
+use Drupal\Tests\Traits\Core\CronRunTrait;
use Drush\TestTraits\DrushTestTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Tests status check failure notification emails during cron runs.
@@ -24,6 +27,7 @@ use Drush\TestTraits\DrushTestTrait;
*/
class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
+ use CronRunTrait;
use EmailNotificationsTestTrait;
use DrushTestTrait;
use ValidationTestTrait;
@@ -82,11 +86,12 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
*
* @see automatic_updates_cron()
*/
- private function runCron(): void {
+ private function runCronAndWait(): void {
$offset = $this->cronRunCount * 2;
$this->cronRunCount++;
TestTime::setFakeTimeByOffset("+$offset hours");
- $this->container->get('cron')->run();
+ $this->cronRun();
+ sleep(2);
}
/**
@@ -112,7 +117,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$url = Url::fromRoute('system.status')
->setAbsolute()
@@ -135,13 +140,13 @@ END;
$recipient_count = count($this->emailRecipients);
$this->assertGreaterThan(0, $recipient_count);
$sent_messages_count = $recipient_count;
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$this->assertSentMessagesCount($sent_messages_count);
// If a different error is flagged, they should be e-mailed again.
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -153,28 +158,28 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$this->assertSentMessagesCount($sent_messages_count);
// If only a warning is flagged, they should not be e-mailed again because
// we ignore warnings by default.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$this->assertSentMessagesCount($sent_messages_count);
// If we stop ignoring warnings, they should be e-mailed again because we
// clear the stored results if the relevant configuration is changed.
$config = $this->config('automatic_updates.settings');
$config->set('status_check_mail', StatusCheckMailer::ALL)->save();
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
// If we flag a different warning, they should be e-mailed again.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -185,7 +190,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($warnings, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -196,7 +201,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_ERROR),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -205,7 +210,7 @@ END;
// different order.
$results = array_reverse($results);
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable notifications entirely, they should not be e-mailed even
@@ -213,7 +218,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable notifications and go back to ignoring warnings, they
@@ -221,7 +226,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::ERRORS_ONLY)->save();
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable unattended updates entirely and flag a new error, they
@@ -229,13 +234,13 @@ END;
$config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
$config->set('unattended.level', CronUpdateRunner::SECURITY)->save();
- $this->performConsoleUpdate();
+ $this->runCronAndWait();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
}
@@ -245,4 +250,15 @@ END;
$this->drush('auto-update', [], ['is-from-web' => NULL]);
}
+ /**
+ * {@inheritdoc}
+ */
+ protected function installModulesFromClassProperty(ContainerInterface $container): void {
+ $container->get('module_installer')->install([
+ 'system',
+ ]);
+ AutomaticUpdatesTestServiceProvider::useTestCronUpdateRunner();
+ parent::installModulesFromClassProperty($container);
+ }
+
}
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 55aeee0948..9e9ac2c71f 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -5,7 +5,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
use Behat\Mink\Element\NodeElement;
-use Composer\Autoload\ClassLoader;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates_test\AutomaticUpdatesTestServiceProvider;
@@ -20,7 +19,6 @@ use Drupal\system\SystemManager;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\Traits\Core\CronRunTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;
-use Symfony\Component\Filesystem\Filesystem;
/**
* Tests status checks.
@@ -91,7 +89,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
protected function installModulesFromClassProperty(ContainerInterface $container): void {
$container->get('module_installer')->install([
@@ -101,7 +99,6 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
parent::installModulesFromClassProperty($container);
}
-
/**
* Tests status checks are displayed after Automatic Updates is installed.
*
@@ -276,7 +273,6 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
AutomaticUpdatesTestServiceProvider::useTestCronUpdateRunner();
$assert = $this->assertSession();
-
$messages_section_selector = '[data-drupal-messages]';
$this->container->get('module_installer')->install(['automatic_updates', 'automatic_updates_test']);
--
GitLab
From 05b911fc9e4eda7b8dcaa2e6ce5b1ac3fef67f14 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 00:17:15 -0400
Subject: [PATCH 059/142] remove debugger
---
package_manager/src/Debugger.php | 25 -----------------------
src/Commands/AutomaticUpdatesCommands.php | 5 -----
src/CronUpdateRunner.php | 7 -------
3 files changed, 37 deletions(-)
delete mode 100644 package_manager/src/Debugger.php
diff --git a/package_manager/src/Debugger.php b/package_manager/src/Debugger.php
deleted file mode 100644
index 20d5be6a69..0000000000
--- a/package_manager/src/Debugger.php
+++ /dev/null
@@ -1,25 +0,0 @@
-<?php
-
-namespace Drupal\package_manager;
-
-class Debugger {
-
- public static function debugOutput($value, $label = NULL, $flags = FILE_APPEND) {
- file_put_contents("/Users/ted.bowman/sites/debug2.txt", "\n***", $flags);
- if (is_bool($value)) {
- $value = $value ? 'TRUE' : 'FALSE';
- }
- elseif ($value instanceof \Throwable) {
- $value = 'Msg: ' . $value->getMessage() . '- trace ' . $value->getTraceAsString();
- }
- else {
- $value = print_r($value, TRUE);
- }
- if ($label) {
- $value = "$label: $value";
- }
- $value = date("D M d, Y G:i") . "- $value";
- file_put_contents("/Users/ted.bowman/sites/debug3.txt", "\n$value", $flags);
- }
-
-}
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 942e983636..31a12d9838 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -9,7 +9,6 @@ use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\package_manager\Debugger;
use Drush\Commands\DrushCommands;
/**
@@ -69,7 +68,6 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*/
public function autoUpdate(array $options = ['post-apply' => FALSE, 'stage-id' => NULL, 'from-version' => NULL, 'to-version' => NULL, 'is-from-web' => FALSE]) {
$io = $this->io();
- Debugger::debugOutput($options, 'autoUpdate');
// The second half of the update process (post-apply etc.) is done by this
// exact same command, with some additional flags, in a separate process to
@@ -90,7 +88,6 @@ final class AutomaticUpdatesCommands extends DrushCommands {
if ($this->cronUpdateRunner->getMode() !== CronUpdateRunner::DISABLED) {
$release = $this->stage->getTargetRelease();
if ($release) {
- Debugger::debugOutput($release->getVersion(), 'release');
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
$io->info($message);
$this->stage->performUpdate($options['is-from-web']);
@@ -109,7 +106,6 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* Runs status checks, and sends failure notifications if necessary.
*/
private function runStatusChecks(bool $is_from_web): void {
- Debugger::debugOutput($is_from_web, 'runStatusChecks');
$method = $this->configFactory->get('automatic_updates.settings')
->get('unattended.method');
@@ -122,7 +118,6 @@ final class AutomaticUpdatesCommands extends DrushCommands {
// To ensure consistent results, only run the status checks if we're
// explicitly configured to do unattended updates on the command line.
if ($needs_run && ($method === 'web' && $is_from_web) || $method === 'console') {
- Debugger::debugOutput('running status checks');
$this->statusChecker->run();
// Only try to send failure notifications if unattended updates are
// enabled.
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateRunner.php
index bd38aad5b3..807258b5ac 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateRunner.php
@@ -6,7 +6,6 @@ namespace Drupal\automatic_updates;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
-use Drupal\package_manager\Debugger;
use Drupal\package_manager\PathLocator;
use Psr\Log\LoggerAwareTrait;
use Symfony\Component\Process\PhpExecutableFinder;
@@ -82,9 +81,7 @@ class CronUpdateRunner implements CronInterface {
$process->setTimeout(0);
try {
- Debugger::debugOutput($process->getCommandLine(), 'starting');
$process->start();
- Debugger::debugOutput('started');
sleep(1);
$wait_till = time() + 5;
// Wait for the process to start.
@@ -93,7 +90,6 @@ class CronUpdateRunner implements CronInterface {
}
catch (\Throwable $throwable) {
- Debugger::debugOutput($throwable, 'Thrown');
watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
}
}
@@ -112,7 +108,6 @@ class CronUpdateRunner implements CronInterface {
* {@inheritdoc}
*/
public function run() {
- Debugger::debugOutput('cron');
$method = $this->configFactory->get('automatic_updates.settings')
->get('unattended.method');
// Always run the cron service before we trigger the update terminal
@@ -125,9 +120,7 @@ class CronUpdateRunner implements CronInterface {
// normal cron handler.
if ($method === 'web' && !self::isCommandLine()) {
$lock = \Drupal::lock();
- Debugger::debugOutput('about to lock');
if ($lock->acquire('cron', 30)) {
- Debugger::debugOutput('locked');
$this->runTerminalUpdateCommand();
$lock->release('cron');
}
--
GitLab
From cb89ba34c08dd69394e8d428f4e84b51d0cce218 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 00:22:18 -0400
Subject: [PATCH 060/142] cleanup
---
.../src/AutomaticUpdatesTestServiceProvider.php | 2 +-
.../modules/automatic_updates_test/src/TestCronUpdateRunner.php | 2 +-
tests/src/Functional/StatusCheckTest.php | 1 -
3 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
index 363f3d70be..74ddf305ad 100644
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -14,7 +14,7 @@ class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
*/
public function alter(ContainerBuilder $container) {
parent::alter($container);
- if (\Drupal::state()->get(self::class . '-runner') && $container->hasDefinition('automatic_updates.cron_update_runner')) {
+ if (\Drupal::hasContainer() && \Drupal::state()->get(self::class . '-runner') && $container->hasDefinition('automatic_updates.cron_update_runner')) {
$container->getDefinition('automatic_updates.cron_update_runner')->setClass(TestCronUpdateRunner::class);
}
}
diff --git a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
index 82cd493b7f..406dca6557 100644
--- a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
+++ b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
@@ -9,7 +9,7 @@ use function PHPUnit\Framework\assertCount;
class TestCronUpdateRunner extends CronUpdateRunner {
/**
- * {}
+ * {@inheritdoc}
*/
protected function getCommandPath(): string {
// Return the real path of Drush.
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 9e9ac2c71f..9480eedc6f 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -354,7 +354,6 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// Confirm on admin pages only the error summary will be displayed if there
// is more than 1 error.
$this->assertSame(SystemManager::REQUIREMENT_ERROR, $expected_results['2 errors']->severity);
- file_put_contents("/Users/ted.bowman/sites/test.html", $this->getSession()->getPage()->getOuterHtml());
$assert->pageTextNotContains((string) $unexpected_results['1 error']->summary);
$assert->pageTextNotContains($expected_results['2 errors']->messages[0]);
$assert->pageTextNotContains($expected_results['2 errors']->messages[1]);
--
GitLab
From c3f7debfdb3971c9dd35b75080946f25759b8d10 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 00:35:16 -0400
Subject: [PATCH 061/142] remove
automatic_updates_test_cron_form_update_settings_alter
---
tests/src/Kernel/ConsoleUpdateStageTest.php | 1 -
1 file changed, 1 deletion(-)
diff --git a/tests/src/Kernel/ConsoleUpdateStageTest.php b/tests/src/Kernel/ConsoleUpdateStageTest.php
index 0fdf661f47..f0847c346d 100644
--- a/tests/src/Kernel/ConsoleUpdateStageTest.php
+++ b/tests/src/Kernel/ConsoleUpdateStageTest.php
@@ -32,7 +32,6 @@ use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
* @covers \Drupal\automatic_updates\ConsoleUpdateStage
- * @covers \automatic_updates_test_cron_form_update_settings_alter
* @group automatic_updates
* @internal
*/
--
GitLab
From 6757fba357d77efa1114741b3c95e262ce1a7fa6 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 08:12:12 -0400
Subject: [PATCH 062/142] StatusCheckTest do not install automatic_updates_test
as module property as this will also install automatic_updates which should
be installed later
---
tests/src/Functional/StatusCheckTest.php | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 9480eedc6f..e786ff1a69 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -62,7 +62,6 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
*/
protected static $modules = [
'package_manager_test_validation',
- 'automatic_updates_test',
];
/**
@@ -409,7 +408,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
public function testStatusCheckAfterInstall(): void {
$assert = $this->assertSession();
$this->drupalLogin($this->checkerRunnerUser);
- $this->container->get('module_installer')->uninstall(['automatic_updates']);
+ $this->container->get('module_installer')->uninstall(['automatic_updates', 'automatic_updates_test']);
$this->drupalGet('admin/reports/status');
$assert->pageTextNotContains('Update readiness checks');
@@ -794,7 +793,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
private function runCronAndWait(): void {
$this->cronRun();
- sleep(5);
+ sleep(2);
}
}
--
GitLab
From bb38f049fae4dfcfa856a1d175f798396a953fc7 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 08:26:16 -0400
Subject: [PATCH 063/142] update getCommandPath for test
---
.../src/TestCronUpdateRunner.php | 29 ++++++++++++++++---
1 file changed, 25 insertions(+), 4 deletions(-)
diff --git a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
index 406dca6557..5c151caca4 100644
--- a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
+++ b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
@@ -4,7 +4,6 @@ namespace Drupal\automatic_updates_test;
use Composer\Autoload\ClassLoader;
use Drupal\automatic_updates\CronUpdateRunner;
-use function PHPUnit\Framework\assertCount;
class TestCronUpdateRunner extends CronUpdateRunner {
@@ -12,10 +11,32 @@ class TestCronUpdateRunner extends CronUpdateRunner {
* {@inheritdoc}
*/
protected function getCommandPath(): string {
- // Return the real path of Drush.
+ // There may be multiple class loaders at work.
+ // ClassLoader::getRegisteredLoaders() keeps track of them all, indexed by
+ // the path of the vendor directory they load classes from.
$loaders = ClassLoader::getRegisteredLoaders();
- assertCount(1, $loaders);
- $vendor_path = array_keys($loaders)[0];
+
+ // If there's only one class loader, we don't need to search for the right
+ // one.
+ if (count($loaders) === 1) {
+ $vendor_path = key($loaders);
+ }
+ else {
+ // To determine which class loader is the one for Drupal's vendor directory,
+ // look for the loader whose vendor path starts the same way as the path to
+ // this file.
+ foreach (array_keys($loaders) as $path) {
+ if (str_starts_with(__FILE__, dirname($path))) {
+ $vendor_path = $path;
+ }
+ }
+ }
+ if (!isset($vendor_path)) {
+ // If we couldn't find a match, assume that the first registered class
+ // loader is the one we want.
+ $vendor_path = key($loaders);
+ }
+
return $vendor_path . '/drush/drush/drush';
}
--
GitLab
From 1e3805ab8118c332458e0aded86f9ada0300b0d6 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 08:27:46 -0400
Subject: [PATCH 064/142] only test StatusCheckTest
---
drupalci.yml | 27 +--------------------------
1 file changed, 1 insertion(+), 26 deletions(-)
diff --git a/drupalci.yml b/drupalci.yml
index 3cd1b3cc07..91eebdc6c2 100644
--- a/drupalci.yml
+++ b/drupalci.yml
@@ -20,33 +20,8 @@ build:
# halt-on-fail can be set on the run_tests tasks in order to fail fast.
# suppress-deprecations is false in order to be alerted to usages of
# deprecated code.
- run_tests.phpunit:
- types: 'PHPUnit-Unit'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
- run_tests.kernel:
- types: 'PHPUnit-Kernel'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
- run_tests.build:
- # Limit concurrency due to disk space concerns.
- concurrency: 15
- types: 'PHPUnit-Build'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
run_tests.functional:
types: 'PHPUnit-Functional'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
- # Functional JavaScript tests require a concurrency of 1 because there is
- # only one instance of PhantomJS on the testbot machine.
- run_tests.javascript:
- concurrency: 1
- types: 'PHPUnit-FunctionalJavascript'
- testgroups: '--all'
+ testgroups: '--class "Drupal\Tests\automatic_updates\Functional\StatusCheckTest"'
suppress-deprecations: false
halt-on-fail: false
--
GitLab
From 76b472ab420aa9e4a0f22f30cb7938fe4ad0c34f Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 13 Jul 2023 08:41:34 -0400
Subject: [PATCH 065/142] no longer to override installModulesFromClassProperty
---
tests/src/Functional/StatusCheckTest.php | 11 -----------
1 file changed, 11 deletions(-)
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index e786ff1a69..f1af3e8343 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -87,17 +87,6 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->drupalLogin($this->reportViewerUser);
}
- /**
- * {@inheritdoc}
- */
- protected function installModulesFromClassProperty(ContainerInterface $container): void {
- $container->get('module_installer')->install([
- 'system',
- ]);
- AutomaticUpdatesTestServiceProvider::useTestCronUpdateRunner();
- parent::installModulesFromClassProperty($container);
- }
-
/**
* Tests status checks are displayed after Automatic Updates is installed.
*
--
GitLab
From ad81f09cf4e298a2c679fa4c2d940632474e827d Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 14 Jul 2023 13:01:05 -0400
Subject: [PATCH 066/142] probably will not do this , build test instead
---
src/Commands/AutomaticUpdatesCommands.php | 2 +-
.../AutomaticUpdatesTestServiceProvider.php | 9 +++++++++
.../src/TestAutomaticUpdatesCommands.php | 12 ++++++++++++
.../src/TestCronUpdateRunner.php | 2 ++
tests/src/Functional/StatusCheckTest.php | 19 ++++++++++++++-----
5 files changed, 38 insertions(+), 6 deletions(-)
create mode 100644 tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 31a12d9838..4d9cfee82e 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -22,7 +22,7 @@ use Drush\Commands\DrushCommands;
* @todo Either remove this command completely or make it just call the new
* Symfony Console command that will be added in https://drupal.org/i/3360485.
*/
-final class AutomaticUpdatesCommands extends DrushCommands {
+class AutomaticUpdatesCommands extends DrushCommands {
/**
* Constructs a AutomaticUpdatesCommands object.
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
index 74ddf305ad..42db105075 100644
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -19,6 +19,15 @@ class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
}
}
+ /**
+ * {@inheritdoc}
+ */
+ public function register(ContainerBuilder $container) {
+ parent::register($container);
+
+ }
+
+
public static function useTestCronUpdateRunner(bool $use = TRUE) {
\Drupal::state()->set(self::class . '-runner', $use);
diff --git a/tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php b/tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php
new file mode 100644
index 0000000000..0a60e5d1f6
--- /dev/null
+++ b/tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\automatic_updates_test;
+
+use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
+
+class TestAutomaticUpdatesCommands extends AutomaticUpdatesCommands {
+
+
+}
diff --git a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
index 5c151caca4..d589c3e999 100644
--- a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
+++ b/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
@@ -1,5 +1,7 @@
<?php
+declare(strict_types = 1);
+
namespace Drupal\automatic_updates_test;
use Composer\Autoload\ClassLoader;
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index f1af3e8343..f594577aa1 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -5,6 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
use Behat\Mink\Element\NodeElement;
+use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates_test\AutomaticUpdatesTestServiceProvider;
@@ -18,6 +19,7 @@ use Drupal\package_manager_test_validation\EventSubscriber\TestSubscriber;
use Drupal\system\SystemManager;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\Traits\Core\CronRunTrait;
+use Drush\TestTraits\DrushTestTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
@@ -29,6 +31,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
use CronRunTrait;
+ use DrushTestTrait;
use ValidationTestTrait;
/**
@@ -304,7 +307,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
TestSubscriber1::setTestResult($expected_results, StatusCheckEvent::class);
// Confirm a new message is displayed if the cron is run after an hour.
$this->delayRequestTime();
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->drupalGet(Url::fromRoute($admin_route));
$assert->pageTextContainsOnce(static::$errorsExplanation);
// Confirm on admin pages that the summary will be displayed.
@@ -324,7 +327,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
];
TestSubscriber1::setTestResult($unexpected_results, StatusCheckEvent::class);
$this->delayRequestTime(30);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->drupalGet(Url::fromRoute($admin_route));
$assert->pageTextNotContains($unexpected_results['2 errors']->summary);
$assert->pageTextContainsOnce((string) $expected_results['1 error']->summary);
@@ -334,7 +337,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// Confirm that is if cron is run over an hour after the checkers were
// previously run the checkers will be run again.
$this->delayRequestTime(31);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$original_expected_results = $expected_results;
$expected_results = $unexpected_results;
$unexpected_results = $original_expected_results;
@@ -356,7 +359,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$expected_results = [$this->createValidationResult(SystemManager::REQUIREMENT_WARNING, 2)];
TestSubscriber1::setTestResult($expected_results, StatusCheckEvent::class);
$this->delayRequestTime();
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->drupalGet(Url::fromRoute($admin_route));
// Confirm that the warnings summary is displayed on admin pages if there
// are no errors.
@@ -370,7 +373,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$expected_results = [$this->createValidationResult(SystemManager::REQUIREMENT_WARNING)];
TestSubscriber1::setTestResult($expected_results, StatusCheckEvent::class);
$this->delayRequestTime();
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->drupalGet(Url::fromRoute($admin_route));
$assert->pageTextNotContains(static::$errorsExplanation);
// Confirm that a single warning is displayed and not the summary on admin
@@ -391,6 +394,12 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$assert->pageTextNotContains($expected_results[0]->messages[0]);
}
+ private function performConsoleUpdate() {
+ $commands = $this->container->get(AutomaticUpdatesCommands::class);
+ // @todo Should we change working directory?
+ $this->drush('auto-update', [], ['is-from-web' => NULL], NULL, $this->container->get('package_manager.path_locator')->getProjectRoot());
+ }
+
/**
* Tests installing a module with a checker before installing Automatic Updates.
*/
--
GitLab
From 69d58a41c2f973d17478458aa89880b4193d20b1 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 15:16:49 -0400
Subject: [PATCH 067/142] log status check events in build tests also
---
.../src/EventSubscriber/EventLogSubscriber.php | 5 ++++-
.../tests/src/Build/TemplateProjectTestBase.php | 8 ++++----
2 files changed, 8 insertions(+), 5 deletions(-)
diff --git a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
index 2f3e47cb8f..76c2705135 100644
--- a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
+++ b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
@@ -13,6 +13,7 @@ use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Event\PreDestroyEvent;
use Drupal\package_manager\Event\PreRequireEvent;
use Drupal\package_manager\Event\StageEvent;
+use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
/**
@@ -27,7 +28,8 @@ final class EventLogSubscriber implements EventSubscriberInterface {
* The event object.
*/
public function logEventInfo(StageEvent $event): void {
- \Drupal::logger('package_manager_test_event_logger')->info('package_manager_test_event_logger-start: Event: ' . get_class($event) . ', Stage instance of: ' . get_class($event->stage) . ':package_manager_test_event_logger-end');
+ $channel = $event instanceof StatusCheckEvent ? 'package_manager_test_status_event_logger' : 'package_manager_test_lifecycle_event_logger';
+ \Drupal::logger($channel)->info("$channel-start: Event: " . get_class($event) . ', Stage instance of: ' . get_class($event->stage) . ":$channel-end");
}
/**
@@ -48,6 +50,7 @@ final class EventLogSubscriber implements EventSubscriberInterface {
PostApplyEvent::class => ['logEventInfo', PHP_INT_MAX],
PreDestroyEvent::class => ['logEventInfo', PHP_INT_MAX],
PostDestroyEvent::class => ['logEventInfo', PHP_INT_MAX],
+ StatusCheckEvent::class => ['logEventInfo', PHP_INT_MAX],
];
}
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index 955813ab86..e2efbf6858 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -580,7 +580,7 @@ END;
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
- protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL): void {
+ protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL, string $channel = 'package_manager_test_lifecycle_event_logger'): void {
if ($expected_events === NULL) {
$expected_events = [
PreCreateEvent::class,
@@ -605,13 +605,13 @@ END;
$page = $this->getMink()->getSession()->getPage();
$this->visit('/admin/reports/dblog');
$assert_session->statusCodeEquals(200);
- $page->selectFieldOption('Type', 'package_manager_test_event_logger');
+ $page->selectFieldOption('Type', $channel);
$page->pressButton('Filter');
$assert_session->statusCodeEquals(200);
// The log entries will not appear completely in the page text but they will
// appear in the title attribute of the links.
- $links = $page->findAll('css', 'a[title^=package_manager_test_event_logger-start]');
+ $links = $page->findAll('css', "a[title^=$channel-start]");
$actual_titles = [];
// Loop through the links in reverse order because the most recent entries
// will be first.
@@ -620,7 +620,7 @@ END;
}
$expected_titles = [];
foreach ($expected_events as $event) {
- $expected_titles[] = "package_manager_test_event_logger-start: Event: $event, Stage instance of: $expected_stage_class:package_manager_test_event_logger-end";
+ $expected_titles[] = "$channel-start: Event: $event, Stage instance of: $expected_stage_class:$channel-end";
}
$this->assertSame($expected_titles, $actual_titles, $message ?? '');
}
--
GitLab
From bc5f43979a547846dc2df0ffa8781d83cc1305e4 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 15:42:31 -0400
Subject: [PATCH 068/142] remove unless override
---
.../src/AutomaticUpdatesTestServiceProvider.php | 8 --------
1 file changed, 8 deletions(-)
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
index 56b00b213b..74ddf305ad 100644
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -19,14 +19,6 @@ class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
}
}
- /**
- * {@inheritdoc}
- */
- public function register(ContainerBuilder $container) {
- parent::register($container);
-
- }
-
public static function useTestCronUpdateRunner(bool $use = TRUE) {
\Drupal::state()->set(self::class . '-runner', $use);
--
GitLab
From 287f2c8ccac5003bd81d595ed9c950e7c272d358 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 16:30:01 -0400
Subject: [PATCH 069/142] StatusCheckFailureEmailTest change to run drush
command
---
.../StatusCheckFailureEmailTest.php | 39 +++++++++++--------
1 file changed, 23 insertions(+), 16 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 3c40c7a2a3..7e221996f5 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -76,6 +76,10 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
$this->config('update.settings')
->set('check.interval_days', 30)
->save();
+
+ $this->config('automatic_updates.settings')
+ ->set('unattended.method', 'console')
+ ->save();
}
/**
@@ -117,14 +121,14 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$url = Url::fromRoute('system.status')
->setAbsolute()
->toString();
$base = Url::fromUserInput('/')->setAbsolute()->toString();
- $url = str_replace($base, 'http://' . str_replace('test', '', $this->databasePrefix) . '/', $url);
+ $url = str_replace($base, 'http://default/', $url);
$expected_body = <<<END
Your site has failed some readiness checks for automatic updates and may not
@@ -140,13 +144,13 @@ END;
$recipient_count = count($this->emailRecipients);
$this->assertGreaterThan(0, $recipient_count);
$sent_messages_count = $recipient_count;
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If a different error is flagged, they should be e-mailed again.
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -158,28 +162,28 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If only a warning is flagged, they should not be e-mailed again because
// we ignore warnings by default.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we stop ignoring warnings, they should be e-mailed again because we
// clear the stored results if the relevant configuration is changed.
$config = $this->config('automatic_updates.settings');
$config->set('status_check_mail', StatusCheckMailer::ALL)->save();
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
// If we flag a different warning, they should be e-mailed again.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -190,7 +194,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($warnings, StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -201,7 +205,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_ERROR),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -210,7 +214,7 @@ END;
// different order.
$results = array_reverse($results);
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable notifications entirely, they should not be e-mailed even
@@ -218,7 +222,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable notifications and go back to ignoring warnings, they
@@ -226,7 +230,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::ERRORS_ONLY)->save();
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable unattended updates entirely and flag a new error, they
@@ -234,20 +238,23 @@ END;
$config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
$config->set('unattended.level', CronUpdateRunner::SECURITY)->save();
- $this->runCronAndWait();
+ $this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
}
private function performConsoleUpdate() {
+ static $total_delay = 0;
+ $total_delay += 61;
+ TestTime::setFakeTimeByOffset("+$total_delay minutes");
// @todo Should we change working directory?
- $this->drush('auto-update', [], ['is-from-web' => NULL]);
+ $this->drush('auto-update');
}
/**
--
GitLab
From 35e397cce25a074c436893f647d0f5b14156a1e2 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 17:38:51 -0400
Subject: [PATCH 070/142] HookCronTest to use new class name. Will still fail
---
tests/src/Kernel/HookCronTest.php | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/tests/src/Kernel/HookCronTest.php b/tests/src/Kernel/HookCronTest.php
index a81fda6a72..38d1a855ff 100644
--- a/tests/src/Kernel/HookCronTest.php
+++ b/tests/src/Kernel/HookCronTest.php
@@ -2,7 +2,7 @@
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateStage;
+use Drupal\automatic_updates\CronUpdateRunner;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\package_manager\Event\StatusCheckEvent;
@@ -27,9 +27,9 @@ class HookCronTest extends AutomaticUpdatesKernelTestBase {
$this->setCoreVersion('9.8.1');
// Undo override of the 'serverApi' property from the parent test class.
// @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::setUp
- $property = new \ReflectionProperty(CronUpdateStage::class, 'serverApi');
+ $property = new \ReflectionProperty(CronUpdateRunner::class, 'serverApi');
$property->setValue(NULL, 'cli');
- $this->assertTrue(CronUpdateStage::isCommandLine());
+ $this->assertTrue(CronUpdateRunner::isCommandLine());
$status_check_count = 0;
$this->addEventTestListener(function () use (&$status_check_count) {
$status_check_count++;
@@ -42,7 +42,7 @@ class HookCronTest extends AutomaticUpdatesKernelTestBase {
// If we are on the web the status checks should run.
$property->setValue(NULL, 'cgi-fcgi');
- $this->assertFalse(CronUpdateStage::isCommandLine());
+ $this->assertFalse(CronUpdateRunner::isCommandLine());
$this->container->get('cron')->run();
$this->assertSame(1, $status_check_count);
--
GitLab
From 1f5859a9fc904cc0a7f19138b3e761e509e7c281 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 17:41:27 -0400
Subject: [PATCH 071/142] phpcbf
---
.../src/EventSubscriber/EventLogSubscriber.php | 2 +-
package_manager/tests/src/Build/TemplateProjectTestBase.php | 3 +++
tests/src/Functional/StatusCheckFailureEmailTest.php | 2 +-
3 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
index 76c2705135..cd20b12d91 100644
--- a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
+++ b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
@@ -28,7 +28,7 @@ final class EventLogSubscriber implements EventSubscriberInterface {
* The event object.
*/
public function logEventInfo(StageEvent $event): void {
- $channel = $event instanceof StatusCheckEvent ? 'package_manager_test_status_event_logger' : 'package_manager_test_lifecycle_event_logger';
+ $channel = $event instanceof StatusCheckEvent ? 'package_manager_test_status_event_logger' : 'package_manager_test_lifecycle_event_logger';
\Drupal::logger($channel)->info("$channel-start: Event: " . get_class($event) . ', Stage instance of: ' . get_class($event->stage) . ":$channel-end");
}
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index e2efbf6858..dcf0cf65bc 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -577,6 +577,9 @@ END;
* will be asserted.
* @param string|null $message
* (optional) A message to display with the assertion.
+ * @param string $channel
+ * (optional) The longer change to check. If none provide defaults to
+ * 'package_manager_test_lifecycle_event_logger'.
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 7e221996f5..62e0ef1e46 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -144,7 +144,7 @@ END;
$recipient_count = count($this->emailRecipients);
$this->assertGreaterThan(0, $recipient_count);
$sent_messages_count = $recipient_count;
- $this->performConsoleUpdate();
+ $this->performConsoleUpdate();
$this->assertSentMessagesCount($sent_messages_count);
// If a different error is flagged, they should be e-mailed again.
--
GitLab
From 6d55cb3271452030a211369d7d088206d158a7e2 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 18:01:09 -0400
Subject: [PATCH 072/142] remove unneeed diff
---
src/ConsoleUpdateStage.php | 51 +++++++++++--------
.../src/TestAutomaticUpdatesCommands.php | 12 -----
2 files changed, 30 insertions(+), 33 deletions(-)
delete mode 100644 tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php
diff --git a/src/ConsoleUpdateStage.php b/src/ConsoleUpdateStage.php
index 045a96e64e..e8ee417b0c 100644
--- a/src/ConsoleUpdateStage.php
+++ b/src/ConsoleUpdateStage.php
@@ -116,26 +116,6 @@ class ConsoleUpdateStage extends UpdateStage {
throw new \BadMethodCallException(__METHOD__ . '() cannot be called directly.');
}
- /**
- * Runs the post apply command.
- */
- protected function triggerPostApply(string $stage_id, string $start_version, string $target_version, bool $is_from_web): void {
- $alias = Drush::aliasManager()->getSelf();
-
- $output = Drush::processManager()
- ->drush($alias, 'auto-update', [], [
- 'post-apply' => TRUE,
- 'stage-id' => $stage_id,
- 'from-version' => $start_version,
- 'to-version' => $target_version,
- 'is-from-web' => $is_from_web,
- ])
- ->mustRun()
- ->getOutput();
- // Ensure the output of the sub-process is visible.
- Drush::output()->write($output);
- }
-
/**
* Performs the update.
*
@@ -211,7 +191,6 @@ class ConsoleUpdateStage extends UpdateStage {
if ($e instanceof StageFailureMarkerException || $e instanceof ApplyFailedException) {
$mail_params['error_message'] = $this->failureMarker->getMessage(FALSE);
}
-
if ($e instanceof ApplyFailedException) {
$mail_params['urgent'] = TRUE;
$key = 'cron_failed_apply';
@@ -242,6 +221,35 @@ class ConsoleUpdateStage extends UpdateStage {
return TRUE;
}
+ /**
+ * Runs the post apply command.
+ *
+ * @param string $stage_id
+ * The ID of the current stage.
+ * @param string $start_version
+ * The version of Drupal core that started the update.
+ * @param string $target_version
+ * The version of Drupal core to which we are updating.
+ * @param bool $is_from_web
+ * Whether or not the update command was run from the web.
+ */
+ protected function triggerPostApply(string $stage_id, string $start_version, string $target_version, bool $is_from_web): void {
+ $alias = Drush::aliasManager()->getSelf();
+
+ $output = Drush::processManager()
+ ->drush($alias, 'auto-update', [], [
+ 'post-apply' => TRUE,
+ 'stage-id' => $stage_id,
+ 'from-version' => $start_version,
+ 'to-version' => $target_version,
+ 'is-from-web' => $is_from_web,
+ ])
+ ->mustRun()
+ ->getOutput();
+ // Ensure the output of the sub-process is visible.
+ Drush::output()->write($output);
+ }
+
/**
* Runs post-apply tasks.
*
@@ -262,6 +270,7 @@ class ConsoleUpdateStage extends UpdateStage {
$this->tempStore = $this->tempStoreFactory->get('package_manager_stage', $owner);
$this->claim($stage_id);
+
$this->logger->info(
'Drupal core has been updated from %previous_version to %target_version',
[
diff --git a/tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php b/tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php
deleted file mode 100644
index 0a60e5d1f6..0000000000
--- a/tests/modules/automatic_updates_test/src/TestAutomaticUpdatesCommands.php
+++ /dev/null
@@ -1,12 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\automatic_updates_test;
-
-use Drupal\automatic_updates\Commands\AutomaticUpdatesCommands;
-
-class TestAutomaticUpdatesCommands extends AutomaticUpdatesCommands {
-
-
-}
--
GitLab
From 3828f892775bab8604863a1359843bf298ada070 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 18:07:19 -0400
Subject: [PATCH 073/142] Rename CronUpdateRunner back to CronUpdateStage to
minimize diff
---
automatic_updates.install | 4 +-
automatic_updates.module | 14 ++--
automatic_updates.services.yml | 4 +-
src/Commands/AutomaticUpdatesCommands.php | 10 +--
src/ConsoleUpdateStage.php | 6 +-
...onUpdateRunner.php => CronUpdateStage.php} | 6 +-
src/Validation/AdminStatusCheckMessages.php | 8 +--
src/Validation/StatusChecker.php | 8 +--
src/Validator/CronFrequencyValidator.php | 8 +--
src/Validator/VersionPolicyValidator.php | 10 +--
.../AutomaticUpdatesTestServiceProvider.php | 4 +-
...dateRunner.php => TestCronUpdateStage.php} | 4 +-
.../AutomaticUpdatesFunctionalTestBase.php | 4 +-
.../StatusCheckFailureEmailTest.php | 10 +--
tests/src/Functional/StatusCheckTest.php | 6 +-
.../UpdateSettingsFormTest.php | 10 +--
.../Kernel/AutomaticUpdatesKernelTestBase.php | 10 +--
tests/src/Kernel/ConsoleUpdateStageTest.php | 22 +++----
tests/src/Kernel/CronUpdateStageTest.php | 8 +--
tests/src/Kernel/HookCronTest.php | 8 +--
.../CronFrequencyValidatorTest.php | 6 +-
.../PhpExtensionsValidatorTest.php | 8 +--
.../Kernel/StatusCheck/StatusCheckerTest.php | 4 +-
.../VersionPolicyValidatorTest.php | 64 +++++++++----------
24 files changed, 124 insertions(+), 122 deletions(-)
rename src/{CronUpdateRunner.php => CronUpdateStage.php} (96%)
rename tests/modules/automatic_updates_test/src/{TestCronUpdateRunner.php => TestCronUpdateStage.php} (92%)
diff --git a/automatic_updates.install b/automatic_updates.install
index d27d01225b..16c8fb0033 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -8,7 +8,7 @@
declare(strict_types = 1);
use Drupal\automatic_updates\ConsoleUpdateStage;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\Validation\StatusCheckRequirements;
use Drupal\system\SystemManager;
@@ -31,7 +31,7 @@ function automatic_updates_requirements($phase) {
// Check that site has cron updates enabled or not.
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
- if (\Drupal::configFactory()->get('automatic_updates.settings')->get('unattended.level') !== CronUpdateRunner::DISABLED) {
+ if (\Drupal::configFactory()->get('automatic_updates.settings')->get('unattended.level') !== CronUpdateStage::DISABLED) {
$requirements['automatic_updates_cron'] = [
'title' => t('Cron installs updates automatically'),
'severity' => SystemManager::REQUIREMENT_WARNING,
diff --git a/automatic_updates.module b/automatic_updates.module
index 486b7b2826..a739e42e12 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -8,7 +8,7 @@
declare(strict_types = 1);
use Drupal\automatic_updates\BatchProcessor;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\automatic_updates\Validation\AdminStatusCheckMessages;
@@ -159,12 +159,12 @@ function automatic_updates_modules_installed($modules) {
/** @var \Drupal\automatic_updates\Validation\StatusChecker $status_checker */
$status_checker = \Drupal::service('automatic_updates.status_checker');
$status_checker->run();
- /** @var \Drupal\automatic_updates\CronUpdateRunner $stage */
+ /** @var \Drupal\automatic_updates\CronUpdateStage $stage */
$cron_update_runner = \Drupal::service('automatic_updates.cron_update_runner');
// If cron updates are disabled status check messages will not be displayed on
// admin pages. Therefore, after installing the module the user will not be
// alerted to any problems until they access the status report page.
- if ($cron_update_runner->getMode() === CronUpdateRunner::DISABLED) {
+ if ($cron_update_runner->getMode() === CronUpdateStage::DISABLED) {
/** @var \Drupal\automatic_updates\Validation\AdminStatusCheckMessages $status_check_messages */
$status_check_messages = \Drupal::classResolver(AdminStatusCheckMessages::class);
$status_check_messages->displayResultSummary();
@@ -205,9 +205,9 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
'#type' => 'radios',
'#title' => t('Unattended background updates'),
'#options' => [
- CronUpdateRunner::DISABLED => t('Disabled'),
- CronUpdateRunner::SECURITY => t('Security updates only'),
- CronUpdateRunner::ALL => t('All patch releases'),
+ CronUpdateStage::DISABLED => t('Disabled'),
+ CronUpdateStage::SECURITY => t('Security updates only'),
+ CronUpdateStage::ALL => t('All patch releases'),
],
'#default_value' => $config->get('unattended.level'),
'#description' => t('When background updates are applied, your site will be briefly put into maintenance mode.'),
@@ -223,7 +223,7 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
'#states' => [
'invisible' => [
'input[name="unattended_level"]' => [
- 'value' => CronUpdateRunner::DISABLED,
+ 'value' => CronUpdateStage::DISABLED,
],
],
],
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 28bffb11ad..7460d9cfdf 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -24,13 +24,13 @@ services:
- ['setLogger', ['@logger.channel.automatic_updates']]
Drupal\automatic_updates\UpdateStage: '@automatic_updates.update_stage'
automatic_updates.cron_update_runner:
- class: Drupal\automatic_updates\CronUpdateRunner
+ class: Drupal\automatic_updates\CronUpdateStage
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
arguments:
$inner: '@automatic_updates.cron_update_runner.inner'
decorates: 'cron'
- Drupal\automatic_updates\CronUpdateRunner: '@automatic_updates.cron_update_runner'
+ Drupal\automatic_updates\CronUpdateStage: '@automatic_updates.cron_update_runner'
automatic_updates.requested_update_validator:
class: Drupal\automatic_updates\Validator\RequestedUpdateValidator
tags:
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 4d9cfee82e..6257f41bb9 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Commands;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
@@ -27,7 +27,7 @@ class AutomaticUpdatesCommands extends DrushCommands {
/**
* Constructs a AutomaticUpdatesCommands object.
*
- * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\automatic_updates\ConsoleUpdateStage $stage
* The console cron updater service.
@@ -39,7 +39,7 @@ class AutomaticUpdatesCommands extends DrushCommands {
* The config factory service.
*/
public function __construct(
- private readonly CronUpdateRunner $cronUpdateRunner,
+ private readonly CronUpdateStage $cronUpdateRunner,
private readonly ConsoleUpdateStage $stage,
private readonly StatusChecker $statusChecker,
private readonly StatusCheckMailer $statusCheckMailer,
@@ -85,7 +85,7 @@ class AutomaticUpdatesCommands extends DrushCommands {
$this->runStatusChecks($options['is-from-web']);
}
else {
- if ($this->cronUpdateRunner->getMode() !== CronUpdateRunner::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() !== CronUpdateStage::DISABLED) {
$release = $this->stage->getTargetRelease();
if ($release) {
$message = sprintf('Updating Drupal core to %s. This may take a while.', $release->getVersion());
@@ -121,7 +121,7 @@ class AutomaticUpdatesCommands extends DrushCommands {
$this->statusChecker->run();
// Only try to send failure notifications if unattended updates are
// enabled.
- if ($this->cronUpdateRunner->getMode() !== CronUpdateRunner::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() !== CronUpdateStage::DISABLED) {
$this->statusCheckMailer->sendFailureNotifications($last_results, $this->statusChecker->getResults());
}
}
diff --git a/src/ConsoleUpdateStage.php b/src/ConsoleUpdateStage.php
index e8ee417b0c..26c0a22281 100644
--- a/src/ConsoleUpdateStage.php
+++ b/src/ConsoleUpdateStage.php
@@ -39,7 +39,7 @@ class ConsoleUpdateStage extends UpdateStage {
*
* @param \Drupal\Core\State\StateInterface $state
* The state service.
- * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\Core\Mail\MailManagerInterface $mailManager
* The mail manager service.
@@ -72,7 +72,7 @@ class ConsoleUpdateStage extends UpdateStage {
*/
public function __construct(
private readonly StateInterface $state,
- private readonly CronUpdateRunner $cronUpdateRunner,
+ private readonly CronUpdateStage $cronUpdateRunner,
private readonly MailManagerInterface $mailManager,
private readonly StatusCheckMailer $statusCheckMailer,
private readonly ReleaseChooser $releaseChooser,
@@ -123,7 +123,7 @@ class ConsoleUpdateStage extends UpdateStage {
* Returns TRUE if any update was attempted, otherwise FALSE.
*/
public function performUpdate(bool $is_from_web = FALSE): bool {
- if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateStage::DISABLED) {
return FALSE;
}
diff --git a/src/CronUpdateRunner.php b/src/CronUpdateStage.php
similarity index 96%
rename from src/CronUpdateRunner.php
rename to src/CronUpdateStage.php
index 807258b5ac..4d92fe8817 100644
--- a/src/CronUpdateRunner.php
+++ b/src/CronUpdateStage.php
@@ -14,13 +14,15 @@ use Symfony\Component\Process\Process;
/**
* Defines a service that updates via cron.
*
+ * @todo Rename this class to CronUpdateRunner because it is not longer a stage.
+ *
* @internal
* This class implements logic specific to Automatic Updates' cron hook
* implementation and may be changed or removed at any time without warning.
* It should not be called directly, and external code should not interact
* with it.
*/
-class CronUpdateRunner implements CronInterface {
+class CronUpdateStage implements CronInterface {
use LoggerAwareTrait;
@@ -53,7 +55,7 @@ class CronUpdateRunner implements CronInterface {
public const ALL = 'patch';
/**
- * Constructs a CronUpdateRunner object.
+ * Constructs a CronUpdateStage object.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
* The config factory service.
diff --git a/src/Validation/AdminStatusCheckMessages.php b/src/Validation/AdminStatusCheckMessages.php
index 97faa3f760..a1ce812342 100644
--- a/src/Validation/AdminStatusCheckMessages.php
+++ b/src/Validation/AdminStatusCheckMessages.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validation;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Messenger\MessengerInterface;
@@ -46,7 +46,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
* The current user.
* @param \Drupal\Core\Routing\CurrentRouteMatch $currentRouteMatch
* The current route match.
- * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer service.
@@ -58,7 +58,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
private readonly AdminContext $adminContext,
private readonly AccountProxyInterface $currentUser,
private readonly CurrentRouteMatch $currentRouteMatch,
- private readonly CronUpdateRunner $cronUpdateRunner,
+ private readonly CronUpdateStage $cronUpdateRunner,
private readonly RendererInterface $renderer,
private readonly ConfigFactoryInterface $configFactory
) {}
@@ -120,7 +120,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
protected function displayResultsOnCurrentPage(): bool {
// If updates will not run during cron then we don't need to show the
// status checks on admin pages.
- if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateStage::DISABLED) {
return FALSE;
}
diff --git a/src/Validation/StatusChecker.php b/src/Validation/StatusChecker.php
index f73e90e5cc..8b22ac5fb6 100644
--- a/src/Validation/StatusChecker.php
+++ b/src/Validation/StatusChecker.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validation;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\Core\Config\ConfigCrudEvent;
@@ -44,7 +44,7 @@ final class StatusChecker implements EventSubscriberInterface {
* The update stage service.
* @param \Drupal\automatic_updates\ConsoleUpdateStage $consoleUpdateStage
* The console update stage service.
- * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update stage service.
* @param int $resultsTimeToLive
* The number of hours to store results.
@@ -55,7 +55,7 @@ final class StatusChecker implements EventSubscriberInterface {
private readonly EventDispatcherInterface $eventDispatcher,
private readonly UpdateStage $updateStage,
private readonly ConsoleUpdateStage $consoleUpdateStage,
- private readonly CronUpdateRunner $cronUpdateRunner,
+ private readonly CronUpdateStage $cronUpdateRunner,
private readonly int $resultsTimeToLive,
) {
$this->keyValueExpirable = $key_value_expirable_factory->get('automatic_updates');
@@ -70,7 +70,7 @@ final class StatusChecker implements EventSubscriberInterface {
// If updates will run during cron, use the unattended update stage service
// provided by this module. This will allow validators to run specific
// validation for conditions that only affect cron updates.
- if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateStage::DISABLED) {
$stage = $this->updateStage;
}
else {
diff --git a/src/Validator/CronFrequencyValidator.php b/src/Validator/CronFrequencyValidator.php
index 169aabedad..cdbb35873b 100644
--- a/src/Validator/CronFrequencyValidator.php
+++ b/src/Validator/CronFrequencyValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
@@ -56,7 +56,7 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
/**
* CronFrequencyValidator constructor.
*
- * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
* The config factory service.
@@ -68,7 +68,7 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
* The lock service.
*/
public function __construct(
- private readonly CronUpdateRunner $cronUpdateRunner,
+ private readonly CronUpdateStage $cronUpdateRunner,
private readonly ConfigFactoryInterface $configFactory,
private readonly StateInterface $state,
private readonly TimeInterface $time,
@@ -88,7 +88,7 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
}
// If automatic updates are disabled during cron, there's nothing we need
// to validate.
- if ($this->cronUpdateRunner->getMode() === CronUpdateRunner::DISABLED) {
+ if ($this->cronUpdateRunner->getMode() === CronUpdateStage::DISABLED) {
return;
}
// If cron is running right now, cron is clearly being run recently enough!
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index c3f8082659..a6f26501bc 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Component\Utility\NestedArray;
use Drupal\package_manager\ComposerInspector;
@@ -42,7 +42,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
/**
* Constructs a VersionPolicyValidator object.
*
- * @param \Drupal\automatic_updates\CronUpdateRunner $cronUpdateRunner
+ * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $classResolver
* The class resolver service.
@@ -52,7 +52,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
* The Composer inspector service.
*/
public function __construct(
- private readonly CronUpdateRunner $cronUpdateRunner,
+ private readonly CronUpdateStage $cronUpdateRunner,
private readonly ClassResolverInterface $classResolver,
private readonly PathLocator $pathLocator,
private readonly ComposerInspector $composerInspector,
@@ -92,7 +92,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
if ($stage instanceof ConsoleUpdateStage) {
$mode = $this->cronUpdateRunner->getMode();
- if ($mode !== CronUpdateRunner::DISABLED) {
+ if ($mode !== CronUpdateStage::DISABLED) {
// If cron updates are enabled, the installed version must be stable;
// no alphas, betas, or RCs.
$rules[] = StableReleaseInstalled::class;
@@ -108,7 +108,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
// If only security updates are allowed during cron, the target
// version must be a security release.
- if ($mode === CronUpdateRunner::SECURITY) {
+ if ($mode === CronUpdateStage::SECURITY) {
$rules[] = TargetSecurityRelease::class;
}
}
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
index 74ddf305ad..6f9bb82a15 100644
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -15,11 +15,11 @@ class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
public function alter(ContainerBuilder $container) {
parent::alter($container);
if (\Drupal::hasContainer() && \Drupal::state()->get(self::class . '-runner') && $container->hasDefinition('automatic_updates.cron_update_runner')) {
- $container->getDefinition('automatic_updates.cron_update_runner')->setClass(TestCronUpdateRunner::class);
+ $container->getDefinition('automatic_updates.cron_update_runner')->setClass(TestCronUpdateStage::class);
}
}
- public static function useTestCronUpdateRunner(bool $use = TRUE) {
+ public static function useTestCronUpdateStage(bool $use = TRUE) {
\Drupal::state()->set(self::class . '-runner', $use);
}
diff --git a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php b/tests/modules/automatic_updates_test/src/TestCronUpdateStage.php
similarity index 92%
rename from tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
rename to tests/modules/automatic_updates_test/src/TestCronUpdateStage.php
index d589c3e999..81f073a16d 100644
--- a/tests/modules/automatic_updates_test/src/TestCronUpdateRunner.php
+++ b/tests/modules/automatic_updates_test/src/TestCronUpdateStage.php
@@ -5,9 +5,9 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates_test;
use Composer\Autoload\ClassLoader;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
-class TestCronUpdateRunner extends CronUpdateRunner {
+class TestCronUpdateStage extends CronUpdateStage {
/**
* {@inheritdoc}
diff --git a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
index a0e18faa70..f518f16a8d 100644
--- a/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
+++ b/tests/src/Functional/AutomaticUpdatesFunctionalTestBase.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\fixture_manipulator\StageFixtureManipulator;
use Drupal\package_manager\PathLocator;
use Drupal\Tests\BrowserTestBase;
@@ -40,7 +40,7 @@ abstract class AutomaticUpdatesFunctionalTestBase extends BrowserTestBase {
$this->useFixtureDirectoryAsActive(__DIR__ . '/../../../package_manager/tests/fixtures/fake_site');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::SECURITY)
+ ->set('unattended.level', CronUpdateStage::SECURITY)
->save();
}
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 62e0ef1e46..5147a3cb2b 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates_test\AutomaticUpdatesTestServiceProvider;
use Drupal\automatic_updates_test\Datetime\TestTime;
@@ -63,7 +63,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
$this->mockActiveCoreVersion('9.8.1');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::SECURITY)
+ ->set('unattended.level', CronUpdateStage::SECURITY)
->save();
$this->setUpEmailRecipients();
@@ -235,7 +235,7 @@ END;
// If we disable unattended updates entirely and flag a new error, they
// should not be e-mailed.
- $config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
+ $config->set('unattended.level', CronUpdateStage::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
$this->performConsoleUpdate();
@@ -243,7 +243,7 @@ END;
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
- $config->set('unattended.level', CronUpdateRunner::SECURITY)->save();
+ $config->set('unattended.level', CronUpdateStage::SECURITY)->save();
$this->performConsoleUpdate();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -264,7 +264,7 @@ END;
$container->get('module_installer')->install([
'system',
]);
- AutomaticUpdatesTestServiceProvider::useTestCronUpdateRunner();
+ AutomaticUpdatesTestServiceProvider::useTestCronUpdateStage();
parent::installModulesFromClassProperty($container);
}
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index b2ee3f22f5..e939148890 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Functional;
use Behat\Mink\Element\NodeElement;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\automatic_updates_test_status_checker\EventSubscriber\TestSubscriber2;
@@ -362,7 +362,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// Confirm status check messages are not displayed when cron updates are
// disabled.
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::DISABLED)
+ ->set('unattended.level', CronUpdateStage::DISABLED)
->save();
$this->drupalGet('admin/structure');
$this->checkForMetaRefresh();
@@ -386,7 +386,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->container->get('module_installer')->install(['automatic_updates', 'automatic_updates_test']);
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::SECURITY)
+ ->set('unattended.level', CronUpdateStage::SECURITY)
->save();
$this->drupalGet('admin/reports/status');
$this->assertNoErrors(TRUE);
diff --git a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
index 32aef05524..a6b45191d9 100644
--- a/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
+++ b/tests/src/FunctionalJavascript/UpdateSettingsFormTest.php
@@ -2,7 +2,7 @@
namespace Drupal\Tests\automatic_updates\FunctionalJavascript;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
/**
@@ -31,14 +31,14 @@ class UpdateSettingsFormTest extends WebDriverTestBase {
// The default values should be reflected.
$assert_session = $this->assertSession();
$assert_session->fieldValueEquals('unattended_method', 'web');
- $assert_session->fieldValueEquals('unattended_level', CronUpdateRunner::DISABLED);
+ $assert_session->fieldValueEquals('unattended_level', CronUpdateStage::DISABLED);
// Since unattended updates are disabled, the method radio buttons should be
// hidden.
$this->assertFalse($assert_session->fieldExists('unattended_method')->isVisible());
// Enabling unattended updates should reveal the method radio buttons.
$page = $this->getSession()->getPage();
- $page->selectFieldOption('unattended_level', CronUpdateRunner::SECURITY);
+ $page->selectFieldOption('unattended_level', CronUpdateStage::SECURITY);
$this->assertNotEmpty($assert_session->waitForElementVisible('named', ['field', 'unattended_method']));
$assert_session->elementAttributeContains('named', ['link', 'ensure cron is set up correctly'], 'href', 'http://drupal.org/docs/user_guide/en/security-cron.html');
// Change the method, to ensure it is properly saved in config.
@@ -47,10 +47,10 @@ class UpdateSettingsFormTest extends WebDriverTestBase {
// Ensure the changes are reflected in config.
$page->pressButton('Save configuration');
$config = $this->config('automatic_updates.settings');
- $this->assertSame(CronUpdateRunner::SECURITY, $config->get('unattended.level'));
+ $this->assertSame(CronUpdateStage::SECURITY, $config->get('unattended.level'));
$this->assertSame('console', $config->get('unattended.method'));
// Our saved changes should be reflected in the form too.
- $assert_session->fieldValueEquals('unattended_level', CronUpdateRunner::SECURITY);
+ $assert_session->fieldValueEquals('unattended_level', CronUpdateStage::SECURITY);
$assert_session->fieldValueEquals('unattended_method', 'console');
}
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 3a81562a77..4db4feb3db 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
@@ -54,7 +54,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
$this->config('automatic_updates.settings')
->set('unattended', [
'method' => 'web',
- 'level' => CronUpdateRunner::SECURITY,
+ 'level' => CronUpdateStage::SECURITY,
])
->save();
@@ -72,7 +72,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
// our cron handler's PHP_SAPI constant to a valid value that isn't `cli`.
// The choice of `cgi-fcgi` is arbitrary; see
// https://www.php.net/php_sapi_name for some valid values of PHP_SAPI.
- $property = new \ReflectionProperty(CronUpdateRunner::class, 'serverApi');
+ $property = new \ReflectionProperty(CronUpdateStage::class, 'serverApi');
$property->setValue(NULL, 'cgi-fcgi');
}
@@ -84,7 +84,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
- 'automatic_updates.cron_update_runner' => TestCronUpdateRunner::class,
+ 'automatic_updates.cron_update_runner' => TestCronUpdateStage::class,
ConsoleUpdateStage::class => TestConsoleUpdateStage::class,
];
foreach ($overrides as $service_id => $class) {
@@ -106,7 +106,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
/**
* A test-only version of the cron update stage to override and expose internals.
*/
-class TestCronUpdateRunner extends CronUpdateRunner {
+class TestCronUpdateStage extends CronUpdateStage {
/**
* Determines whether an exception should be thrown.
diff --git a/tests/src/Kernel/ConsoleUpdateStageTest.php b/tests/src/Kernel/ConsoleUpdateStageTest.php
index e5055e6808..a9c3a4722c 100644
--- a/tests/src/Kernel/ConsoleUpdateStageTest.php
+++ b/tests/src/Kernel/ConsoleUpdateStageTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
@@ -129,32 +129,32 @@ END;
$fixture_dir = __DIR__ . '/../../../package_manager/tests/fixtures/release-history';
return [
'disabled, normal release' => [
- CronUpdateRunner::DISABLED,
+ CronUpdateStage::DISABLED,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
FALSE,
],
'disabled, security release' => [
- CronUpdateRunner::DISABLED,
+ CronUpdateStage::DISABLED,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
FALSE,
],
'security only, security release' => [
- CronUpdateRunner::SECURITY,
+ CronUpdateStage::SECURITY,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
TRUE,
],
'security only, normal release' => [
- CronUpdateRunner::SECURITY,
+ CronUpdateStage::SECURITY,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
FALSE,
],
'enabled, normal release' => [
- CronUpdateRunner::ALL,
+ CronUpdateStage::ALL,
['drupal' => "$fixture_dir/drupal.9.8.2.xml"],
TRUE,
],
'enabled, security release' => [
- CronUpdateRunner::ALL,
+ CronUpdateStage::ALL,
['drupal' => "$fixture_dir/drupal.9.8.1-security.xml"],
TRUE,
],
@@ -294,7 +294,7 @@ END;
$this->installConfig('automatic_updates');
// @todo Remove in https://www.drupal.org/project/automatic_updates/issues/3284443
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::SECURITY)
+ ->set('unattended.level', CronUpdateStage::SECURITY)
->save();
// Ensure that there is a security release to which we should update.
$this->setReleaseMetadata([
@@ -408,7 +408,7 @@ END;
*/
public function testStageNotDestroyedIfApplying(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::ALL)
+ ->set('unattended.level', CronUpdateStage::ALL)
->save();
$this->setReleaseMetadata([
'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml",
@@ -448,7 +448,7 @@ END;
*/
public function testStageNotDestroyedIfSecure(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::ALL)
+ ->set('unattended.level', CronUpdateStage::ALL)
->save();
$this->setReleaseMetadata([
'drupal' => __DIR__ . "/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml",
@@ -534,7 +534,7 @@ END;
'drupal' => __DIR__ . '/../../../package_manager/tests/fixtures/release-history/drupal.9.8.2.xml',
]);
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::ALL)
+ ->set('unattended.level', CronUpdateStage::ALL)
->save();
$error = ValidationResult::createError([
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index e34959bbe7..6c890b0827 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -4,13 +4,13 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
/**
- * @covers \Drupal\automatic_updates\CronUpdateRunner
+ * @covers \Drupal\automatic_updates\CronUpdateStage
* @group automatic_updates
* @internal
*/
@@ -34,8 +34,8 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
* Tests that regular cron always runs.
*/
public function testRegularCronRuns(): void {
- /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateRunner $cron_stage */
- $cron_stage = $this->container->get(CronUpdateRunner::class);
+ /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
+ $cron_stage = $this->container->get(CronUpdateStage::class);
$cron_stage->throwExceptionOnTerminalCommand = TRUE;
$this->assertRegularCronRun(FALSE);
diff --git a/tests/src/Kernel/HookCronTest.php b/tests/src/Kernel/HookCronTest.php
index 38d1a855ff..a81fda6a72 100644
--- a/tests/src/Kernel/HookCronTest.php
+++ b/tests/src/Kernel/HookCronTest.php
@@ -2,7 +2,7 @@
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\package_manager\Event\StatusCheckEvent;
@@ -27,9 +27,9 @@ class HookCronTest extends AutomaticUpdatesKernelTestBase {
$this->setCoreVersion('9.8.1');
// Undo override of the 'serverApi' property from the parent test class.
// @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::setUp
- $property = new \ReflectionProperty(CronUpdateRunner::class, 'serverApi');
+ $property = new \ReflectionProperty(CronUpdateStage::class, 'serverApi');
$property->setValue(NULL, 'cli');
- $this->assertTrue(CronUpdateRunner::isCommandLine());
+ $this->assertTrue(CronUpdateStage::isCommandLine());
$status_check_count = 0;
$this->addEventTestListener(function () use (&$status_check_count) {
$status_check_count++;
@@ -42,7 +42,7 @@ class HookCronTest extends AutomaticUpdatesKernelTestBase {
// If we are on the web the status checks should run.
$property->setValue(NULL, 'cgi-fcgi');
- $this->assertFalse(CronUpdateRunner::isCommandLine());
+ $this->assertFalse(CronUpdateStage::isCommandLine());
$this->container->get('cron')->run();
$this->assertSame(1, $status_check_count);
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 600f9713c4..4d9a8337df 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
@@ -39,14 +39,14 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
*/
public function testNoValidationIfCronDisabled(): void {
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::DISABLED)
+ ->set('unattended.level', CronUpdateStage::DISABLED)
->save();
$state = $this->container->get('state');
$state->delete('system.cron_last');
$state->delete('install_time');
$this->assertCheckerResultsFromManager([], TRUE);
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::ALL)
+ ->set('unattended.level', CronUpdateStage::ALL)
->save();
$error = ValidationResult::createError([
t('Cron has not run recently. For more information, see the online handbook entry for <a href="https://www.drupal.org/cron">configuring cron jobs</a> to run at least every 3 hours.'),
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index e4fb08f948..cdf37224e4 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\package_manager\ValidationResult;
@@ -45,12 +45,12 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
// If unattended updates are disabled, we should only see a warning from
// Package Manager.
- $config->set('unattended.level', CronUpdateRunner::DISABLED)->save();
+ $config->set('unattended.level', CronUpdateStage::DISABLED)->save();
$this->assertCheckerResultsFromManager([$warning_result], TRUE);
// The parent class' setUp() method simulates an available security update,
// so ensure that the cron update stage will try to update to it.
- $config->set('unattended.level', CronUpdateRunner::SECURITY)->save();
+ $config->set('unattended.level', CronUpdateStage::SECURITY)->save();
// If unattended updates are enabled, we should see an error from Automatic
// Updates.
@@ -78,7 +78,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
// The parent class' setUp() method simulates an available security
// update, so ensure that the cron update stage will try to update to it.
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::SECURITY)
+ ->set('unattended.level', CronUpdateStage::SECURITY)
->save();
$logger = new TestLogger();
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
index 0f24bc7a9a..9acec34a97 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\automatic_updates\Validation\StatusChecker;
@@ -212,7 +212,7 @@ class StatusCheckerTest extends AutomaticUpdatesKernelTestBase {
// By default, updates will be enabled on cron.
$this->assertInstanceOf(ConsoleUpdateStage::class, $stage);
$this->config('automatic_updates.settings')
- ->set('unattended.level', CronUpdateRunner::DISABLED)
+ ->set('unattended.level', CronUpdateStage::DISABLED)
->save();
$this->container->get(StatusChecker::class)->run();
$this->assertInstanceOf(UpdateStage::class, $stage);
diff --git a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
index c19a7fc380..d11bb0a3f4 100644
--- a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
-use Drupal\automatic_updates\CronUpdateRunner;
+use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\ConsoleUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\fixture_manipulator\ActiveFixtureManipulator;
@@ -46,7 +46,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.1',
NULL,
"$metadata_dir/drupal.9.8.2.xml",
- [CronUpdateRunner::DISABLED, CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::DISABLED, CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[],
],
// These three cases prove that updating from an unsupported minor version
@@ -59,14 +59,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[],
],
'update from unsupported minor, cron enabled, minor updates forbidden' => [
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('See the <a href="/admin/reports/updates">available updates page</a> for available updates.'),
@@ -76,7 +76,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
NULL,
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('Use the <a href="/admin/modules/update">update form</a> to update to a supported version.'),
@@ -103,7 +103,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::DISABLED, CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::DISABLED, CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[],
],
// This case proves that updating from a dev snapshot is never allowed,
@@ -112,7 +112,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-dev',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::DISABLED, CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::DISABLED, CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('Drupal cannot be automatically updated from the installed version, 9.8.0-dev, because automatic updates from a dev version to any other version are not supported.'),
],
@@ -123,14 +123,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-alpha1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[],
],
'alpha installed, cron enabled' => [
'9.8.0-alpha1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-alpha1, because it is not a stable version.'),
],
@@ -139,14 +139,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-beta2',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[],
],
'beta installed, cron enabled' => [
'9.8.0-beta2',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-beta2, because it is not a stable version.'),
],
@@ -155,14 +155,14 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0-rc3',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[],
],
'rc installed, cron enabled' => [
'9.8.0-rc3',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('Drupal cannot be automatically updated during cron from its current version, 9.8.0-rc3, because it is not a stable version.'),
],
@@ -181,9 +181,9 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
* The path of the core release metadata to serve to the update system.
* @param string[] $cron_modes
* The modes for unattended updates. Can contain any of
- * \Drupal\automatic_updates\CronUpdateRunner::DISABLED,
- * \Drupal\automatic_updates\CronUpdateRunner::SECURITY, and
- * \Drupal\automatic_updates\CronUpdateRunner::ALL.
+ * \Drupal\automatic_updates\CronUpdateStage::DISABLED,
+ * \Drupal\automatic_updates\CronUpdateStage::SECURITY, and
+ * \Drupal\automatic_updates\CronUpdateStage::ALL.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $expected_validation_messages
* The expected validation messages.
* @param bool $allow_minor_updates
@@ -230,21 +230,21 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[],
],
'update to beta, cron disabled' => [
'9.8.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[],
],
'update to rc, cron disabled' => [
'9.8.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[],
],
// This case proves that, if a stable release is installed, there is an
@@ -255,7 +255,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.1',
'9.8.2',
"$metadata_dir/drupal.9.8.2.xml",
- [CronUpdateRunner::SECURITY],
+ [CronUpdateStage::SECURITY],
[
t('Drupal cannot be automatically updated during cron from 9.8.1 to 9.8.2 because 9.8.2 is not a security release.'),
],
@@ -267,7 +267,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::SECURITY],
+ [CronUpdateStage::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-alpha1, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-alpha1 because 9.8.1-alpha1 is not a security release.'),
@@ -277,7 +277,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::SECURITY],
+ [CronUpdateStage::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-beta2, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-beta2 because 9.8.1-beta2 is not a security release.'),
@@ -287,7 +287,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.8.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::SECURITY],
+ [CronUpdateStage::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-rc3, because it is not a stable version.'),
t('Drupal cannot be automatically updated during cron from 9.8.0 to 9.8.1-rc3 because 9.8.1-rc3 is not a security release.'),
@@ -300,7 +300,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-alpha1',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::SECURITY],
+ [CronUpdateStage::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-alpha1, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-alpha1 because automatic updates from one minor version to another are not supported during cron.'),
@@ -311,7 +311,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-beta2',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::SECURITY],
+ [CronUpdateStage::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-beta2, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-beta2 because automatic updates from one minor version to another are not supported during cron.'),
@@ -322,7 +322,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.0',
'9.8.1-rc3',
"$metadata_dir/drupal.9.8.1-extra.xml",
- [CronUpdateRunner::SECURITY],
+ [CronUpdateStage::SECURITY],
[
t('Drupal cannot be automatically updated during cron to the recommended version, 9.8.1-rc3, because it is not a stable version.'),
t('Drupal cannot be automatically updated from 9.7.0 to 9.8.1-rc3 because automatic updates from one minor version to another are not supported during cron.'),
@@ -340,7 +340,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::DISABLED],
+ [CronUpdateStage::DISABLED],
[
t('Drupal cannot be automatically updated from 9.7.1 to 9.8.1 because automatic updates from one minor version to another are not supported.'),
],
@@ -349,7 +349,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('See the <a href="/admin/reports/updates">available updates page</a> for available updates.'),
@@ -360,7 +360,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
'9.7.1',
'9.8.1',
"$metadata_dir/drupal.9.8.1-security.xml",
- [CronUpdateRunner::SECURITY, CronUpdateRunner::ALL],
+ [CronUpdateStage::SECURITY, CronUpdateStage::ALL],
[
t('The currently installed version of Drupal core, 9.7.1, is not in a supported minor version. Your site will not be automatically updated during cron until it is updated to a supported minor version.'),
t('Use the <a href="/admin/modules/update">update form</a> to update to a supported version.'),
@@ -382,9 +382,9 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
* The path of the core release metadata to serve to the update system.
* @param string[] $cron_modes
* The modes for unattended updates. Can contain any of
- * \Drupal\automatic_updates\CronUpdateRunner::DISABLED,
- * \Drupal\automatic_updates\CronUpdateRunner::SECURITY, and
- * \Drupal\automatic_updates\CronUpdateRunner::ALL.
+ * \Drupal\automatic_updates\CronUpdateStage::DISABLED,
+ * \Drupal\automatic_updates\CronUpdateStage::SECURITY, and
+ * \Drupal\automatic_updates\CronUpdateStage::ALL.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $expected_validation_messages
* The expected validation messages.
* @param bool $allow_minor_updates
--
GitLab
From aee7068649f50880401f7b1ddde4879dab7db7f7 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 18:15:50 -0400
Subject: [PATCH 074/142] revert service name to
automatic_updates.cron_update_stage
---
automatic_updates.module | 4 ++--
automatic_updates.services.yml | 6 +++---
src/Validation/AdminStatusCheckMessages.php | 2 +-
.../src/AutomaticUpdatesTestServiceProvider.php | 4 ++--
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 2 +-
tests/src/Kernel/ConsoleUpdateStageTest.php | 2 +-
6 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/automatic_updates.module b/automatic_updates.module
index a739e42e12..a48f003889 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -160,11 +160,11 @@ function automatic_updates_modules_installed($modules) {
$status_checker = \Drupal::service('automatic_updates.status_checker');
$status_checker->run();
/** @var \Drupal\automatic_updates\CronUpdateStage $stage */
- $cron_update_runner = \Drupal::service('automatic_updates.cron_update_runner');
+ $stage = \Drupal::service('automatic_updates.cron_update_stage');
// If cron updates are disabled status check messages will not be displayed on
// admin pages. Therefore, after installing the module the user will not be
// alerted to any problems until they access the status report page.
- if ($cron_update_runner->getMode() === CronUpdateStage::DISABLED) {
+ if ($stage->getMode() === CronUpdateStage::DISABLED) {
/** @var \Drupal\automatic_updates\Validation\AdminStatusCheckMessages $status_check_messages */
$status_check_messages = \Drupal::classResolver(AdminStatusCheckMessages::class);
$status_check_messages->displayResultSummary();
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 7460d9cfdf..cea271edea 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -23,14 +23,14 @@ services:
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
Drupal\automatic_updates\UpdateStage: '@automatic_updates.update_stage'
- automatic_updates.cron_update_runner:
+ automatic_updates.cron_update_stage:
class: Drupal\automatic_updates\CronUpdateStage
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
arguments:
- $inner: '@automatic_updates.cron_update_runner.inner'
+ $inner: '@automatic_updates.cron_update_stage.inner'
decorates: 'cron'
- Drupal\automatic_updates\CronUpdateStage: '@automatic_updates.cron_update_runner'
+ Drupal\automatic_updates\CronUpdateStage: '@automatic_updates.cron_update_stage'
automatic_updates.requested_update_validator:
class: Drupal\automatic_updates\Validator\RequestedUpdateValidator
tags:
diff --git a/src/Validation/AdminStatusCheckMessages.php b/src/Validation/AdminStatusCheckMessages.php
index a1ce812342..5e25d9e34e 100644
--- a/src/Validation/AdminStatusCheckMessages.php
+++ b/src/Validation/AdminStatusCheckMessages.php
@@ -72,7 +72,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
$container->get('router.admin_context'),
$container->get('current_user'),
$container->get('current_route_match'),
- $container->get('automatic_updates.cron_update_runner'),
+ $container->get('automatic_updates.cron_update_stage'),
$container->get('renderer'),
$container->get('config.factory')
);
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
index 6f9bb82a15..7073f8d6c6 100644
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
@@ -14,8 +14,8 @@ class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
*/
public function alter(ContainerBuilder $container) {
parent::alter($container);
- if (\Drupal::hasContainer() && \Drupal::state()->get(self::class . '-runner') && $container->hasDefinition('automatic_updates.cron_update_runner')) {
- $container->getDefinition('automatic_updates.cron_update_runner')->setClass(TestCronUpdateStage::class);
+ if (\Drupal::hasContainer() && \Drupal::state()->get(self::class . '-runner') && $container->hasDefinition('automatic_updates.cron_update_stage')) {
+ $container->getDefinition('automatic_updates.cron_update_stage')->setClass(TestCronUpdateStage::class);
}
}
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 4db4feb3db..4bcae3d78a 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -84,7 +84,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
- 'automatic_updates.cron_update_runner' => TestCronUpdateStage::class,
+ 'automatic_updates.cron_update_stage' => TestCronUpdateStage::class,
ConsoleUpdateStage::class => TestConsoleUpdateStage::class,
];
foreach ($overrides as $service_id => $class) {
diff --git a/tests/src/Kernel/ConsoleUpdateStageTest.php b/tests/src/Kernel/ConsoleUpdateStageTest.php
index a9c3a4722c..320a4f6055 100644
--- a/tests/src/Kernel/ConsoleUpdateStageTest.php
+++ b/tests/src/Kernel/ConsoleUpdateStageTest.php
@@ -629,7 +629,7 @@ END;
* Tests that setLogger is called on the cron update stage service.
*/
public function testLoggerIsSetByContainer(): void {
- $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_runner')->getMethodCalls();
+ $stage_method_calls = $this->container->getDefinition('automatic_updates.cron_update_stage')->getMethodCalls();
$this->assertSame('setLogger', $stage_method_calls[0][0]);
}
--
GitLab
From 7d92d5f65836fa06afc8eef2e6c731b657c65d63 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 18:20:44 -0400
Subject: [PATCH 075/142] AutomaticUpdatesCommands is not extended
---
src/Commands/AutomaticUpdatesCommands.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 6257f41bb9..77928827ad 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -22,7 +22,7 @@ use Drush\Commands\DrushCommands;
* @todo Either remove this command completely or make it just call the new
* Symfony Console command that will be added in https://drupal.org/i/3360485.
*/
-class AutomaticUpdatesCommands extends DrushCommands {
+final class AutomaticUpdatesCommands extends DrushCommands {
/**
* Constructs a AutomaticUpdatesCommands object.
--
GitLab
From 6e4dc2d4031dbe096a8e9d98a32f7431d971e3d1 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 18:25:03 -0400
Subject: [PATCH 076/142] unneeded changes to AdminStatusCheckMessages.php
---
src/Validation/AdminStatusCheckMessages.php | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/Validation/AdminStatusCheckMessages.php b/src/Validation/AdminStatusCheckMessages.php
index 5e25d9e34e..47afe48ccb 100644
--- a/src/Validation/AdminStatusCheckMessages.php
+++ b/src/Validation/AdminStatusCheckMessages.php
@@ -46,8 +46,8 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
* The current user.
* @param \Drupal\Core\Routing\CurrentRouteMatch $currentRouteMatch
* The current route match.
- * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
- * The cron update runner service.
+ * @param \Drupal\automatic_updates\CronUpdateStage $stage
+ * The cron update stage service.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
@@ -58,7 +58,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
private readonly AdminContext $adminContext,
private readonly AccountProxyInterface $currentUser,
private readonly CurrentRouteMatch $currentRouteMatch,
- private readonly CronUpdateStage $cronUpdateRunner,
+ private readonly CronUpdateStage $stage,
private readonly RendererInterface $renderer,
private readonly ConfigFactoryInterface $configFactory
) {}
@@ -120,7 +120,7 @@ final class AdminStatusCheckMessages implements ContainerInjectionInterface {
protected function displayResultsOnCurrentPage(): bool {
// If updates will not run during cron then we don't need to show the
// status checks on admin pages.
- if ($this->cronUpdateRunner->getMode() === CronUpdateStage::DISABLED) {
+ if ($this->stage->getMode() === CronUpdateStage::DISABLED) {
return FALSE;
}
--
GitLab
From 1990a402f6930062af934e2e78f69c52738c1ab6 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 18:28:20 -0400
Subject: [PATCH 077/142] =?UTF-8?q?revert=20drupalci=20changes=20?=
=?UTF-8?q?=F0=9F=A4=A6=F0=9F=8F=BC?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
drupalci.yml | 27 ++++++++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
diff --git a/drupalci.yml b/drupalci.yml
index 91eebdc6c2..3cd1b3cc07 100644
--- a/drupalci.yml
+++ b/drupalci.yml
@@ -20,8 +20,33 @@ build:
# halt-on-fail can be set on the run_tests tasks in order to fail fast.
# suppress-deprecations is false in order to be alerted to usages of
# deprecated code.
+ run_tests.phpunit:
+ types: 'PHPUnit-Unit'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
+ run_tests.kernel:
+ types: 'PHPUnit-Kernel'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
+ run_tests.build:
+ # Limit concurrency due to disk space concerns.
+ concurrency: 15
+ types: 'PHPUnit-Build'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
run_tests.functional:
types: 'PHPUnit-Functional'
- testgroups: '--class "Drupal\Tests\automatic_updates\Functional\StatusCheckTest"'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
+ # Functional JavaScript tests require a concurrency of 1 because there is
+ # only one instance of PhantomJS on the testbot machine.
+ run_tests.javascript:
+ concurrency: 1
+ types: 'PHPUnit-FunctionalJavascript'
+ testgroups: '--all'
suppress-deprecations: false
halt-on-fail: false
--
GitLab
From e8c60c05ec7e4868356e8e92320c24ae58593917 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 22:47:51 -0400
Subject: [PATCH 078/142] simplify StatusCheckFailureEmailTest
---
src/CronUpdateStage.php | 23 ++-----
.../AutomaticUpdatesTestServiceProvider.php | 27 --------
.../src/TestCronUpdateStage.php | 45 -------------
.../StatusCheckFailureEmailTest.php | 64 ++++++-------------
4 files changed, 26 insertions(+), 133 deletions(-)
delete mode 100644 tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
delete mode 100644 tests/modules/automatic_updates_test/src/TestCronUpdateStage.php
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 4d92fe8817..e189f3dfd9 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -74,7 +74,13 @@ class CronUpdateStage implements CronInterface {
* Runs the terminal update command.
*/
public function runTerminalUpdateCommand(): void {
- $drush_path = $this->getCommandPath();
+ // @todo Make a validator to ensure this path exists if settings select
+ // background updates.
+ // @todo Replace drush call with Symfony console command in
+ // https://www.drupal.org/i/3360485
+ // @todo Why isn't it in vendor bin in build tests?
+ $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
+
$phpBinaryFinder = new PhpExecutableFinder();
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
@@ -147,19 +153,4 @@ class CronUpdateStage implements CronInterface {
return $mode ?: static::SECURITY;
}
- /**
- * Gets the update command path.
- *
- * @return string
- * The absolute path of the update command.
- */
- protected function getCommandPath(): string {
- // @todo Make a validator to ensure this path exists if settings select
- // background updates.
- // @todo Replace drush call with Symfony console command in
- // https://www.drupal.org/i/3360485
- // @todo Why isn't it in vendor bin in build tests?
- return $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
- }
-
}
diff --git a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php b/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
deleted file mode 100644
index 7073f8d6c6..0000000000
--- a/tests/modules/automatic_updates_test/src/AutomaticUpdatesTestServiceProvider.php
+++ /dev/null
@@ -1,27 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\automatic_updates_test;
-
-use Drupal\Core\DependencyInjection\ContainerBuilder;
-use Drupal\Core\DependencyInjection\ServiceProviderBase;
-
-class AutomaticUpdatesTestServiceProvider extends ServiceProviderBase {
-
- /**
- * {@inheritdoc}
- */
- public function alter(ContainerBuilder $container) {
- parent::alter($container);
- if (\Drupal::hasContainer() && \Drupal::state()->get(self::class . '-runner') && $container->hasDefinition('automatic_updates.cron_update_stage')) {
- $container->getDefinition('automatic_updates.cron_update_stage')->setClass(TestCronUpdateStage::class);
- }
- }
-
- public static function useTestCronUpdateStage(bool $use = TRUE) {
- \Drupal::state()->set(self::class . '-runner', $use);
-
- }
-
-}
diff --git a/tests/modules/automatic_updates_test/src/TestCronUpdateStage.php b/tests/modules/automatic_updates_test/src/TestCronUpdateStage.php
deleted file mode 100644
index 81f073a16d..0000000000
--- a/tests/modules/automatic_updates_test/src/TestCronUpdateStage.php
+++ /dev/null
@@ -1,45 +0,0 @@
-<?php
-
-declare(strict_types = 1);
-
-namespace Drupal\automatic_updates_test;
-
-use Composer\Autoload\ClassLoader;
-use Drupal\automatic_updates\CronUpdateStage;
-
-class TestCronUpdateStage extends CronUpdateStage {
-
- /**
- * {@inheritdoc}
- */
- protected function getCommandPath(): string {
- // There may be multiple class loaders at work.
- // ClassLoader::getRegisteredLoaders() keeps track of them all, indexed by
- // the path of the vendor directory they load classes from.
- $loaders = ClassLoader::getRegisteredLoaders();
-
- // If there's only one class loader, we don't need to search for the right
- // one.
- if (count($loaders) === 1) {
- $vendor_path = key($loaders);
- }
- else {
- // To determine which class loader is the one for Drupal's vendor directory,
- // look for the loader whose vendor path starts the same way as the path to
- // this file.
- foreach (array_keys($loaders) as $path) {
- if (str_starts_with(__FILE__, dirname($path))) {
- $vendor_path = $path;
- }
- }
- }
- if (!isset($vendor_path)) {
- // If we couldn't find a match, assume that the first registered class
- // loader is the one we want.
- $vendor_path = key($loaders);
- }
-
- return $vendor_path . '/drush/drush/drush';
- }
-
-}
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 5147a3cb2b..96e3379bc5 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -6,7 +6,6 @@ namespace Drupal\Tests\automatic_updates\Functional;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
-use Drupal\automatic_updates_test\AutomaticUpdatesTestServiceProvider;
use Drupal\automatic_updates_test\Datetime\TestTime;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\Url;
@@ -16,7 +15,6 @@ use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\Traits\Core\CronRunTrait;
use Drush\TestTraits\DrushTestTrait;
-use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Tests status check failure notification emails during cron runs.
@@ -82,22 +80,6 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
->save();
}
- /**
- * Runs cron, simulating a two-hour interval since the previous run.
- *
- * We need to simulate that at least an hour has passed since the previous
- * run, so that our cron hook will run status checks again.
- *
- * @see automatic_updates_cron()
- */
- private function runCronAndWait(): void {
- $offset = $this->cronRunCount * 2;
- $this->cronRunCount++;
- TestTime::setFakeTimeByOffset("+$offset hours");
- $this->cronRun();
- sleep(2);
- }
-
/**
* Asserts that a certain number of failure notifications has been sent.
*
@@ -121,7 +103,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$url = Url::fromRoute('system.status')
->setAbsolute()
@@ -144,13 +126,13 @@ END;
$recipient_count = count($this->emailRecipients);
$this->assertGreaterThan(0, $recipient_count);
$sent_messages_count = $recipient_count;
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$this->assertSentMessagesCount($sent_messages_count);
// If a different error is flagged, they should be e-mailed again.
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -162,28 +144,28 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$this->assertSentMessagesCount($sent_messages_count);
// If only a warning is flagged, they should not be e-mailed again because
// we ignore warnings by default.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$this->assertSentMessagesCount($sent_messages_count);
// If we stop ignoring warnings, they should be e-mailed again because we
// clear the stored results if the relevant configuration is changed.
$config = $this->config('automatic_updates.settings');
$config->set('status_check_mail', StatusCheckMailer::ALL)->save();
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
// If we flag a different warning, they should be e-mailed again.
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -194,7 +176,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_WARNING),
];
TestSubscriber1::setTestResult($warnings, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -205,7 +187,7 @@ END;
$this->createValidationResult(SystemManager::REQUIREMENT_ERROR),
];
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
@@ -214,7 +196,7 @@ END;
// different order.
$results = array_reverse($results);
TestSubscriber1::setTestResult($results, StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable notifications entirely, they should not be e-mailed even
@@ -222,7 +204,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable notifications and go back to ignoring warnings, they
@@ -230,7 +212,7 @@ END;
$config->set('status_check_mail', StatusCheckMailer::ERRORS_ONLY)->save();
$warning = $this->createValidationResult(SystemManager::REQUIREMENT_WARNING);
TestSubscriber1::setTestResult([$warning], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$this->assertSentMessagesCount($sent_messages_count);
// If we disable unattended updates entirely and flag a new error, they
@@ -238,34 +220,26 @@ END;
$config->set('unattended.level', CronUpdateStage::DISABLED)->save();
$error = $this->createValidationResult(SystemManager::REQUIREMENT_ERROR);
TestSubscriber1::setTestResult([$error], StatusCheckEvent::class);
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$this->assertSentMessagesCount($sent_messages_count);
// If we re-enable unattended updates, they should be emailed again, even if
// the results haven't changed.
$config->set('unattended.level', CronUpdateStage::SECURITY)->save();
- $this->performConsoleUpdate();
+ $this->runConsoleUpdateCommand();
$sent_messages_count += $recipient_count;
$this->assertSentMessagesCount($sent_messages_count);
}
- private function performConsoleUpdate() {
+ /**
+ * Runs the console update command.
+ */
+ private function runConsoleUpdateCommand(): void {
static $total_delay = 0;
+ // Delay the run so status checks will run.
$total_delay += 61;
TestTime::setFakeTimeByOffset("+$total_delay minutes");
- // @todo Should we change working directory?
$this->drush('auto-update');
}
- /**
- * {@inheritdoc}
- */
- protected function installModulesFromClassProperty(ContainerInterface $container): void {
- $container->get('module_installer')->install([
- 'system',
- ]);
- AutomaticUpdatesTestServiceProvider::useTestCronUpdateStage();
- parent::installModulesFromClassProperty($container);
- }
-
}
--
GitLab
From 3002e5d612e53866cb2bb75cc2b7bc4a8e2552b1 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 23:00:35 -0400
Subject: [PATCH 079/142] fix assertNoCronRun
---
tests/src/Kernel/ConsoleUpdateStageTest.php | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/tests/src/Kernel/ConsoleUpdateStageTest.php b/tests/src/Kernel/ConsoleUpdateStageTest.php
index 320a4f6055..66a1219523 100644
--- a/tests/src/Kernel/ConsoleUpdateStageTest.php
+++ b/tests/src/Kernel/ConsoleUpdateStageTest.php
@@ -76,7 +76,7 @@ class ConsoleUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->installSchema('user', ['users_data']);
$this->setUpEmailRecipients();
- $this->assertRegularCronRun(FALSE);
+ $this->assertNoCronRun();
}
/**
@@ -89,7 +89,7 @@ class ConsoleUpdateStageTest extends AutomaticUpdatesKernelTestBase {
TestSubscriber1::setException($exception, PostApplyEvent::class);
$this->performConsoleUpdate();
- $this->assertRegularCronRun(FALSE);
+ $this->assertNoCronRun();
$this->assertTrue($this->logger->hasRecord($exception->getMessage(), (string) RfcLogLevel::ERROR));
// Ensure we sent a success email to all recipients, even though post-apply
@@ -700,8 +700,13 @@ END;
$this->assertSame($will_be_in_maintenance_mode, $state->get('system.maintenance_mode'));
}
- private function assertRegularCronRun(bool $expected_cron_run) {
- $this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
+ /**
+ * Asserts cron has not run.
+ *
+ * @see \common_test_cron_helper_cron()
+ */
+ private function assertNoCronRun(): void {
+ $this->assertNull($this->container->get('state')->get('common_test.cron'));
}
}
--
GitLab
From fe003138edfc2a18ddfc58c99799e7a367072f15 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 23:07:01 -0400
Subject: [PATCH 080/142] clean up testRegularCronRuns
---
tests/src/Kernel/CronUpdateStageTest.php | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index 6c890b0827..dcb7916823 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -37,7 +37,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
/** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
$cron_stage = $this->container->get(CronUpdateStage::class);
$cron_stage->throwExceptionOnTerminalCommand = TRUE;
- $this->assertRegularCronRun(FALSE);
+ $this->assertCronRan(FALSE);
try {
$this->container->get('cron')->run();
@@ -47,10 +47,18 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
catch (\Exception $e) {
$this->assertSame('Simulated process failure.', $e->getMessage());
}
- $this->assertRegularCronRun(TRUE);
+ $this->assertCronRan(TRUE);
}
- private function assertRegularCronRun(bool $expected_cron_run) {
+ /**
+ * Asserts whether cron has run.
+ *
+ * @param bool $expected_cron_run
+ * Whether cron is expected to have run.
+ *
+ * @see \common_test_cron_helper_cron()
+ */
+ private function assertCronRan(bool $expected_cron_run): void {
$this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
}
--
GitLab
From 577ec28c91934527bcd60972384dfdd80c27d678 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 23:18:56 -0400
Subject: [PATCH 081/142] Revert "log status check events in build tests also"
This reverts commit 69d58a41c2f973d17478458aa89880b4193d20b1.
---
.../src/EventSubscriber/EventLogSubscriber.php | 5 +----
.../tests/src/Build/TemplateProjectTestBase.php | 8 ++++----
2 files changed, 5 insertions(+), 8 deletions(-)
diff --git a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
index cd20b12d91..2f3e47cb8f 100644
--- a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
+++ b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
@@ -13,7 +13,6 @@ use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Event\PreDestroyEvent;
use Drupal\package_manager\Event\PreRequireEvent;
use Drupal\package_manager\Event\StageEvent;
-use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
/**
@@ -28,8 +27,7 @@ final class EventLogSubscriber implements EventSubscriberInterface {
* The event object.
*/
public function logEventInfo(StageEvent $event): void {
- $channel = $event instanceof StatusCheckEvent ? 'package_manager_test_status_event_logger' : 'package_manager_test_lifecycle_event_logger';
- \Drupal::logger($channel)->info("$channel-start: Event: " . get_class($event) . ', Stage instance of: ' . get_class($event->stage) . ":$channel-end");
+ \Drupal::logger('package_manager_test_event_logger')->info('package_manager_test_event_logger-start: Event: ' . get_class($event) . ', Stage instance of: ' . get_class($event->stage) . ':package_manager_test_event_logger-end');
}
/**
@@ -50,7 +48,6 @@ final class EventLogSubscriber implements EventSubscriberInterface {
PostApplyEvent::class => ['logEventInfo', PHP_INT_MAX],
PreDestroyEvent::class => ['logEventInfo', PHP_INT_MAX],
PostDestroyEvent::class => ['logEventInfo', PHP_INT_MAX],
- StatusCheckEvent::class => ['logEventInfo', PHP_INT_MAX],
];
}
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index dcf0cf65bc..41d28209f6 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -583,7 +583,7 @@ END;
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
- protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL, string $channel = 'package_manager_test_lifecycle_event_logger'): void {
+ protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, ?string $message = NULL): void {
if ($expected_events === NULL) {
$expected_events = [
PreCreateEvent::class,
@@ -608,13 +608,13 @@ END;
$page = $this->getMink()->getSession()->getPage();
$this->visit('/admin/reports/dblog');
$assert_session->statusCodeEquals(200);
- $page->selectFieldOption('Type', $channel);
+ $page->selectFieldOption('Type', 'package_manager_test_event_logger');
$page->pressButton('Filter');
$assert_session->statusCodeEquals(200);
// The log entries will not appear completely in the page text but they will
// appear in the title attribute of the links.
- $links = $page->findAll('css', "a[title^=$channel-start]");
+ $links = $page->findAll('css', 'a[title^=package_manager_test_event_logger-start]');
$actual_titles = [];
// Loop through the links in reverse order because the most recent entries
// will be first.
@@ -623,7 +623,7 @@ END;
}
$expected_titles = [];
foreach ($expected_events as $event) {
- $expected_titles[] = "$channel-start: Event: $event, Stage instance of: $expected_stage_class:$channel-end";
+ $expected_titles[] = "package_manager_test_event_logger-start: Event: $event, Stage instance of: $expected_stage_class:package_manager_test_event_logger-end";
}
$this->assertSame($expected_titles, $actual_titles, $message ?? '');
}
--
GitLab
From 498bdc3f093fd1d975781be15c3ea451e54c1c89 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 23:21:27 -0400
Subject: [PATCH 082/142] remove unneeded @param
---
package_manager/tests/src/Build/TemplateProjectTestBase.php | 3 ---
1 file changed, 3 deletions(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index 41d28209f6..955813ab86 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -577,9 +577,6 @@ END;
* will be asserted.
* @param string|null $message
* (optional) A message to display with the assertion.
- * @param string $channel
- * (optional) The longer change to check. If none provide defaults to
- * 'package_manager_test_lifecycle_event_logger'.
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
--
GitLab
From 385a609e42e1d230fbe672fb967935bdacf31c74 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 23:37:51 -0400
Subject: [PATCH 083/142] reduce StatusChecker diff
---
src/Validation/StatusChecker.php | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/Validation/StatusChecker.php b/src/Validation/StatusChecker.php
index 8b22ac5fb6..9ce61d4d51 100644
--- a/src/Validation/StatusChecker.php
+++ b/src/Validation/StatusChecker.php
@@ -44,7 +44,7 @@ final class StatusChecker implements EventSubscriberInterface {
* The update stage service.
* @param \Drupal\automatic_updates\ConsoleUpdateStage $consoleUpdateStage
* The console update stage service.
- * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
+ * @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateStage
* The cron update stage service.
* @param int $resultsTimeToLive
* The number of hours to store results.
@@ -55,7 +55,7 @@ final class StatusChecker implements EventSubscriberInterface {
private readonly EventDispatcherInterface $eventDispatcher,
private readonly UpdateStage $updateStage,
private readonly ConsoleUpdateStage $consoleUpdateStage,
- private readonly CronUpdateStage $cronUpdateRunner,
+ private readonly CronUpdateStage $cronUpdateStage,
private readonly int $resultsTimeToLive,
) {
$this->keyValueExpirable = $key_value_expirable_factory->get('automatic_updates');
@@ -67,10 +67,10 @@ final class StatusChecker implements EventSubscriberInterface {
* @return $this
*/
public function run(): self {
- // If updates will run during cron, use the unattended update stage service
+ // If updates will run during cron, use the console update stage service
// provided by this module. This will allow validators to run specific
// validation for conditions that only affect cron updates.
- if ($this->cronUpdateRunner->getMode() === CronUpdateStage::DISABLED) {
+ if ($this->cronUpdateStage->getMode() === CronUpdateStage::DISABLED) {
$stage = $this->updateStage;
}
else {
--
GitLab
From e08a1cc4399bf7142a2f443f6c7818d0b3c7d237 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 19 Jul 2023 23:44:53 -0400
Subject: [PATCH 084/142] extra line
---
tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php | 1 -
1 file changed, 1 deletion(-)
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index cdf37224e4..7476c9f2a9 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -5,7 +5,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateStage;
-
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
--
GitLab
From 5717e99477b66a6ee41370c683ed1b7b21c80af9 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 20 Jul 2023 08:27:42 -0400
Subject: [PATCH 085/142] ensure terminal command is run in kernel tests
---
.../Kernel/AutomaticUpdatesKernelTestBase.php | 2 +-
tests/src/Kernel/CronUpdateStageTest.php | 40 ++++++++++++-
tests/src/Kernel/HookCronTest.php | 60 -------------------
.../CronFrequencyValidatorTest.php | 15 ++++-
4 files changed, 51 insertions(+), 66 deletions(-)
delete mode 100644 tests/src/Kernel/HookCronTest.php
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 4bcae3d78a..aafdc4fbd4 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -122,7 +122,7 @@ class TestCronUpdateStage extends CronUpdateStage {
if ($this->throwExceptionOnTerminalCommand) {
throw new \Exception('Simulated process failure.');
}
- parent::runTerminalUpdateCommand();
+ throw new \LogicException('Terminal command will not work in kernel tests');
}
}
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index dcb7916823..f7b492c920 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -10,7 +10,7 @@ use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
/**
- * @covers \Drupal\automatic_updates\CronUpdateStage
+ * @coversDefaultClass \Drupal\automatic_updates\CronUpdateStage
* @group automatic_updates
* @internal
*/
@@ -32,21 +32,50 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
/**
* Tests that regular cron always runs.
+ *
+ * @covers ::run
*/
public function testRegularCronRuns(): void {
+ // Ensure that if the terminal command is attempted an expection will be
+ // raised.
/** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
$cron_stage = $this->container->get(CronUpdateStage::class);
$cron_stage->throwExceptionOnTerminalCommand = TRUE;
- $this->assertCronRan(FALSE);
+ // Undo override of the 'serverApi' property from the parent test class.
+ // @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::setUp
+ $property = new \ReflectionProperty(CronUpdateStage::class, 'serverApi');
+ $property->setValue(NULL, 'cli');
+ $this->assertTrue(CronUpdateStage::isCommandLine());
+
+ // Since we're at the command line the terminal command should not be
+ // invoked.
+ $this->container->get('cron')->run();
+ // Even though the terminal command was not invoke hook_cron
+ // implementations should have been invoked.
+ $this->assertCronRan(TRUE);
+ // If we are on the web but the method is set to 'console the terminal
+ // command should not be invoked.
+ $property->setValue(NULL, 'cgi-fcgi');
+ $this->assertFalse(CronUpdateStage::isCommandLine());
+ $this->config('automatic_updates.settings')
+ ->set('unattended.method', 'console')
+ ->save();
+ $this->container->get('cron')->run();
+ $this->assertCronRan(TRUE);
+
+ $this->config('automatic_updates.settings')
+ ->set('unattended.method', 'web')
+ ->save();
try {
$this->container->get('cron')->run();
$this->fail('Expected cron exception');
}
-
catch (\Exception $e) {
$this->assertSame('Simulated process failure.', $e->getMessage());
}
+ // Even though the terminal command threw exception hook_cron
+ // implementations should have been invoked before this.
$this->assertCronRan(TRUE);
}
@@ -59,7 +88,12 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
* @see \common_test_cron_helper_cron()
*/
private function assertCronRan(bool $expected_cron_run): void {
+ $this->assertTrue(
+ $this->container->get('module_handler')->moduleExists('common_test_cron_helper'),
+ '\Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::assertCronRan can only be used if common_test_cron_helper is enabled.'
+ );
$this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
+ $this->container->get('state')->delete('common_test.cron');
}
}
diff --git a/tests/src/Kernel/HookCronTest.php b/tests/src/Kernel/HookCronTest.php
deleted file mode 100644
index a81fda6a72..0000000000
--- a/tests/src/Kernel/HookCronTest.php
+++ /dev/null
@@ -1,60 +0,0 @@
-<?php
-
-namespace Drupal\Tests\automatic_updates\Kernel;
-
-use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates_test\Datetime\TestTime;
-use Drupal\package_manager\Event\StatusCheckEvent;
-
-/**
- * @group automatic_updates
- */
-class HookCronTest extends AutomaticUpdatesKernelTestBase {
-
- /**
- * {@inheritdoc}
- */
- protected static $modules = ['automatic_updates', 'automatic_updates_test'];
-
- /**
- * Tests that our cron hook will run status checks.
- */
- public function testStatusChecksRunOnCron(): void {
- // Set the core version to 9.8.1 so there will not be an update attempted.
- // The hook_cron implementations will not be run if there is an update.
- // @see \Drupal\automatic_updates\CronUpdateStage::run()
- // @todo Remove this is https://drupal.org/i/3357969
- $this->setCoreVersion('9.8.1');
- // Undo override of the 'serverApi' property from the parent test class.
- // @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::setUp
- $property = new \ReflectionProperty(CronUpdateStage::class, 'serverApi');
- $property->setValue(NULL, 'cli');
- $this->assertTrue(CronUpdateStage::isCommandLine());
- $status_check_count = 0;
- $this->addEventTestListener(function () use (&$status_check_count) {
- $status_check_count++;
- }, StatusCheckEvent::class);
-
- // Since we're at the command line, status checks should still not run, even
- // if we do run cron.
- $this->container->get('cron')->run();
- $this->assertSame(0, $status_check_count);
-
- // If we are on the web the status checks should run.
- $property->setValue(NULL, 'cgi-fcgi');
- $this->assertFalse(CronUpdateStage::isCommandLine());
- $this->container->get('cron')->run();
- $this->assertSame(1, $status_check_count);
-
- // Ensure that the status checks won't run if less than an hour has passed.
- TestTime::setFakeTimeByOffset("+30 minutes");
- $this->container->get('cron')->run();
- $this->assertSame(1, $status_check_count);
-
- // The status checks should run if more than an hour has passed.
- TestTime::setFakeTimeByOffset("+61 minutes");
- $this->container->get('cron')->run();
- $this->assertSame(2, $status_check_count);
- }
-
-}
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 1fb92b8381..591e0000c5 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -110,8 +110,19 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
$this->container->get('state')->set('system.cron_last', $last_run);
$this->assertCheckerResultsFromManager($expected_results, TRUE);
- // After running cron, any errors or warnings should be gone.
- $this->container->get('cron')->run();
+ /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
+ $cron_stage = $this->container->get(CronUpdateStage::class);
+ $cron_stage->throwExceptionOnTerminalCommand = TRUE;
+ try {
+ $this->container->get('cron')->run();
+ $this->fail('Expected failure');
+ }
+ catch (\Exception $exception) {
+ $this->assertSame('Simulated process failure.', $exception->getMessage());
+ }
+ // After running cron, any errors or warnings should be gone. Even though
+ // the terminal command did not succeed the system cron service should have
+ // been called.
$this->assertCheckerResultsFromManager([], TRUE);
}
--
GitLab
From e3b9d963bd5b955e6f387bc6d0c6dfd27f3aaa92 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 20 Jul 2023 09:39:09 -0400
Subject: [PATCH 086/142] Simplify logic around ensuring the terminal command
is invoked during kernel tests
---
.../Kernel/AutomaticUpdatesKernelTestBase.php | 14 +++----
tests/src/Kernel/CronUpdateStageTest.php | 41 ++++++++++---------
.../CronFrequencyValidatorTest.php | 6 +--
3 files changed, 29 insertions(+), 32 deletions(-)
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index aafdc4fbd4..63809cea3e 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -109,20 +109,18 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
class TestCronUpdateStage extends CronUpdateStage {
/**
- * Determines whether an exception should be thrown.
- *
- * @var bool
+ * Expected exception message if terminal command is invoked.
*/
- public bool $throwExceptionOnTerminalCommand = FALSE;
+ public const EXPECTED_TERMINAL_EXCEPTION = 'Expected exception: Terminal command will not work in kernel tests';
/**
* {@inheritdoc}
*/
public function runTerminalUpdateCommand(): void {
- if ($this->throwExceptionOnTerminalCommand) {
- throw new \Exception('Simulated process failure.');
- }
- throw new \LogicException('Terminal command will not work in kernel tests');
+ // Invoking the terminal command will not work and is not necessary in
+ // kernel tests. Throw an exception for tests that need to assert that
+ // the terminal command would have been invoked.
+ throw new \Exception(static::EXPECTED_TERMINAL_EXCEPTION);
}
}
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index f7b492c920..7dc6e4cbc2 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -31,16 +31,16 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
];
/**
- * Tests that regular cron always runs.
+ * Tests that hook_cron implementations are always invoked.
*
* @covers ::run
*/
- public function testRegularCronRuns(): void {
- // Ensure that if the terminal command is attempted an expection will be
- // raised.
- /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
- $cron_stage = $this->container->get(CronUpdateStage::class);
- $cron_stage->throwExceptionOnTerminalCommand = TRUE;
+ public function testHookCronInvoked(): void {
+ // Delete the state value set when cron runs to ensure next asserts start
+ // from a good state.
+ // @see \common_test_cron_helper_cron()
+ $this->container->get('state')->delete('common_test.cron');
+
// Undo override of the 'serverApi' property from the parent test class.
// @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::setUp
$property = new \ReflectionProperty(CronUpdateStage::class, 'serverApi');
@@ -50,11 +50,11 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
// Since we're at the command line the terminal command should not be
// invoked.
$this->container->get('cron')->run();
- // Even though the terminal command was not invoke hook_cron
+ // Even though the terminal command was not invoked hook_cron
// implementations should have been invoked.
- $this->assertCronRan(TRUE);
+ $this->assertCronRan();
- // If we are on the web but the method is set to 'console the terminal
+ // If we are on the web but the method is set to 'console' the terminal
// command should not be invoked.
$property->setValue(NULL, 'cgi-fcgi');
$this->assertFalse(CronUpdateStage::isCommandLine());
@@ -62,37 +62,38 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
->set('unattended.method', 'console')
->save();
$this->container->get('cron')->run();
- $this->assertCronRan(TRUE);
+ $this->assertCronRan();
+ // If we are on the web and method settings is 'web' the terminal command
+ // should be invoked.
$this->config('automatic_updates.settings')
->set('unattended.method', 'web')
->save();
try {
$this->container->get('cron')->run();
- $this->fail('Expected cron exception');
+ $this->fail('Expected process exception');
}
catch (\Exception $e) {
- $this->assertSame('Simulated process failure.', $e->getMessage());
+ $this->assertSame(TestCronUpdateStage::EXPECTED_TERMINAL_EXCEPTION, $e->getMessage());
}
// Even though the terminal command threw exception hook_cron
// implementations should have been invoked before this.
- $this->assertCronRan(TRUE);
+ $this->assertCronRan();
}
/**
- * Asserts whether cron has run.
- *
- * @param bool $expected_cron_run
- * Whether cron is expected to have run.
+ * Asserts hook_cron implementations were invoked.
*
* @see \common_test_cron_helper_cron()
*/
- private function assertCronRan(bool $expected_cron_run): void {
+ private function assertCronRan(): void {
$this->assertTrue(
$this->container->get('module_handler')->moduleExists('common_test_cron_helper'),
'\Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::assertCronRan can only be used if common_test_cron_helper is enabled.'
);
- $this->assertSame($expected_cron_run, $this->container->get('state')->get('common_test.cron') === 'success');
+ $this->assertSame('success', $this->container->get('state')->get('common_test.cron'));
+ // Delete the value so this function can be called again after the next cron
+ // attempt.
$this->container->get('state')->delete('common_test.cron');
}
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 591e0000c5..8d3008ae4d 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -7,6 +7,7 @@ namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\package_manager\ValidationResult;
use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
+use Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage;
/**
* @covers \Drupal\automatic_updates\Validator\CronFrequencyValidator
@@ -110,15 +111,12 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
$this->container->get('state')->set('system.cron_last', $last_run);
$this->assertCheckerResultsFromManager($expected_results, TRUE);
- /** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage $cron_stage */
- $cron_stage = $this->container->get(CronUpdateStage::class);
- $cron_stage->throwExceptionOnTerminalCommand = TRUE;
try {
$this->container->get('cron')->run();
$this->fail('Expected failure');
}
catch (\Exception $exception) {
- $this->assertSame('Simulated process failure.', $exception->getMessage());
+ $this->assertSame(TestCronUpdateStage::EXPECTED_TERMINAL_EXCEPTION, $exception->getMessage());
}
// After running cron, any errors or warnings should be gone. Even though
// the terminal command did not succeed the system cron service should have
--
GitLab
From ead51444cecde8bd51402ad30f842490dd695665 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 20 Jul 2023 10:27:20 -0400
Subject: [PATCH 087/142] rename back to DrushUpdateStage to minimize diff
---
automatic_updates.install | 6 +++---
automatic_updates.services.yml | 2 +-
src/Commands/AutomaticUpdatesCommands.php | 8 ++++----
...oleUpdateStage.php => DrushUpdateStage.php} | 4 ++--
src/MaintenanceModeAwareCommitter.php | 2 +-
src/Validation/StatusChecker.php | 6 +++---
src/Validator/CronFrequencyValidator.php | 4 ++--
src/Validator/PhpExtensionsValidator.php | 4 ++--
.../StagedDatabaseUpdateValidator.php | 4 ++--
src/Validator/VersionPolicyValidator.php | 8 ++++----
tests/src/Build/CoreUpdateTest.php | 6 +++---
.../Kernel/AutomaticUpdatesKernelTestBase.php | 8 ++++----
...eStageTest.php => DrushUpdateStageTest.php} | 18 +++++++++---------
tests/src/Kernel/ReleaseChooserTest.php | 14 +++++++-------
.../Kernel/StatusCheck/StatusCheckerTest.php | 4 ++--
.../StatusCheck/VersionPolicyValidatorTest.php | 6 +++---
16 files changed, 52 insertions(+), 52 deletions(-)
rename src/{ConsoleUpdateStage.php => DrushUpdateStage.php} (99%)
rename tests/src/Kernel/{ConsoleUpdateStageTest.php => DrushUpdateStageTest.php} (97%)
diff --git a/automatic_updates.install b/automatic_updates.install
index 16c8fb0033..c1dab5094a 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -7,7 +7,7 @@
declare(strict_types = 1);
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\Validation\StatusCheckRequirements;
use Drupal\system\SystemManager;
@@ -38,8 +38,8 @@ function automatic_updates_requirements($phase) {
'value' => t('Enabled. This is NOT an officially supported feature of the Automatic Updates module at this time. Use at your own risk.'),
];
}
- /** @var \Drupal\automatic_updates\ConsoleUpdateStage $console_stage */
- $console_stage = Drupal::service(ConsoleUpdateStage::class);
+ /** @var \Drupal\automatic_updates\DrushUpdateStage $console_stage */
+ $console_stage = Drupal::service(DrushUpdateStage::class);
if ($console_update_status = $console_stage->getProcessStatus()) {
$requirements['automatic_updates_console_update_status'] = [
'title' => t('Automatic background updates'),
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index cea271edea..55dac36e4f 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -63,7 +63,7 @@ services:
logger.channel.automatic_updates:
parent: logger.channel_base
arguments: ['automatic_updates']
- Drupal\automatic_updates\ConsoleUpdateStage:
+ Drupal\automatic_updates\DrushUpdateStage:
arguments:
$committer: '@Drupal\automatic_updates\MaintenanceModeAwareCommitter'
calls:
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 77928827ad..086119a124 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Commands;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\Core\Config\ConfigFactoryInterface;
@@ -29,7 +29,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*
* @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
- * @param \Drupal\automatic_updates\ConsoleUpdateStage $stage
+ * @param \Drupal\automatic_updates\DrushUpdateStage $stage
* The console cron updater service.
* @param \Drupal\automatic_updates\Validation\StatusChecker $statusChecker
* The status checker service.
@@ -40,7 +40,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
*/
public function __construct(
private readonly CronUpdateStage $cronUpdateRunner,
- private readonly ConsoleUpdateStage $stage,
+ private readonly DrushUpdateStage $stage,
private readonly StatusChecker $statusChecker,
private readonly StatusCheckMailer $statusCheckMailer,
private readonly ConfigFactoryInterface $configFactory,
@@ -72,7 +72,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
// The second half of the update process (post-apply etc.) is done by this
// exact same command, with some additional flags, in a separate process to
// ensure that the system is in a consistent state.
- // @see \Drupal\automatic_updates\ConsoleUpdateStage::triggerPostApply()
+ // @see \Drupal\automatic_updates\DrushUpdateStage::triggerPostApply()
if ($options['post-apply']) {
if (empty($options['stage-id']) || empty($options['from-version']) || empty($options['to-version'])) {
throw new \LogicException("The post-apply option is for internal use only. It should never be passed directly.");
diff --git a/src/ConsoleUpdateStage.php b/src/DrushUpdateStage.php
similarity index 99%
rename from src/ConsoleUpdateStage.php
rename to src/DrushUpdateStage.php
index 26c0a22281..fe8545e052 100644
--- a/src/ConsoleUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -32,10 +32,10 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
*
* @todo Make this class a generic console stage in https://drupal.org/i/3360485
*/
-class ConsoleUpdateStage extends UpdateStage {
+class DrushUpdateStage extends UpdateStage {
/**
- * Constructs a ConsoleUpdateStage object.
+ * Constructs a DrushUpdateStage object.
*
* @param \Drupal\Core\State\StateInterface $state
* The state service.
diff --git a/src/MaintenanceModeAwareCommitter.php b/src/MaintenanceModeAwareCommitter.php
index 024a610859..1599bc3049 100644
--- a/src/MaintenanceModeAwareCommitter.php
+++ b/src/MaintenanceModeAwareCommitter.php
@@ -61,7 +61,7 @@ final class MaintenanceModeAwareCommitter implements CommitterInterface, EventSu
* The event being handled.
*/
public function restore(PostApplyEvent $event): void {
- if ($event->stage instanceof ConsoleUpdateStage) {
+ if ($event->stage instanceof DrushUpdateStage) {
$this->doRestore();
}
}
diff --git a/src/Validation/StatusChecker.php b/src/Validation/StatusChecker.php
index 9ce61d4d51..ec9ff0cbce 100644
--- a/src/Validation/StatusChecker.php
+++ b/src/Validation/StatusChecker.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validation;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
@@ -42,7 +42,7 @@ final class StatusChecker implements EventSubscriberInterface {
* The event dispatcher service.
* @param \Drupal\automatic_updates\UpdateStage $updateStage
* The update stage service.
- * @param \Drupal\automatic_updates\ConsoleUpdateStage $consoleUpdateStage
+ * @param \Drupal\automatic_updates\DrushUpdateStage $consoleUpdateStage
* The console update stage service.
* @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateStage
* The cron update stage service.
@@ -54,7 +54,7 @@ final class StatusChecker implements EventSubscriberInterface {
private readonly TimeInterface $time,
private readonly EventDispatcherInterface $eventDispatcher,
private readonly UpdateStage $updateStage,
- private readonly ConsoleUpdateStage $consoleUpdateStage,
+ private readonly DrushUpdateStage $consoleUpdateStage,
private readonly CronUpdateStage $cronUpdateStage,
private readonly int $resultsTimeToLive,
) {
diff --git a/src/Validator/CronFrequencyValidator.php b/src/Validator/CronFrequencyValidator.php
index 10f72bd7fc..c74e473791 100644
--- a/src/Validator/CronFrequencyValidator.php
+++ b/src/Validator/CronFrequencyValidator.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Lock\LockBackendInterface;
@@ -83,7 +83,7 @@ final class CronFrequencyValidator implements EventSubscriberInterface {
*/
public function validateLastCronRun(StatusCheckEvent $event): void {
// We only want to do this check if the stage belongs to Automatic Updates.
- if (!$event->stage instanceof ConsoleUpdateStage) {
+ if (!$event->stage instanceof DrushUpdateStage) {
return;
}
// If automatic updates are disabled during cron or updates will be run via
diff --git a/src/Validator/PhpExtensionsValidator.php b/src/Validator/PhpExtensionsValidator.php
index 38ea624140..9885146661 100644
--- a/src/Validator/PhpExtensionsValidator.php
+++ b/src/Validator/PhpExtensionsValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -26,7 +26,7 @@ final class PhpExtensionsValidator extends PackageManagerPhpExtensionsValidator
* {@inheritdoc}
*/
public function validateXdebug(PreOperationStageEvent $event): void {
- if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof ConsoleUpdateStage) {
+ if ($this->isExtensionLoaded('xdebug') && $event->stage instanceof DrushUpdateStage) {
$event->addError([$this->t("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.")]);
}
elseif ($event instanceof StatusCheckEvent) {
diff --git a/src/Validator/StagedDatabaseUpdateValidator.php b/src/Validator/StagedDatabaseUpdateValidator.php
index ac9892080e..e2998ddb5d 100644
--- a/src/Validator/StagedDatabaseUpdateValidator.php
+++ b/src/Validator/StagedDatabaseUpdateValidator.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Validator\StagedDBUpdateValidator;
@@ -39,7 +39,7 @@ final class StagedDatabaseUpdateValidator implements EventSubscriberInterface {
*/
public function checkUpdateHooks(PreApplyEvent $event): void {
$stage = $event->stage;
- if (!$stage instanceof ConsoleUpdateStage) {
+ if (!$stage instanceof DrushUpdateStage) {
return;
}
diff --git a/src/Validator/VersionPolicyValidator.php b/src/Validator/VersionPolicyValidator.php
index a6f26501bc..9b671b4770 100644
--- a/src/Validator/VersionPolicyValidator.php
+++ b/src/Validator/VersionPolicyValidator.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates\Validator;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Component\Utility\NestedArray;
use Drupal\package_manager\ComposerInspector;
use Drupal\package_manager\Event\StatusCheckEvent;
@@ -89,7 +89,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
// If this is a cron update, we may need to do additional checks.
- if ($stage instanceof ConsoleUpdateStage) {
+ if ($stage instanceof DrushUpdateStage) {
$mode = $this->cronUpdateRunner->getMode();
if ($mode !== CronUpdateStage::DISABLED) {
@@ -239,7 +239,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
}
}
elseif ($event instanceof StatusCheckEvent) {
- if ($stage instanceof ConsoleUpdateStage) {
+ if ($stage instanceof DrushUpdateStage) {
$target_release = $stage->getTargetRelease();
if ($target_release) {
return $target_release->getVersion();
@@ -268,7 +268,7 @@ final class VersionPolicyValidator implements EventSubscriberInterface {
$project_info = new ProjectInfo('drupal');
$available_releases = $project_info->getInstallableReleases() ?? [];
- if ($stage instanceof ConsoleUpdateStage) {
+ if ($stage instanceof DrushUpdateStage) {
$available_releases = array_reverse($available_releases);
}
return $available_releases;
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index ed0c924539..a9e8227d83 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Build;
use Behat\Mink\Element\DocumentElement;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
@@ -399,7 +399,7 @@ class CoreUpdateTest extends UpdateTestBase {
$this->visit('/admin/reports/status');
}
- $this->assertExpectedStageEventsFired(ConsoleUpdateStage::class);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class);
// There should be log messages, but no errors or warnings should have been
// logged by Automatic Updates.
// The use of the database log here implies one can only retrieve log
@@ -468,7 +468,7 @@ class CoreUpdateTest extends UpdateTestBase {
$this->assertStringContainsString('Drupal core was successfully updated to 9.8.1!', $output);
$this->assertStringContainsString('Running post-apply tasks and final clean-up...', $output);
$this->assertUpdateSuccessful('9.8.1');
- $this->assertExpectedStageEventsFired(ConsoleUpdateStage::class);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class);
// Rerunning the command should exit with a message that no newer version
// is available.
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 63809cea3e..d8c5e6a5d0 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
@@ -85,7 +85,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
// Use the test-only implementations of the regular and cron update stages.
$overrides = [
'automatic_updates.cron_update_stage' => TestCronUpdateStage::class,
- ConsoleUpdateStage::class => TestConsoleUpdateStage::class,
+ DrushUpdateStage::class => TestDrushUpdateStage::class,
];
foreach ($overrides as $service_id => $class) {
if ($container->hasDefinition($service_id)) {
@@ -98,7 +98,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
* Performs an update using the console update stage directly.
*/
protected function performConsoleUpdate(): void {
- $this->container->get(ConsoleUpdateStage::class)->performUpdate();
+ $this->container->get(DrushUpdateStage::class)->performUpdate();
}
}
@@ -128,7 +128,7 @@ class TestCronUpdateStage extends CronUpdateStage {
/**
* A test-only version of the drush update stage to override and expose internals.
*/
-class TestConsoleUpdateStage extends ConsoleUpdateStage {
+class TestDrushUpdateStage extends DrushUpdateStage {
/**
* {@inheritdoc}
diff --git a/tests/src/Kernel/ConsoleUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
similarity index 97%
rename from tests/src/Kernel/ConsoleUpdateStageTest.php
rename to tests/src/Kernel/DrushUpdateStageTest.php
index 66a1219523..0e41f21439 100644
--- a/tests/src/Kernel/ConsoleUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates_test\EventSubscriber\TestSubscriber1;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Logger\RfcLogLevel;
@@ -35,11 +35,11 @@ use ColinODell\PsrTestLogger\TestLogger;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
- * @covers \Drupal\automatic_updates\ConsoleUpdateStage
+ * @covers \Drupal\automatic_updates\DrushUpdateStage
* @group automatic_updates
* @internal
*/
-class ConsoleUpdateStageTest extends AutomaticUpdatesKernelTestBase {
+class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
use EmailNotificationsTestTrait;
use PackageManagerBypassTestTrait;
@@ -309,8 +309,8 @@ END;
->get('cron')
->addLogger($cron_logger);
- /** @var \Drupal\automatic_updates\ConsoleUpdateStage $stage */
- $stage = $this->container->get(ConsoleUpdateStage::class);
+ /** @var \Drupal\automatic_updates\DrushUpdateStage $stage */
+ $stage = $this->container->get(DrushUpdateStage::class);
// When the event specified by $event_class is dispatched, either throw an
// exception directly from the event subscriber, or prepare a
@@ -471,8 +471,8 @@ END;
* Tests that CronUpdateStage::begin() unconditionally throws an exception.
*/
public function testBeginThrowsException(): void {
- $this->expectExceptionMessage(ConsoleUpdateStage::class . '::begin() cannot be called directly.');
- $this->container->get(ConsoleUpdateStage::class)
+ $this->expectExceptionMessage(DrushUpdateStage::class . '::begin() cannot be called directly.');
+ $this->container->get(DrushUpdateStage::class)
->begin(['drupal' => '9.8.1']);
}
@@ -540,7 +540,7 @@ END;
$error = ValidationResult::createError([
t('Error while updating!'),
]);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(ConsoleUpdateStage::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
$this->performConsoleUpdate();
@@ -582,7 +582,7 @@ END;
t('Error while updating!'),
]);
TestSubscriber1::setTestResult([$error], $event_class);
- $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(ConsoleUpdateStage::class));
+ $exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
$this->performConsoleUpdate();
diff --git a/tests/src/Kernel/ReleaseChooserTest.php b/tests/src/Kernel/ReleaseChooserTest.php
index c9839081ef..552dd77c31 100644
--- a/tests/src/Kernel/ReleaseChooserTest.php
+++ b/tests/src/Kernel/ReleaseChooserTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\ReleaseChooser;
use Drupal\automatic_updates\UpdateStage;
use Drupal\Core\Extension\ExtensionVersion;
@@ -83,42 +83,42 @@ class ReleaseChooserTest extends AutomaticUpdatesKernelTestBase {
'next_minor' => '9.8.2',
],
'cron, installed 9.8.0, no minor support' => [
- 'stage' => ConsoleUpdateStage::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.8.0, minor support' => [
- 'stage' => ConsoleUpdateStage::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.8.0',
'current_minor' => '9.8.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, no minor support' => [
- 'stage' => ConsoleUpdateStage::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.0, minor support' => [
- 'stage' => ConsoleUpdateStage::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.7.0',
'current_minor' => '9.7.1',
'next_minor' => NULL,
],
'cron, installed 9.7.2, no minor support' => [
- 'stage' => ConsoleUpdateStage::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => FALSE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
'next_minor' => NULL,
],
'cron, installed 9.7.2, minor support' => [
- 'stage' => ConsoleUpdateStage::class,
+ 'stage' => DrushUpdateStage::class,
'minor_support' => TRUE,
'installed_version' => '9.7.2',
'current_minor' => NULL,
diff --git a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
index 9acec34a97..7158aeaf91 100644
--- a/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
+++ b/tests/src/Kernel/StatusCheck/StatusCheckerTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\automatic_updates\Validation\StatusChecker;
use Drupal\automatic_updates\Validator\StagedProjectsValidator;
@@ -210,7 +210,7 @@ class StatusCheckerTest extends AutomaticUpdatesKernelTestBase {
$this->addEventTestListener($listener, StatusCheckEvent::class);
$this->container->get(StatusChecker::class)->run();
// By default, updates will be enabled on cron.
- $this->assertInstanceOf(ConsoleUpdateStage::class, $stage);
+ $this->assertInstanceOf(DrushUpdateStage::class, $stage);
$this->config('automatic_updates.settings')
->set('unattended.level', CronUpdateStage::DISABLED)
->save();
diff --git a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
index d11bb0a3f4..5930296b9a 100644
--- a/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/VersionPolicyValidatorTest.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel\StatusCheck;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\automatic_updates\ConsoleUpdateStage;
+use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
use Drupal\fixture_manipulator\ActiveFixtureManipulator;
use Drupal\package_manager\Event\PreCreateEvent;
@@ -405,7 +405,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
// that would get executed after pre-create.
// @see \Drupal\automatic_updates\Validator\VersionPolicyValidator::validateVersion()
$this->addEventTestListener(function (PreCreateEvent $event) use ($target_version): void {
- /** @var \Drupal\automatic_updates\ConsoleUpdateStage $stage */
+ /** @var \Drupal\automatic_updates\DrushUpdateStage $stage */
$stage = $event->stage;
$stage->setMetadata('packages', [
'production' => [
@@ -425,7 +425,7 @@ class VersionPolicyValidatorTest extends AutomaticUpdatesKernelTestBase {
->set('allow_core_minor_updates', $allow_minor_updates)
->save();
- $stage = $this->container->get(ConsoleUpdateStage::class);
+ $stage = $this->container->get(DrushUpdateStage::class);
try {
$stage->create();
// If we did not get an exception, ensure we didn't expect any results.
--
GitLab
From 2a012cd1b5258f369b881ddbca9102685f3b4065 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 20 Jul 2023 14:28:18 -0400
Subject: [PATCH 088/142] clean up call to drush. add warning if not found
---
automatic_updates.install | 17 +++++++++++++++++
automatic_updates.module | 11 +++++++++++
src/CronUpdateStage.php | 34 ++++++++++++++++++++++++----------
3 files changed, 52 insertions(+), 10 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index c1dab5094a..fae0ad608a 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -50,6 +50,23 @@ function automatic_updates_requirements($phase) {
),
];
}
+ else {
+ /** @var \Drupal\automatic_updates\CronUpdateStage $cron_update_stage */
+ $cron_update_stage = \Drupal::service('automatic_updates.cron_update_stage');
+ if ($cron_update_stage->getMode() !== CronUpdateStage::DISABLED) {
+ try {
+ $cron_update_stage->getDrushPath();
+ }
+ catch (Exception $exception) {
+ $requirements['automatic_updates_drush_missing'] = [
+ 'title' => t('Automatic Updates Drush Requirement'),
+ 'severity' => SystemManager::REQUIREMENT_ERROR,
+ 'value' => t('Drush is require for unattended updates'),
+ ];
+ }
+ }
+
+ }
return $requirements;
}
diff --git a/automatic_updates.module b/automatic_updates.module
index a48f003889..942da9af41 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -229,6 +229,17 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
],
'#description' => t('To use the <code>/system/cron</code> method <a href="http://drupal.org/docs/user_guide/en/security-cron.html">ensure cron is set up correctly</a>.'),
];
+ // @todo Remove check in https://drupal.org/i/3360485.
+ try {
+ /** @var \Drupal\automatic_updates\CronUpdateStage $cron_update_stage */
+ $cron_update_stage = \Drupal::service('automatic_updates.cron_update_stage');
+ $cron_update_stage->getDrushPath();
+ }
+ catch (Exception) {
+ \Drupal::messenger()->addWarning('Drush is required for unattended updates.');
+ $form['unattended_level']['#disabled'] = TRUE;
+ $form['unattended_method']['#disabled'] = TRUE;
+ }
$form['#submit'][] = '_automatic_updates_submit_update_settings';
}
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index e189f3dfd9..37e20ca652 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -74,25 +74,18 @@ class CronUpdateStage implements CronInterface {
* Runs the terminal update command.
*/
public function runTerminalUpdateCommand(): void {
- // @todo Make a validator to ensure this path exists if settings select
- // background updates.
- // @todo Replace drush call with Symfony console command in
- // https://www.drupal.org/i/3360485
- // @todo Why isn't it in vendor bin in build tests?
- $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
-
+ $drush_path = $this->getDrushPath();
$phpBinaryFinder = new PhpExecutableFinder();
-
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- // $process->disableOutput();
+ $process->disableOutput();
$process->setTimeout(0);
try {
$process->start();
+ // Wait for the process to start.
sleep(1);
$wait_till = time() + 5;
- // Wait for the process to start.
while (is_null($process->getPid()) && $wait_till > time()) {
}
}
@@ -153,4 +146,25 @@ class CronUpdateStage implements CronInterface {
return $mode ?: static::SECURITY;
}
+ /**
+ * Gets the drush path.
+ *
+ * @return string
+ * The drush path.
+ *
+ * @throws \Exception
+ * Thrown if drush is not available.
+ *
+ * @todo Remove in https://drupal.org/i/3360485.
+ */
+ public function getDrushPath(): string {
+ // For some reason 'vendor/bin/drush' does not exist in build tests but this
+ // method will be removed entirely before beta.
+ $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
+ if (!file_exists($drush_path)) {
+ throw new \Exception("Drush is not available at $drush_path.");
+ }
+ return $drush_path;
+ }
+
}
--
GitLab
From a62364a0605f2032fc4e09b803a0777dc5a472ab Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 20 Jul 2023 14:54:33 -0400
Subject: [PATCH 089/142] add todo to rename CronUpdateRunner
---
src/CronUpdateStage.php | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 37e20ca652..badce9df14 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -12,9 +12,10 @@ use Symfony\Component\Process\PhpExecutableFinder;
use Symfony\Component\Process\Process;
/**
- * Defines a service that updates via cron.
+ * Defines a service runs updates during cron.
*
- * @todo Rename this class to CronUpdateRunner because it is not longer a stage.
+ * @todo Rename this class to CronUpdateRunner because it is no longer a stage
+ * in https://drupal.org/i/3375940.
*
* @internal
* This class implements logic specific to Automatic Updates' cron hook
--
GitLab
From 03234920a76235a085c39b3914ecc15dcc60c607 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 20 Jul 2023 15:36:08 -0400
Subject: [PATCH 090/142] check for drush warning
---
tests/src/Functional/StatusCheckTest.php | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index e939148890..23f25861bc 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -262,7 +262,21 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->drupalGet('admin/reports/status');
$this->assertNoErrors();
$this->drupalGet(Url::fromRoute($admin_route));
- $assert->elementNotExists('css', $messages_section_selector);
+
+ // @todo Replace this with asserts the $messages_section_selector does not
+ // exist in https://drupal.org/i/3360485.
+ $assert_no_status_check_messages = function () use ($admin_route, $messages_section_selector, $assert) {
+ // @todo Remove in https://drupal.org/i/3360485.
+ if ($admin_route === 'update.settings') {
+ $assert->statusMessageContains('Drush is required for unattended updates.', 'warning');
+ // Ensure there are no other errors or warnings.
+ $assert->elementTextEquals('css', $messages_section_selector, 'Warning message Drush is required for unattended updates.');
+ }
+ else {
+ $assert->elementNotExists('css', $messages_section_selector);
+ }
+ };
+ $assert_no_status_check_messages();
// Confirm a user without the permission to run status checks does not have
// a link to run the checks when the checks need to be run again.
@@ -274,7 +288,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
// A user without the permission to run the checkers will not see a message
// on other pages if the checkers need to be run again.
$this->drupalGet(Url::fromRoute($admin_route));
- $assert->elementNotExists('css', $messages_section_selector);
+ $assert_no_status_check_messages();
// Confirm that a user with the correct permission can also run the checkers
// on another admin page.
--
GitLab
From d3421d7f0df7bf7d33fd0c4dd3cb6b899cae3cd2 Mon Sep 17 00:00:00 2001
From: Adam G-H <32250-phenaproxima@users.noreply.drupalcode.org>
Date: Fri, 21 Jul 2023 18:16:06 +0000
Subject: [PATCH 091/142] Apply a few suggestions.
---
automatic_updates.install | 2 +-
automatic_updates.services.yml | 2 +-
src/DrushUpdateStage.php | 14 +++++---------
tests/src/Build/CoreUpdateTest.php | 4 +---
tests/src/Build/UpdateTestBase.php | 2 +-
5 files changed, 9 insertions(+), 15 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index fae0ad608a..e9b0898720 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -57,7 +57,7 @@ function automatic_updates_requirements($phase) {
try {
$cron_update_stage->getDrushPath();
}
- catch (Exception $exception) {
+ catch (Exception) {
$requirements['automatic_updates_drush_missing'] = [
'title' => t('Automatic Updates Drush Requirement'),
'severity' => SystemManager::REQUIREMENT_ERROR,
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 55dac36e4f..94f0a64997 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -67,7 +67,7 @@ services:
arguments:
$committer: '@Drupal\automatic_updates\MaintenanceModeAwareCommitter'
calls:
- - [ 'setLogger', [ '@logger.channel.automatic_updates' ] ]
+ - ['setLogger', ['@logger.channel.automatic_updates']]
Drupal\automatic_updates\MaintenanceModeAwareCommitter:
tags:
- { name: event_subscriber }
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index fe8545e052..44bba9cb2c 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -343,15 +343,11 @@ class DrushUpdateStage extends UpdateStage {
* The target version.
*/
private function setProcessStatus(string $start_version, string $target_version): void {
- $pid = getmypid();
- $this->state->set(
- 'automatic_updates.console_stage_status',
- [
- 'pid' => $pid,
- 'start_version' => $start_version,
- 'target_version' => $target_version,
- ],
- );
+ $this->state->set('automatic_updates.console_stage_status', [
+ 'pid' => getmypid(),
+ 'start_version' => $start_version,
+ 'target_version' => $target_version,
+ ]);
}
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index a9e8227d83..08501ea0ad 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -160,9 +160,7 @@ class CoreUpdateTest extends UpdateTestBase {
$this->installModules(['automated_cron']);
$this->visit('/automatic-updates-test-api/reset-cron');
- $mink = $this->getMink();
- $assert_session = $mink->assertSession();
- $assert_session->pageTextContains('cron reset');
+ $this->getMink()->assertSession()->pageTextContains('cron reset');
$this->assertCronUpdateSuccessful();
}
diff --git a/tests/src/Build/UpdateTestBase.php b/tests/src/Build/UpdateTestBase.php
index de359a56cd..a1f6b7befe 100644
--- a/tests/src/Build/UpdateTestBase.php
+++ b/tests/src/Build/UpdateTestBase.php
@@ -31,7 +31,7 @@ END;
]);
// Uninstall Automated Cron because this will run cron updates on most
- // requests making it difficult to test other forms of updating.
+ // requests, making it difficult to test other forms of updating.
// Also uninstall Big Pipe, since it may cause page elements to be rendered
// in the background and replaced with JavaScript, which isn't supported in
// build tests.
--
GitLab
From 3d1343cb05aa981d70ab5d19a390e2e9c7318531 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 21 Jul 2023 14:21:33 -0400
Subject: [PATCH 092/142] Inject the lock backend, and make
runTerminalUpdateCommand protected
---
automatic_updates.services.yml | 1 +
src/CronUpdateStage.php | 11 +++++++----
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 2 +-
3 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 94f0a64997..32005af50e 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -28,6 +28,7 @@ services:
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
arguments:
+ $lock: '@lock'
$inner: '@automatic_updates.cron_update_stage.inner'
decorates: 'cron'
Drupal\automatic_updates\CronUpdateStage: '@automatic_updates.cron_update_stage'
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index badce9df14..6b16444503 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -6,6 +6,7 @@ namespace Drupal\automatic_updates;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
+use Drupal\Core\Lock\LockBackendInterface;
use Drupal\package_manager\PathLocator;
use Psr\Log\LoggerAwareTrait;
use Symfony\Component\Process\PhpExecutableFinder;
@@ -62,19 +63,22 @@ class CronUpdateStage implements CronInterface {
* The config factory service.
* @param \Drupal\package_manager\PathLocator $pathLocator
* The path locator service.
+ * @param \Drupal\Core\Lock\LockBackendInterface $lock
+ * The lock service.
* @param \Drupal\Core\CronInterface $inner
* The decorated cron service.
*/
public function __construct(
private readonly ConfigFactoryInterface $configFactory,
private readonly PathLocator $pathLocator,
+ private readonly LockBackendInterface $lock,
private readonly CronInterface $inner
) {}
/**
* Runs the terminal update command.
*/
- public function runTerminalUpdateCommand(): void {
+ protected function runTerminalUpdateCommand(): void {
$drush_path = $this->getDrushPath();
$phpBinaryFinder = new PhpExecutableFinder();
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
@@ -121,10 +125,9 @@ class CronUpdateStage implements CronInterface {
// ahead and try to do the update. In all other circumstances, just run the
// normal cron handler.
if ($method === 'web' && !self::isCommandLine()) {
- $lock = \Drupal::lock();
- if ($lock->acquire('cron', 30)) {
+ if ($this->lock->acquire('cron', 30)) {
$this->runTerminalUpdateCommand();
- $lock->release('cron');
+ $this->lock->release('cron');
}
}
return $inner_success;
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index d8c5e6a5d0..6be4599807 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -116,7 +116,7 @@ class TestCronUpdateStage extends CronUpdateStage {
/**
* {@inheritdoc}
*/
- public function runTerminalUpdateCommand(): void {
+ protected function runTerminalUpdateCommand(): void {
// Invoking the terminal command will not work and is not necessary in
// kernel tests. Throw an exception for tests that need to assert that
// the terminal command would have been invoked.
--
GitLab
From 73153599fa57f8498504cf4eeac9d189e7fd988e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 21 Jul 2023 14:25:25 -0400
Subject: [PATCH 093/142] Remove use of watchdog_exception()
---
src/CronUpdateStage.php | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 6b16444503..554b9e9e2a 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -7,8 +7,11 @@ namespace Drupal\automatic_updates;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
use Drupal\Core\Lock\LockBackendInterface;
+use Drupal\Core\Utility\Error;
use Drupal\package_manager\PathLocator;
+use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
+use Psr\Log\NullLogger;
use Symfony\Component\Process\PhpExecutableFinder;
use Symfony\Component\Process\Process;
@@ -24,7 +27,7 @@ use Symfony\Component\Process\Process;
* It should not be called directly, and external code should not interact
* with it.
*/
-class CronUpdateStage implements CronInterface {
+class CronUpdateStage implements CronInterface, LoggerAwareInterface {
use LoggerAwareTrait;
@@ -73,7 +76,9 @@ class CronUpdateStage implements CronInterface {
private readonly PathLocator $pathLocator,
private readonly LockBackendInterface $lock,
private readonly CronInterface $inner
- ) {}
+ ) {
+ $this->setLogger(new NullLogger());
+ }
/**
* Runs the terminal update command.
@@ -94,9 +99,8 @@ class CronUpdateStage implements CronInterface {
while (is_null($process->getPid()) && $wait_till > time()) {
}
}
-
catch (\Throwable $throwable) {
- watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
+ Error::logException($this->logger, $throwable, 'Unable to start background update.');
}
}
--
GitLab
From 85b4732eef9a0bdfc2bd10a1807884386c90d825 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 21 Jul 2023 14:27:32 -0400
Subject: [PATCH 094/142] Remove cron_port from test
---
package_manager/tests/src/Build/TemplateProjectTestBase.php | 1 -
1 file changed, 1 deletion(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index 955813ab86..75445df66c 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -361,7 +361,6 @@ END;
$port = $this->findAvailablePort();
$this->metadataServer = $this->instantiateServer($port);
$code = <<<END
-\$config['automatic_updates.settings']['cron_port'] = $port;
\$config['update.settings']['fetch']['url'] = 'http://localhost:$port/test-release-history';
END;
$this->writeSettings($code);
--
GitLab
From b640e58cdceb566b5a366b12934d01bba51957bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 21 Jul 2023 14:29:49 -0400
Subject: [PATCH 095/142] Inject time service into AutomaticUpdatesCommands
---
src/Commands/AutomaticUpdatesCommands.php | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 086119a124..9758b30267 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -8,6 +8,7 @@ use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\StatusCheckMailer;
use Drupal\automatic_updates\Validation\StatusChecker;
+use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drush\Commands\DrushCommands;
@@ -37,6 +38,8 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* The status check mailer service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
* The config factory service.
+ * @param \Drupal\Component\Datetime\TimeInterface $time
+ * The time service.
*/
public function __construct(
private readonly CronUpdateStage $cronUpdateRunner,
@@ -44,6 +47,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
private readonly StatusChecker $statusChecker,
private readonly StatusCheckMailer $statusCheckMailer,
private readonly ConfigFactoryInterface $configFactory,
+ private readonly TimeInterface $time,
) {
parent::__construct();
}
@@ -113,7 +117,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
$last_run_time = $this->statusChecker->getLastRunTime();
// Do not run status checks more than once an hour unless there are no results
// available.
- $needs_run = $last_results === NULL || !$last_run_time || \Drupal::time()->getRequestTime() - $last_run_time > 3600;
+ $needs_run = $last_results === NULL || !$last_run_time || $this->time->getRequestTime() - $last_run_time > 3600;
// To ensure consistent results, only run the status checks if we're
// explicitly configured to do unattended updates on the command line.
--
GitLab
From ad60854e413e623bd7019ccb223eb0a124a8165e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 21 Jul 2023 16:11:06 -0400
Subject: [PATCH 096/142] Moar minor changes I asked for
---
src/Commands/AutomaticUpdatesCommands.php | 2 +-
src/CronUpdateStage.php | 8 ++++----
tests/src/Build/CoreUpdateTest.php | 14 ++++++--------
.../src/Functional/StatusCheckFailureEmailTest.php | 3 ++-
4 files changed, 13 insertions(+), 14 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 9758b30267..5816638da3 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -62,7 +62,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* @option $stage-id Internal use only.
* @option $from-version Internal use only.
* @option $to-version Internal use only.
- * @option $is-from-web Whether the request was triggered from the web.
+ * @option $is-from-web Internal use only.
*
* @command auto-update
*
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 554b9e9e2a..b163812055 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -118,12 +118,12 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
* {@inheritdoc}
*/
public function run() {
- $method = $this->configFactory->get('automatic_updates.settings')
- ->get('unattended.method');
// Always run the cron service before we trigger the update terminal
// command.
- $inner_success = $this->inner->run();
+ $decorated_cron_succeeded = $this->inner->run();
+ $method = $this->configFactory->get('automatic_updates.settings')
+ ->get('unattended.method');
// If we are configured to run updates via the web, and we're actually being
// accessed via the web (i.e., anything that isn't the command line), go
// ahead and try to do the update. In all other circumstances, just run the
@@ -134,7 +134,7 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
$this->lock->release('cron');
}
}
- return $inner_success;
+ return $decorated_cron_succeeded;
}
/**
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 08501ea0ad..a85756c56e 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -208,13 +208,11 @@ class CoreUpdateTest extends UpdateTestBase {
$this->assertStringNotContainsString('Symlinking', $output);
$this->visit('/admin/reports/status');
- $mink = $this->getMink();
- $page = $mink->getSession()->getPage();
- $page->clickLink('Run cron');
- $cron_run_status_code = $mink->getSession()->getStatusCode();
+ $session = $this->getMink()->getSession();
+ $session->getPage()->clickLink('Run cron');
+ $this->assertSame(200, $session->getStatusCode());
$this->assertCronUpdateSuccessful();
- $this->assertSame(200, $cron_run_status_code);
}
/**
@@ -388,11 +386,11 @@ class CoreUpdateTest extends UpdateTestBase {
sleep(5);
$this->visit('/admin/reports/status');
// Ensure the console update process has started.
- $current_update_requirement_text = 'There is currently a background update running to update to Drupal core to 9.8.1';
- $assert_session->pageTextContains($current_update_requirement_text);
+ $update_in_progress_text = 'There is currently a background update running to update to Drupal core to 9.8.1';
+ $assert_session->pageTextContains($update_in_progress_text);
$max_wait = time() + 360;
// Wait a maximum of 6 minutes for the console update process to finish.
- while ($max_wait > time() && str_contains($page->getText(), $current_update_requirement_text)) {
+ while ($max_wait > time() && str_contains($page->getText(), $update_in_progress_text)) {
sleep(5);
$this->visit('/admin/reports/status');
}
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 96e3379bc5..a1d2de6ab1 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -236,7 +236,8 @@ END;
*/
private function runConsoleUpdateCommand(): void {
static $total_delay = 0;
- // Delay the run so status checks will run.
+ // Status checks don't run more than once an hour, so pretend that 61
+ // minutes have elapsed since the last run.
$total_delay += 61;
TestTime::setFakeTimeByOffset("+$total_delay minutes");
$this->drush('auto-update');
--
GitLab
From 439a6c0e254afe5f5917213b85a443166de91254 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 09:35:54 -0400
Subject: [PATCH 097/142] Change to getCommandPath
---
automatic_updates.install | 2 +-
automatic_updates.module | 2 +-
src/CronUpdateStage.php | 20 ++++++++++----------
3 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index e9b0898720..75654fbf4d 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -55,7 +55,7 @@ function automatic_updates_requirements($phase) {
$cron_update_stage = \Drupal::service('automatic_updates.cron_update_stage');
if ($cron_update_stage->getMode() !== CronUpdateStage::DISABLED) {
try {
- $cron_update_stage->getDrushPath();
+ $cron_update_stage->getCommandPath();
}
catch (Exception) {
$requirements['automatic_updates_drush_missing'] = [
diff --git a/automatic_updates.module b/automatic_updates.module
index 942da9af41..8d749899e1 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -233,7 +233,7 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
try {
/** @var \Drupal\automatic_updates\CronUpdateStage $cron_update_stage */
$cron_update_stage = \Drupal::service('automatic_updates.cron_update_stage');
- $cron_update_stage->getDrushPath();
+ $cron_update_stage->getCommandPath();
}
catch (Exception) {
\Drupal::messenger()->addWarning('Drush is required for unattended updates.');
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index b163812055..02bebb4574 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -84,9 +84,9 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
* Runs the terminal update command.
*/
protected function runTerminalUpdateCommand(): void {
- $drush_path = $this->getDrushPath();
+ $command_path = $this->getCommandPath();
$phpBinaryFinder = new PhpExecutableFinder();
- $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $drush_path auto-update --is-from-web &");
+ $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $command_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
$process->disableOutput();
$process->setTimeout(0);
@@ -155,24 +155,24 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
}
/**
- * Gets the drush path.
+ * Gets the command path.
*
* @return string
- * The drush path.
+ * The command path.
*
* @throws \Exception
- * Thrown if drush is not available.
+ * Thrown if command path does not exist.
*
* @todo Remove in https://drupal.org/i/3360485.
*/
- public function getDrushPath(): string {
+ public function getCommandPath(): string {
// For some reason 'vendor/bin/drush' does not exist in build tests but this
// method will be removed entirely before beta.
- $drush_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
- if (!file_exists($drush_path)) {
- throw new \Exception("Drush is not available at $drush_path.");
+ $command_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
+ if (!file_exists($command_path)) {
+ throw new \Exception("The Automatic Update terminal command is not available at $command_path.");
}
- return $drush_path;
+ return $command_path;
}
}
--
GitLab
From dbfa136439cf512934468b95e93d6e0ecd65f6e5 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 10:23:57 -0400
Subject: [PATCH 098/142] review from phenaproxima
---
src/Commands/AutomaticUpdatesCommands.php | 4 +-
src/DrushUpdateStage.php | 47 +++++++++----------
.../src/ApiController.php | 2 +-
tests/src/Build/CoreUpdateTest.php | 3 ++
.../StatusCheckFailureEmailTest.php | 2 +-
tests/src/Functional/StatusCheckTest.php | 4 +-
tests/src/Kernel/CronUpdateStageTest.php | 7 ---
7 files changed, 31 insertions(+), 38 deletions(-)
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 5816638da3..191b9dab80 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -20,8 +20,8 @@ use Drush\Commands\DrushCommands;
* at any time without warning. It should not be called directly, and external
* code should not interact with it.
*
- * @todo Either remove this command completely or make it just call the new
- * Symfony Console command that will be added in https://drupal.org/i/3360485.
+ * @todo Remove this class when switching to a Symfony Console command in
+ * https://drupal.org/i/3360485.
*/
final class AutomaticUpdatesCommands extends DrushCommands {
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index 44bba9cb2c..d3e53fa520 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -34,6 +34,11 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
*/
class DrushUpdateStage extends UpdateStage {
+ /**
+ * The state key under which to store the data about the process status.
+ */
+ private const PROCESS_STATE_KEY = 'automatic_updates.console_stage_status';
+
/**
* Constructs a DrushUpdateStage object.
*
@@ -107,12 +112,12 @@ class DrushUpdateStage extends UpdateStage {
*/
final public function begin(array $project_versions, ?int $timeout = 300): never {
// Unattended updates should never be started using this method. They should
- // only be done by ::handleCron(), which has a strong opinion about which
- // release to update to. Throwing an exception here is just to enforce this
- // boundary. To update to a specific version of core, use
- // \Drupal\automatic_updates\UpdateStage::begin() (which is called in
- // ::performUpdate() to start the update to the target version of core
- // chosen by ::handleCron()).
+ // only be done by ::performUpdate(), which has a strong opinion about which
+ // release to update to and will call ::setProcessStatus(). Throwing an
+ // exception here is just to enforce this boundary. To update to a specific
+ // version of core, use \Drupal\automatic_updates\UpdateStage::begin()
+ // (which is called in::performUpdate() to start the update to the target
+ // version of core chosen by ::getTargetRelease()).
throw new \BadMethodCallException(__METHOD__ . '() cannot be called directly.');
}
@@ -168,7 +173,13 @@ class DrushUpdateStage extends UpdateStage {
// stage regardless of whether the update succeeds.
try {
$update_started = TRUE;
- $this->setProcessStatus($installed_version, $target_version);
+ // Store the process information.
+ // @see ::getProcessStatus()
+ $this->state->set(self::PROCESS_STATE_KEY, [
+ 'pid' => getmypid(),
+ 'start_version' => $installed_version,
+ 'target_version' => $target_version,
+ ]);
// @see ::begin()
$stage_id = parent::begin(['drupal' => $target_version], 300);
$this->stage();
@@ -323,31 +334,17 @@ class DrushUpdateStage extends UpdateStage {
* - (string) target_version: The target version of the update.
*/
public function getProcessStatus(): ?array {
- $process_status = $this->state->get('automatic_updates.console_stage_status');
+ $process_status = $this->state->get(self::PROCESS_STATE_KEY);
if ($process_status) {
$process_group = posix_getpgid($process_status['pid']);
if (is_int($process_group)) {
return $process_status;
}
- $this->state->delete('automatic_updates.console_stage_status');
+ // If no process group was found then the process running update is no
+ // longer running, and we can remove the data from the state.
+ $this->state->delete(self::PROCESS_STATE_KEY);
}
return NULL;
}
- /**
- * Sets the update process status.
- *
- * @param string $start_version
- * The start version.
- * @param string $target_version
- * The target version.
- */
- private function setProcessStatus(string $start_version, string $target_version): void {
- $this->state->set('automatic_updates.console_stage_status', [
- 'pid' => getmypid(),
- 'start_version' => $start_version,
- 'target_version' => $target_version,
- ]);
- }
-
}
diff --git a/tests/modules/automatic_updates_test_api/src/ApiController.php b/tests/modules/automatic_updates_test_api/src/ApiController.php
index 18003aabf1..8d99628226 100644
--- a/tests/modules/automatic_updates_test_api/src/ApiController.php
+++ b/tests/modules/automatic_updates_test_api/src/ApiController.php
@@ -37,7 +37,7 @@ class ApiController extends PackageManagerApiController {
}
/**
- * Resets cron.
+ * Deletes last cron run time, so Automated Cron will run during this request.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response.
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index a85756c56e..b45eb3d2e6 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -159,6 +159,9 @@ class CoreUpdateTest extends UpdateTestBase {
$this->assertStringNotContainsString('Symlinking', $output);
$this->installModules(['automated_cron']);
+ // Reset the record of the last cron run, so we do not have to wait for
+ // Automated Cron to trigger cron again. Automated Cron will be triggered
+ // at the end of this request.
$this->visit('/automatic-updates-test-api/reset-cron');
$this->getMink()->assertSession()->pageTextContains('cron reset');
$this->assertCronUpdateSuccessful();
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index a1d2de6ab1..1ae4457e40 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -232,7 +232,7 @@ END;
}
/**
- * Runs the console update command.
+ * Runs the console update command which will trigger the status checks.
*/
private function runConsoleUpdateCommand(): void {
static $total_delay = 0;
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 23f25861bc..513f88e6bd 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -268,8 +268,8 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$assert_no_status_check_messages = function () use ($admin_route, $messages_section_selector, $assert) {
// @todo Remove in https://drupal.org/i/3360485.
if ($admin_route === 'update.settings') {
- $assert->statusMessageContains('Drush is required for unattended updates.', 'warning');
- // Ensure there are no other errors or warnings.
+ // Ensure there is warning about missing Drush and no other errors or
+ // warnings.
$assert->elementTextEquals('css', $messages_section_selector, 'Warning message Drush is required for unattended updates.');
}
else {
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index 7dc6e4cbc2..7a8cbf668e 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -5,9 +5,6 @@ declare(strict_types = 1);
namespace Drupal\Tests\automatic_updates\Kernel;
use Drupal\automatic_updates\CronUpdateStage;
-use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
-use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
-use Drupal\Tests\user\Traits\UserCreationTrait;
/**
* @coversDefaultClass \Drupal\automatic_updates\CronUpdateStage
@@ -16,10 +13,6 @@ use Drupal\Tests\user\Traits\UserCreationTrait;
*/
class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
- use EmailNotificationsTestTrait;
- use PackageManagerBypassTestTrait;
- use UserCreationTrait;
-
/**
* {@inheritdoc}
*/
--
GitLab
From 82230bd47bc630b88a7da47e5298805e1513c2e7 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 10:46:01 -0400
Subject: [PATCH 099/142] only wait for process to start in automated cron
---
tests/src/Build/CoreUpdateTest.php | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index b45eb3d2e6..f80e054fab 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -164,6 +164,10 @@ class CoreUpdateTest extends UpdateTestBase {
// at the end of this request.
$this->visit('/automatic-updates-test-api/reset-cron');
$this->getMink()->assertSession()->pageTextContains('cron reset');
+ // Because Automated Cron triggers cron during the kernel terminate event
+ // which happens after the response is returned, wait a few seconds for the
+ // process to be started during the event.
+ sleep(5);
$this->assertCronUpdateSuccessful();
}
@@ -384,18 +388,21 @@ class CoreUpdateTest extends UpdateTestBase {
$mink = $this->getMink();
$assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
-
- // Wait for console update process to start.
- sleep(5);
$this->visit('/admin/reports/status');
+
// Ensure the console update process has started.
$update_in_progress_text = 'There is currently a background update running to update to Drupal core to 9.8.1';
$assert_session->pageTextContains($update_in_progress_text);
$max_wait = time() + 360;
// Wait a maximum of 6 minutes for the console update process to finish.
- while ($max_wait > time() && str_contains($page->getText(), $update_in_progress_text)) {
- sleep(5);
+ while ($max_wait > time()) {
+ sleep(10);
$this->visit('/admin/reports/status');
+ if (!str_contains($page->getText(), $update_in_progress_text)) {
+ // If the $update_in_progress_text message is no longer on the status
+ // report page the update has completed.
+ break;
+ }
}
$this->assertExpectedStageEventsFired(DrushUpdateStage::class);
--
GitLab
From 20eab37f074b059d4d6256a20a09b2f286116f98 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 11:51:39 -0400
Subject: [PATCH 100/142] create waitForCronUpdateToComplete
---
tests/src/Build/CoreUpdateTest.php | 21 +++++++++++++++------
1 file changed, 15 insertions(+), 6 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index f80e054fab..90deea3d94 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -237,9 +237,7 @@ class CoreUpdateTest extends UpdateTestBase {
$this->visit('/admin/reports/status');
$assert_session->pageTextContains('Your site is ready for automatic updates.');
$page->clickLink('Run cron');
- // @todo Make a dynamic wait system in this test because the update will
- // still be happening in the background.
- sleep(120);
+ $this->waitForCronUpdateToComplete();
$this->assertUpdateSuccessful('9.8.1');
}
@@ -382,9 +380,9 @@ class CoreUpdateTest extends UpdateTestBase {
}
/**
- * Assert a cron update ran successfully.
+ * Waits for a cron update to complete to by checking the status report.
*/
- protected function assertCronUpdateSuccessful(): void {
+ private function waitForCronUpdateToComplete(): void {
$mink = $this->getMink();
$assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
@@ -401,9 +399,20 @@ class CoreUpdateTest extends UpdateTestBase {
if (!str_contains($page->getText(), $update_in_progress_text)) {
// If the $update_in_progress_text message is no longer on the status
// report page the update has completed.
- break;
+ return;
}
}
+ $this->fail('Cron update did not completed after wait.');
+ }
+
+ /**
+ * Assert a cron update ran successfully.
+ */
+ private function assertCronUpdateSuccessful(): void {
+ $mink = $this->getMink();
+ $assert_session = $mink->assertSession();
+ $page = $mink->getSession()->getPage();
+ $this->waitForCronUpdateToComplete();
$this->assertExpectedStageEventsFired(DrushUpdateStage::class);
// There should be log messages, but no errors or warnings should have been
--
GitLab
From 139c6f7f5901fdf18637380db8005a25e20a5b50 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 13:34:55 -0400
Subject: [PATCH 101/142] remove 1 sec wait for process to start. Will this
break on drupalci?
---
src/CronUpdateStage.php | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 02bebb4574..006bdb6954 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -94,7 +94,6 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
try {
$process->start();
// Wait for the process to start.
- sleep(1);
$wait_till = time() + 5;
while (is_null($process->getPid()) && $wait_till > time()) {
}
--
GitLab
From e2cc8c9c3735d211d35756e66290cd55e8422aab Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 14:04:07 -0400
Subject: [PATCH 102/142] Move build test install drush to 1 location
---
tests/src/Build/CoreUpdateTest.php | 26 ++++++++++++--------------
1 file changed, 12 insertions(+), 14 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 90deea3d94..26eb2ed9dc 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -65,7 +65,7 @@ class CoreUpdateTest extends UpdateTestBase {
/**
* {@inheritdoc}
*/
- protected function createTestProject(string $template): void {
+ protected function createTestProject(string $template, bool $require_drush = FALSE): void {
parent::createTestProject($template);
// Prepare an "upstream" version of core, 9.8.1, to which we will update.
@@ -88,6 +88,13 @@ class CoreUpdateTest extends UpdateTestBase {
// Ensure that Drupal has write-protected the site directory.
$this->assertDirectoryIsNotWritable($this->getWebRoot() . '/sites/default');
+
+ // @todo Remove along with $require_drush parameter in
+ // https://drupal.org/i/3360485.
+ if ($require_drush) {
+ $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
+ $this->assertStringNotContainsString('Symlinking', $output);
+ }
}
/**
@@ -154,9 +161,7 @@ class CoreUpdateTest extends UpdateTestBase {
* Tests updating during cron using the Automated Cron module.
*/
public function testAutomatedCron(): void {
- $this->createTestProject('RecommendedProject');
- $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
- $this->assertStringNotContainsString('Symlinking', $output);
+ $this->createTestProject('RecommendedProject', TRUE);
$this->installModules(['automated_cron']);
// Reset the record of the last cron run, so we do not have to wait for
@@ -210,9 +215,7 @@ class CoreUpdateTest extends UpdateTestBase {
* @dataProvider providerTemplate
*/
public function testCron(string $template): void {
- $this->createTestProject($template);
- $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
- $this->assertStringNotContainsString('Symlinking', $output);
+ $this->createTestProject($template, TRUE);
$this->visit('/admin/reports/status');
$session = $this->getMink()->getSession();
@@ -226,9 +229,7 @@ class CoreUpdateTest extends UpdateTestBase {
* Tests stage is destroyed if not available and site is on insecure version.
*/
public function testStageDestroyedIfNotAvailable(): void {
- $this->createTestProject('RecommendedProject');
- $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
- $this->assertStringNotContainsString('Symlinking', $output);
+ $this->createTestProject('RecommendedProject', TRUE);
$mink = $this->getMink();
$session = $mink->getSession();
$page = $session->getPage();
@@ -463,10 +464,7 @@ class CoreUpdateTest extends UpdateTestBase {
* Tests updating via Drush.
*/
public function testDrushUpdate(): void {
- $this->createTestProject('RecommendedProject');
-
- $output = $this->runComposer('COMPOSER_MIRROR_PATH_REPOS=1 composer require drush/drush', 'project');
- $this->assertStringNotContainsString('Symlinking', $output);
+ $this->createTestProject('RecommendedProject', TRUE);
$dir = $this->getWorkspaceDirectory() . '/project';
$command = [
--
GitLab
From 69952f12e3fa62f51959da78aa885c750d0bd7bf Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 14:07:56 -0400
Subject: [PATCH 103/142] address more reviews
---
automatic_updates.module | 1 +
src/Commands/AutomaticUpdatesCommands.php | 5 ++++-
src/CronUpdateStage.php | 10 +++++++++-
src/DrushUpdateStage.php | 3 +++
4 files changed, 17 insertions(+), 2 deletions(-)
diff --git a/automatic_updates.module b/automatic_updates.module
index 8d749899e1..408a984186 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -238,6 +238,7 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
catch (Exception) {
\Drupal::messenger()->addWarning('Drush is required for unattended updates.');
$form['unattended_level']['#disabled'] = TRUE;
+ $form['unattended_level']['#default_value'] = CronUpdateStage::DISABLED;
$form['unattended_method']['#disabled'] = TRUE;
}
$form['#submit'][] = '_automatic_updates_submit_update_settings';
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 191b9dab80..7fcaf88396 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -108,6 +108,9 @@ final class AutomaticUpdatesCommands extends DrushCommands {
/**
* Runs status checks, and sends failure notifications if necessary.
+ *
+ * @param bool $is_from_web
+ * Whether the current process was started from a web request.
*/
private function runStatusChecks(bool $is_from_web): void {
$method = $this->configFactory->get('automatic_updates.settings')
@@ -121,7 +124,7 @@ final class AutomaticUpdatesCommands extends DrushCommands {
// To ensure consistent results, only run the status checks if we're
// explicitly configured to do unattended updates on the command line.
- if ($needs_run && ($method === 'web' && $is_from_web) || $method === 'console') {
+ if ($needs_run && (($method === 'web' && $is_from_web) || $method === 'console')) {
$this->statusChecker->run();
// Only try to send failure notifications if unattended updates are
// enabled.
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 006bdb6954..13ef7021d2 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -16,7 +16,14 @@ use Symfony\Component\Process\PhpExecutableFinder;
use Symfony\Component\Process\Process;
/**
- * Defines a service runs updates during cron.
+ * Runs updates as a detached background process during cron after regular cron.
+ *
+ * The update process will be started in a detached process which will continue
+ * running after the web request has terminated. This is done after the
+ * decorated cron service has been called, so regular cron tasks will always be
+ * run regardless of whether there is an update available and whether an update
+ * is successful.
+ *
*
* @todo Rename this class to CronUpdateRunner because it is no longer a stage
* in https://drupal.org/i/3375940.
@@ -86,6 +93,7 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
protected function runTerminalUpdateCommand(): void {
$command_path = $this->getCommandPath();
$phpBinaryFinder = new PhpExecutableFinder();
+ // @todo Check if on windows to not allow cron updates.
$process = Process::fromShellCommandline($phpBinaryFinder->find() . " $command_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
$process->disableOutput();
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index d3e53fa520..984251a5b4 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -124,6 +124,9 @@ class DrushUpdateStage extends UpdateStage {
/**
* Performs the update.
*
+ * @param bool $is_from_web
+ * Whether the current process was started from a web request.
+ *
* @return bool
* Returns TRUE if any update was attempted, otherwise FALSE.
*/
--
GitLab
From 97a778455506330544564443cefd5e9f9edd3a2c Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 17:34:54 -0400
Subject: [PATCH 104/142] change wait in build test to rely on Available
Updates page
---
src/CronUpdateStage.php | 1 +
tests/src/Build/CoreUpdateTest.php | 23 +++++++++++++----------
2 files changed, 14 insertions(+), 10 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 13ef7021d2..c85c76f6a4 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -101,6 +101,7 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
try {
$process->start();
+ sleep(1);
// Wait for the process to start.
$wait_till = time() + 5;
while (is_null($process->getPid()) && $wait_till > time()) {
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 26eb2ed9dc..72b8bf609f 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -387,23 +387,26 @@ class CoreUpdateTest extends UpdateTestBase {
$mink = $this->getMink();
$assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
- $this->visit('/admin/reports/status');
+ $this->visit('/admin/reports/updates');
- // Ensure the console update process has started.
- $update_in_progress_text = 'There is currently a background update running to update to Drupal core to 9.8.1';
- $assert_session->pageTextContains($update_in_progress_text);
- $max_wait = time() + 360;
+ $assert_session->pageTextContains('Security update required');
// Wait a maximum of 6 minutes for the console update process to finish.
+ $max_wait = time() + 360;
while ($max_wait > time()) {
sleep(10);
- $this->visit('/admin/reports/status');
- if (!str_contains($page->getText(), $update_in_progress_text)) {
- // If the $update_in_progress_text message is no longer on the status
- // report page the update has completed.
+ $this->visit('/admin/reports/updates');
+ if (str_contains($page->getText(), 'Up to date')) {
+ // If we are up-to-date then the cron update has been applied but the
+ // post apply tasks may still be running. Wait a few seconds for them
+ // to complete.
+ sleep(10);
return;
}
+ // If we are not up-to-date then 'Security update required' should still
+ // show.
+ $assert_session->pageTextContains('Security update required');
}
- $this->fail('Cron update did not completed after wait.');
+ $this->fail('Cron update was completed within 6 minutes.');
}
/**
--
GitLab
From 9db15ca91af206147f5f65915b6cb770c924b563 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 26 Jul 2023 17:39:38 -0400
Subject: [PATCH 105/142] remove getProcessStatus
---
automatic_updates.install | 41 +++++++++++++--------------------------
src/DrushUpdateStage.php | 36 ----------------------------------
2 files changed, 13 insertions(+), 64 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index 75654fbf4d..085956e822 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -7,7 +7,6 @@
declare(strict_types = 1);
-use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\CronUpdateStage;
use Drupal\automatic_updates\Validation\StatusCheckRequirements;
use Drupal\system\SystemManager;
@@ -38,34 +37,20 @@ function automatic_updates_requirements($phase) {
'value' => t('Enabled. This is NOT an officially supported feature of the Automatic Updates module at this time. Use at your own risk.'),
];
}
- /** @var \Drupal\automatic_updates\DrushUpdateStage $console_stage */
- $console_stage = Drupal::service(DrushUpdateStage::class);
- if ($console_update_status = $console_stage->getProcessStatus()) {
- $requirements['automatic_updates_console_update_status'] = [
- 'title' => t('Automatic background updates'),
- 'severity' => SystemManager::REQUIREMENT_OK,
- 'value' => t(
- 'There is currently a background update running to update to Drupal core to %version',
- ['%version' => $console_update_status['target_version']]
- ),
- ];
- }
- else {
- /** @var \Drupal\automatic_updates\CronUpdateStage $cron_update_stage */
- $cron_update_stage = \Drupal::service('automatic_updates.cron_update_stage');
- if ($cron_update_stage->getMode() !== CronUpdateStage::DISABLED) {
- try {
- $cron_update_stage->getCommandPath();
- }
- catch (Exception) {
- $requirements['automatic_updates_drush_missing'] = [
- 'title' => t('Automatic Updates Drush Requirement'),
- 'severity' => SystemManager::REQUIREMENT_ERROR,
- 'value' => t('Drush is require for unattended updates'),
- ];
- }
- }
+ /** @var \Drupal\automatic_updates\CronUpdateStage $cron_update_stage */
+ $cron_update_stage = \Drupal::service('automatic_updates.cron_update_stage');
+ if ($cron_update_stage->getMode() !== CronUpdateStage::DISABLED) {
+ try {
+ $cron_update_stage->getCommandPath();
+ }
+ catch (Exception) {
+ $requirements['automatic_updates_drush_missing'] = [
+ 'title' => t('Automatic Updates Drush Requirement'),
+ 'severity' => SystemManager::REQUIREMENT_ERROR,
+ 'value' => t('Drush is require for unattended updates'),
+ ];
+ }
}
return $requirements;
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index 984251a5b4..bffb59c2ae 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -34,11 +34,6 @@ use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
*/
class DrushUpdateStage extends UpdateStage {
- /**
- * The state key under which to store the data about the process status.
- */
- private const PROCESS_STATE_KEY = 'automatic_updates.console_stage_status';
-
/**
* Constructs a DrushUpdateStage object.
*
@@ -176,13 +171,6 @@ class DrushUpdateStage extends UpdateStage {
// stage regardless of whether the update succeeds.
try {
$update_started = TRUE;
- // Store the process information.
- // @see ::getProcessStatus()
- $this->state->set(self::PROCESS_STATE_KEY, [
- 'pid' => getmypid(),
- 'start_version' => $installed_version,
- 'target_version' => $target_version,
- ]);
// @see ::begin()
$stage_id = parent::begin(['drupal' => $target_version], 300);
$this->stage();
@@ -326,28 +314,4 @@ class DrushUpdateStage extends UpdateStage {
return new Response();
}
- /**
- * Gets the update process status.
- *
- * @return array|null
- * The update process status, or NULL if no update process is active. If the
- * update process is active the array keys will be:
- * - (int) pid: The process ID.
- * - (string) start_version: The start version of the update.
- * - (string) target_version: The target version of the update.
- */
- public function getProcessStatus(): ?array {
- $process_status = $this->state->get(self::PROCESS_STATE_KEY);
- if ($process_status) {
- $process_group = posix_getpgid($process_status['pid']);
- if (is_int($process_group)) {
- return $process_status;
- }
- // If no process group was found then the process running update is no
- // longer running, and we can remove the data from the state.
- $this->state->delete(self::PROCESS_STATE_KEY);
- }
- return NULL;
- }
-
}
--
GitLab
From ba0fa7f2eea8d2b70ef21e0cab665b39d96f1161 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Thu, 27 Jul 2023 09:39:49 -0400
Subject: [PATCH 106/142] make compatible with 10.0.x
---
src/CronUpdateStage.php | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index c85c76f6a4..e01132b438 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -108,7 +108,14 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
}
}
catch (\Throwable $throwable) {
- Error::logException($this->logger, $throwable, 'Unable to start background update.');
+ // @todo Just call Error::logException() in https://drupal.org/i/3377458.
+ if (method_exists(Error::class, 'logException')) {
+ Error::logException($this->logger, $throwable, 'Unable to start background update.');
+ }
+ else {
+ watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
+ }
+
}
}
--
GitLab
From 4805e74ca2d4512aa869ae628d10f8621e560497 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 11:15:42 -0400
Subject: [PATCH 107/142] for build test after cron update wait for update form
to show no update available
---
drupalci.yml | 25 +------------------------
tests/src/Build/CoreUpdateTest.php | 27 +++++++++++++++------------
2 files changed, 16 insertions(+), 36 deletions(-)
diff --git a/drupalci.yml b/drupalci.yml
index 3cd1b3cc07..aced7db924 100644
--- a/drupalci.yml
+++ b/drupalci.yml
@@ -20,33 +20,10 @@ build:
# halt-on-fail can be set on the run_tests tasks in order to fail fast.
# suppress-deprecations is false in order to be alerted to usages of
# deprecated code.
- run_tests.phpunit:
- types: 'PHPUnit-Unit'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
- run_tests.kernel:
- types: 'PHPUnit-Kernel'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
run_tests.build:
# Limit concurrency due to disk space concerns.
concurrency: 15
types: 'PHPUnit-Build'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
- run_tests.functional:
- types: 'PHPUnit-Functional'
- testgroups: '--all'
- suppress-deprecations: false
- halt-on-fail: false
- # Functional JavaScript tests require a concurrency of 1 because there is
- # only one instance of PhantomJS on the testbot machine.
- run_tests.javascript:
- concurrency: 1
- types: 'PHPUnit-FunctionalJavascript'
- testgroups: '--all'
+ testgroups: '--class ""'
suppress-deprecations: false
halt-on-fail: false
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 72b8bf609f..884f8120d3 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -340,6 +340,12 @@ class CoreUpdateTest extends UpdateTestBase {
$this->visit('/admin/modules/update');
$this->getMink()->assertSession()->pageTextContains('No update available');
+ $session = $this->getMink()->getSession();
+ $assert_session = $this->getMink()->assertSession($session);
+ $this->visit('/admin/modules/update');
+ $assert_session->pageTextNotContains('Automatic updates failed to apply, and the site is in an indeterminate state. Consider restoring the code and database from a backup.');
+ $assert_session->pageTextContains('No update available');
+
// The status page should report that we're running the expected version and
// the README and default site configuration files should contain the
// placeholder text written by ::setUpstreamCoreVersion(), even though
@@ -387,24 +393,21 @@ class CoreUpdateTest extends UpdateTestBase {
$mink = $this->getMink();
$assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
- $this->visit('/admin/reports/updates');
-
- $assert_session->pageTextContains('Security update required');
+ sleep(10);
+ $this->visit('/admin/modules/update');
+ $update_in_progress_text = 'Cannot begin an update because another Composer operation is currently in progress.';
+ $assert_session->pageTextContains($update_in_progress_text);
// Wait a maximum of 6 minutes for the console update process to finish.
$max_wait = time() + 360;
while ($max_wait > time()) {
sleep(10);
- $this->visit('/admin/reports/updates');
- if (str_contains($page->getText(), 'Up to date')) {
- // If we are up-to-date then the cron update has been applied but the
- // post apply tasks may still be running. Wait a few seconds for them
- // to complete.
- sleep(10);
+ $this->visit('/admin/modules/update');
+ if (!str_contains($page->getText(), $update_in_progress_text)) {
+ // Ensure the request was not redirected.
+ $assert_session->addressEquals('/admin/modules/update');
+ $assert_session->pageTextContains('No update available');
return;
}
- // If we are not up-to-date then 'Security update required' should still
- // show.
- $assert_session->pageTextContains('Security update required');
}
$this->fail('Cron update was completed within 6 minutes.');
}
--
GitLab
From 683cbc117d8367027e483d52c0592b3c30ff2b5f Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 11:16:06 -0400
Subject: [PATCH 108/142] drupalci fix
---
drupalci.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drupalci.yml b/drupalci.yml
index aced7db924..0c83dc1896 100644
--- a/drupalci.yml
+++ b/drupalci.yml
@@ -24,6 +24,6 @@ build:
# Limit concurrency due to disk space concerns.
concurrency: 15
types: 'PHPUnit-Build'
- testgroups: '--class ""'
+ testgroups: '--all'
suppress-deprecations: false
halt-on-fail: false
--
GitLab
From 188d4a176813535a895d367093f15aba7c5d8348 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 13:44:03 -0400
Subject: [PATCH 109/142] wait on file being created instead of pinging the
site during the update.
---
.../src/EventSubscriber/EventLogSubscriber.php | 9 +++++++++
tests/src/Build/CoreUpdateTest.php | 18 ++++--------------
2 files changed, 13 insertions(+), 14 deletions(-)
diff --git a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
index 2f3e47cb8f..30586c0b23 100644
--- a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
+++ b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
@@ -28,6 +28,15 @@ final class EventLogSubscriber implements EventSubscriberInterface {
*/
public function logEventInfo(StageEvent $event): void {
\Drupal::logger('package_manager_test_event_logger')->info('package_manager_test_event_logger-start: Event: ' . get_class($event) . ', Stage instance of: ' . get_class($event->stage) . ':package_manager_test_event_logger-end');
+ if ($event instanceof PostDestroyEvent) {
+ // Add a file to indicate the end of the update.
+ /** @var \Drupal\package_manager\PathLocator $path_locator */
+ $path_locator = \Drupal::service('package_manager.path_locator');
+ file_put_contents(
+ $path_locator->getProjectRoot() . '/update-complete.txt',
+ "Update complete:" . get_class($event->stage)
+ );
+ }
}
/**
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 884f8120d3..8a478dcdbc 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -390,24 +390,14 @@ class CoreUpdateTest extends UpdateTestBase {
* Waits for a cron update to complete to by checking the status report.
*/
private function waitForCronUpdateToComplete(): void {
- $mink = $this->getMink();
- $assert_session = $mink->assertSession();
- $page = $mink->getSession()->getPage();
- sleep(10);
- $this->visit('/admin/modules/update');
- $update_in_progress_text = 'Cannot begin an update because another Composer operation is currently in progress.';
- $assert_session->pageTextContains($update_in_progress_text);
- // Wait a maximum of 6 minutes for the console update process to finish.
$max_wait = time() + 360;
+ // @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
+ $update_complete_file = $this->getWorkspaceDirectory() . '/project/update-complete.txt';
while ($max_wait > time()) {
- sleep(10);
- $this->visit('/admin/modules/update');
- if (!str_contains($page->getText(), $update_in_progress_text)) {
- // Ensure the request was not redirected.
- $assert_session->addressEquals('/admin/modules/update');
- $assert_session->pageTextContains('No update available');
+ if (file_exists($update_complete_file)) {
return;
}
+ sleep(20);
}
$this->fail('Cron update was completed within 6 minutes.');
}
--
GitLab
From 589ae0be055ceb5f2ef7b9c4a4baf4656f910030 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 14:00:10 -0400
Subject: [PATCH 110/142] undo drupalci changes
---
drupalci.yml | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/drupalci.yml b/drupalci.yml
index 0c83dc1896..3cd1b3cc07 100644
--- a/drupalci.yml
+++ b/drupalci.yml
@@ -20,6 +20,16 @@ build:
# halt-on-fail can be set on the run_tests tasks in order to fail fast.
# suppress-deprecations is false in order to be alerted to usages of
# deprecated code.
+ run_tests.phpunit:
+ types: 'PHPUnit-Unit'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
+ run_tests.kernel:
+ types: 'PHPUnit-Kernel'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
run_tests.build:
# Limit concurrency due to disk space concerns.
concurrency: 15
@@ -27,3 +37,16 @@ build:
testgroups: '--all'
suppress-deprecations: false
halt-on-fail: false
+ run_tests.functional:
+ types: 'PHPUnit-Functional'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
+ # Functional JavaScript tests require a concurrency of 1 because there is
+ # only one instance of PhantomJS on the testbot machine.
+ run_tests.javascript:
+ concurrency: 1
+ types: 'PHPUnit-FunctionalJavascript'
+ testgroups: '--all'
+ suppress-deprecations: false
+ halt-on-fail: false
--
GitLab
From 008e04998284007262b1642e871408e74a388608 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 14:57:03 -0400
Subject: [PATCH 111/142] keep track of how may stages have been destroyed for
build tests
---
.../src/EventSubscriber/EventLogSubscriber.php | 17 ++++++++++++++---
tests/src/Build/CoreUpdateTest.php | 18 +++++++++++++-----
2 files changed, 27 insertions(+), 8 deletions(-)
diff --git a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
index 30586c0b23..3dd1d2b685 100644
--- a/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
+++ b/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php
@@ -28,13 +28,24 @@ final class EventLogSubscriber implements EventSubscriberInterface {
*/
public function logEventInfo(StageEvent $event): void {
\Drupal::logger('package_manager_test_event_logger')->info('package_manager_test_event_logger-start: Event: ' . get_class($event) . ', Stage instance of: ' . get_class($event->stage) . ':package_manager_test_event_logger-end');
+
+ // Add a file that keeps track of how times a stage has been destroyed.
+ // @see \Drupal\Tests\automatic_updates\Build\CoreUpdateTest::waitForStageToBeDestroyed
if ($event instanceof PostDestroyEvent) {
- // Add a file to indicate the end of the update.
/** @var \Drupal\package_manager\PathLocator $path_locator */
$path_locator = \Drupal::service('package_manager.path_locator');
+ $stage_destroyed_file = $path_locator->getProjectRoot() . '/update-complete.txt';
+ if (file_exists($stage_destroyed_file)) {
+ $destroy_count = (int) file_get_contents($stage_destroyed_file);
+ $destroy_count++;
+ }
+ else {
+ $destroy_count = 1;
+ }
+ // Add a file to indicate the stage has been destroyed.
file_put_contents(
- $path_locator->getProjectRoot() . '/update-complete.txt',
- "Update complete:" . get_class($event->stage)
+ $stage_destroyed_file,
+ $destroy_count,
);
}
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 8a478dcdbc..c509a9a37c 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -238,7 +238,9 @@ class CoreUpdateTest extends UpdateTestBase {
$this->visit('/admin/reports/status');
$assert_session->pageTextContains('Your site is ready for automatic updates.');
$page->clickLink('Run cron');
- $this->waitForCronUpdateToComplete();
+ // Wait for the second stage to be destroyed because the stage created above
+ // will be destroyed to allow the cron update to proceed.
+ $this->waitForStageToBeDestroyed(2);
$this->assertUpdateSuccessful('9.8.1');
}
@@ -387,15 +389,21 @@ class CoreUpdateTest extends UpdateTestBase {
}
/**
- * Waits for a cron update to complete to by checking the status report.
+ * Waits for stage to be destroyed.
+ *
+ * @param int $expected_destroy_calls
+ * The number stages are expected to be destroyed.
*/
- private function waitForCronUpdateToComplete(): void {
+ private function waitForStageToBeDestroyed(int $expected_destroy_calls = 1): void {
$max_wait = time() + 360;
// @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
$update_complete_file = $this->getWorkspaceDirectory() . '/project/update-complete.txt';
while ($max_wait > time()) {
if (file_exists($update_complete_file)) {
- return;
+ $actual_destroy_calls = (int) file_get_contents($update_complete_file);
+ if ($actual_destroy_calls === $expected_destroy_calls) {
+ return;
+ }
}
sleep(20);
}
@@ -409,7 +417,7 @@ class CoreUpdateTest extends UpdateTestBase {
$mink = $this->getMink();
$assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
- $this->waitForCronUpdateToComplete();
+ $this->waitForStageToBeDestroyed();
$this->assertExpectedStageEventsFired(DrushUpdateStage::class);
// There should be log messages, but no errors or warnings should have been
--
GitLab
From 9457729d78125e4e5d2352673b9d8888512436dd Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 15:08:34 -0400
Subject: [PATCH 112/142] remove wait no longer needed in testAutomatedCron
---
tests/src/Build/CoreUpdateTest.php | 4 ----
1 file changed, 4 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index c509a9a37c..7b92544fee 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -169,10 +169,6 @@ class CoreUpdateTest extends UpdateTestBase {
// at the end of this request.
$this->visit('/automatic-updates-test-api/reset-cron');
$this->getMink()->assertSession()->pageTextContains('cron reset');
- // Because Automated Cron triggers cron during the kernel terminate event
- // which happens after the response is returned, wait a few seconds for the
- // process to be started during the event.
- sleep(5);
$this->assertCronUpdateSuccessful();
}
--
GitLab
From 20c16eb1740ca2027194ebf912c45ad584be2f02 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 16:09:39 -0400
Subject: [PATCH 113/142] address for reviews
---
.../src/Functional/StatusCheckFailureEmailTest.php | 5 ++++-
tests/src/Functional/StatusCheckTest.php | 2 +-
tests/src/Kernel/AutomaticUpdatesKernelTestBase.php | 10 ++++------
tests/src/Kernel/CronUpdateStageTest.php | 8 +++++---
.../StatusCheck/CronFrequencyValidatorTest.php | 13 +++++++------
5 files changed, 21 insertions(+), 17 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 1ae4457e40..27867a3750 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -109,7 +109,10 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
->setAbsolute()
->toString();
- $base = Url::fromUserInput('/')->setAbsolute()->toString();
+ // @todo For some reason Drush does not use the correct base path when
+ // creating the emails. Remove this workaround when the Drush dependency
+ // is removed in https://drupal.org/i/3360485.
+ $base = $this->buildUrl('');
$url = str_replace($base, 'http://default/', $url);
$expected_body = <<<END
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 513f88e6bd..8aa6ef2576 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -273,7 +273,7 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$assert->elementTextEquals('css', $messages_section_selector, 'Warning message Drush is required for unattended updates.');
}
else {
- $assert->elementNotExists('css', $messages_section_selector);
+ $assert->statusMessageNotExists();
}
};
$assert_no_status_check_messages();
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 6be4599807..8130145b5a 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -108,11 +108,6 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
*/
class TestCronUpdateStage extends CronUpdateStage {
- /**
- * Expected exception message if terminal command is invoked.
- */
- public const EXPECTED_TERMINAL_EXCEPTION = 'Expected exception: Terminal command will not work in kernel tests';
-
/**
* {@inheritdoc}
*/
@@ -120,7 +115,10 @@ class TestCronUpdateStage extends CronUpdateStage {
// Invoking the terminal command will not work and is not necessary in
// kernel tests. Throw an exception for tests that need to assert that
// the terminal command would have been invoked.
- throw new \Exception(static::EXPECTED_TERMINAL_EXCEPTION);
+ // @todo Determine if the terminal command can be run in kernel tests when
+ // the Drush dependency is removed in https://drupal.org/i/3360485.
+ // Drush\TestTraits\DrushTestTrait only works with functional tests.
+ throw new \BadMethodCallException(static::class);
}
}
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index 7a8cbf668e..211f748f12 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -41,7 +41,9 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertTrue(CronUpdateStage::isCommandLine());
// Since we're at the command line the terminal command should not be
- // invoked.
+ // invoked. Since we are in a kernel test if the terminal command were
+ // invoked it would throw an exception.
+ // @see \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage::runTerminalUpdateCommand
$this->container->get('cron')->run();
// Even though the terminal command was not invoked hook_cron
// implementations should have been invoked.
@@ -66,8 +68,8 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->container->get('cron')->run();
$this->fail('Expected process exception');
}
- catch (\Exception $e) {
- $this->assertSame(TestCronUpdateStage::EXPECTED_TERMINAL_EXCEPTION, $e->getMessage());
+ catch (\BadMethodCallException $e) {
+ $this->assertSame(TestCronUpdateStage::class, $e->getMessage());
}
// Even though the terminal command threw exception hook_cron
// implementations should have been invoked before this.
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 8d3008ae4d..8568ff88ed 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -115,13 +115,14 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
$this->container->get('cron')->run();
$this->fail('Expected failure');
}
- catch (\Exception $exception) {
- $this->assertSame(TestCronUpdateStage::EXPECTED_TERMINAL_EXCEPTION, $exception->getMessage());
+ catch (\BadMethodCallException $e) {
+ // The terminal command cannot be run in a kernel test.
+ $this->assertSame(TestCronUpdateStage::class, $e->getMessage());
+ // After running cron, any errors or warnings should be gone. Even though
+ // the terminal command did not succeed the system cron service should
+ // have been called.
+ $this->assertCheckerResultsFromManager([], TRUE);
}
- // After running cron, any errors or warnings should be gone. Even though
- // the terminal command did not succeed the system cron service should have
- // been called.
- $this->assertCheckerResultsFromManager([], TRUE);
}
}
--
GitLab
From 18811c50a679d5c9b8819bf583d0515cd9d9fd13 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 28 Jul 2023 16:39:26 -0400
Subject: [PATCH 114/142] test comments
---
tests/src/Functional/StatusCheckFailureEmailTest.php | 6 ++++++
tests/src/Functional/StatusCheckTest.php | 4 ++--
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 27867a3750..670f5d04de 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -87,6 +87,9 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
* The expected number of failure notifications that should have been sent.
*/
private function assertSentMessagesCount(int $expected_count): void {
+ // Since the terminal command that sent the emails does us the same
+ // container as this test we need to reset the state cache where to get the
+ // test data about the sent emails.
$this->container->get('state')->resetCache();
$sent_messages = $this->getMails([
'id' => 'automatic_updates_status_check_failed',
@@ -121,6 +124,9 @@ be able to receive automatic updates until further action is taken. Please
visit $url for more information.
END;
+ // Since the terminal command that sent the emails does us the same
+ // container as this test we need to reset the state cache where to get the
+ // test data about the sent emails.
$this->container->get('state')->resetCache();
$this->assertMessagesSent('Automatic updates readiness checks failed', $expected_body);
diff --git a/tests/src/Functional/StatusCheckTest.php b/tests/src/Functional/StatusCheckTest.php
index 8aa6ef2576..86225b5e28 100644
--- a/tests/src/Functional/StatusCheckTest.php
+++ b/tests/src/Functional/StatusCheckTest.php
@@ -263,8 +263,8 @@ class StatusCheckTest extends AutomaticUpdatesFunctionalTestBase {
$this->assertNoErrors();
$this->drupalGet(Url::fromRoute($admin_route));
- // @todo Replace this with asserts the $messages_section_selector does not
- // exist in https://drupal.org/i/3360485.
+ // @todo When removing the Drush dependency we should only need assert that
+ // no status messages appear at all in https://drupal.org/i/3360485.
$assert_no_status_check_messages = function () use ($admin_route, $messages_section_selector, $assert) {
// @todo Remove in https://drupal.org/i/3360485.
if ($admin_route === 'update.settings') {
--
GitLab
From 22781028572bfee5b4572a1057a6e2458857b252 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Tue, 1 Aug 2023 14:38:07 -0400
Subject: [PATCH 115/142] change wait for process to start
---
src/CronUpdateStage.php | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index e01132b438..4b20b5a561 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -101,11 +101,13 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
try {
$process->start();
- sleep(1);
- // Wait for the process to start.
+ // Wait for the process to start otherwise the web request may end before
+ // the detached process can start.
$wait_till = time() + 5;
- while (is_null($process->getPid()) && $wait_till > time()) {
- }
+ do {
+ sleep(1);
+ } while (is_null($process->getPid()) && $wait_till > time());
+
}
catch (\Throwable $throwable) {
// @todo Just call Error::logException() in https://drupal.org/i/3377458.
--
GitLab
From 022961f98d0ba48eb66f00f4e26f763cafc2917d Mon Sep 17 00:00:00 2001
From: Adam G-H <32250-phenaproxima@users.noreply.drupalcode.org>
Date: Wed, 2 Aug 2023 14:19:53 +0000
Subject: [PATCH 116/142] Review
---
automatic_updates.install | 4 ++--
automatic_updates.module | 2 +-
tests/src/Functional/StatusCheckFailureEmailTest.php | 2 +-
tests/src/Kernel/CronUpdateStageTest.php | 4 ++--
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/automatic_updates.install b/automatic_updates.install
index 085956e822..8e926e1551 100644
--- a/automatic_updates.install
+++ b/automatic_updates.install
@@ -44,11 +44,11 @@ function automatic_updates_requirements($phase) {
try {
$cron_update_stage->getCommandPath();
}
- catch (Exception) {
+ catch (\Throwable) {
$requirements['automatic_updates_drush_missing'] = [
'title' => t('Automatic Updates Drush Requirement'),
'severity' => SystemManager::REQUIREMENT_ERROR,
- 'value' => t('Drush is require for unattended updates'),
+ 'value' => t('Drush is required for unattended updates.'),
];
}
}
diff --git a/automatic_updates.module b/automatic_updates.module
index 408a984186..4e15732367 100644
--- a/automatic_updates.module
+++ b/automatic_updates.module
@@ -235,7 +235,7 @@ function automatic_updates_form_update_settings_alter(array &$form): void {
$cron_update_stage = \Drupal::service('automatic_updates.cron_update_stage');
$cron_update_stage->getCommandPath();
}
- catch (Exception) {
+ catch (\Throwable) {
\Drupal::messenger()->addWarning('Drush is required for unattended updates.');
$form['unattended_level']['#disabled'] = TRUE;
$form['unattended_level']['#default_value'] = CronUpdateStage::DISABLED;
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 670f5d04de..b1f27d9f75 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -125,7 +125,7 @@ visit $url for more information.
END;
// Since the terminal command that sent the emails does us the same
- // container as this test we need to reset the state cache where to get the
+ // container as this test we need to reset the state cache to get the
// test data about the sent emails.
$this->container->get('state')->resetCache();
$this->assertMessagesSent('Automatic updates readiness checks failed', $expected_body);
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index 211f748f12..c6750b1b15 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -41,8 +41,8 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->assertTrue(CronUpdateStage::isCommandLine());
// Since we're at the command line the terminal command should not be
- // invoked. Since we are in a kernel test if the terminal command were
- // invoked it would throw an exception.
+ // invoked. Since we are in a kernel test, there would be an exception
+ // if that happened.
// @see \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage::runTerminalUpdateCommand
$this->container->get('cron')->run();
// Even though the terminal command was not invoked hook_cron
--
GitLab
From 2d5e331089f253ca80b928d56555cea19dfa186c Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 10:32:35 -0400
Subject: [PATCH 117/142] more review phenaproxima
---
.../Kernel/AutomaticUpdatesKernelTestBase.php | 4 ++--
tests/src/Kernel/DrushUpdateStageTest.php | 24 +++++++++----------
.../CronFrequencyValidatorTest.php | 3 ++-
.../PhpExtensionsValidatorTest.php | 4 ++--
.../StagedDatabaseUpdateValidatorTest.php | 2 +-
5 files changed, 19 insertions(+), 18 deletions(-)
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index 8130145b5a..f591068632 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -97,7 +97,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
/**
* Performs an update using the console update stage directly.
*/
- protected function performConsoleUpdate(): void {
+ protected function runUpdateViaConsole(): void {
$this->container->get(DrushUpdateStage::class)->performUpdate();
}
@@ -111,7 +111,7 @@ class TestCronUpdateStage extends CronUpdateStage {
/**
* {@inheritdoc}
*/
- protected function runTerminalUpdateCommand(): void {
+ protected function runTerminalUpdateCommand(): never {
// Invoking the terminal command will not work and is not necessary in
// kernel tests. Throw an exception for tests that need to assert that
// the terminal command would have been invoked.
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 0e41f21439..7e65ba4317 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -88,7 +88,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$exception = new \Exception('Error during running post-apply tasks!');
TestSubscriber1::setException($exception, PostApplyEvent::class);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$this->assertNoCronRun();
$this->assertTrue($this->logger->hasRecord($exception->getMessage(), (string) RfcLogLevel::ERROR));
@@ -200,7 +200,7 @@ END;
$this->assertCount(0, $this->container->get('package_manager.beginner')->getInvocationArguments());
// Run cron and ensure that Package Manager's services were called or
// bypassed depending on configuration.
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$will_update = (int) $will_update;
$this->assertCount($will_update, $this->container->get('package_manager.beginner')->getInvocationArguments());
@@ -336,7 +336,7 @@ END;
$this->assertEmpty($this->logger->records);
$this->assertTrue($stage->isAvailable());
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) RfcLogLevel::ERROR);
// To check if the exception was logged by the main cron service, we need
@@ -390,7 +390,7 @@ END;
$this->addEventTestListener($listener, PostRequireEvent::class);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$this->assertIsString($cron_stage_dir);
$this->assertNotEquals($original_stage_directory, $cron_stage_dir);
$this->assertDirectoryDoesNotExist($cron_stage_dir);
@@ -425,7 +425,7 @@ END;
// Ensure the stage that is applying the operation is not the cron
// update stage.
$this->assertInstanceOf(TestStage::class, $event->stage);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
// We do not actually want to apply this operation it was just invoked to
// allow cron to be attempted.
$event->addError([$stop_error]);
@@ -461,7 +461,7 @@ END;
// Trigger CronUpdateStage, the above should cause it to detect a stage that
// is applying.
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
$this->assertUpdateStagedTimes(1);
@@ -481,7 +481,7 @@ END;
*/
public function testEmailOnSuccess(): void {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
// Ensure we sent a success message to all recipients.
$expected_body = <<<END
@@ -543,7 +543,7 @@ END;
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -584,7 +584,7 @@ END;
TestSubscriber1::setTestResult([$error], $event_class);
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -612,7 +612,7 @@ END;
$error = new \LogicException('I drink your milkshake!');
LoggingCommitter::setException($error);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$expected_body = <<<END
Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
@@ -644,7 +644,7 @@ END;
// Before the update begins, we should have no indication that we have ever
// been in maintenance mode (i.e., the value in state is NULL).
$this->assertNull($state->get('system.maintenance_mode'));
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$state->resetCache();
// @see \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage::apply()
$this->assertTrue($this->logger->hasRecord('Unattended update was applied in maintenance mode.', RfcLogLevel::INFO));
@@ -695,7 +695,7 @@ END;
/** @var \Drupal\Core\State\StateInterface $state */
$state = $this->container->get('state');
$this->assertNull($state->get('system.maintenance_mode'));
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$this->assertFalse($this->logger->hasRecord('Unattended update was applied in maintenance mode.', RfcLogLevel::INFO));
$this->assertSame($will_be_in_maintenance_mode, $state->get('system.maintenance_mode'));
}
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 8568ff88ed..c078f2eac0 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -117,11 +117,12 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
}
catch (\BadMethodCallException $e) {
// The terminal command cannot be run in a kernel test.
+ // @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::runUpdateViaConsole
$this->assertSame(TestCronUpdateStage::class, $e->getMessage());
// After running cron, any errors or warnings should be gone. Even though
// the terminal command did not succeed the system cron service should
// have been called.
- $this->assertCheckerResultsFromManager([], TRUE);
+ $this->assertCheckerResultsFromManager([]);
}
}
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index 7476c9f2a9..07b8332112 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -61,7 +61,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
// The update should have been stopped before it started.
$this->assertUpdateStagedTimes(0);
$this->assertTrue($logger->hasRecordThatContains((string) $error_result->messages[0], RfcLogLevel::ERROR));
@@ -85,7 +85,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
// The update should have been staged, but then stopped with an error.
$this->assertUpdateStagedTimes(1);
$this->assertTrue($logger->hasRecordThatContains("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.", RfcLogLevel::ERROR));
diff --git a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
index d60982bdf4..8de4d3839e 100644
--- a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
@@ -38,7 +38,7 @@ class StagedDatabaseUpdateValidatorTest extends AutomaticUpdatesKernelTestBase {
};
$this->addEventTestListener($listener);
- $this->performConsoleUpdate();
+ $this->runUpdateViaConsole();
$expected_message = "The update cannot proceed because database updates have been detected in the following extensions.\nSystem\n";
$this->assertTrue($logger->hasRecord($expected_message, (string) RfcLogLevel::ERROR));
}
--
GitLab
From 5b24d72dbf95736d6c9a952e16417ff53f6979a5 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 10:44:54 -0400
Subject: [PATCH 118/142] explain that test coverage relies on decorated cron
running before terminal command
---
.../Kernel/StatusCheck/CronFrequencyValidatorTest.php | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index c078f2eac0..07fad847c2 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -119,10 +119,12 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
// The terminal command cannot be run in a kernel test.
// @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::runUpdateViaConsole
$this->assertSame(TestCronUpdateStage::class, $e->getMessage());
- // After running cron, any errors or warnings should be gone. Even though
- // the terminal command did not succeed the system cron service should
- // have been called.
- $this->assertCheckerResultsFromManager([]);
+ // After cron runs, running the validator again should detect that cron
+ // ran recently. Even though the terminal command did not succeed the
+ // decorated cron service from the system module should have been called
+ // before the attempt to run the terminal command.
+ // @see \Drupal\automatic_updates\CronUpdateStage::run
+ $this->assertCheckerResultsFromManager([], TRUE);
}
}
--
GitLab
From 334dec6e60182d678c29218aab6a8be527e84365 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 10:53:56 -0400
Subject: [PATCH 119/142] reset state cache after running terminal command
---
tests/src/Functional/StatusCheckFailureEmailTest.php | 12 ++++--------
1 file changed, 4 insertions(+), 8 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index b1f27d9f75..22cc4cea25 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -87,10 +87,6 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
* The expected number of failure notifications that should have been sent.
*/
private function assertSentMessagesCount(int $expected_count): void {
- // Since the terminal command that sent the emails does us the same
- // container as this test we need to reset the state cache where to get the
- // test data about the sent emails.
- $this->container->get('state')->resetCache();
$sent_messages = $this->getMails([
'id' => 'automatic_updates_status_check_failed',
]);
@@ -124,10 +120,6 @@ be able to receive automatic updates until further action is taken. Please
visit $url for more information.
END;
- // Since the terminal command that sent the emails does us the same
- // container as this test we need to reset the state cache to get the
- // test data about the sent emails.
- $this->container->get('state')->resetCache();
$this->assertMessagesSent('Automatic updates readiness checks failed', $expected_body);
// Running cron again should not trigger another e-mail (i.e., each
@@ -250,6 +242,10 @@ END;
$total_delay += 61;
TestTime::setFakeTimeByOffset("+$total_delay minutes");
$this->drush('auto-update');
+ // Since the terminal command that sent the emails doesn't use the same
+ // container as this test we need to reset the state cache where to get the
+ // test data about the sent emails.
+ $this->container->get('state')->resetCache();
}
}
--
GitLab
From e54ac46b8ad7027ad9fcb26c46f8a5515b77f41b Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 16:26:46 -0400
Subject: [PATCH 120/142] assert stage events fired
---
.../src/Build/TemplateProjectTestBase.php | 19 ++++++--
tests/src/Build/CoreUpdateTest.php | 44 ++++++++++++++++++-
2 files changed, 58 insertions(+), 5 deletions(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index bd9744b401..dd63fd05fd 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -583,10 +583,7 @@ END;
$expected_events = array_keys($expected_events);
}
- $log_file = $this->getWorkspaceDirectory() . '/project/' . EventLogSubscriber::LOG_FILE_NAME;
- $this->assertFileIsReadable($log_file);
- $log_data = file_get_contents($log_file);
- $log_data = json_decode($log_data, TRUE, flags: JSON_THROW_ON_ERROR);
+ $log_data = $this->getLoggedStageEvents();
$this->assertSame($expected_events, array_column($log_data, 'event'), $message);
@@ -595,6 +592,20 @@ END;
$this->assertSame([$expected_stage_class], $actual_stages_used);
}
+ /**
+ * Gets the logged stage events.
+ *
+ * @return string[]
+ * The logged stage events.
+ */
+ protected function getLoggedStageEvents(): mixed {
+ $log_file = $this->getWorkspaceDirectory() . '/project/' . EventLogSubscriber::LOG_FILE_NAME;
+ $this->assertFileIsReadable($log_file);
+ $log_data = file_get_contents($log_file);
+ $log_data = json_decode($log_data, TRUE, flags: JSON_THROW_ON_ERROR);
+ return $log_data;
+ }
+
/**
* Visits the 'admin/reports/dblog' and selects Package Manager's change log.
*/
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 7b92544fee..bfc8642817 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -7,6 +7,7 @@ namespace Drupal\Tests\automatic_updates\Build;
use Behat\Mink\Element\DocumentElement;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
use Drupal\package_manager\Event\PostDestroyEvent;
@@ -15,6 +16,7 @@ use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Event\PreDestroyEvent;
use Drupal\package_manager\Event\PreRequireEvent;
+use Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber;
use Drupal\Tests\WebAssert;
use Symfony\Component\Process\Process;
@@ -169,6 +171,7 @@ class CoreUpdateTest extends UpdateTestBase {
// at the end of this request.
$this->visit('/automatic-updates-test-api/reset-cron');
$this->getMink()->assertSession()->pageTextContains('cron reset');
+ $this->waitForStageEventsToBeFired(DrushUpdateStage::class);
$this->assertCronUpdateSuccessful();
}
@@ -218,6 +221,7 @@ class CoreUpdateTest extends UpdateTestBase {
$session->getPage()->clickLink('Run cron');
$this->assertSame(200, $session->getStatusCode());
+ $this->waitForStageEventsToBeFired(DrushUpdateStage::class);
$this->assertCronUpdateSuccessful();
}
@@ -240,6 +244,45 @@ class CoreUpdateTest extends UpdateTestBase {
$this->assertUpdateSuccessful('9.8.1');
}
+ /**
+ * Wait for stage events to be fired.
+ *
+ * @param string $stage_class
+ * @param array|null $expected_events
+ */
+ private function waitForStageEventsToBeFired(string $stage_class, ?array $expected_events = NULL): void {
+ if ($expected_events === NULL) {
+ $expected_events = EventLogSubscriber::getSubscribedEvents();
+ // The event subscriber uses this event to ensure the log file is excluded
+ // from Package Manager operations, but it's not relevant for our purposes
+ // because it's not part of the stage life cycle.
+ unset($expected_events[CollectPathsToExcludeEvent::class]);
+ $expected_events = array_keys($expected_events);
+ }
+ else {
+ $this->assertNotEmpty($expected_events);
+ }
+ $max_wait = time() + 360;
+ while ($max_wait > time()) {
+ $logged_stage_events = $this->getLoggedStageEvents();
+ $first_expected_events = array_slice($expected_events, 0, count($logged_stage_events));
+ $filtered_logged_events = array_filter($logged_stage_events, fn($logged_stage_event) => $logged_stage_event['stage'] === $stage_class);
+ $this->assertCount(count($logged_stage_events), $filtered_logged_events);
+ $this->assertSame($first_expected_events, array_column($logged_stage_events, 'event'));
+
+ // Ensure all the events were fired by the stage we expected.
+ $actual_stages_used = array_unique(array_column($logged_stage_events, 'stage'));
+ $this->assertSame([$stage_class], $actual_stages_used);
+ // If all the expected events have been first returned
+ if (count($logged_stage_events) === count($expected_events)) {
+ return;
+ }
+ $this->assertLessThan(count($expected_events), count($logged_stage_events));
+ sleep(20);
+ }
+ $this->fail('Failed to fire events in six minutes');
+ }
+
/**
* Asserts that the update is prevented if the filesystem isn't writable.
*
@@ -413,7 +456,6 @@ class CoreUpdateTest extends UpdateTestBase {
$mink = $this->getMink();
$assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
- $this->waitForStageToBeDestroyed();
$this->assertExpectedStageEventsFired(DrushUpdateStage::class);
// There should be log messages, but no errors or warnings should have been
--
GitLab
From 20825e618aa158a10235bf59ea318e1443a1d1f4 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 17:05:13 -0400
Subject: [PATCH 121/142] ignore other stages option
---
tests/src/Build/CoreUpdateTest.php | 40 +++++++++++++++++++-----------
1 file changed, 26 insertions(+), 14 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index bfc8642817..e35d75c68e 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -238,9 +238,21 @@ class CoreUpdateTest extends UpdateTestBase {
$this->visit('/admin/reports/status');
$assert_session->pageTextContains('Your site is ready for automatic updates.');
$page->clickLink('Run cron');
- // Wait for the second stage to be destroyed because the stage created above
- // will be destroyed to allow the cron update to proceed.
- $this->waitForStageToBeDestroyed(2);
+ // The stage will first destroy the stage made above before going through
+ // stage lifecyle events for the cron update.
+ $expected_events = [
+ PreDestroyEvent::class,
+ PostDestroyEvent::class,
+ PreCreateEvent::class,
+ PostCreateEvent::class,
+ PreRequireEvent::class,
+ PostRequireEvent::class,
+ PreApplyEvent::class,
+ PostApplyEvent::class,
+ PreDestroyEvent::class,
+ PostDestroyEvent::class,
+ ];
+ $this->waitForStageEventsToBeFired(DrushUpdateStage::class, $expected_events, TRUE);
$this->assertUpdateSuccessful('9.8.1');
}
@@ -250,7 +262,7 @@ class CoreUpdateTest extends UpdateTestBase {
* @param string $stage_class
* @param array|null $expected_events
*/
- private function waitForStageEventsToBeFired(string $stage_class, ?array $expected_events = NULL): void {
+ private function waitForStageEventsToBeFired(string $stage_class, ?array $expected_events = NULL, bool $ignore_other_stages = FALSE): void {
if ($expected_events === NULL) {
$expected_events = EventLogSubscriber::getSubscribedEvents();
// The event subscriber uses this event to ensure the log file is excluded
@@ -265,19 +277,19 @@ class CoreUpdateTest extends UpdateTestBase {
$max_wait = time() + 360;
while ($max_wait > time()) {
$logged_stage_events = $this->getLoggedStageEvents();
- $first_expected_events = array_slice($expected_events, 0, count($logged_stage_events));
$filtered_logged_events = array_filter($logged_stage_events, fn($logged_stage_event) => $logged_stage_event['stage'] === $stage_class);
- $this->assertCount(count($logged_stage_events), $filtered_logged_events);
- $this->assertSame($first_expected_events, array_column($logged_stage_events, 'event'));
-
- // Ensure all the events were fired by the stage we expected.
- $actual_stages_used = array_unique(array_column($logged_stage_events, 'stage'));
- $this->assertSame([$stage_class], $actual_stages_used);
- // If all the expected events have been first returned
- if (count($logged_stage_events) === count($expected_events)) {
+ if (!$ignore_other_stages) {
+ $this->assertCount(count($logged_stage_events), $filtered_logged_events);
+ }
+ $first_expected_events = array_slice($expected_events, 0, count($filtered_logged_events));
+ $this->assertSame($first_expected_events, array_column($filtered_logged_events, 'event'));
+
+ // If all the expected events have been fired return.
+ if (count($filtered_logged_events) === count($expected_events)) {
return;
}
- $this->assertLessThan(count($expected_events), count($logged_stage_events));
+ // We should never have more logged events than we were waiting for.
+ $this->assertLessThan(count($expected_events), count($filtered_logged_events));
sleep(20);
}
$this->fail('Failed to fire events in six minutes');
--
GitLab
From 28d622e5798d4daf8e74e47aa413f963ba268e10 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 17:13:04 -0400
Subject: [PATCH 122/142] comments
---
.../tests/src/Build/TemplateProjectTestBase.php | 4 +++-
tests/src/Build/CoreUpdateTest.php | 16 ++++++++++++----
2 files changed, 15 insertions(+), 5 deletions(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index dd63fd05fd..514ad0bf6c 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -596,7 +596,9 @@ END;
* Gets the logged stage events.
*
* @return string[]
- * The logged stage events.
+ * An array of logged stage events with array keys of:
+ * - 'stage': The stage that fired the event.
+ * - 'event': The event class.
*/
protected function getLoggedStageEvents(): mixed {
$log_file = $this->getWorkspaceDirectory() . '/project/' . EventLogSubscriber::LOG_FILE_NAME;
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index e35d75c68e..4d3796e38e 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -239,7 +239,7 @@ class CoreUpdateTest extends UpdateTestBase {
$assert_session->pageTextContains('Your site is ready for automatic updates.');
$page->clickLink('Run cron');
// The stage will first destroy the stage made above before going through
- // stage lifecyle events for the cron update.
+ // stage lifecycle events for the cron update.
$expected_events = [
PreDestroyEvent::class,
PostDestroyEvent::class,
@@ -259,10 +259,18 @@ class CoreUpdateTest extends UpdateTestBase {
/**
* Wait for stage events to be fired.
*
- * @param string $stage_class
+ * @param string $expected_stage_class
+ * The expected stage class for the events.
* @param array|null $expected_events
+ * (optional) The expected stage events that should have been fired in the
+ * order in which they should have been fired. Events can be specified more
+ * that once if they will be fired multiple times. If there are no events
+ * specified all life cycle events from PreCreateEvent to PostDestroyEvent
+ * will be asserted.
+ * @param bool $ignore_other_stages
+ * Whether events fired by other stages should be ignored.
*/
- private function waitForStageEventsToBeFired(string $stage_class, ?array $expected_events = NULL, bool $ignore_other_stages = FALSE): void {
+ private function waitForStageEventsToBeFired(string $expected_stage_class, ?array $expected_events = NULL, bool $ignore_other_stages = FALSE): void {
if ($expected_events === NULL) {
$expected_events = EventLogSubscriber::getSubscribedEvents();
// The event subscriber uses this event to ensure the log file is excluded
@@ -277,7 +285,7 @@ class CoreUpdateTest extends UpdateTestBase {
$max_wait = time() + 360;
while ($max_wait > time()) {
$logged_stage_events = $this->getLoggedStageEvents();
- $filtered_logged_events = array_filter($logged_stage_events, fn($logged_stage_event) => $logged_stage_event['stage'] === $stage_class);
+ $filtered_logged_events = array_filter($logged_stage_events, fn($logged_stage_event) => $logged_stage_event['stage'] === $expected_stage_class);
if (!$ignore_other_stages) {
$this->assertCount(count($logged_stage_events), $filtered_logged_events);
}
--
GitLab
From 3d8cda67a727c6c616f8a50dd48a9b8f4b4b12f5 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 17:46:42 -0400
Subject: [PATCH 123/142] remove separate waitForStageEventsToBeFired
---
.../src/Build/TemplateProjectTestBase.php | 55 ++++++++++--------
tests/src/Build/CoreUpdateTest.php | 57 ++-----------------
2 files changed, 36 insertions(+), 76 deletions(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index 514ad0bf6c..b6ce831959 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -568,12 +568,18 @@ END;
* that once if they will be fired multiple times. If there are no events
* specified all life cycle events from PreCreateEvent to PostDestroyEvent
* will be asserted.
+ * @param bool $ignore_other_stages
+ * (optional) Whether events fired by other stages should be ignored.
+ * Defaults to FALSE.
+ * @param int $wait
+ * (optional) How many seconds to wait for the events to be fired. Defaults
+ * to 0.
* @param string $message
* (optional) A message to display with the assertion.
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
- protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, string $message = ''): void {
+ protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, bool $ignore_other_stages = FALSE, int $wait = 0, string $message = ''): void {
if ($expected_events === NULL) {
$expected_events = EventLogSubscriber::getSubscribedEvents();
// The event subscriber uses this event to ensure the log file is excluded
@@ -582,30 +588,31 @@ END;
unset($expected_events[CollectPathsToExcludeEvent::class]);
$expected_events = array_keys($expected_events);
}
+ else {
+ $this->assertNotEmpty($expected_events);
+ }
+ $max_wait = time() + $wait;
+ do {
+ $log_file = $this->getWorkspaceDirectory() . '/project/' . EventLogSubscriber::LOG_FILE_NAME;
+ $this->assertFileIsReadable($log_file);
+ $log_data = file_get_contents($log_file);
+ $log_data = json_decode($log_data, TRUE, flags: JSON_THROW_ON_ERROR);
+ $filtered_logged_events = array_filter($log_data, fn($logged_stage_event) => $logged_stage_event['stage'] === $expected_stage_class);
+ if (!$ignore_other_stages) {
+ $this->assertCount(count($log_data), $filtered_logged_events);
+ }
+ $first_expected_events = array_slice($expected_events, 0, count($filtered_logged_events));
+ $this->assertSame($first_expected_events, array_column($filtered_logged_events, 'event'), $message);
- $log_data = $this->getLoggedStageEvents();
-
- $this->assertSame($expected_events, array_column($log_data, 'event'), $message);
-
- // Ensure all the events were fired by the stage we expected.
- $actual_stages_used = array_unique(array_column($log_data, 'stage'));
- $this->assertSame([$expected_stage_class], $actual_stages_used);
- }
-
- /**
- * Gets the logged stage events.
- *
- * @return string[]
- * An array of logged stage events with array keys of:
- * - 'stage': The stage that fired the event.
- * - 'event': The event class.
- */
- protected function getLoggedStageEvents(): mixed {
- $log_file = $this->getWorkspaceDirectory() . '/project/' . EventLogSubscriber::LOG_FILE_NAME;
- $this->assertFileIsReadable($log_file);
- $log_data = file_get_contents($log_file);
- $log_data = json_decode($log_data, TRUE, flags: JSON_THROW_ON_ERROR);
- return $log_data;
+ // If all the expected events have been fired return.
+ if (count($filtered_logged_events) === count($expected_events)) {
+ return;
+ }
+ // We should never have more logged events than we were waiting for.
+ $this->assertLessThan(count($expected_events), count($filtered_logged_events));
+ sleep(20);
+ } while ($max_wait > time());
+ $this->fail("Failed to fire events in $wait seconds");
}
/**
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 542700cabc..55c5460329 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -7,7 +7,6 @@ namespace Drupal\Tests\automatic_updates\Build;
use Behat\Mink\Element\DocumentElement;
use Drupal\automatic_updates\DrushUpdateStage;
use Drupal\automatic_updates\UpdateStage;
-use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
use Drupal\package_manager\Event\PostDestroyEvent;
@@ -16,7 +15,6 @@ use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\PreCreateEvent;
use Drupal\package_manager\Event\PreDestroyEvent;
use Drupal\package_manager\Event\PreRequireEvent;
-use Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber;
use Drupal\Tests\WebAssert;
use Symfony\Component\Process\Process;
@@ -138,6 +136,8 @@ class CoreUpdateTest extends UpdateTestBase {
PreDestroyEvent::class,
PostDestroyEvent::class,
],
+ FALSE,
+ 0,
'Error response: ' . $file_contents
);
// Even though the response is what we expect, assert the status code as
@@ -171,7 +171,7 @@ class CoreUpdateTest extends UpdateTestBase {
// at the end of this request.
$this->visit('/automatic-updates-test-api/reset-cron');
$this->getMink()->assertSession()->pageTextContains('cron reset');
- $this->waitForStageEventsToBeFired(DrushUpdateStage::class);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class, NULL, FALSE, 360);
$this->assertCronUpdateSuccessful();
}
@@ -221,7 +221,7 @@ class CoreUpdateTest extends UpdateTestBase {
$session->getPage()->clickLink('Run cron');
$this->assertSame(200, $session->getStatusCode());
- $this->waitForStageEventsToBeFired(DrushUpdateStage::class);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class, NULL, FALSE, 360);
$this->assertCronUpdateSuccessful();
}
@@ -252,57 +252,10 @@ class CoreUpdateTest extends UpdateTestBase {
PreDestroyEvent::class,
PostDestroyEvent::class,
];
- $this->waitForStageEventsToBeFired(DrushUpdateStage::class, $expected_events, TRUE);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class, $expected_events, TRUE, 360);
$this->assertCronUpdateSuccessful();
}
- /**
- * Wait for stage events to be fired.
- *
- * @param string $expected_stage_class
- * The expected stage class for the events.
- * @param array|null $expected_events
- * (optional) The expected stage events that should have been fired in the
- * order in which they should have been fired. Events can be specified more
- * that once if they will be fired multiple times. If there are no events
- * specified all life cycle events from PreCreateEvent to PostDestroyEvent
- * will be asserted.
- * @param bool $ignore_other_stages
- * Whether events fired by other stages should be ignored.
- */
- private function waitForStageEventsToBeFired(string $expected_stage_class, ?array $expected_events = NULL, bool $ignore_other_stages = FALSE): void {
- if ($expected_events === NULL) {
- $expected_events = EventLogSubscriber::getSubscribedEvents();
- // The event subscriber uses this event to ensure the log file is excluded
- // from Package Manager operations, but it's not relevant for our purposes
- // because it's not part of the stage life cycle.
- unset($expected_events[CollectPathsToExcludeEvent::class]);
- $expected_events = array_keys($expected_events);
- }
- else {
- $this->assertNotEmpty($expected_events);
- }
- $max_wait = time() + 360;
- while ($max_wait > time()) {
- $logged_stage_events = $this->getLoggedStageEvents();
- $filtered_logged_events = array_filter($logged_stage_events, fn($logged_stage_event) => $logged_stage_event['stage'] === $expected_stage_class);
- if (!$ignore_other_stages) {
- $this->assertCount(count($logged_stage_events), $filtered_logged_events);
- }
- $first_expected_events = array_slice($expected_events, 0, count($filtered_logged_events));
- $this->assertSame($first_expected_events, array_column($filtered_logged_events, 'event'));
-
- // If all the expected events have been fired return.
- if (count($filtered_logged_events) === count($expected_events)) {
- return;
- }
- // We should never have more logged events than we were waiting for.
- $this->assertLessThan(count($expected_events), count($filtered_logged_events));
- sleep(20);
- }
- $this->fail('Failed to fire events in six minutes');
- }
-
/**
* Asserts that the update is prevented if the filesystem isn't writable.
*
--
GitLab
From 7cc3558439f487242339ca0c0593a608f85672ef Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 2 Aug 2023 17:51:55 -0400
Subject: [PATCH 124/142] remove unused function
---
tests/src/Build/CoreUpdateTest.php | 22 ----------------------
1 file changed, 22 deletions(-)
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 55c5460329..e88ef51894 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -440,28 +440,6 @@ class CoreUpdateTest extends UpdateTestBase {
$assert_session->pageTextContains('Ready to update');
}
- /**
- * Waits for stage to be destroyed.
- *
- * @param int $expected_destroy_calls
- * The number stages are expected to be destroyed.
- */
- private function waitForStageToBeDestroyed(int $expected_destroy_calls = 1): void {
- $max_wait = time() + 360;
- // @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
- $update_complete_file = $this->getWorkspaceDirectory() . '/project/update-complete.txt';
- while ($max_wait > time()) {
- if (file_exists($update_complete_file)) {
- $actual_destroy_calls = (int) file_get_contents($update_complete_file);
- if ($actual_destroy_calls === $expected_destroy_calls) {
- return;
- }
- }
- sleep(20);
- }
- $this->fail('Cron update was completed within 6 minutes.');
- }
-
/**
* Assert a cron update ran successfully.
*/
--
GitLab
From 24398f0cf0c1be6f36f9b97c712af5b972b36c4c Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 4 Aug 2023 14:07:07 -0400
Subject: [PATCH 125/142] var case
---
src/CronUpdateStage.php | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 4b20b5a561..935d333d11 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -92,9 +92,9 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
*/
protected function runTerminalUpdateCommand(): void {
$command_path = $this->getCommandPath();
- $phpBinaryFinder = new PhpExecutableFinder();
+ $php_binary_finder = new PhpExecutableFinder();
// @todo Check if on windows to not allow cron updates.
- $process = Process::fromShellCommandline($phpBinaryFinder->find() . " $command_path auto-update --is-from-web &");
+ $process = Process::fromShellCommandline($php_binary_finder->find() . " $command_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
$process->disableOutput();
$process->setTimeout(0);
--
GitLab
From 0077c07c5699a069d76b1caae3a212ef060904a5 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 4 Aug 2023 14:26:44 -0400
Subject: [PATCH 126/142] remove new lines when testing email
---
tests/src/Functional/StatusCheckFailureEmailTest.php | 5 +----
tests/src/Traits/EmailNotificationsTestTrait.php | 4 +++-
2 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/tests/src/Functional/StatusCheckFailureEmailTest.php b/tests/src/Functional/StatusCheckFailureEmailTest.php
index 22cc4cea25..3286e50fca 100644
--- a/tests/src/Functional/StatusCheckFailureEmailTest.php
+++ b/tests/src/Functional/StatusCheckFailureEmailTest.php
@@ -115,10 +115,7 @@ class StatusCheckFailureEmailTest extends AutomaticUpdatesFunctionalTestBase {
$url = str_replace($base, 'http://default/', $url);
$expected_body = <<<END
-Your site has failed some readiness checks for automatic updates and may not
-be able to receive automatic updates until further action is taken. Please
-visit $url for more information.
-
+Your site has failed some readiness checks for automatic updates and may not be able to receive automatic updates until further action is taken. Please visit $url for more information.
END;
$this->assertMessagesSent('Automatic updates readiness checks failed', $expected_body);
diff --git a/tests/src/Traits/EmailNotificationsTestTrait.php b/tests/src/Traits/EmailNotificationsTestTrait.php
index 3c34a90189..732bb52d35 100644
--- a/tests/src/Traits/EmailNotificationsTestTrait.php
+++ b/tests/src/Traits/EmailNotificationsTestTrait.php
@@ -89,7 +89,9 @@ trait EmailNotificationsTestTrait {
// @see automatic_updates_test_mail_alter()
$this->assertArrayHasKey('line_langcodes', $message);
$this->assertSame([$expected_langcode], $message['line_langcodes']);
- $this->assertStringStartsWith($body, $message['body']);
+ $actual_body = trim(str_replace("\n", ' ', $message['body']));
+ $body = trim(str_replace("\n", ' ', $body));
+ $this->assertStringStartsWith($body, $actual_body);
}
}
--
GitLab
From be557e292984892aedeb92e107b74b5db52e33fb Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 9 Aug 2023 09:15:03 -0400
Subject: [PATCH 127/142] added a comment as to why we detach the process and
disable the output.
---
src/CronUpdateStage.php | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 935d333d11..04c49e17e8 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -94,8 +94,13 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
$command_path = $this->getCommandPath();
$php_binary_finder = new PhpExecutableFinder();
// @todo Check if on windows to not allow cron updates.
+ // Use the `&` on the command line to detach this process after it is
+ // started. This will allow the command to run longer than web request
+ // timeout.
$process = Process::fromShellCommandline($php_binary_finder->find() . " $command_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
+ // Since this process will run detached, and we won't be able to access its
+ // output, we disable the output.
$process->disableOutput();
$process->setTimeout(0);
--
GitLab
From 2aee40ae8b649576c1716fdc78f04269189988df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Wed, 9 Aug 2023 10:04:26 -0400
Subject: [PATCH 128/142] Minor stylistic changes
---
src/CronUpdateStage.php | 18 ++++++++++--------
tests/src/Build/CoreUpdateTest.php | 11 ++++-------
tests/src/Kernel/CronUpdateStageTest.php | 6 +++---
.../StatusCheck/CronFrequencyValidatorTest.php | 8 ++++----
4 files changed, 21 insertions(+), 22 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 935d333d11..3c0a54c487 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -4,6 +4,7 @@ declare(strict_types = 1);
namespace Drupal\automatic_updates;
+use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
use Drupal\Core\Lock\LockBackendInterface;
@@ -16,7 +17,7 @@ use Symfony\Component\Process\PhpExecutableFinder;
use Symfony\Component\Process\Process;
/**
- * Runs updates as a detached background process during cron after regular cron.
+ * Runs updates as a detached background process after regular cron tasks.
*
* The update process will be started in a detached process which will continue
* running after the web request has terminated. This is done after the
@@ -24,7 +25,6 @@ use Symfony\Component\Process\Process;
* run regardless of whether there is an update available and whether an update
* is successful.
*
- *
* @todo Rename this class to CronUpdateRunner because it is no longer a stage
* in https://drupal.org/i/3375940.
*
@@ -77,12 +77,15 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
* The lock service.
* @param \Drupal\Core\CronInterface $inner
* The decorated cron service.
+ * @param \Drupal\Component\Datetime\TimeInterface $time
+ * The time service.
*/
public function __construct(
private readonly ConfigFactoryInterface $configFactory,
private readonly PathLocator $pathLocator,
private readonly LockBackendInterface $lock,
- private readonly CronInterface $inner
+ private readonly CronInterface $inner,
+ private readonly TimeInterface $time,
) {
$this->setLogger(new NullLogger());
}
@@ -101,13 +104,12 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
try {
$process->start();
- // Wait for the process to start otherwise the web request may end before
- // the detached process can start.
- $wait_till = time() + 5;
+ // Wait for the process to have an ID, otherwise the web request may end
+ // before the detached process has a chance to start.
+ $wait_until = $this->time->getCurrentTime() + 5;
do {
sleep(1);
- } while (is_null($process->getPid()) && $wait_till > time());
-
+ } while (is_null($process->getPid()) && $wait_until > $this->time->getCurrentTime());
}
catch (\Throwable $throwable) {
// @todo Just call Error::logException() in https://drupal.org/i/3377458.
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index e88ef51894..dac1061127 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -136,9 +136,7 @@ class CoreUpdateTest extends UpdateTestBase {
PreDestroyEvent::class,
PostDestroyEvent::class,
],
- FALSE,
- 0,
- 'Error response: ' . $file_contents
+ message: 'Error response: ' . $file_contents
);
// Even though the response is what we expect, assert the status code as
// well, to be extra-certain that there was no kind of server-side error.
@@ -171,7 +169,7 @@ class CoreUpdateTest extends UpdateTestBase {
// at the end of this request.
$this->visit('/automatic-updates-test-api/reset-cron');
$this->getMink()->assertSession()->pageTextContains('cron reset');
- $this->assertExpectedStageEventsFired(DrushUpdateStage::class, NULL, FALSE, 360);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class, wait: 360);
$this->assertCronUpdateSuccessful();
}
@@ -221,7 +219,7 @@ class CoreUpdateTest extends UpdateTestBase {
$session->getPage()->clickLink('Run cron');
$this->assertSame(200, $session->getStatusCode());
- $this->assertExpectedStageEventsFired(DrushUpdateStage::class, NULL, FALSE, 360);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class, wait: 360);
$this->assertCronUpdateSuccessful();
}
@@ -445,7 +443,6 @@ class CoreUpdateTest extends UpdateTestBase {
*/
private function assertCronUpdateSuccessful(): void {
$mink = $this->getMink();
- $assert_session = $mink->assertSession();
$page = $mink->getSession()->getPage();
$this->visit('/admin/reports/dblog');
@@ -453,7 +450,7 @@ class CoreUpdateTest extends UpdateTestBase {
$page->selectFieldOption('Severity', 'Info');
$page->pressButton('Filter');
// There should be a log entry about the successful update.
- $log_entry = $assert_session->elementExists('named', [
+ $log_entry = $mink->assertSession()->elementExists('named', [
'link',
'Drupal core has been updated from 9.8.0 to 9.8.1',
]);
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index c6750b1b15..42ded52a1f 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -40,13 +40,13 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$property->setValue(NULL, 'cli');
$this->assertTrue(CronUpdateStage::isCommandLine());
- // Since we're at the command line the terminal command should not be
+ // Since we're at the command line, the terminal command should not be
// invoked. Since we are in a kernel test, there would be an exception
// if that happened.
// @see \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage::runTerminalUpdateCommand
$this->container->get('cron')->run();
- // Even though the terminal command was not invoked hook_cron
- // implementations should have been invoked.
+ // Even though the terminal command was not invoked, hook_cron
+ // implementations should have been run.
$this->assertCronRan();
// If we are on the web but the method is set to 'console' the terminal
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 07fad847c2..72823e1c53 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -119,10 +119,10 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
// The terminal command cannot be run in a kernel test.
// @see \Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::runUpdateViaConsole
$this->assertSame(TestCronUpdateStage::class, $e->getMessage());
- // After cron runs, running the validator again should detect that cron
- // ran recently. Even though the terminal command did not succeed the
- // decorated cron service from the system module should have been called
- // before the attempt to run the terminal command.
+ // After cron runs, the validator should detect that cron ran recently.
+ // Even though the terminal command did not succeed, the decorated cron
+ // service from the System module should have been called before the
+ // attempt to run the terminal command.
// @see \Drupal\automatic_updates\CronUpdateStage::run
$this->assertCheckerResultsFromManager([], TRUE);
}
--
GitLab
From 1f27d033a10a9b00c30488e95b41745f1b7e4224 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 9 Aug 2023 10:53:03 -0400
Subject: [PATCH 129/142] log error if process failed or did not start
---
src/CronUpdateStage.php | 24 +++++++++++++++++++-----
1 file changed, 19 insertions(+), 5 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 4ba60e18cc..384218aad6 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -102,9 +102,6 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
// timeout.
$process = Process::fromShellCommandline($php_binary_finder->find() . " $command_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- // Since this process will run detached, and we won't be able to access its
- // output, we disable the output.
- $process->disableOutput();
$process->setTimeout(0);
try {
@@ -112,9 +109,26 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
// Wait for the process to have an ID, otherwise the web request may end
// before the detached process has a chance to start.
$wait_until = $this->time->getCurrentTime() + 5;
- do {
+ $pid = NULL;
+ while ($wait_until > $this->time->getCurrentTime()) {
+ $pid = $process->getPid();
+ if ($pid || $process->isTerminated()) {
+ break;
+ }
sleep(1);
- } while (is_null($process->getPid()) && $wait_until > $this->time->getCurrentTime());
+ }
+ if ($process->isTerminated()) {
+ if ($process->getExitCode() !== 0) {
+ $this->logger->error('Background update failed: %message',
+ [
+ '%message' => $process->getErrorOutput(),
+ ]
+ );
+ }
+ }
+ elseif (is_null($pid)) {
+ $this->logger->error('Background update failed because the process did not start within 5 seconds.');
+ }
}
catch (\Throwable $throwable) {
// @todo Just call Error::logException() in https://drupal.org/i/3377458.
--
GitLab
From d39a3d4f7a2cada6efd91fa9bf81a73a0be3c4ee Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 9 Aug 2023 11:47:35 -0400
Subject: [PATCH 130/142] sleep first before checks. Do not break on terminated
---
src/CronUpdateStage.php | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 384218aad6..1363e18d2d 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -109,14 +109,13 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
// Wait for the process to have an ID, otherwise the web request may end
// before the detached process has a chance to start.
$wait_until = $this->time->getCurrentTime() + 5;
- $pid = NULL;
- while ($wait_until > $this->time->getCurrentTime()) {
+ do {
+ sleep(1);
$pid = $process->getPid();
- if ($pid || $process->isTerminated()) {
+ if ($pid) {
break;
}
- sleep(1);
- }
+ } while ($wait_until > $this->time->getCurrentTime());
if ($process->isTerminated()) {
if ($process->getExitCode() !== 0) {
$this->logger->error('Background update failed: %message',
--
GitLab
From 4a1aad6d99a00a55d70e9df9375a7e25ea24f2d3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Wed, 9 Aug 2023 12:51:02 -0400
Subject: [PATCH 131/142] Refactor assertExpectedEventsFired
---
.../src/Build/TemplateProjectTestBase.php | 36 ++++++++-----------
src/Commands/AutomaticUpdatesCommands.php | 4 ++-
src/CronUpdateStage.php | 28 +++++++--------
tests/src/Build/CoreUpdateTest.php | 2 +-
4 files changed, 32 insertions(+), 38 deletions(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index b6ce831959..6dc9846b7a 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -568,9 +568,6 @@ END;
* that once if they will be fired multiple times. If there are no events
* specified all life cycle events from PreCreateEvent to PostDestroyEvent
* will be asserted.
- * @param bool $ignore_other_stages
- * (optional) Whether events fired by other stages should be ignored.
- * Defaults to FALSE.
* @param int $wait
* (optional) How many seconds to wait for the events to be fired. Defaults
* to 0.
@@ -579,7 +576,7 @@ END;
*
* @see \Drupal\package_manager_test_event_logger\EventSubscriber\EventLogSubscriber::logEventInfo
*/
- protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, bool $ignore_other_stages = FALSE, int $wait = 0, string $message = ''): void {
+ protected function assertExpectedStageEventsFired(string $expected_stage_class, ?array $expected_events = NULL, int $wait = 0, string $message = ''): void {
if ($expected_events === NULL) {
$expected_events = EventLogSubscriber::getSubscribedEvents();
// The event subscriber uses this event to ensure the log file is excluded
@@ -588,31 +585,28 @@ END;
unset($expected_events[CollectPathsToExcludeEvent::class]);
$expected_events = array_keys($expected_events);
}
- else {
- $this->assertNotEmpty($expected_events);
- }
+ $this->assertNotEmpty($expected_events);
+
+ $log_file = $this->getWorkspaceDirectory() . '/project/' . EventLogSubscriber::LOG_FILE_NAME;
$max_wait = time() + $wait;
do {
- $log_file = $this->getWorkspaceDirectory() . '/project/' . EventLogSubscriber::LOG_FILE_NAME;
$this->assertFileIsReadable($log_file);
$log_data = file_get_contents($log_file);
$log_data = json_decode($log_data, TRUE, flags: JSON_THROW_ON_ERROR);
- $filtered_logged_events = array_filter($log_data, fn($logged_stage_event) => $logged_stage_event['stage'] === $expected_stage_class);
- if (!$ignore_other_stages) {
- $this->assertCount(count($log_data), $filtered_logged_events);
- }
- $first_expected_events = array_slice($expected_events, 0, count($filtered_logged_events));
- $this->assertSame($first_expected_events, array_column($filtered_logged_events, 'event'), $message);
- // If all the expected events have been fired return.
- if (count($filtered_logged_events) === count($expected_events)) {
- return;
+ // Filter out events logged by any other stage.
+ $log_data = array_filter($log_data, fn (array $event): bool => $event['stage'] === $expected_stage_class);
+
+ // If we've logged at least the expected number of events, stop waiting.
+ // Break out of the loop and assert the expected events were logged.
+ if (count($log_data) >= count($expected_events)) {
+ break;
}
- // We should never have more logged events than we were waiting for.
- $this->assertLessThan(count($expected_events), count($filtered_logged_events));
- sleep(20);
+ // Wait a bit before checking again.
+ sleep(5);
} while ($max_wait > time());
- $this->fail("Failed to fire events in $wait seconds");
+
+ $this->assertSame($expected_events, array_column($log_data, 'event'));
}
/**
diff --git a/src/Commands/AutomaticUpdatesCommands.php b/src/Commands/AutomaticUpdatesCommands.php
index 7fcaf88396..4a3b33d7a6 100644
--- a/src/Commands/AutomaticUpdatesCommands.php
+++ b/src/Commands/AutomaticUpdatesCommands.php
@@ -110,7 +110,9 @@ final class AutomaticUpdatesCommands extends DrushCommands {
* Runs status checks, and sends failure notifications if necessary.
*
* @param bool $is_from_web
- * Whether the current process was started from a web request.
+ * Whether the current process was started from a web request. To prevent
+ * misleading or inaccurate results, it's very important that status checks
+ * are run as the web server user if $is_from_web is TRUE.
*/
private function runStatusChecks(bool $is_from_web): void {
$method = $this->configFactory->get('automatic_updates.settings')
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 1363e18d2d..7e5926bc80 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -96,10 +96,10 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
protected function runTerminalUpdateCommand(): void {
$command_path = $this->getCommandPath();
$php_binary_finder = new PhpExecutableFinder();
- // @todo Check if on windows to not allow cron updates.
+ // @todo Check if on Windows to not allow cron updates in
+ // https://drupal.org/i/3377237.
// Use the `&` on the command line to detach this process after it is
- // started. This will allow the command to run longer than web request
- // timeout.
+ // started. This will allow the command to outlive the web request.
$process = Process::fromShellCommandline($php_binary_finder->find() . " $command_path auto-update --is-from-web &");
$process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
$process->setTimeout(0);
@@ -116,18 +116,6 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
break;
}
} while ($wait_until > $this->time->getCurrentTime());
- if ($process->isTerminated()) {
- if ($process->getExitCode() !== 0) {
- $this->logger->error('Background update failed: %message',
- [
- '%message' => $process->getErrorOutput(),
- ]
- );
- }
- }
- elseif (is_null($pid)) {
- $this->logger->error('Background update failed because the process did not start within 5 seconds.');
- }
}
catch (\Throwable $throwable) {
// @todo Just call Error::logException() in https://drupal.org/i/3377458.
@@ -137,7 +125,17 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
else {
watchdog_exception('automatic_updates', $throwable, 'Unable to start background update.');
}
+ }
+ if ($process->isTerminated()) {
+ if ($process->getExitCode() !== 0) {
+ $this->logger->error('Background update failed: %message', [
+ '%message' => $process->getErrorOutput(),
+ ]);
+ }
+ }
+ elseif (is_null($pid)) {
+ $this->logger->error('Background update failed because the process did not start within 5 seconds.');
}
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index dac1061127..7f966262ab 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -250,7 +250,7 @@ class CoreUpdateTest extends UpdateTestBase {
PreDestroyEvent::class,
PostDestroyEvent::class,
];
- $this->assertExpectedStageEventsFired(DrushUpdateStage::class, $expected_events, TRUE, 360);
+ $this->assertExpectedStageEventsFired(DrushUpdateStage::class, $expected_events, 360);
$this->assertCronUpdateSuccessful();
}
--
GitLab
From 29fbcd61117bd676a1419ca264c45c45ab202299 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Wed, 9 Aug 2023 13:23:13 -0400
Subject: [PATCH 132/142] Some more changes
---
.../src/Build/TemplateProjectTestBase.php | 2 +-
src/CronUpdateStage.php | 27 ++++++++++---------
src/DrushUpdateStage.php | 13 ++++-----
tests/src/Build/CoreUpdateTest.php | 20 +++++---------
.../Kernel/AutomaticUpdatesKernelTestBase.php | 2 +-
tests/src/Kernel/CronUpdateStageTest.php | 7 ++---
tests/src/Kernel/DrushUpdateStageTest.php | 24 ++++++++---------
.../CronFrequencyValidatorTest.php | 2 +-
.../PhpExtensionsValidatorTest.php | 4 +--
.../StagedDatabaseUpdateValidatorTest.php | 2 +-
10 files changed, 47 insertions(+), 56 deletions(-)
diff --git a/package_manager/tests/src/Build/TemplateProjectTestBase.php b/package_manager/tests/src/Build/TemplateProjectTestBase.php
index 6dc9846b7a..a2f034a647 100644
--- a/package_manager/tests/src/Build/TemplateProjectTestBase.php
+++ b/package_manager/tests/src/Build/TemplateProjectTestBase.php
@@ -606,7 +606,7 @@ END;
sleep(5);
} while ($max_wait > time());
- $this->assertSame($expected_events, array_column($log_data, 'event'));
+ $this->assertSame($expected_events, array_column($log_data, 'event'), $message);
}
/**
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 7e5926bc80..5a538cb677 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -100,9 +100,9 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
// https://drupal.org/i/3377237.
// Use the `&` on the command line to detach this process after it is
// started. This will allow the command to outlive the web request.
- $process = Process::fromShellCommandline($php_binary_finder->find() . " $command_path auto-update --is-from-web &");
- $process->setWorkingDirectory($this->pathLocator->getProjectRoot() . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot());
- $process->setTimeout(0);
+ $process = Process::fromShellCommandline($php_binary_finder->find() . " $command_path auto-update --is-from-web &")
+ ->setWorkingDirectory($this->pathLocator->getProjectRoot())
+ ->setTimeout(0);
try {
$process->start();
@@ -134,7 +134,7 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
]);
}
}
- elseif (is_null($pid)) {
+ elseif (empty($pid)) {
$this->logger->error('Background update failed because the process did not start within 5 seconds.');
}
}
@@ -161,13 +161,14 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
->get('unattended.method');
// If we are configured to run updates via the web, and we're actually being
// accessed via the web (i.e., anything that isn't the command line), go
- // ahead and try to do the update. In all other circumstances, just run the
- // normal cron handler.
- if ($method === 'web' && !self::isCommandLine()) {
- if ($this->lock->acquire('cron', 30)) {
- $this->runTerminalUpdateCommand();
- $this->lock->release('cron');
- }
+ // ahead and try to do the update. Re-acquire the cron lock while we do this
+ // so that nothing else can try to run cron while we're doing an update.
+ // @TODO BEFORE MERGE: The cron lock should not be acquired or released
+ // here; that's the job of the DrushUpdateStage itself. (Acquire the lock
+ // when the update starts, and release it on post-apply?)
+ if ($method === 'web' && !self::isCommandLine() && $this->lock->acquire('cron', 30)) {
+ $this->runTerminalUpdateCommand();
+ $this->lock->release('cron');
}
return $decorated_cron_succeeded;
}
@@ -204,8 +205,8 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
// For some reason 'vendor/bin/drush' does not exist in build tests but this
// method will be removed entirely before beta.
$command_path = $this->pathLocator->getVendorDirectory() . '/drush/drush/drush';
- if (!file_exists($command_path)) {
- throw new \Exception("The Automatic Update terminal command is not available at $command_path.");
+ if (!is_executable($command_path)) {
+ throw new \Exception("The Automatic Updates terminal command is not available at $command_path.");
}
return $command_path;
}
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index bffb59c2ae..315678867d 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -24,7 +24,6 @@ use PhpTuf\ComposerStager\API\Core\BeginnerInterface;
use PhpTuf\ComposerStager\API\Core\CommitterInterface;
use PhpTuf\ComposerStager\API\Core\StagerInterface;
use PhpTuf\ComposerStager\API\Path\Factory\PathFactoryInterface;
-use Symfony\Component\HttpFoundation\Response;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
@@ -120,7 +119,10 @@ class DrushUpdateStage extends UpdateStage {
* Performs the update.
*
* @param bool $is_from_web
- * Whether the current process was started from a web request.
+ * Whether the current process was started from a web request. This is not
+ * used by this method specifically, but it's passed through to post-apply
+ * to ensure that status checks are only run as the web server user if the
+ * update is being trigger via the web.
*
* @return bool
* Returns TRUE if any update was attempted, otherwise FALSE.
@@ -261,11 +263,8 @@ class DrushUpdateStage extends UpdateStage {
* The version of Drupal core that started the update.
* @param string $target_version
* The version of Drupal core to which we updated.
- *
- * @return \Symfony\Component\HttpFoundation\Response
- * An empty 200 response if the post-apply tasks succeeded.
*/
- public function handlePostApply(string $stage_id, string $installed_version, string $target_version): Response {
+ public function handlePostApply(string $stage_id, string $installed_version, string $target_version): void {
$owner = $this->tempStore->getMetadata(static::TEMPSTORE_LOCK_KEY)
->getOwnerId();
// Reload the tempstore with the correct owner ID so we can claim the stage.
@@ -310,8 +309,6 @@ class DrushUpdateStage extends UpdateStage {
catch (StageEventException $e) {
$this->logger->error($e->getMessage());
}
-
- return new Response();
}
}
diff --git a/tests/src/Build/CoreUpdateTest.php b/tests/src/Build/CoreUpdateTest.php
index 7f966262ab..c008c2fb42 100644
--- a/tests/src/Build/CoreUpdateTest.php
+++ b/tests/src/Build/CoreUpdateTest.php
@@ -164,9 +164,8 @@ class CoreUpdateTest extends UpdateTestBase {
$this->createTestProject('RecommendedProject', TRUE);
$this->installModules(['automated_cron']);
- // Reset the record of the last cron run, so we do not have to wait for
- // Automated Cron to trigger cron again. Automated Cron will be triggered
- // at the end of this request.
+ // Reset the record of the last cron run, so that Automated Cron will be
+ // triggered at the end of this request.
$this->visit('/automatic-updates-test-api/reset-cron');
$this->getMink()->assertSession()->pageTextContains('cron reset');
$this->assertExpectedStageEventsFired(DrushUpdateStage::class, wait: 360);
@@ -390,13 +389,9 @@ class CoreUpdateTest extends UpdateTestBase {
$this->assertSame($expected_version, $info['devRequires']['drupal/core-dev']);
// The update form should not have any available updates.
$this->visit('/admin/modules/update');
- $this->getMink()->assertSession()->pageTextContains('No update available');
-
- $session = $this->getMink()->getSession();
- $assert_session = $this->getMink()->assertSession($session);
- $this->visit('/admin/modules/update');
- $assert_session->pageTextNotContains('Automatic updates failed to apply, and the site is in an indeterminate state. Consider restoring the code and database from a backup.');
+ $assert_session = $this->getMink()->assertSession();
$assert_session->pageTextContains('No update available');
+ $assert_session->pageTextNotContains('Automatic updates failed to apply, and the site is in an indeterminate state. Consider restoring the code and database from a backup.');
// The status page should report that we're running the expected version and
// the README and default site configuration files should contain the
@@ -450,11 +445,8 @@ class CoreUpdateTest extends UpdateTestBase {
$page->selectFieldOption('Severity', 'Info');
$page->pressButton('Filter');
// There should be a log entry about the successful update.
- $log_entry = $mink->assertSession()->elementExists('named', [
- 'link',
- 'Drupal core has been updated from 9.8.0 to 9.8.1',
- ]);
- $this->assertStringContainsString('/admin/reports/dblog/event/', $log_entry->getAttribute('href'));
+ $mink->assertSession()
+ ->elementAttributeContains('named', ['link', 'Drupal core has been updated from 9.8.0 to 9.8.1'], 'href', '/admin/reports/dblog/event/');
$this->assertUpdateSuccessful('9.8.1');
}
diff --git a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
index f591068632..eecd31e087 100644
--- a/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
+++ b/tests/src/Kernel/AutomaticUpdatesKernelTestBase.php
@@ -97,7 +97,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
/**
* Performs an update using the console update stage directly.
*/
- protected function runUpdateViaConsole(): void {
+ protected function runConsoleUpdateStage(): void {
$this->container->get(DrushUpdateStage::class)->performUpdate();
}
diff --git a/tests/src/Kernel/CronUpdateStageTest.php b/tests/src/Kernel/CronUpdateStageTest.php
index 42ded52a1f..1b8c625a5a 100644
--- a/tests/src/Kernel/CronUpdateStageTest.php
+++ b/tests/src/Kernel/CronUpdateStageTest.php
@@ -66,7 +66,7 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
->save();
try {
$this->container->get('cron')->run();
- $this->fail('Expected process exception');
+ $this->fail('Expected an exception when running updates via cron.');
}
catch (\BadMethodCallException $e) {
$this->assertSame(TestCronUpdateStage::class, $e->getMessage());
@@ -86,10 +86,11 @@ class CronUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$this->container->get('module_handler')->moduleExists('common_test_cron_helper'),
'\Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase::assertCronRan can only be used if common_test_cron_helper is enabled.'
);
- $this->assertSame('success', $this->container->get('state')->get('common_test.cron'));
+ $state = $this->container->get('state');
+ $this->assertSame('success', $state->get('common_test.cron'));
// Delete the value so this function can be called again after the next cron
// attempt.
- $this->container->get('state')->delete('common_test.cron');
+ $state->delete('common_test.cron');
}
}
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 7e65ba4317..2bc2e26d09 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -88,7 +88,7 @@ class DrushUpdateStageTest extends AutomaticUpdatesKernelTestBase {
$exception = new \Exception('Error during running post-apply tasks!');
TestSubscriber1::setException($exception, PostApplyEvent::class);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$this->assertNoCronRun();
$this->assertTrue($this->logger->hasRecord($exception->getMessage(), (string) RfcLogLevel::ERROR));
@@ -200,7 +200,7 @@ END;
$this->assertCount(0, $this->container->get('package_manager.beginner')->getInvocationArguments());
// Run cron and ensure that Package Manager's services were called or
// bypassed depending on configuration.
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$will_update = (int) $will_update;
$this->assertCount($will_update, $this->container->get('package_manager.beginner')->getInvocationArguments());
@@ -336,7 +336,7 @@ END;
$this->assertEmpty($this->logger->records);
$this->assertTrue($stage->isAvailable());
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$logged_by_stage = $this->logger->hasRecord($expected_log_message, (string) RfcLogLevel::ERROR);
// To check if the exception was logged by the main cron service, we need
@@ -390,7 +390,7 @@ END;
$this->addEventTestListener($listener, PostRequireEvent::class);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$this->assertIsString($cron_stage_dir);
$this->assertNotEquals($original_stage_directory, $cron_stage_dir);
$this->assertDirectoryDoesNotExist($cron_stage_dir);
@@ -425,7 +425,7 @@ END;
// Ensure the stage that is applying the operation is not the cron
// update stage.
$this->assertInstanceOf(TestStage::class, $event->stage);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
// We do not actually want to apply this operation it was just invoked to
// allow cron to be attempted.
$event->addError([$stop_error]);
@@ -461,7 +461,7 @@ END;
// Trigger CronUpdateStage, the above should cause it to detect a stage that
// is applying.
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$this->assertTrue($this->logger->hasRecord('Cron will not perform any updates because there is an existing stage and the current version of the site is secure.', (string) RfcLogLevel::NOTICE));
$this->assertUpdateStagedTimes(1);
@@ -481,7 +481,7 @@ END;
*/
public function testEmailOnSuccess(): void {
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
// Ensure we sent a success message to all recipients.
$expected_body = <<<END
@@ -543,7 +543,7 @@ END;
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
TestSubscriber1::setTestResult($exception->event->getResults(), $event_class);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -584,7 +584,7 @@ END;
TestSubscriber1::setTestResult([$error], $event_class);
$exception = $this->createStageEventExceptionFromResults([$error], $event_class, $this->container->get(DrushUpdateStage::class));
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$url = Url::fromRoute('update.report_update')
->setAbsolute()
@@ -612,7 +612,7 @@ END;
$error = new \LogicException('I drink your milkshake!');
LoggingCommitter::setException($error);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$expected_body = <<<END
Drupal core failed to update automatically from 9.8.0 to 9.8.1. The following error was logged:
@@ -644,7 +644,7 @@ END;
// Before the update begins, we should have no indication that we have ever
// been in maintenance mode (i.e., the value in state is NULL).
$this->assertNull($state->get('system.maintenance_mode'));
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$state->resetCache();
// @see \Drupal\Tests\automatic_updates\Kernel\TestCronUpdateStage::apply()
$this->assertTrue($this->logger->hasRecord('Unattended update was applied in maintenance mode.', RfcLogLevel::INFO));
@@ -695,7 +695,7 @@ END;
/** @var \Drupal\Core\State\StateInterface $state */
$state = $this->container->get('state');
$this->assertNull($state->get('system.maintenance_mode'));
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$this->assertFalse($this->logger->hasRecord('Unattended update was applied in maintenance mode.', RfcLogLevel::INFO));
$this->assertSame($will_be_in_maintenance_mode, $state->get('system.maintenance_mode'));
}
diff --git a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
index 72823e1c53..871eb07b16 100644
--- a/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/CronFrequencyValidatorTest.php
@@ -113,7 +113,7 @@ class CronFrequencyValidatorTest extends AutomaticUpdatesKernelTestBase {
try {
$this->container->get('cron')->run();
- $this->fail('Expected failure');
+ $this->fail('Expected an exception but one was not thrown.');
}
catch (\BadMethodCallException $e) {
// The terminal command cannot be run in a kernel test.
diff --git a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
index 07b8332112..0c1c456187 100644
--- a/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/PhpExtensionsValidatorTest.php
@@ -61,7 +61,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
// The update should have been stopped before it started.
$this->assertUpdateStagedTimes(0);
$this->assertTrue($logger->hasRecordThatContains((string) $error_result->messages[0], RfcLogLevel::ERROR));
@@ -85,7 +85,7 @@ class PhpExtensionsValidatorTest extends AutomaticUpdatesKernelTestBase {
->get('automatic_updates')
->addLogger($logger);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
// The update should have been staged, but then stopped with an error.
$this->assertUpdateStagedTimes(1);
$this->assertTrue($logger->hasRecordThatContains("Unattended updates are not allowed while Xdebug is enabled. You cannot receive updates, including security updates, until it is disabled.", RfcLogLevel::ERROR));
diff --git a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
index 8de4d3839e..d4b3368541 100644
--- a/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
+++ b/tests/src/Kernel/StatusCheck/StagedDatabaseUpdateValidatorTest.php
@@ -38,7 +38,7 @@ class StagedDatabaseUpdateValidatorTest extends AutomaticUpdatesKernelTestBase {
};
$this->addEventTestListener($listener);
- $this->runUpdateViaConsole();
+ $this->runConsoleUpdateStage();
$expected_message = "The update cannot proceed because database updates have been detected in the following extensions.\nSystem\n";
$this->assertTrue($logger->hasRecord($expected_message, (string) RfcLogLevel::ERROR));
}
--
GitLab
From be0d6a1fe102be69c5a9f8305d8a9e9ceb887967 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Wed, 9 Aug 2023 13:25:15 -0400
Subject: [PATCH 133/142] cs
---
src/CronUpdateStage.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 5a538cb677..3229be9da3 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -163,7 +163,7 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
// accessed via the web (i.e., anything that isn't the command line), go
// ahead and try to do the update. Re-acquire the cron lock while we do this
// so that nothing else can try to run cron while we're doing an update.
- // @TODO BEFORE MERGE: The cron lock should not be acquired or released
+ // @todo BEFORE MERGE: The cron lock should not be acquired or released
// here; that's the job of the DrushUpdateStage itself. (Acquire the lock
// when the update starts, and release it on post-apply?)
if ($method === 'web' && !self::isCommandLine() && $this->lock->acquire('cron', 30)) {
--
GitLab
From bb5750926efae73a736e53177a16e6b939ee018e Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 9 Aug 2023 13:47:30 -0400
Subject: [PATCH 134/142] state service no longer needed
---
src/DrushUpdateStage.php | 3 ---
1 file changed, 3 deletions(-)
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index 315678867d..f798a27174 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -36,8 +36,6 @@ class DrushUpdateStage extends UpdateStage {
/**
* Constructs a DrushUpdateStage object.
*
- * @param \Drupal\Core\State\StateInterface $state
- * The state service.
* @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\Core\Mail\MailManagerInterface $mailManager
@@ -70,7 +68,6 @@ class DrushUpdateStage extends UpdateStage {
* The failure marker service.
*/
public function __construct(
- private readonly StateInterface $state,
private readonly CronUpdateStage $cronUpdateRunner,
private readonly MailManagerInterface $mailManager,
private readonly StatusCheckMailer $statusCheckMailer,
--
GitLab
From d02e19ff598efd30bcce146f6a32f04f0b013c77 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 9 Aug 2023 15:09:02 -0400
Subject: [PATCH 135/142] acquire the cron lock in the Drush update stage
---
automatic_updates.services.yml | 2 +-
src/CronUpdateStage.php | 13 +-----
src/DrushUpdateStage.php | 11 ++++-
tests/src/Kernel/DrushUpdateStageTest.php | 49 +++++++++++++++++++++++
4 files changed, 62 insertions(+), 13 deletions(-)
diff --git a/automatic_updates.services.yml b/automatic_updates.services.yml
index 32005af50e..cd396172d1 100644
--- a/automatic_updates.services.yml
+++ b/automatic_updates.services.yml
@@ -28,7 +28,6 @@ services:
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
arguments:
- $lock: '@lock'
$inner: '@automatic_updates.cron_update_stage.inner'
decorates: 'cron'
Drupal\automatic_updates\CronUpdateStage: '@automatic_updates.cron_update_stage'
@@ -66,6 +65,7 @@ services:
arguments: ['automatic_updates']
Drupal\automatic_updates\DrushUpdateStage:
arguments:
+ $lock: '@lock'
$committer: '@Drupal\automatic_updates\MaintenanceModeAwareCommitter'
calls:
- ['setLogger', ['@logger.channel.automatic_updates']]
diff --git a/src/CronUpdateStage.php b/src/CronUpdateStage.php
index 3229be9da3..dde2596226 100644
--- a/src/CronUpdateStage.php
+++ b/src/CronUpdateStage.php
@@ -7,7 +7,6 @@ namespace Drupal\automatic_updates;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\CronInterface;
-use Drupal\Core\Lock\LockBackendInterface;
use Drupal\Core\Utility\Error;
use Drupal\package_manager\PathLocator;
use Psr\Log\LoggerAwareInterface;
@@ -73,8 +72,6 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
* The config factory service.
* @param \Drupal\package_manager\PathLocator $pathLocator
* The path locator service.
- * @param \Drupal\Core\Lock\LockBackendInterface $lock
- * The lock service.
* @param \Drupal\Core\CronInterface $inner
* The decorated cron service.
* @param \Drupal\Component\Datetime\TimeInterface $time
@@ -83,7 +80,6 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
public function __construct(
private readonly ConfigFactoryInterface $configFactory,
private readonly PathLocator $pathLocator,
- private readonly LockBackendInterface $lock,
private readonly CronInterface $inner,
private readonly TimeInterface $time,
) {
@@ -161,14 +157,9 @@ class CronUpdateStage implements CronInterface, LoggerAwareInterface {
->get('unattended.method');
// If we are configured to run updates via the web, and we're actually being
// accessed via the web (i.e., anything that isn't the command line), go
- // ahead and try to do the update. Re-acquire the cron lock while we do this
- // so that nothing else can try to run cron while we're doing an update.
- // @todo BEFORE MERGE: The cron lock should not be acquired or released
- // here; that's the job of the DrushUpdateStage itself. (Acquire the lock
- // when the update starts, and release it on post-apply?)
- if ($method === 'web' && !self::isCommandLine() && $this->lock->acquire('cron', 30)) {
+ // ahead and try to do the update.
+ if ($method === 'web' && !self::isCommandLine()) {
$this->runTerminalUpdateCommand();
- $this->lock->release('cron');
}
return $decorated_cron_succeeded;
}
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index f798a27174..af9fcfa28b 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -6,8 +6,8 @@ namespace Drupal\automatic_updates;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\Lock\LockBackendInterface;
use Drupal\Core\Mail\MailManagerInterface;
-use Drupal\Core\State\StateInterface;
use Drupal\Core\TempStore\SharedTempStoreFactory;
use Drupal\Core\Url;
use Drupal\package_manager\ComposerInspector;
@@ -36,6 +36,8 @@ class DrushUpdateStage extends UpdateStage {
/**
* Constructs a DrushUpdateStage object.
*
+ * @param \Drupal\Core\Lock\LockBackendInterface $lock
+ * The lock service.
* @param \Drupal\automatic_updates\CronUpdateStage $cronUpdateRunner
* The cron update runner service.
* @param \Drupal\Core\Mail\MailManagerInterface $mailManager
@@ -68,6 +70,7 @@ class DrushUpdateStage extends UpdateStage {
* The failure marker service.
*/
public function __construct(
+ private readonly LockBackendInterface $lock,
private readonly CronUpdateStage $cronUpdateRunner,
private readonly MailManagerInterface $mailManager,
private readonly StatusCheckMailer $statusCheckMailer,
@@ -164,6 +167,10 @@ class DrushUpdateStage extends UpdateStage {
$this->logger->error('Unable to determine the current version of Drupal core.');
return $update_started;
}
+ if (!$this->lock->acquire('cron', 600)) {
+ $this->logger->error('Unable to start Drupal core update because cron is running.');
+ return $update_started;
+ }
// Do the bulk of the update in its own try-catch structure, so that we can
// handle any exceptions or validation errors consistently, and destroy the
@@ -174,8 +181,10 @@ class DrushUpdateStage extends UpdateStage {
$stage_id = parent::begin(['drupal' => $target_version], 300);
$this->stage();
$this->apply();
+ $this->lock->release('cron');
}
catch (\Throwable $e) {
+ $this->lock->release('cron');
if ($e instanceof StageEventException && $e->event instanceof PreCreateEvent) {
// If the error happened during PreCreateEvent then the update did not
// really start.
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 2bc2e26d09..ab118a13a1 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -32,6 +32,7 @@ use PhpTuf\ComposerStager\API\Precondition\Service\PreconditionInterface;
use PhpTuf\ComposerStager\Internal\Translation\Value\TranslatableMessage;
use Prophecy\Argument;
use ColinODell\PsrTestLogger\TestLogger;
+use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
@@ -112,6 +113,11 @@ END;
public function register(ContainerBuilder $container) {
parent::register($container);
+ // Change container to use database lock backends.
+ $container
+ ->register('lock', 'Drupal\Core\Lock\DatabaseLockBackend')
+ ->addArgument(new Reference('database'));
+
// 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.
@@ -700,6 +706,49 @@ END;
$this->assertSame($will_be_in_maintenance_mode, $state->get('system.maintenance_mode'));
}
+ /**
+ * Tests that the cron lock is acquired and released during an update.
+ */
+ public function testCronIsLockedDuringUpdate(): void {
+ $lock_checked_on_pre_create = FALSE;
+ $lock = $this->container->get('lock');
+ $pre_create_lock_checker = function () use (&$lock_checked_on_pre_create, $lock) {
+ $this->assertFalse($lock->lockMayBeAvailable('cron'));
+ $lock_checked_on_pre_create = TRUE;
+ };
+ // Add listener to ensure the cron lock is acquired during an update.
+ $this->addEventTestListener(
+ $pre_create_lock_checker,
+ PreCreateEvent::class
+ );
+ $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
+ // Ensure that the cron lock is available before the update attempt.
+ $this->assertTrue($lock->lockMayBeAvailable('cron'));
+ $this->runConsoleUpdateStage();
+ // Ensure our pre-create listener was called.
+ $this->assertTrue($lock_checked_on_pre_create);
+ $this->assertTrue($lock->lockMayBeAvailable('cron'));
+
+ // Ensure that the cron lock is released when there is exception in the
+ // update.
+ $this->addEventTestListener(
+ function () {
+ throw new \Exception('Cron update failed.');
+ },
+ PostCreateEvent::class
+ );
+ $this->addEventTestListener(
+ $pre_create_lock_checker,
+ PreCreateEvent::class
+ );
+ $lock_checked_on_pre_create = FALSE;
+ $this->runConsoleUpdateStage();
+ $this->logger->hasErrorThatContains('Cron update failed.');
+ $this->assertTrue($lock->lockMayBeAvailable('cron'));
+ $this->assertTrue($lock_checked_on_pre_create);
+
+ }
+
/**
* Asserts cron has not run.
*
--
GitLab
From da3a12fe172f2a9141dae388149914b483b0b78b Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 9 Aug 2023 15:23:07 -0400
Subject: [PATCH 136/142] create finally for lock release
---
src/DrushUpdateStage.php | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index af9fcfa28b..4f8c58b466 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -181,10 +181,8 @@ class DrushUpdateStage extends UpdateStage {
$stage_id = parent::begin(['drupal' => $target_version], 300);
$this->stage();
$this->apply();
- $this->lock->release('cron');
}
catch (\Throwable $e) {
- $this->lock->release('cron');
if ($e instanceof StageEventException && $e->event instanceof PreCreateEvent) {
// If the error happened during PreCreateEvent then the update did not
// really start.
@@ -226,6 +224,8 @@ class DrushUpdateStage extends UpdateStage {
$this->destroy();
}
return $update_started;
+ } finally {
+ $this->lock->release('cron');
}
$this->triggerPostApply($stage_id, $installed_version, $target_version, $is_from_web);
return TRUE;
--
GitLab
From a9ed3bb04778b9b96acff6f0ea89fef54e1856a5 Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Wed, 9 Aug 2023 15:58:53 -0400
Subject: [PATCH 137/142] do not release the cron lock until post apply
---
src/DrushUpdateStage.php | 4 +--
tests/src/Kernel/DrushUpdateStageTest.php | 34 +++++++++++++----------
2 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/src/DrushUpdateStage.php b/src/DrushUpdateStage.php
index 4f8c58b466..9704b127cc 100644
--- a/src/DrushUpdateStage.php
+++ b/src/DrushUpdateStage.php
@@ -183,6 +183,7 @@ class DrushUpdateStage extends UpdateStage {
$this->apply();
}
catch (\Throwable $e) {
+ $this->lock->release('cron');
if ($e instanceof StageEventException && $e->event instanceof PreCreateEvent) {
// If the error happened during PreCreateEvent then the update did not
// really start.
@@ -224,8 +225,6 @@ class DrushUpdateStage extends UpdateStage {
$this->destroy();
}
return $update_started;
- } finally {
- $this->lock->release('cron');
}
$this->triggerPostApply($stage_id, $installed_version, $target_version, $is_from_web);
return TRUE;
@@ -304,6 +303,7 @@ class DrushUpdateStage extends UpdateStage {
catch (\Throwable $e) {
$this->logger->error($e->getMessage());
}
+ $this->lock->release('cron');
// If any pre-destroy event subscribers raise validation errors, ensure they
// are formatted and logged. But if any pre- or post-destroy event
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index ab118a13a1..f248c5d9c0 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -18,6 +18,7 @@ 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\Event\StageEvent;
use Drupal\package_manager\Exception\StageEventException;
use Drupal\package_manager\Exception\StageOwnershipException;
use Drupal\package_manager\ValidationResult;
@@ -123,6 +124,11 @@ END;
// staged changes are applied.
// @see ::testStageDestroyedOnError()
$container->getDefinition('logger.factory')->addTag('persist');
+
+ // Since this test adds arbitrary event listeners that aren't services, we
+ // need to ensure they will persist even if the container is rebuilt when
+ // staged changes are applied.
+ $container->getDefinition('event_dispatcher')->addTag('persist');
}
/**
@@ -710,23 +716,28 @@ END;
* Tests that the cron lock is acquired and released during an update.
*/
public function testCronIsLockedDuringUpdate(): void {
- $lock_checked_on_pre_create = FALSE;
+ $lock_checked_on_events = [];
$lock = $this->container->get('lock');
- $pre_create_lock_checker = function () use (&$lock_checked_on_pre_create, $lock) {
+ $lock_checker = function (StageEvent $event) use (&$lock_checked_on_events, $lock) {
$this->assertFalse($lock->lockMayBeAvailable('cron'));
- $lock_checked_on_pre_create = TRUE;
+ $lock_checked_on_events[] = get_class($event);
};
- // Add listener to ensure the cron lock is acquired during an update.
+ // Add listeners to ensure the cron lock is acquired at the beginning of the
+ // update and only released in post-apply.
$this->addEventTestListener(
- $pre_create_lock_checker,
+ $lock_checker,
PreCreateEvent::class
);
+ $this->addEventTestListener(
+ $lock_checker,
+ PostApplyEvent::class
+ );
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
// Ensure that the cron lock is available before the update attempt.
$this->assertTrue($lock->lockMayBeAvailable('cron'));
$this->runConsoleUpdateStage();
- // Ensure our pre-create listener was called.
- $this->assertTrue($lock_checked_on_pre_create);
+ // Ensure the lock listeners was called.
+ $this->assertSame([PreCreateEvent::class, PostApplyEvent::class], $lock_checked_on_events);
$this->assertTrue($lock->lockMayBeAvailable('cron'));
// Ensure that the cron lock is released when there is exception in the
@@ -737,16 +748,11 @@ END;
},
PostCreateEvent::class
);
- $this->addEventTestListener(
- $pre_create_lock_checker,
- PreCreateEvent::class
- );
- $lock_checked_on_pre_create = FALSE;
+ $lock_checked_on_events = [];
$this->runConsoleUpdateStage();
$this->logger->hasErrorThatContains('Cron update failed.');
$this->assertTrue($lock->lockMayBeAvailable('cron'));
- $this->assertTrue($lock_checked_on_pre_create);
-
+ $this->assertSame([PreCreateEvent::class], $lock_checked_on_events);
}
/**
--
GitLab
From 41d7b73158c18a279f0ef17a407c8280ceb20670 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Wed, 9 Aug 2023 16:04:56 -0400
Subject: [PATCH 138/142] Clean up test
---
tests/src/Kernel/DrushUpdateStageTest.php | 29 +++++++++--------------
1 file changed, 11 insertions(+), 18 deletions(-)
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index f248c5d9c0..4ab8bd21d3 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -718,39 +718,32 @@ END;
public function testCronIsLockedDuringUpdate(): void {
$lock_checked_on_events = [];
$lock = $this->container->get('lock');
+
+ // Add listeners to ensure the cron lock is acquired at the beginning of the
+ // update and only released in post-apply.
$lock_checker = function (StageEvent $event) use (&$lock_checked_on_events, $lock) {
+ // The lock should not be available, since it should have been acquired
+ // by the stage before pre-create, and released after post-apply.
$this->assertFalse($lock->lockMayBeAvailable('cron'));
$lock_checked_on_events[] = get_class($event);
};
- // Add listeners to ensure the cron lock is acquired at the beginning of the
- // update and only released in post-apply.
- $this->addEventTestListener(
- $lock_checker,
- PreCreateEvent::class
- );
- $this->addEventTestListener(
- $lock_checker,
- PostApplyEvent::class
- );
+ $this->addEventTestListener($lock_checker, PreCreateEvent::class);
+ $this->addEventTestListener($lock_checker, PostApplyEvent::class);
+
$this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
// Ensure that the cron lock is available before the update attempt.
$this->assertTrue($lock->lockMayBeAvailable('cron'));
$this->runConsoleUpdateStage();
- // Ensure the lock listeners was called.
+ // Ensure the lock was checked on pre-create and post-apply.
$this->assertSame([PreCreateEvent::class, PostApplyEvent::class], $lock_checked_on_events);
$this->assertTrue($lock->lockMayBeAvailable('cron'));
// Ensure that the cron lock is released when there is exception in the
// update.
- $this->addEventTestListener(
- function () {
- throw new \Exception('Cron update failed.');
- },
- PostCreateEvent::class
- );
+ $this->addEventTestListener(fn () => throw new \Exception('Nope!'), PostCreateEvent::class);
$lock_checked_on_events = [];
$this->runConsoleUpdateStage();
- $this->logger->hasErrorThatContains('Cron update failed.');
+ $this->assertTrue($this->logger->hasErrorThatContains('Nope!'));
$this->assertTrue($lock->lockMayBeAvailable('cron'));
$this->assertSame([PreCreateEvent::class], $lock_checked_on_events);
}
--
GitLab
From 31ee27420c479b71e2c3a6aa61fbcddedeab73e8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Wed, 9 Aug 2023 16:13:29 -0400
Subject: [PATCH 139/142] try to fix cs
---
tests/src/Kernel/DrushUpdateStageTest.php | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 4ab8bd21d3..6e661a0ead 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -740,7 +740,10 @@ END;
// Ensure that the cron lock is released when there is exception in the
// update.
- $this->addEventTestListener(fn () => throw new \Exception('Nope!'), PostCreateEvent::class);
+ $listener = function (): never {
+ throw new \Exception('Nope!');
+ };
+ $this->addEventTestListener($listener, PostCreateEvent::class);
$lock_checked_on_events = [];
$this->runConsoleUpdateStage();
$this->assertTrue($this->logger->hasErrorThatContains('Nope!'));
--
GitLab
From 801af187dc62a07509a4be820185a45409e7741d Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 11 Aug 2023 10:11:46 -0400
Subject: [PATCH 140/142] do not mock event_dispatcher because it must persist
---
tests/src/Kernel/DrushUpdateStageTest.php | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 6e661a0ead..1f3d6bab0d 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -31,10 +31,8 @@ use PhpTuf\ComposerStager\API\Exception\InvalidArgumentException;
use PhpTuf\ComposerStager\API\Exception\PreconditionException;
use PhpTuf\ComposerStager\API\Precondition\Service\PreconditionInterface;
use PhpTuf\ComposerStager\Internal\Translation\Value\TranslatableMessage;
-use Prophecy\Argument;
use ColinODell\PsrTestLogger\TestLogger;
use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
* @covers \Drupal\automatic_updates\DrushUpdateStage
@@ -202,13 +200,6 @@ END;
->set('unattended.level', $setting)
->save();
- // 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);
- $event_dispatcher->dispatch(Argument::type('object'))->willReturnArgument(0);
- $this->container->set('event_dispatcher', $event_dispatcher->reveal());
-
$this->assertCount(0, $this->container->get('package_manager.beginner')->getInvocationArguments());
// Run cron and ensure that Package Manager's services were called or
// bypassed depending on configuration.
--
GitLab
From f37616b01767abe2a563a9e25fbe01d793bd2eba Mon Sep 17 00:00:00 2001
From: Ted Bowman <ted+git@tedbow.com>
Date: Fri, 11 Aug 2023 11:04:15 -0400
Subject: [PATCH 141/142] use RfcLogLevel::ERROR
---
tests/src/Kernel/DrushUpdateStageTest.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tests/src/Kernel/DrushUpdateStageTest.php b/tests/src/Kernel/DrushUpdateStageTest.php
index 1f3d6bab0d..b7b24c78f3 100644
--- a/tests/src/Kernel/DrushUpdateStageTest.php
+++ b/tests/src/Kernel/DrushUpdateStageTest.php
@@ -737,7 +737,7 @@ END;
$this->addEventTestListener($listener, PostCreateEvent::class);
$lock_checked_on_events = [];
$this->runConsoleUpdateStage();
- $this->assertTrue($this->logger->hasErrorThatContains('Nope!'));
+ $this->assertTrue($this->logger->hasRecordThatContains('Nope!', RfcLogLevel::ERROR));
$this->assertTrue($lock->lockMayBeAvailable('cron'));
$this->assertSame([PreCreateEvent::class], $lock_checked_on_events);
}
--
GitLab
From b443b95f00788e209017a92bbccc965d307190f2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ph=C3=A9na=20Proxima?= <adam@phenaproxima.net>
Date: Fri, 11 Aug 2023 11:58:13 -0400
Subject: [PATCH 142/142] Remove possibly unnecessary email normalization lines
---
tests/src/Traits/EmailNotificationsTestTrait.php | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/tests/src/Traits/EmailNotificationsTestTrait.php b/tests/src/Traits/EmailNotificationsTestTrait.php
index d63c3e9385..48a5eb0d43 100644
--- a/tests/src/Traits/EmailNotificationsTestTrait.php
+++ b/tests/src/Traits/EmailNotificationsTestTrait.php
@@ -89,9 +89,7 @@ trait EmailNotificationsTestTrait {
// @see automatic_updates_test_mail_alter()
$this->assertArrayHasKey('line_langcodes', $sent_message);
$this->assertSame([$expected_langcode], $sent_message['line_langcodes']);
- $actual_body = trim(str_replace("\n", ' ', $sent_message['body']));
- $expected_body = trim(str_replace("\n", ' ', $expected_body));
- $this->assertStringStartsWith($expected_body, $actual_body);
+ $this->assertStringStartsWith($expected_body, $sent_message['body']);
}
}
--
GitLab