You are here

Home » API reference » Rules 8.3 » IpIsBannedTest.php

class IpIsBannedTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\Condition\IpIsBanned @group RulesCondition

Hierarchy

Expanded class hierarchy of IpIsBannedTest

File

tests/src/Unit/Integration/Condition/IpIsBannedTest.php, line 15

Namespace

Drupal\Tests\rules\Unit\Integration\Condition
View source 
class IpIsBannedTest extends RulesIntegrationTestBase {

  /**
   * The condition to be tested.
   *
   * @var \Drupal\rules\Core\RulesConditionInterface
   */
  protected $condition;

  /**
   * The ban manager used to ban the IP.
   *
   * @var \Drupal\ban\BanIpManagerInterface
   */
  protected $banManager;

  /**
   * @var \Symfony\Component\HttpFoundation\Request|\Prophecy\Prophecy\ProphecyInterface
   */
  protected $request;

  /**
   * @var \Symfony\Component\HttpFoundation\RequestStack|\Prophecy\Prophecy\ProphecyInterface
   */
  protected $requestStack;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Must enable the ban module.
    $this
      ->enableModule('ban');
    $this->banManager = $this
      ->prophesize(BanIpManagerInterface::class);
    $this->container
      ->set('ban.ip_manager', $this->banManager
      ->reveal());

    // Mock a request.
    $this->request = $this
      ->prophesize(Request::class);

    // Mock the request_stack service, make it return our mocked request,
    // and register it in the container.
    $this->requestStack = $this
      ->prophesize(RequestStack::class);
    $this->requestStack
      ->getCurrentRequest()
      ->willReturn($this->request
      ->reveal());
    $this->container
      ->set('request_stack', $this->requestStack
      ->reveal());
    $this->condition = $this->conditionManager
      ->createInstance('rules_ip_is_banned');
  }

  /**
   * Tests evaluating the condition.
   *
   * @covers ::evaluate
   */
  public function testConditionEvaluation() {

    // Test an IPv4 address that has not been banned; should return FALSE.
    // TEST-NET-1 IPv4.
    $ipv4 = '192.0.2.0';
    $this->banManager
      ->isBanned($ipv4)
      ->willReturn(FALSE);
    $context = $this->condition
      ->getContext('ip');
    $context = Context::createFromContext($context, $this
      ->getTypedData('string', $ipv4));
    $this->condition
      ->setContext('ip', $context);
    $this
      ->assertFalse($this->condition
      ->evaluate());

    // Test an IPv6 address that has not been banned; should return FALSE.
    // TEST-NET-1 IPv4 '192.0.2.0' converted to IPv6.
    $ipv6 = '2002:0:0:0:0:0:c000:200';
    $this->banManager
      ->isBanned($ipv6)
      ->willReturn(FALSE);
    $context = $this->condition
      ->getContext('ip');
    $context = Context::createFromContext($context, $this
      ->getTypedData('string', $ipv6));
    $this->condition
      ->setContext('ip', $context);
    $this
      ->assertFalse($this->condition
      ->evaluate());

    // Ban an IPv4 address and an IPv6 address.
    $ip_addresses_to_ban = [
      // TEST-NET-1 IPv4.
      'IPv4' => [
        'ip' => '192.0.2.0',
      ],
      // TEST-NET-1 IPv4 '192.0.2.0' converted to IPv6.
      'IPv6' => [
        'ip' => '2002:0:0:0:0:0:c000:200',
      ],
    ];

    // Ban the above IP addresses.
    foreach ($ip_addresses_to_ban as $ip_address_to_ban) {
      $this->banManager
        ->banIp($ip_address_to_ban['ip']);
      $this->banManager
        ->isBanned($ip_address_to_ban['ip'])
        ->willReturn(TRUE);
    }

    // Test an IPv4 address that has been banned; should return TRUE.
    $context = $this->condition
      ->getContext('ip');
    $context = Context::createFromContext($context, $this
      ->getTypedData('string', $ip_addresses_to_ban['IPv4']['ip']));
    $this->condition
      ->setContext('ip', $context);
    $this
      ->assertTrue($this->condition
      ->evaluate());

    // Test an IPv6 address that has been banned; should return TRUE.
    $context = $this->condition
      ->getContext('ip');
    $context = Context::createFromContext($context, $this
      ->getTypedData('string', $ip_addresses_to_ban['IPv6']['ip']));
    $this->condition
      ->setContext('ip', $context);
    $this
      ->assertTrue($this->condition
      ->evaluate());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
IpIsBannedTest::$banManager protected property The ban manager used to ban the IP.
IpIsBannedTest::$condition protected property The condition to be tested.
IpIsBannedTest::$request protected property
IpIsBannedTest::$requestStack protected property
IpIsBannedTest::setUp protected function Overrides RulesIntegrationTestBase::setUp
IpIsBannedTest::testConditionEvaluation public function Tests evaluating the condition.
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.
RulesIntegrationTestBase::$actionManager protected property
RulesIntegrationTestBase::$cacheBackend protected property
RulesIntegrationTestBase::$classResolver protected property The class resolver mock for the typed data manager.
RulesIntegrationTestBase::$conditionManager protected property
RulesIntegrationTestBase::$container protected property The Drupal service container.
RulesIntegrationTestBase::$dataFetcher protected property The data fetcher service.
RulesIntegrationTestBase::$dataFilterManager protected property The data filter manager.
RulesIntegrationTestBase::$enabledModules protected property Array object keyed with module names and TRUE as value.
RulesIntegrationTestBase::$entityFieldManager protected property
RulesIntegrationTestBase::$entityTypeBundleInfo protected property
RulesIntegrationTestBase::$entityTypeManager protected property
RulesIntegrationTestBase::$logger protected property A mocked Rules logger.channel.rules_debug service. 6
RulesIntegrationTestBase::$messenger protected property The messenger service.
RulesIntegrationTestBase::$moduleHandler protected property
RulesIntegrationTestBase::$namespaces protected property All setup'ed namespaces.
RulesIntegrationTestBase::$placeholderResolver protected property The placeholder resolver service.
RulesIntegrationTestBase::$rulesDataProcessorManager protected property
RulesIntegrationTestBase::$rulesExpressionManager protected property
RulesIntegrationTestBase::$typedDataManager protected property
RulesIntegrationTestBase::constructModulePath protected function Determines the path to a module's class files.
RulesIntegrationTestBase::enableModule protected function Fakes the enabling of a module and adds its namespace for plugin loading.
RulesIntegrationTestBase::getTypedData protected function Returns a typed data object.
RulesIntegrationTestBase::prophesizeEntity protected function Helper method to mock irrelevant cache methods on entities.
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.