class FormTestBase
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/Form/FormTestBase.php \Drupal\Tests\Core\Form\FormTestBase
- 8.9.x core/tests/Drupal/Tests/Core/Form/FormTestBase.php \Drupal\Tests\Core\Form\FormTestBase
- 10 core/tests/Drupal/Tests/Core/Form/FormTestBase.php \Drupal\Tests\Core\Form\FormTestBase
Provides a base class for testing form functionality.
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\Form\FormTestBase extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of FormTestBase
See also
File
-
core/
tests/ Drupal/ Tests/ Core/ Form/ FormTestBase.php, line 25
Namespace
Drupal\Tests\Core\FormView source
abstract class FormTestBase extends UnitTestCase {
/**
* The form builder being tested.
*
* @var \Drupal\Core\Form\FormBuilderInterface
*/
protected $formBuilder;
/**
* @var \Drupal\Core\Form\FormValidatorInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $formValidator;
/**
* @var \Drupal\Core\Form\FormSubmitterInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $formSubmitter;
/**
* The mocked URL generator.
*
* @var \Drupal\Core\Routing\UrlGeneratorInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $urlGenerator;
/**
* The mocked module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $moduleHandler;
/**
* The form cache.
*
* @var \Drupal\Core\Form\FormCacheInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $formCache;
/**
* The cache backend to use.
*
* @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $cache;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $account;
/**
* The controller resolver.
*
* @var \Drupal\Core\Controller\ControllerResolverInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $controllerResolver;
/**
* The CSRF token generator.
*
* @var \Drupal\Core\Access\CsrfTokenGenerator|\PHPUnit\Framework\MockObject\MockObject
*/
protected $csrfToken;
/**
* The request.
*
* @var \Symfony\Component\HttpFoundation\Request
*/
protected $request;
/**
* The request stack.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected $requestStack;
/**
* The class results.
*
* @var \Drupal\Core\DependencyInjection\ClassResolverInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $classResolver;
/**
* The element info manager.
*
* @var \Drupal\Core\Render\ElementInfoManagerInterface
*/
protected $elementInfo;
/**
* The event dispatcher.
*
* @var \Symfony\Contracts\EventDispatcher\EventDispatcherInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $eventDispatcher;
/**
* @var \Drupal\Core\StringTranslation\TranslationInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $translationManager;
/**
* @var \Drupal\Core\DrupalKernelInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $kernel;
/**
* @var \PHPUnit\Framework\MockObject\MockObject|\Psr\Log\LoggerInterface
*/
protected $logger;
/**
* @var \PHPUnit\Framework\MockObject\MockObject|\Drupal\Core\EventSubscriber\RedirectResponseSubscriber
*/
protected $redirectResponseSubscriber;
/**
* The mocked theme manager.
*
* @var \Drupal\Core\Theme\ThemeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $themeManager;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
// Add functions to the global namespace for testing.
require_once __DIR__ . '/fixtures/form_base_test.inc';
$this->moduleHandler = $this->createMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->formCache = $this->createMock('Drupal\\Core\\Form\\FormCacheInterface');
$this->cache = $this->createMock('Drupal\\Core\\Cache\\CacheBackendInterface');
$this->urlGenerator = $this->createMock('Drupal\\Core\\Routing\\UrlGeneratorInterface');
$this->redirectResponseSubscriber = $this->createMock(RedirectResponseSubscriber::class);
$this->classResolver = $this->getClassResolverStub();
$this->elementInfo = $this->getMockBuilder('\\Drupal\\Core\\Render\\ElementInfoManagerInterface')
->disableOriginalConstructor()
->getMock();
$this->elementInfo
->expects($this->any())
->method('getInfo')
->willReturnCallback([
$this,
'getInfo',
]);
$this->csrfToken = $this->getMockBuilder('Drupal\\Core\\Access\\CsrfTokenGenerator')
->disableOriginalConstructor()
->getMock();
$this->kernel = $this->getMockBuilder('\\Drupal\\Core\\DrupalKernel')
->disableOriginalConstructor()
->getMock();
$this->account = $this->createMock('Drupal\\Core\\Session\\AccountInterface');
$this->themeManager = $this->createMock('Drupal\\Core\\Theme\\ThemeManagerInterface');
$this->request = Request::createFromGlobals();
$this->request
->setSession(new Session(new MockArraySessionStorage()));
$this->eventDispatcher = $this->createMock('Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface');
$this->requestStack = new RequestStack();
$this->requestStack
->push($this->request);
$this->logger = $this->createMock('Drupal\\Core\\Logger\\LoggerChannelInterface');
$form_error_handler = $this->createMock('Drupal\\Core\\Form\\FormErrorHandlerInterface');
$this->formValidator = new FormValidator($this->requestStack, $this->getStringTranslationStub(), $this->csrfToken, $this->logger, $form_error_handler);
$this->formSubmitter = $this->getMockBuilder('Drupal\\Core\\Form\\FormSubmitter')
->setConstructorArgs([
$this->requestStack,
$this->urlGenerator,
$this->redirectResponseSubscriber,
])
->onlyMethods([
'batchGet',
])
->getMock();
$this->root = dirname(substr(__DIR__, 0, -strlen(__NAMESPACE__)), 2);
$this->formBuilder = new FormBuilder($this->formValidator, $this->formSubmitter, $this->formCache, $this->moduleHandler, $this->eventDispatcher, $this->requestStack, $this->classResolver, $this->elementInfo, $this->themeManager, $this->csrfToken);
}
/**
* {@inheritdoc}
*/
protected function tearDown() : void {
Html::resetSeenIds();
(new FormState())->clearErrors();
}
/**
* Provides a mocked form object.
*
* @param string $form_id
* The form ID to be used.
* @param mixed $expected_form
* (optional) If provided, the expected form response for buildForm() to
* return. Defaults to NULL.
* @param int $count
* (optional) The number of times the form is expected to be built. Defaults
* to 1.
*
* @return \PHPUnit\Framework\MockObject\MockObject|\Drupal\Core\Form\FormInterface
* The mocked form object.
*/
protected function getMockForm($form_id, $expected_form = NULL, $count = 1) {
$form = $this->createMock('Drupal\\Core\\Form\\FormInterface');
$form->expects($this->once())
->method('getFormId')
->willReturn($form_id);
if ($expected_form) {
$form->expects($this->exactly($count))
->method('buildForm')
->willReturn($expected_form);
}
return $form;
}
/**
* Simulates a form submission within a request, bypassing submitForm().
*
* Calling submitForm() will reset the form builder, if two forms were on the
* same page, they will be submitted simultaneously.
*
* @param string $form_id
* The unique string identifying the form.
* @param \Drupal\Core\Form\FormInterface $form_arg
* The form object.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param bool $programmed
* Whether $form_state->setProgrammed() should be passed TRUE or not. If it
* is not set to TRUE, you must provide additional data in $form_state for
* the submission to take place.
*
* @return array
* The built form.
*/
protected function simulateFormSubmission($form_id, FormInterface $form_arg, FormStateInterface $form_state, $programmed = TRUE) {
$input = $form_state->getUserInput();
$input['op'] = 'Submit';
$form_state->setUserInput($input)
->setProgrammed($programmed)
->setSubmitted();
return $this->formBuilder
->buildForm($form_arg, $form_state);
}
/**
* Asserts that the expected form structure is found in a form for a given key.
*
* @param array $expected_form
* The expected form structure.
* @param array $actual_form
* The actual form.
* @param string|null $form_key
* (optional) The form key to look in. Otherwise the entire form will be
* compared.
*/
protected function assertFormElement(array $expected_form, array $actual_form, $form_key = NULL) {
$expected_element = $form_key ? $expected_form[$form_key] : $expected_form;
$actual_element = $form_key ? $actual_form[$form_key] : $actual_form;
$this->assertSame(array_intersect_key($expected_element, $actual_element), $expected_element);
}
/**
* A stub method returning properties for the defined element type.
*
* @param string $type
* The machine name of an element type plugin.
*
* @return array
* An array with dummy values to be used in tests. Defaults to an empty
* array.
*/
public function getInfo($type) {
$types['hidden'] = [
'#input' => TRUE,
];
$types['token'] = [
'#input' => TRUE,
];
$types['value'] = [
'#input' => TRUE,
];
$types['radios'] = [
'#input' => TRUE,
];
$types['textfield'] = [
'#input' => TRUE,
];
$types['submit'] = [
'#input' => TRUE,
'#name' => 'op',
'#is_button' => TRUE,
];
if (!isset($types[$type])) {
$types[$type] = [];
}
return $types[$type];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | ||
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | ||
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | ||
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | ||
FormTestBase::$account | protected | property | The current user. | ||
FormTestBase::$cache | protected | property | The cache backend to use. | ||
FormTestBase::$classResolver | protected | property | The class results. | ||
FormTestBase::$controllerResolver | protected | property | The controller resolver. | ||
FormTestBase::$csrfToken | protected | property | The CSRF token generator. | ||
FormTestBase::$elementInfo | protected | property | The element info manager. | ||
FormTestBase::$eventDispatcher | protected | property | The event dispatcher. | ||
FormTestBase::$formBuilder | protected | property | The form builder being tested. | ||
FormTestBase::$formCache | protected | property | The form cache. | ||
FormTestBase::$formSubmitter | protected | property | |||
FormTestBase::$formValidator | protected | property | |||
FormTestBase::$kernel | protected | property | |||
FormTestBase::$logger | protected | property | |||
FormTestBase::$moduleHandler | protected | property | The mocked module handler. | ||
FormTestBase::$redirectResponseSubscriber | protected | property | |||
FormTestBase::$request | protected | property | The request. | ||
FormTestBase::$requestStack | protected | property | The request stack. | ||
FormTestBase::$themeManager | protected | property | The mocked theme manager. | ||
FormTestBase::$translationManager | protected | property | |||
FormTestBase::$urlGenerator | protected | property | The mocked URL generator. | ||
FormTestBase::assertFormElement | protected | function | Asserts that the expected form structure is found in a form for a given key. | ||
FormTestBase::getInfo | public | function | A stub method returning properties for the defined element type. | ||
FormTestBase::getMockForm | protected | function | Provides a mocked form object. | ||
FormTestBase::setUp | protected | function | Overrides UnitTestCase::setUp | 1 | |
FormTestBase::simulateFormSubmission | protected | function | Simulates a form submission within a request, bypassing submitForm(). | ||
FormTestBase::tearDown | protected | function | |||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | ||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||
UnitTestCase::$root | protected | property | The app root. | ||
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::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | ||
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.