class BanMiddlewareTest in Drupal 8

@coversDefaultClass \Drupal\ban\BanMiddleware @group ban

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\ban\Unit\BanMiddlewareTest

File

core/modules/ban/tests/src/Unit/BanMiddlewareTest.php, line 15

Namespace

Drupal\Tests\ban\Unit

class BanMiddlewareTest extends UnitTestCase {

  /**
   * The mocked wrapped kernel.
   *
   * @var \Symfony\Component\HttpKernel\HttpKernelInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $kernel;

  /**
   * The mocked ban IP manager.
   *
   * @var \Drupal\ban\BanIpManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $banManager;

  /**
   * The tested ban middleware.
   *
   * @var \Drupal\ban\BanMiddleware
   */
  protected $banMiddleware;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->kernel = $this
      ->createMock('Symfony\\Component\\HttpKernel\\HttpKernelInterface');
    $this->banManager = $this
      ->createMock('Drupal\\ban\\BanIpManagerInterface');
    $this->banMiddleware = new BanMiddleware($this->kernel, $this->banManager);
  }

  /**
   * Tests a banned IP.
   */
  public function testBannedIp() {
    $banned_ip = '17.0.0.2';
    $this->banManager
      ->expects($this
      ->once())
      ->method('isBanned')
      ->with($banned_ip)
      ->willReturn(TRUE);
    $this->kernel
      ->expects($this
      ->never())
      ->method('handle');
    $request = Request::create('/test-path');
    $request->server
      ->set('REMOTE_ADDR', $banned_ip);
    $response = $this->banMiddleware
      ->handle($request);
    $this
      ->assertEquals(403, $response
      ->getStatusCode());
  }

  /**
   * Tests an unbanned IP.
   */
  public function testUnbannedIp() {
    $unbanned_ip = '18.0.0.2';
    $this->banManager
      ->expects($this
      ->once())
      ->method('isBanned')
      ->with($unbanned_ip)
      ->willReturn(FALSE);
    $request = Request::create('/test-path');
    $request->server
      ->set('REMOTE_ADDR', $unbanned_ip);
    $expected_response = new Response(200);
    $this->kernel
      ->expects($this
      ->once())
      ->method('handle')
      ->with($request, HttpKernelInterface::MASTER_REQUEST, TRUE)
      ->willReturn($expected_response);
    $response = $this->banMiddleware
      ->handle($request);
    $this
      ->assertSame($expected_response, $response);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BanMiddlewareTest::$banManager	protected	property	The mocked ban IP manager.
BanMiddlewareTest::$banMiddleware	protected	property	The tested ban middleware.
BanMiddlewareTest::$kernel	protected	property	The mocked wrapped kernel.
BanMiddlewareTest::setUp	protected	function	Overrides UnitTestCase::setUp
BanMiddlewareTest::testBannedIp	public	function	Tests a banned IP.
BanMiddlewareTest::testUnbannedIp	public	function	Tests an unbanned IP.
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.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	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::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.