AlterTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Form;

use Drupal\Component\Utility\Xss;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests hook_form_alter() and hook_form_FORM_ID_alter().
 *
 * @group Form
 */
class AlterTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'form_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests execution order of hook_form_alter() and hook_form_FORM_ID_alter().
     */
    public function testExecutionOrder() : void {
        $this->drupalGet('form-test/alter');
        // Ensure that the order is first by module, then for a given module, the
        // id-specific one after the generic one.
        $expected = [
            'block_form_form_test_alter_form_alter() executed.',
            'form_test_form_alter() executed.',
            'form_test_form_form_test_alter_form_alter() executed.',
            'system_form_form_test_alter_form_alter() executed.',
        ];
        $content = preg_replace('/\\s+/', ' ', Xss::filter($this->getSession()
            ->getPage()
            ->getContent(), []));
        $this->assertStringContainsString(implode(' ', $expected), $content, 'Form alter hooks executed in the expected order.');
    }

}