Issue #3279064 by tedbow: Consolidate logic around test stages (349ea640) · Commits · project / automatic_updates

automatic_updates_extensions/tests/src/Kernel/AutomaticUpdatesExtensionsKernelTestBase.php

+2 −28

Original line number	Diff line number	Diff line
		@@ -3,12 +3,9 @@
		namespace Drupal\Tests\automatic_updates_extensions\Kernel;

		use Drupal\automatic_updates_extensions\ExtensionUpdater;
		use Drupal\package_manager\Event\StageEvent;
		use Drupal\package_manager\Exception\StageException;
		use Drupal\package_manager\Exception\StageValidationException;
		use Drupal\package_manager\Stage;
		use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
		use Drupal\Tests\package_manager\Kernel\TestStage;
		use Drupal\Tests\package_manager\Kernel\TestStageTrait;
		use GuzzleHttp\Client;
		use GuzzleHttp\Handler\MockHandler;
		use GuzzleHttp\HandlerStack;
		@@ -124,29 +121,6 @@ abstract class AutomaticUpdatesExtensionsKernelTestBase extends AutomaticUpdates
		*/
		class TestExtensionUpdater extends ExtensionUpdater {

		/**
		* {@inheritdoc}
		*/
		public function __construct(...$arguments) {
		parent::__construct(...$arguments);

		$mirror = new \ReflectionClass(Stage::class);
		$this->tempStore->set($mirror->getConstant('TEMPSTORE_STAGING_ROOT_KEY'), TestStage::$stagingRoot);
		}

		/**
		* {@inheritdoc}
		*/
		protected function dispatch(StageEvent $event, callable $on_error = NULL): void {
		try {
		parent::dispatch($event, $on_error);
		}
		catch (StageException $e) {
		// Attach the event object to the exception so that test code can verify
		// that the exception was thrown when a specific event was dispatched.
		$e->event = $event;
		throw $e;
		}
		}
		use TestStageTrait;

		}

package_manager/tests/src/Kernel/PackageManagerKernelTestBase.php

+24 −6

Original line number	Diff line number	Diff line
		@@ -31,6 +31,17 @@ abstract class PackageManagerKernelTestBase extends KernelTestBase {
		'package_manager_bypass',
		];

		/**
		* The test staging root.
		*
		* This value must be set before creating a test stage instance.
		*
		* @var string
		*
		* @see \Drupal\Tests\package_manager\Kernel\TestStageTrait::__construct()
		*/
		public static $testStagingRoot;

		/**
		* The service IDs of any validators to disable.
		*
		@@ -175,7 +186,7 @@ abstract class PackageManagerKernelTestBase extends KernelTestBase {
		// Create a staging root directory alongside the active directory.
		$stage_dir = vfsStream::newDirectory('stage');
		$this->vfsRoot->addChild($stage_dir);
		TestStage::$stagingRoot = $stage_dir->url();
		static::$testStagingRoot = $stage_dir->url();

		$path_locator = $this->mockPathLocator($active_dir->url());

		@@ -230,9 +241,9 @@ abstract class PackageManagerKernelTestBase extends KernelTestBase {
		}

		/**
		* Defines a stage specifically for testing purposes.
		* Common functions for test stages.
		*/
		class TestStage extends Stage {
		trait TestStageTrait {

		/**
		* The directory where staging areas will be created.
		@@ -246,9 +257,8 @@ class TestStage extends Stage {
		*/
		public function __construct(...$arguments) {
		parent::__construct(...$arguments);

		$mirror = new \ReflectionClass(parent::class);
		$this->tempStore->set($mirror->getConstant('TEMPSTORE_STAGING_ROOT_KEY'), static::$stagingRoot);
		$mirror = new \ReflectionClass(Stage::class);
		$this->tempStore->set($mirror->getConstant('TEMPSTORE_STAGING_ROOT_KEY'), PackageManagerKernelTestBase::$testStagingRoot);
		}

		/**
		@@ -266,6 +276,14 @@ class TestStage extends Stage {
		}
		}

		}
		/**
		* Defines a stage specifically for testing purposes.
		*/
		class TestStage extends Stage {

		use TestStageTrait;

		}

		/**

tests/src/Kernel/AutomaticUpdatesKernelTestBase.php

+3 −20

Original line number	Diff line number	Diff line
		@@ -5,10 +5,9 @@ namespace Drupal\Tests\automatic_updates\Kernel;
		use Drupal\automatic_updates\CronUpdater;
		use Drupal\automatic_updates\Updater;
		use Drupal\Core\DependencyInjection\ContainerBuilder;
		use Drupal\package_manager\Stage;
		use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
		use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
		use Drupal\Tests\package_manager\Kernel\TestStage;
		use Drupal\Tests\package_manager\Kernel\TestStageTrait;
		use GuzzleHttp\Client;
		use GuzzleHttp\Handler\MockHandler;
		use GuzzleHttp\HandlerStack;
		@@ -151,15 +150,7 @@ abstract class AutomaticUpdatesKernelTestBase extends PackageManagerKernelTestBa
		*/
		class TestUpdater extends Updater {

		/**
		* {@inheritdoc}
		*/
		public function __construct(...$arguments) {
		parent::__construct(...$arguments);

		$mirror = new \ReflectionClass(Stage::class);
		$this->tempStore->set($mirror->getConstant('TEMPSTORE_STAGING_ROOT_KEY'), TestStage::$stagingRoot);
		}
		use TestStageTrait;

		}

		@@ -168,14 +159,6 @@ class TestUpdater extends Updater {
		*/
		class TestCronUpdater extends CronUpdater {

		/**
		* {@inheritdoc}
		*/
		public function __construct(...$arguments) {
		parent::__construct(...$arguments);

		$mirror = new \ReflectionClass(Stage::class);
		$this->tempStore->set($mirror->getConstant('TEMPSTORE_STAGING_ROOT_KEY'), TestStage::$stagingRoot);
		}
		use TestStageTrait;

		}

tests/src/Kernel/ReadinessValidation/StagedDatabaseUpdateValidatorTest.php

+1 −2

Original line number	Diff line number	Diff line
		@@ -5,7 +5,6 @@ namespace Drupal\Tests\automatic_updates\Kernel\ReadinessValidation;
		use Drupal\package_manager\Exception\StageValidationException;
		use Drupal\package_manager\ValidationResult;
		use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
		use Drupal\Tests\package_manager\Kernel\TestStage;

		/**
		* @covers \Drupal\automatic_updates\Validator\StagedDatabaseUpdateValidator
		@@ -36,7 +35,7 @@ class StagedDatabaseUpdateValidatorTest extends AutomaticUpdatesKernelTestBase {
		$this->disableValidators[] = 'package_manager.validator.lock_file';
		parent::setUp();

		TestStage::$stagingRoot = $this->vfsRoot->url();
		static::$testStagingRoot = $this->vfsRoot->url();

		/** @var \Drupal\Tests\automatic_updates\Kernel\TestCronUpdater $updater */
		$updater = $this->container->get('automatic_updates.cron_updater');

tests/src/Kernel/ReadinessValidation/StagedProjectsValidatorTest.php

+2 −3

Original line number	Diff line number	Diff line
		@@ -5,7 +5,6 @@ namespace Drupal\Tests\automatic_updates\Kernel\ReadinessValidation;
		use Drupal\package_manager\Event\PreApplyEvent;
		use Drupal\package_manager\Exception\StageValidationException;
		use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
		use Drupal\Tests\package_manager\Kernel\TestStage;
		use org\bovigo\vfs\vfsStream;
		use Symfony\Component\Filesystem\Filesystem;

		@@ -52,12 +51,12 @@ class StagedProjectsValidatorTest extends AutomaticUpdatesKernelTestBase {
		// subdirectory using the stage ID after it is created below.
		$stage_vfs_dir = vfsStream::newDirectory('au_stage');
		$this->vfsRoot->addChild($stage_vfs_dir);
		TestStage::$stagingRoot = $stage_vfs_dir->url();
		static::$testStagingRoot = $stage_vfs_dir->url();
		}
		else {
		// If we are testing non-existent staging directory we can use the path
		// directly.
		TestStage::$stagingRoot = $stage_dir;
		static::$testStagingRoot = $stage_dir;
		}

		$updater = $this->container->get('automatic_updates.updater');