class MemoryBackendTest
Tests the memory flood implementation.
Attributes
#[CoversClass(MemoryBackend::class)]
#[Group('flood')]
#[Medium]
  Hierarchy
- class \Drupal\Tests\UnitTestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait extends \PHPUnit\Framework\TestCase- class \Drupal\Tests\Core\Flood\MemoryBackendTest extends \Drupal\Tests\UnitTestCase
 
Expanded class hierarchy of MemoryBackendTest
File
- 
              core/tests/ Drupal/ Tests/ Core/ Flood/ MemoryBackendTest.php, line 18 
Namespace
Drupal\Tests\Core\FloodView source
class MemoryBackendTest extends UnitTestCase {
  
  /**
   * The tested memory flood backend.
   *
   * @var \Drupal\Core\Flood\MemoryBackend
   */
  protected $flood;
  protected function setUp() : void {
    parent::setUp();
    $request = new RequestStack();
    $request_mock = $this->getMockBuilder(Request::class)
      ->onlyMethods([
      'getClientIp',
    ])
      ->getMock();
    $request->push($request_mock);
    $this->flood = new MemoryBackend($request);
  }
  
  /**
   * Tests an allowed flood event.
   */
  public function testAllowedProceeding() : void {
    $threshold = 2;
    $window_expired = -1;
    $this->flood
      ->register('test_event', $window_expired);
    $this->assertTrue($this->flood
      ->isAllowed('test_event', $threshold));
  }
  
  /**
   * Tests a flood event with more than the allowed calls.
   */
  public function testNotAllowedProceeding() : void {
    $threshold = 1;
    $window_expired = -1;
    // Register the event twice, so it is not allowed to proceed.
    $this->flood
      ->register('test_event', $window_expired);
    $this->flood
      ->register('test_event', $window_expired, 1);
    $this->assertFalse($this->flood
      ->isAllowed('test_event', $threshold));
  }
  
  /**
   * Tests a flood event with expiring, so cron will allow to proceed.
   */
  public function testExpiring() : void {
    $threshold = 1;
    $window_expired = -1;
    $this->flood
      ->register('test_event', $window_expired);
    usleep(2);
    $this->flood
      ->register('test_event', $window_expired);
    $this->assertFalse($this->flood
      ->isAllowed('test_event', $threshold));
    // "Run cron", which clears the flood data and verify event is now allowed.
    $this->flood
      ->garbageCollection();
    $this->assertTrue($this->flood
      ->isAllowed('test_event', $threshold));
  }
  
  /**
   * Tests a flood event with no expiring, so cron will not allow to proceed.
   */
  public function testNotExpiring() : void {
    $threshold = 2;
    $this->flood
      ->register('test_event', 1);
    usleep(3);
    $this->flood
      ->register('test_event', 1);
    $this->assertFalse($this->flood
      ->isAllowed('test_event', $threshold));
    // "Run cron", which clears the flood data and verify event is not allowed.
    $this->flood
      ->garbageCollection();
    $this->assertFalse($this->flood
      ->isAllowed('test_event', $threshold));
  }
  
  /**
   * Tests memory backend records events to the nearest microsecond.
   */
  public function testMemoryBackendThreshold() : void {
    $this->flood
      ->register('new event');
    $this->assertTrue($this->flood
      ->isAllowed('new event', '2'));
    $this->flood
      ->register('new event');
    $this->assertFalse($this->flood
      ->isAllowed('new event', '2'));
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 
|---|---|---|---|---|
| ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
| ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
| ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
| MemoryBackendTest::$flood | protected | property | The tested memory flood backend. | |
| MemoryBackendTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
| MemoryBackendTest::testAllowedProceeding | public | function | Tests an allowed flood event. | |
| MemoryBackendTest::testExpiring | public | function | Tests a flood event with expiring, so cron will allow to proceed. | |
| MemoryBackendTest::testMemoryBackendThreshold | public | function | Tests memory backend records events to the nearest microsecond. | |
| MemoryBackendTest::testNotAllowedProceeding | public | function | Tests a flood event with more than the allowed calls. | |
| MemoryBackendTest::testNotExpiring | public | function | Tests a flood event with no expiring, so cron will not allow to proceed. | |
| 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. | |
| 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. | |
| UnitTestCase::$root | protected | property | The app root. | |
| UnitTestCase::getClassResolverStub | protected | function | Returns a stub class resolver. | |
| UnitTestCase::getConfigFactoryStub | public | function | Returns a stub config factory that behaves according to the passed array. | |
| UnitTestCase::getContainerWithCacheTagsInvalidator | protected | function | Sets up a container with a cache tags invalidator. | |
| UnitTestCase::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
| UnitTestCase::setDebugDumpHandler | public static | function | Registers the dumper CLI handler when the DebugDump extension is enabled. | |
| UnitTestCase::setupMockIterator | protected | function | Set up a traversable class mock to return specific items when iterated. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
