class UnBanIpTest

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\UnBanIp @group RulesAction

Hierarchy

  • class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait
    • class \Drupal\Tests\rules\Unit\Integration\RulesIntegrationTestBase extends \Drupal\Tests\UnitTestCase
      • class \Drupal\Tests\rules\Unit\Integration\RulesAction\UnBanIpTest extends \Drupal\Tests\rules\Unit\Integration\RulesIntegrationTestBase

Expanded class hierarchy of UnBanIpTest

File

tests/src/Unit/Integration/RulesAction/UnBanIpTest.php, line 16

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction
View source
class UnBanIpTest extends RulesIntegrationTestBase {
    
    /**
     * The action to be tested.
     *
     * @var \Drupal\rules\Core\RulesActionInterface
     */
    protected $action;
    
    /**
     * @var \Drupal\ban\BanIpManagerInterface|\Prophecy\Prophecy\ProphecyInterface
     */
    protected $banManager;
    
    /**
     * @var \Symfony\Component\HttpFoundation\Request|\Prophecy\Prophecy\ProphecyInterface
     */
    protected $request;
    
    /**
     * @var \Symfony\Component\HttpFoundation\RequestStack|\Prophecy\Prophecy\ProphecyInterface
     */
    protected $requestStack;
    
    /**
     * @var \Drupal\Core\Logger\LoggerChannelInterface|\Prophecy\Prophecy\ProphecyInterface
     */
    protected $logger;
    
    /**
     * {@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());
        // Mock the logger.factory service, make it return the Rules logger channel,
        // and register it in the container.
        $this->logger = $this->prophesize(LoggerChannelInterface::class);
        $logger_factory = $this->prophesize(LoggerChannelFactoryInterface::class);
        $logger_factory->get('rules')
            ->willReturn($this->logger
            ->reveal());
        $this->container
            ->set('logger.factory', $logger_factory->reveal());
        // Instantiate the rules_unban_ip action.
        $this->action = $this->actionManager
            ->createInstance('rules_unban_ip');
    }
    
    /**
     * Tests the summary.
     *
     * @covers ::summary
     */
    public function testSummary() {
        $this->assertEquals('Remove the ban on an IP address', $this->action
            ->summary());
    }
    
    /**
     * Tests the action execution with Context IPv4.
     *
     * Uses the 192.0.2.0/24 "TEST-NET" address block as defined in RFC3330.
     *
     * @see http://en.wikipedia.org/wiki/Reserved_IP_addresses
     * @see https://tools.ietf.org/html/rfc3330
     *
     * @covers ::execute
     */
    public function testActionExecutionWithContextIpv4() {
        // TEST-NET-1 IPv4.
        $ipv4 = '192.0.2.0';
        $this->action
            ->setContextValue('ip', $ipv4);
        $this->banManager
            ->unbanIp($ipv4)
            ->shouldBeCalledTimes(1);
        $this->action
            ->execute();
        $this->logger
            ->notice('Removed ban on IP address %ip', [
            '%ip' => $ipv4,
        ])
            ->shouldHaveBeenCalled();
    }
    
    /**
     * Tests the action execution with Context IPv6.
     *
     * Uses the 192.0.2.0/24 "TEST-NET" address block as defined in RFC3330.
     *
     * @see http://en.wikipedia.org/wiki/Reserved_IP_addresses
     * @see https://tools.ietf.org/html/rfc3330
     *
     * @covers ::execute
     */
    public function testActionExecutionWithContextIpv6() {
        // TEST-NET-1 IPv4 '192.0.2.0' converted to IPv6.
        $ipv6 = '2002:0:0:0:0:0:c000:200';
        $this->action
            ->setContextValue('ip', $ipv6);
        $this->banManager
            ->unbanIp($ipv6)
            ->shouldBeCalledTimes(1);
        $this->action
            ->execute();
        $this->logger
            ->notice('Removed ban on IP address %ip', [
            '%ip' => $ipv6,
        ])
            ->shouldHaveBeenCalled();
    }
    
    /**
     * Tests the action execution without Context IP set.
     *
     * Should fallback to the current IP of the request.
     *
     * @covers ::execute
     */
    public function testActionExecutionWithoutContextIp() {
        // TEST-NET-1 IPv4.
        $ip = '192.0.2.0';
        $this->request
            ->getClientIp()
            ->willReturn($ip)
            ->shouldBeCalledTimes(1);
        $this->banManager
            ->unbanIp($ip)
            ->shouldBeCalledTimes(1);
        $this->action
            ->execute();
        $this->logger
            ->notice('Removed ban on IP address %ip', [
            '%ip' => $ip,
        ])
            ->shouldHaveBeenCalled();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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.
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::$fieldTypeCategoryManager protected property The field type category info plugin manager.
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.
UnBanIpTest::$action protected property The action to be tested.
UnBanIpTest::$banManager protected property
UnBanIpTest::$logger protected property Overrides RulesIntegrationTestBase::$logger
UnBanIpTest::$request protected property
UnBanIpTest::$requestStack protected property
UnBanIpTest::setUp protected function Overrides RulesIntegrationTestBase::setUp
UnBanIpTest::testActionExecutionWithContextIpv4 public function Tests the action execution with Context IPv4.
UnBanIpTest::testActionExecutionWithContextIpv6 public function Tests the action execution with Context IPv6.
UnBanIpTest::testActionExecutionWithoutContextIp public function Tests the action execution without Context IP set.
UnBanIpTest::testSummary public function Tests the summary.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
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.
UnitTestCase::setUpBeforeClass public static function