MachineNameControllerTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Unit\Transliteration;

use Drupal\Core\Access\CsrfTokenGenerator;
use Drupal\Tests\UnitTestCase;
use Drupal\Component\Transliteration\PhpTransliteration;
use Drupal\system\MachineNameController;
use Prophecy\Argument;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
// cspell:ignore aewesome

/**
 * Tests that the machine name controller can transliterate strings as expected.
 *
 * @group legacy
 */
class MachineNameControllerTest extends UnitTestCase {
    
    /**
     * The machine name controller.
     *
     * @var \Drupal\system\MachineNameController
     */
    protected $machineNameController;
    
    /**
     * The CSRF token generator.
     *
     * @var \Drupal\Core\Access\CsrfTokenGenerator
     */
    protected $tokenGenerator;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create the machine name controller.
        $this->tokenGenerator = $this->prophesize(CsrfTokenGenerator::class);
        $this->tokenGenerator
            ->validate(Argument::cetera())
            ->will(function ($args) {
            return $args[0] === 'token-' . $args[1];
        });
        $this->machineNameController = new MachineNameController(new PhpTransliteration(), $this->tokenGenerator
            ->reveal());
    }
    
    /**
     * Data provider for testMachineNameController().
     *
     * @see testMachineNameController()
     *
     * @return array
     *   An array containing:
     *     - An array of request parameters.
     *     - The expected content of the JSONresponse.
     */
    public static function providerTestMachineNameController() {
        // cspell:ignore äwesome
        $valid_data = [
            [
                [
                    'text' => 'Bob',
                    'langcode' => 'en',
                ],
                '"Bob"',
            ],
            [
                [
                    'text' => 'Bob',
                    'langcode' => 'en',
                    'lowercase' => TRUE,
                ],
                '"bob"',
            ],
            [
                [
                    'text' => 'Bob',
                    'langcode' => 'en',
                    'replace' => 'Alice',
                    'replace_pattern' => 'Bob',
                ],
                '"Alice"',
            ],
            [
                [
                    'text' => 'Bob',
                    'langcode' => 'en',
                    'replace' => 'Alice',
                    'replace_pattern' => 'Tom',
                ],
                '"Bob"',
            ],
            [
                [
                    'text' => 'Äwesome',
                    'langcode' => 'en',
                    'lowercase' => TRUE,
                ],
                '"awesome"',
            ],
            [
                [
                    'text' => 'Äwesome',
                    'langcode' => 'de',
                    'lowercase' => TRUE,
                ],
                '"aewesome"',
            ],
            // Tests special characters replacement in the input text.
[
                [
                    'text' => 'B?!"@\\/-ob@e',
                    'langcode' => 'en',
                    'lowercase' => TRUE,
                    'replace' => '_',
                    'replace_pattern' => '[^a-z0-9_.]+',
                ],
                '"b_ob_e"',
            ],
            // Tests @ character in the replace_pattern regex.
[
                [
                    'text' => 'Bob@e\\0',
                    'langcode' => 'en',
                    'lowercase' => TRUE,
                    'replace' => '_',
                    'replace_pattern' => '[^a-z0-9_.@]+',
                ],
                '"bob@e_0"',
            ],
            // Tests null byte in the replace_pattern regex.
[
                [
                    'text' => 'Bob',
                    'langcode' => 'en',
                    'lowercase' => TRUE,
                    'replace' => 'fail()',
                    'replace_pattern' => ".*@e\x00",
                ],
                '"bob"',
            ],
            [
                [
                    'text' => 'Bob@e',
                    'langcode' => 'en',
                    'lowercase' => TRUE,
                    'replace' => 'fail()',
                    'replace_pattern' => ".*@e\x00",
                ],
                '"fail()"',
            ],
        ];
        $valid_data = array_map(function ($data) {
            if (isset($data[0]['replace_pattern'])) {
                $data[0]['replace_token'] = 'token-' . $data[0]['replace_pattern'];
            }
            return $data;
        }, $valid_data);
        return $valid_data;
    }
    
    /**
     * Tests machine name controller's transliteration functionality.
     *
     * @param array $request_params
     *   An array of request parameters.
     * @param $expected_content
     *   The expected content of the JSONresponse.
     *
     * @see \Drupal\system\MachineNameController::transliterate()
     *
     * @dataProvider providerTestMachineNameController
     */
    public function testMachineNameController(array $request_params, $expected_content) : void {
        $request = Request::create('', 'GET', $request_params);
        $json = $this->machineNameController
            ->transliterate($request);
        $this->assertEquals($expected_content, $json->getContent());
    }
    
    /**
     * Tests the pattern validation.
     */
    public function testMachineNameControllerWithInvalidReplacePattern() : void {
        $request = Request::create('', 'GET', [
            'text' => 'Bob',
            'langcode' => 'en',
            'replace' => 'Alice',
            'replace_pattern' => 'Bob',
            'replace_token' => 'invalid',
        ]);
        $this->expectException(AccessDeniedHttpException::class);
        $this->expectExceptionMessage("Invalid 'replace_token' query parameter.");
        $this->machineNameController
            ->transliterate($request);
    }
    
    /**
     * Tests the pattern validation with a missing token.
     */
    public function testMachineNameControllerWithMissingToken() : void {
        $request = Request::create('', 'GET', [
            'text' => 'Bob',
            'langcode' => 'en',
            'replace' => 'Alice',
            'replace_pattern' => 'Bob',
        ]);
        $this->expectException(AccessDeniedHttpException::class);
        $this->expectExceptionMessage("Missing 'replace_token' query parameter.");
        $this->machineNameController
            ->transliterate($request);
    }
    
    /**
     * Tests deprecation of MachineNameController.
     */
    public function testMachineNameControllerDeprecation() : void {
        $request = Request::create('', 'GET', [
            'text' => 'Bob',
            'langcode' => 'en',
        ]);
        $this->expectDeprecation('Drupal\\system\\MachineNameController::transliterate() is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3367037');
        $json = $this->machineNameController
            ->transliterate($request);
        $this->assertEquals('"Bob"', $json->getContent());
    }

}