class Fix404RedirectCronJobTest in Redirect 8

Tests the clean up cron job for redirect_404.

@group redirect_404

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\redirect_404\Kernel\Fix404RedirectCronJobTest

Expanded class hierarchy of Fix404RedirectCronJobTest

File

modules/redirect_404/tests/src/Kernel/Fix404RedirectCronJobTest.php, line 13

Namespace

Drupal\Tests\redirect_404\Kernel

View source

class Fix404RedirectCronJobTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'redirect_404',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('redirect_404', 'redirect_404');

    // Insert some records in the test table with a given count and timestamp.
    $this
      ->insert404Row('/test1', 12, 5, strtotime('now'));
    $this
      ->insert404Row('/test2', 5, 3, strtotime('-1 hour'));
    $this
      ->insert404Row('/test3', 315, 0, strtotime('-1 week'));
    $this
      ->insert404Row('/test4', 300, 0, strtotime('-1 month'));
    $this
      ->insert404Row('/test5', 1557, 0, strtotime('-1 week'));
    $this
      ->insert404Row('/test6', 1, 0, strtotime('-1 day'));
  }

  /**
   * Tests adding and deleting rows from redirect_404 table.
   */
  function testRedirect404CronJob() {

    // Set the limit to 3 just for the test.
    \Drupal::configFactory()
      ->getEditable('redirect_404.settings')
      ->set('row_limit', 3)
      ->save();

    // Check that there are 6 rows in the redirect_404 table.
    $result = Database::getConnection()
      ->query("SELECT COUNT(*) FROM {redirect_404}")
      ->fetchField();
    $this
      ->assertEquals(6, $result);

    // Run cron to drop 3 rows from the redirect_404 test table.
    redirect_404_cron();
    $result = Database::getConnection()
      ->query("SELECT COUNT(*) FROM {redirect_404}")
      ->fetchField();
    $this
      ->assertEquals(3, $result);

    // Check there are only 3 rows with more count in the redirect_404 table.
    if (\Drupal::database()
      ->driver() == 'mysql' || \Drupal::database()
      ->driver() == 'pgsql') {
      $this
        ->assertNo404Row('/test1');
      $this
        ->assertNo404Row('/test2');
      $this
        ->assert404Row('/test3');
      $this
        ->assert404Row('/test4');
      $this
        ->assert404Row('/test5');
      $this
        ->assertNo404Row('/test6');
    }
    else {

      // In SQLite is the opposite: the 3 rows kept are the newest ones.
      $this
        ->assert404Row('/test1');
      $this
        ->assert404Row('/test2');
      $this
        ->assertNo404Row('/test3');
      $this
        ->assertNo404Row('/test4');
      $this
        ->assertNo404Row('/test5');
      $this
        ->assert404Row('/test6');
    }
  }

  /**
   * Tests adding rows and deleting one row from redirect_404 table.
   */
  function testRedirect404CronJobKeepAllButOne() {

    // Set the limit to 5 just for the test.
    \Drupal::configFactory()
      ->getEditable('redirect_404.settings')
      ->set('row_limit', 5)
      ->save();

    // Check that there are 6 rows in the redirect_404 table.
    $result = Database::getConnection()
      ->query("SELECT COUNT(*) FROM {redirect_404}")
      ->fetchField();
    $this
      ->assertEquals(6, $result);

    // Run cron to drop just 1 row from the redirect_404 test table.
    redirect_404_cron();
    $result = Database::getConnection()
      ->query("SELECT COUNT(*) FROM {redirect_404}")
      ->fetchField();
    $this
      ->assertEquals(5, $result);

    // Check only the row with least count has been removed from the table.
    if (\Drupal::database()
      ->driver() == 'mysql' || \Drupal::database()
      ->driver() == 'pgsql') {
      $this
        ->assert404Row('/test1');
      $this
        ->assert404Row('/test2');
      $this
        ->assert404Row('/test3');
      $this
        ->assert404Row('/test4');
      $this
        ->assert404Row('/test5');
      $this
        ->assertNo404Row('/test6');
    }
    else {

      // In SQlite, only the oldest row is deleted.
      $this
        ->assert404Row('/test1');
      $this
        ->assert404Row('/test2');
      $this
        ->assert404Row('/test3');
      $this
        ->assertNo404Row('/test4');
      $this
        ->assert404Row('/test5');
      $this
        ->assert404Row('/test6');
    }
  }

  /**
   * Tests resetting the daily counts in the redirect_404 table.
   */
  function testRedirect404CronJobDailyCountReset() {

    // Check that there are 2 rows with daily count value bigger than 0.
    $result = \Drupal::database()
      ->query("SELECT COUNT(*) FROM {redirect_404} WHERE daily_count > 0")
      ->fetchField();
    $this
      ->assertEquals(2, $result);

    // Run cron to reset the daily counts in the redirect_404 test table.
    redirect_404_cron();
    $result = \Drupal::database()
      ->query("SELECT COUNT(*) FROM {redirect_404} WHERE daily_count > 0")
      ->fetchField();
    $this
      ->assertEquals(0, $result);

    // Add new row with daily count value.
    $this
      ->insert404Row('/test7', 2, 2, time());
    redirect_404_cron();

    // Check if the row exists and the daily count isn't reset after cron run.
    $this
      ->assert404Row('/test7');
    $result = \Drupal::database()
      ->query("SELECT COUNT(*) FROM {redirect_404} WHERE daily_count > 0")
      ->fetchField();
    $this
      ->assertEquals(1, $result);
  }

  /**
   * Inserts a 404 request log in the redirect_404 test table.
   *
   * @param string $path
   *   The path of the request.
   * @param int $count
   *   (optional) The visits count of the request.
   * @param int $daily_count
   *   (optional) The visits count of the request for a day.
   * @param int $timestamp
   *   (optional) The timestamp of the last visited request.
   * @param string $langcode
   *   (optional) The langcode of the request.
   */
  protected function insert404Row($path, $count = 1, $daily_count = 0, $timestamp = 0, $langcode = 'en') {
    \Drupal::database()
      ->insert('redirect_404')
      ->fields([
      'path' => $path,
      'langcode' => $langcode,
      'count' => $count,
      'daily_count' => $daily_count,
      'timestamp' => $timestamp,
      'resolved' => 0,
    ])
      ->execute();
  }

  /**
   * Passes if the row with the given parameters is in the redirect_404 table.
   *
   * @param string $path
   *   The path of the request.
   * @param string $langcode
   *   (optional) The langcode of the request.
   */
  protected function assert404Row($path, $langcode = 'en') {
    $this
      ->assert404RowHelper($path, $langcode, FALSE);
  }

  /**
   * Passes if the row with the given parameters is NOT in the redirect_404 table.
   *
   * @param string $path
   *   The path of the request.
   * @param string $langcode
   *   (optional) The langcode of the request.
   */
  protected function assertNo404Row($path, $langcode = 'en') {
    $this
      ->assert404RowHelper($path, $langcode, TRUE);
  }

  /**
   * Passes if the row with the given parameters is in the redirect_404 table.
   *
   * @param string $path
   *   The path of the request.
   * @param string $langcode
   *   (optional) The langcode of the request.
   * @param bool $not_exists
   *   (optional) TRUE if this 404 row should not exist in the redirect_404
   *   table, FALSE if it should. Defaults to TRUE.
   */
  protected function assert404RowHelper($path, $langcode = 'en', $not_exists = TRUE) {
    $result = Database::getConnection()
      ->select('redirect_404', 'r404')
      ->fields('r404', [
      'path',
    ])
      ->condition('path', $path)
      ->condition('langcode', $langcode)
      ->condition('resolved', 0)
      ->execute()
      ->fetchField();
    if ($not_exists) {
      $this
        ->assertNotEquals($path, $result);
    }
    else {
      $this
        ->assertEquals($path, $result);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
Fix404RedirectCronJobTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
Fix404RedirectCronJobTest::assert404Row	protected	function	Passes if the row with the given parameters is in the redirect_404 table.
Fix404RedirectCronJobTest::assert404RowHelper	protected	function	Passes if the row with the given parameters is in the redirect_404 table.
Fix404RedirectCronJobTest::assertNo404Row	protected	function	Passes if the row with the given parameters is NOT in the redirect_404 table.
Fix404RedirectCronJobTest::insert404Row	protected	function	Inserts a 404 request log in the redirect_404 test table.
Fix404RedirectCronJobTest::setUp	protected	function	Overrides KernelTestBase::setUp
Fix404RedirectCronJobTest::testRedirect404CronJob		function	Tests adding and deleting rows from redirect_404 table.
Fix404RedirectCronJobTest::testRedirect404CronJobDailyCountReset		function	Tests resetting the daily counts in the redirect_404 table.
Fix404RedirectCronJobTest::testRedirect404CronJobKeepAllButOne		function	Tests adding rows and deleting one row from redirect_404 table.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class Fix404RedirectCronJobTest in Redirect 8

Hierarchy

File

Namespace

Members

API Navigation