class ChainRequestPolicyTest

Same name and namespace in other branches
  1. 9 core/tests/Drupal/Tests/Core/PageCache/ChainRequestPolicyTest.php \Drupal\Tests\Core\PageCache\ChainRequestPolicyTest
  2. 8.9.x core/tests/Drupal/Tests/Core/PageCache/ChainRequestPolicyTest.php \Drupal\Tests\Core\PageCache\ChainRequestPolicyTest
  3. 11.x core/tests/Drupal/Tests/Core/PageCache/ChainRequestPolicyTest.php \Drupal\Tests\Core\PageCache\ChainRequestPolicyTest

@coversDefaultClass \Drupal\Core\PageCache\ChainRequestPolicy
@group PageCache

Hierarchy

Expanded class hierarchy of ChainRequestPolicyTest

File

core/tests/Drupal/Tests/Core/PageCache/ChainRequestPolicyTest.php, line 16

Namespace

Drupal\Tests\Core\PageCache
View source
class ChainRequestPolicyTest extends UnitTestCase {
  
  /**
   * The chain request policy under test.
   *
   * @var \Drupal\Core\PageCache\ChainRequestPolicy
   */
  protected $policy;
  
  /**
   * A request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->policy = new ChainRequestPolicy();
    $this->request = new Request();
  }
  
  /**
   * Asserts that check() returns NULL if the chain is empty.
   *
   * @covers ::check
   */
  public function testEmptyChain() : void {
    $result = $this->policy
      ->check($this->request);
    $this->assertNull($result);
  }
  
  /**
   * Asserts that check() returns NULL if a rule returns NULL.
   *
   * @covers ::check
   */
  public function testNullRuleChain() : void {
    $rule = $this->createMock('Drupal\\Core\\PageCache\\RequestPolicyInterface');
    $rule->expects($this->once())
      ->method('check')
      ->with($this->request)
      ->willReturn(NULL);
    $this->policy
      ->addPolicy($rule);
    $result = $this->policy
      ->check($this->request);
    $this->assertNull($result);
  }
  
  /**
   * Asserts that check() throws an exception if a rule returns an invalid value.
   *
   * @dataProvider providerChainExceptionOnInvalidReturnValue
   * @covers ::check
   */
  public function testChainExceptionOnInvalidReturnValue($return_value) : void {
    $rule = $this->createMock('Drupal\\Core\\PageCache\\RequestPolicyInterface');
    $rule->expects($this->once())
      ->method('check')
      ->with($this->request)
      ->willReturn($return_value);
    $this->policy
      ->addPolicy($rule);
    $this->expectException(\UnexpectedValueException::class);
    $this->policy
      ->check($this->request);
  }
  
  /**
   * Provides test data for testChainExceptionOnInvalidReturnValue.
   *
   * @return array
   *   Test input and expected result.
   */
  public static function providerChainExceptionOnInvalidReturnValue() {
    return [
      [
        FALSE,
      ],
      [
        0,
      ],
      [
        1,
      ],
      [
        TRUE,
      ],
      [
        [
          1,
          2,
          3,
        ],
      ],
      [
        new \stdClass(),
      ],
    ];
  }
  
  /**
   * Asserts that check() returns ALLOW if any of the rules returns ALLOW.
   *
   * @dataProvider providerAllowIfAnyRuleReturnedAllow
   * @covers ::check
   */
  public function testAllowIfAnyRuleReturnedAllow($return_values) : void {
    foreach ($return_values as $return_value) {
      $rule = $this->createMock('Drupal\\Core\\PageCache\\RequestPolicyInterface');
      $rule->expects($this->once())
        ->method('check')
        ->with($this->request)
        ->willReturn($return_value);
      $this->policy
        ->addPolicy($rule);
    }
    $actual_result = $this->policy
      ->check($this->request);
    $this->assertSame(RequestPolicyInterface::ALLOW, $actual_result);
  }
  
  /**
   * Provides test data for testAllowIfAnyRuleReturnedAllow.
   *
   * @return array
   *   Test input and expected result.
   */
  public static function providerAllowIfAnyRuleReturnedAllow() {
    return [
      [
        [
          RequestPolicyInterface::ALLOW,
        ],
      ],
      [
        [
          NULL,
          RequestPolicyInterface::ALLOW,
        ],
      ],
    ];
  }
  
  /**
   * Asserts that check() returns immediately when a rule returned DENY.
   */
  public function testStopChainOnFirstDeny() : void {
    $rule1 = $this->createMock('Drupal\\Core\\PageCache\\RequestPolicyInterface');
    $rule1->expects($this->once())
      ->method('check')
      ->with($this->request)
      ->willReturn(RequestPolicyInterface::ALLOW);
    $this->policy
      ->addPolicy($rule1);
    $deny_rule = $this->createMock('Drupal\\Core\\PageCache\\RequestPolicyInterface');
    $deny_rule->expects($this->once())
      ->method('check')
      ->with($this->request)
      ->willReturn(RequestPolicyInterface::DENY);
    $this->policy
      ->addPolicy($deny_rule);
    $ignored_rule = $this->createMock('Drupal\\Core\\PageCache\\RequestPolicyInterface');
    $ignored_rule->expects($this->never())
      ->method('check');
    $this->policy
      ->addPolicy($ignored_rule);
    $actual_result = $this->policy
      ->check($this->request);
    $this->assertSame(RequestPolicyInterface::DENY, $actual_result);
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
ChainRequestPolicyTest::$policy protected property The chain request policy under test.
ChainRequestPolicyTest::$request protected property A request object.
ChainRequestPolicyTest::providerAllowIfAnyRuleReturnedAllow public static function Provides test data for testAllowIfAnyRuleReturnedAllow.
ChainRequestPolicyTest::providerChainExceptionOnInvalidReturnValue public static function Provides test data for testChainExceptionOnInvalidReturnValue.
ChainRequestPolicyTest::setUp protected function Overrides UnitTestCase::setUp
ChainRequestPolicyTest::testAllowIfAnyRuleReturnedAllow public function Asserts that check() returns ALLOW if any of the rules returns ALLOW.
ChainRequestPolicyTest::testChainExceptionOnInvalidReturnValue public function Asserts that check() throws an exception if a rule returns an invalid value.
ChainRequestPolicyTest::testEmptyChain public function Asserts that check() returns NULL if the chain is empty.
ChainRequestPolicyTest::testNullRuleChain public function Asserts that check() returns NULL if a rule returns NULL.
ChainRequestPolicyTest::testStopChainOnFirstDeny public function Asserts that check() returns immediately when a rule returned DENY.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
UnitTestCase::$root protected property The app root. 1
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::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
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::setUpBeforeClass public static function
UnitTestCase::__get public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.