abstract class MinisiteTestBase in Mini site 8
Provides methods specifically for testing Minisite module's field handling.
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\minisite\Functional\MinisiteTestBase uses StringTranslationTrait, FieldUiTestTrait, FieldCreationTrait, FixtureTrait
Expanded class hierarchy of MinisiteTestBase
File
- tests/
src/ Functional/ MinisiteTestBase.php, line 23
Namespace
Drupal\Tests\minisite\FunctionalView source
abstract class MinisiteTestBase extends BrowserTestBase {
use FixtureTrait;
use FieldCreationTrait;
use FieldUiTestTrait;
use StringTranslationTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'node',
'file',
'field',
'field_ui',
'path',
'minisite',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* An user with administration permissions.
*
* @var \Drupal\user\UserInterface
*/
protected $adminUser;
/**
* Content type used to create the field on.
*
* @var string
*/
protected $contentType = 'article';
/**
* Array of admin user permissions.
*
* Can be overridden from descendant classes.
*
* @var array
*/
protected $adminUserPermissions = [
'access content',
'access administration pages',
'administer site configuration',
'administer users',
'administer permissions',
'administer content types',
'administer node fields',
'administer node display',
'administer nodes',
'bypass node access',
'administer url aliases',
];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this
->fixtureSetUp();
$this->adminUser = $this
->drupalCreateUser($this->adminUserPermissions);
$this
->drupalLogin($this->adminUser);
$this
->drupalCreateContentType([
'type' => $this->contentType,
'name' => 'Article',
]);
}
/**
* {@inheritdoc}
*/
protected function tearDown() {
parent::tearDown();
$this
->fixtureTearDown();
}
/**
* Captures and saves a screenshot.
*
* The result of calling this function will be triggering fail in order to
* output the URL to the generated screenshot. This is due to result printer
* not allowing print output from within the test.
*
* @todo: Find a better way to add output to the result printer.
*/
protected function screenshot() {
$base_directory = '/sites/simpletest/browser_output';
$directory = DRUPAL_ROOT . $base_directory;
// Ensure directory exists.
if (!is_dir($directory)) {
mkdir($directory, 0777, TRUE);
}
$current_url = substr(Html::cleanCssIdentifier($this
->getSession()
->getCurrentUrl()), 100);
$filename = uniqid() . '_' . $current_url . '.html';
$full_filename = file_create_filename($filename, $directory);
$screenshot = $this
->getSession()
->getPage()
->getContent();
file_put_contents($full_filename, $screenshot);
$url = $GLOBALS['base_url'] . $base_directory . '/' . $filename;
$this
->fail($url);
}
/**
* Uploads a file to a node.
*
* @param \Drupal\file\FileInterface $file
* The File to be uploaded.
* @param string $field_name
* The name of the field on which the files should be saved.
* @param int|string $nid_or_type
* A numeric node id to upload files to an existing node, or a string
* indicating the desired bundle for a new node.
* @param bool $new_revision
* The revision number.
* @param array $extras
* Additional values when a new node is created.
*
* @return int
* The node id.
*/
public function uploadNodeFile(FileInterface $file, $field_name, $nid_or_type, $new_revision = TRUE, array $extras = []) {
return $this
->uploadNodeFiles([
$file,
], $field_name, $nid_or_type, $new_revision, $extras);
}
/**
* Uploads multiple files to a node.
*
* @param \Drupal\file\FileInterface[] $files
* The files to be uploaded.
* @param string $field_name
* The name of the field on which the files should be saved.
* @param int|string $nid_or_type
* A numeric node id to upload files to an existing node, or a string
* indicating the desired bundle for a new node.
* @param bool $new_revision
* The revision number.
* @param array $extras
* Additional values when a new node is created.
*
* @return int
* The node id.
*/
public function uploadNodeFiles(array $files, $field_name, $nid_or_type, $new_revision = TRUE, array $extras = []) {
$edit = [
'title[0][value]' => $this
->randomMachineName(),
'revision' => (string) (int) $new_revision,
];
$node_storage = $this->container
->get('entity_type.manager')
->getStorage('node');
if (is_numeric($nid_or_type)) {
$nid = $nid_or_type;
$node_storage
->resetCache([
$nid,
]);
$node = $node_storage
->load($nid);
}
else {
// Add a new node.
$extras['type'] = $nid_or_type;
$node = $this
->drupalCreateNode($extras);
$nid = $node
->id();
// Save at least one revision to better simulate a real site.
$node
->setNewRevision();
$node
->save();
$node_storage
->resetCache([
$nid,
]);
$node = $node_storage
->load($nid);
$this
->assertNotEqual($nid, $node
->getRevisionId(), 'Node revision exists.');
}
$this
->drupalGet("node/{$nid}/edit");
$page = $this
->getSession()
->getPage();
// Attach files to the node.
$field_storage = FieldStorageConfig::loadByName('node', $field_name);
// File input name depends on number of files already uploaded.
$field_num = count($node->{$field_name});
foreach ($files as $i => $file) {
$delta = $field_num + $i;
$file_path = $this->container
->get('file_system')
->realpath($file
->getFileUri());
$name = 'files[' . $field_name . '_' . $delta . ']';
if ($field_storage
->getCardinality() != 1) {
$name .= '[]';
}
if (count($files) == 1) {
$edit[$name] = $file_path;
}
else {
$page
->attachFileToField($name, $file_path);
$this
->drupalPostForm(NULL, [], $this
->t('Upload'));
}
}
$this
->drupalPostForm(NULL, $edit, $this
->t('Save'));
return $nid;
}
/**
* Asserts that a file exists physically on disk.
*
* Uses PHPUnit\Framework\Assert::assertFileUriExists() to work with
* file entities.
*
* @param \Drupal\File\FileInterface|string $filename
* Either the file entity or the file URI.
* @param string $message
* (optional) A message to display with the assertion.
*/
public static function assertFileUriExists($filename, $message = '') {
$message = isset($message) ? $message : new FormattableMarkup('File %file exists on the disk.', [
'%file' => $filename
->getFileUri(),
]);
$filename = $filename instanceof FileInterface ? $filename
->getFileUri() : $filename;
parent::assertFileExists($filename, $message);
}
/**
* Asserts that a file exists in the database.
*/
public function assertFileEntryExists($file, $message = NULL) {
$this->container
->get('entity_type.manager')
->getStorage('file')
->resetCache();
$db_file = File::load($file
->id());
$message = isset($message) ? $message : new FormattableMarkup('File %file exists in database at the correct path.', [
'%file' => $file
->getFileUri(),
]);
$this
->assertEqual($db_file
->getFileUri(), $file
->getFileUri(), $message);
}
/**
* Asserts that a file does not exist in the database.
*/
public function assertFileEntryNotExists($file, $message = NULL) {
$this->container
->get('entity_type.manager')
->getStorage('file')
->resetCache();
$db_file = File::load($file
->id());
$message = isset($message) ? $message : new FormattableMarkup('File %file does not exists in database at the correct path.', [
'%file' => $file
->getFileUri(),
]);
$this
->assertNull($db_file, $message);
}
/**
* Convert file provided by absolute path to file entity.
*
* @param string $absolute_file_path
* Absolute path to file.
*
* @return \Drupal\file\Entity\File
* The File entity object.
*/
protected function convertToFileEntity($absolute_file_path) {
$archive_file = basename($absolute_file_path);
$file = new \stdClass();
$file->uri = $absolute_file_path;
$file->filename = $archive_file;
$file->name = pathinfo($archive_file, PATHINFO_FILENAME);
// Add a filesize property to files as would be read by
// \Drupal\file\Entity\File::load().
$file->filesize = filesize($file->uri);
return File::create((array) $file);
}
/**
* Get valid test files stub.
*/
public function getTestFilesStubValid() {
return [
'parent' . DIRECTORY_SEPARATOR . 'index.html' => $this
->fixtureHtmlPage('Index page', $this
->fixtureLink('Go to Page 1', 'page1.html')),
'parent' . DIRECTORY_SEPARATOR . 'page1.html' => $this
->fixtureHtmlPage('Page 1', $this
->fixtureLink('Go to Page 2', 'page2.html')),
'parent' . DIRECTORY_SEPARATOR . 'page2.html' => $this
->fixtureHtmlPage('Page 2'),
'parent' . DIRECTORY_SEPARATOR . 'image.jpg' => file_get_contents($this
->getFixtureFileDir() . DIRECTORY_SEPARATOR . 'example.jpeg'),
];
}
/**
* Shorthand to get a valid archive file.
*
* @return \Drupal\file\Entity\File
* The File entity object.
*/
public function getTestArchiveValid() {
// Create valid fixture archive.
// All files must reside in the top-level directory, archive must contain
// index.html file, and files should have allowed extension.
$archive_file_absolute = $this
->fixtureCreateArchive($this
->getTestFilesStubValid());
return $this
->convertToFileEntity($archive_file_absolute);
}
/**
* Shorthand to get an invalid archive file.
*
* @return \Drupal\file\Entity\File
* The File entity object.
*/
public function getTestArchiveInvalidFormat() {
$filename = $this
->fixtureCreateFile('invalid.zip', rand(1, 9));
return $this
->convertToFileEntity($filename);
}
/**
* Assert archive file exists.
*/
public function assertArchiveFileExist(FileInterface $file) {
$this
->assertFileEntryExists($file, 'Archive file entry exists');
$this
->assertFileUriExists(Minisite::getCommonArchiveDir() . DIRECTORY_SEPARATOR . $file
->getFilename(), 'Archive file exists');
}
/**
* Assert archive file does not exist.
*/
public function assertArchiveFileNotExist(FileInterface $file) {
$this
->assertFileEntryNotExists($file, 'Archive file entry does not');
$this
->assertFileNotExists(Minisite::getCommonArchiveDir() . DIRECTORY_SEPARATOR . $file
->getFilename(), 'Archive file does not exist');
}
/**
* Assert assets paths exist.
*/
public function assertAssetFilesExist($files) {
$actual_files = array_keys(LegacyWrapper::scanDirectory(Minisite::getCommonAssetDir(), '/.*/'));
$this
->assertEquals(count($actual_files), count($files));
foreach ($files as $test_file) {
$found_files = array_filter($actual_files, function ($value) use ($test_file) {
return substr($value, -strlen($test_file)) === $test_file;
});
$this
->assertTrue(count($found_files) == 1, 'Asset file found in the list of created files');
}
}
/**
* Assert assets paths not exist.
*/
public function assertAssetFilesNotExist($files) {
$actual_files = array_keys(LegacyWrapper::scanDirectory(Minisite::getCommonAssetDir(), '/.*/'));
foreach ($files as $test_file) {
$found_files = array_filter($actual_files, function ($value) use ($test_file) {
return substr($value, -strlen($test_file)) === $test_file;
});
$this
->assertTrue(empty($found_files), 'Asset file does not exist');
}
}
/**
* Create Minisite field through UI and upload a fixture archive.
*
* @param string $node_type
* Node type (bundle).
* @param string $node_title
* Node title to set.
* @param string $description
* (optional) Minisite field description to set.
* @param array $edit
* (optional) Additional node form elements to set before the node is
* created.
*
* @return string
* Created field name.
*/
public function createFieldAndNode($node_type, $node_title, $description = NULL, array $edit = []) {
$field_name = 'ms_fn_' . strtolower($this
->randomMachineName(4));
$field_label = 'ms_fl_' . strtolower($this
->randomMachineName(4));
// Create field through UI.
// Note that config schema is also validated when field is created.
$storage_edit = [
'settings[uri_scheme]' => 'public',
];
$this
->fieldUIAddNewField("admin/structure/types/manage/{$node_type}", $field_name, $field_label, 'minisite', $storage_edit);
// Create valid fixture archive.
// All files must reside in the top-level directory and archive must contain
// index.html file.
$test_archive = $this
->getTestArchiveValid();
// Manually clear cache on the tester side.
\Drupal::service('entity_field.manager')
->clearCachedFieldDefinitions();
// Create node and upload fixture file.
// Note that in order to reveal field fields available only after file
// is uploaded, we submitting a form with a file and without a title.
$edit1 = [
'files[field_' . $field_name . '_' . 0 . ']' => $test_archive
->getFileUri(),
];
$this
->drupalPostForm("node/add/{$node_type}", $edit1, $this
->t('Save'));
$edit2 = [
'title[0][value]' => $node_title,
'field_' . $field_name . '[' . 0 . '][options][alias_status]' => TRUE,
];
$edit = $edit2 + $edit;
if (!empty($description)) {
$edit['field_' . $field_name . '[' . 0 . '][description]'] = $description;
}
$this
->drupalPostForm(NULL, $edit, $this
->t('Save'));
return $field_name;
}
/**
* Assert that Minisite archive file was uploaded and assets expanded.
*/
public function assertMinisiteUploaded($node, $field_name, $test_archive_assets) {
$archive_file = $this
->getUploadedArchiveFile($node, $field_name);
$this
->assertArchiveFileExist($archive_file);
$this
->assertAssetFilesExist($test_archive_assets);
}
/**
* Assert that a Minisite archive and assets were removed.
*/
public function assertMinisiteRemoved($node, $field_name, $test_archive_assets) {
$archive_file = $this
->getUploadedArchiveFile($node, $field_name);
$this
->assertArchiveFileNotExist($archive_file);
$this
->assertAssetFilesNotExist($test_archive_assets);
// Assert that archive file has been removed.
$this
->assertFileEntryNotExists($archive_file);
// Assert that there are no records in the 'minisites_assets' table about
// assets for this node.
foreach ($test_archive_assets as $test_archive_asset) {
$this
->assertNull(Asset::loadByUri($test_archive_asset));
}
}
/**
* Get uploaded archive file.
*
* @param \Drupal\node\Entity\Node $node
* The node object to get the file from.
* @param string $field_name
* Field name without 'field_' prefix.
*
* @return \Drupal\file\Entity\File|null
* Uploaded file or NULL.
*/
public function getUploadedArchiveFile(Node $node, $field_name) {
return File::load($node->{'field_' . $field_name}->target_id);
}
/**
* Helper to browse fixture pages.
*/
public function browseFixtureMinisite($node, $description) {
// Visit node and start browsing minisite.
$this
->drupalGet('node/' . $node
->id());
$this
->assertResponse(200);
$this
->assertLink($description);
$this
->clickLink($description);
// Brose minisite pages starting from index page.
$this
->assertText('Index page');
$this
->assertLink('Go to Page 1');
$this
->clickLink('Go to Page 1');
$this
->assertText('Page 1');
$this
->assertLink('Go to Page 2');
$this
->clickLink('Go to Page 2');
$this
->assertResponse(200);
$this
->assertHeader('Content-Type', 'text/html; charset=UTF-8');
$this
->assertText('Page 2');
}
/**
* Helper to browse aliased fixture pages.
*/
public function browseFixtureMinisiteAliased($alias, $description, $assets_paths) {
$this
->drupalGet($alias);
$this
->assertResponse(200);
// Assert that a link to a minisite is present.
$this
->assertLink($description);
$this
->assertLinkByHref($alias . '/' . $assets_paths[0]);
// Start browsing the minisite.
$this
->clickLink($description);
// Assert first index path as aliased.
$this
->assertUrl($alias . '/' . $assets_paths[0]);
$this
->assertResponse(200);
$this
->assertHeader('Content-Type', 'text/html; charset=UTF-8');
// Brose minisite pages starting from index page.
$this
->assertText('Index page');
$this
->assertLink('Go to Page 1');
$this
->clickLink('Go to Page 1');
$this
->assertResponse(200);
$this
->assertHeader('Content-Type', 'text/html; charset=UTF-8');
$this
->assertText('Page 1');
$this
->assertUrl($alias . '/' . $assets_paths[1]);
$this
->assertLink('Go to Page 2');
$this
->clickLink('Go to Page 2');
$this
->assertResponse(200);
$this
->assertHeader('Content-Type', 'text/html; charset=UTF-8');
$this
->assertText('Page 2');
$this
->assertUrl($alias . '/' . $assets_paths[2]);
// Navigate to the page using URL with a query.
$this
->drupalGet($alias . '/' . $assets_paths[1], [
'query' => [
'param' => 'val',
],
'fragment' => 'someid',
]);
$this
->assertResponse(200);
$this
->assertHeader('Content-Type', 'text/html; charset=UTF-8');
// Get non-document file through an alias.
$this
->drupalGet($alias . '/' . $assets_paths[3]);
$this
->assertResponse(200);
$this
->assertHeader('Content-Type', 'image/jpeg');
$this
->assertHeader('Content-Length', (string) filesize($this
->getFixtureFileDir() . DIRECTORY_SEPARATOR . 'example.jpeg'));
}
/**
* Create a stub asset path.
*
* @return string
* Path for a stub asset.
*/
protected function getStubAssetPath() {
$randomizer = new Random();
$prefix = 'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/';
$suffix = '.html';
$dir_path = $randomizer
->name(10) . '/';
// The full path of the file with the scheme should be exactly 2048
// characters long.
// Note that most of the browsers support URLs length under 2048 characters.
$file_path = $randomizer
->name(2048 - strlen($dir_path) - strlen($prefix) - strlen($suffix)) . $suffix;
$path = $prefix . $dir_path . $file_path;
return $path;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was present in the last response. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is not present. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is present. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertLegacyTrait:: |
protected | function | Checks that current response header equals value. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was absent in the last response. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text is not found escaped on the loaded page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does NOT exist with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option does NOT exist in the current page. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Asserts the page responds with the specified response code. | 1 |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertLegacyTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Passes if the internal browser's URL matches the given path. | |
AssertLegacyTrait:: |
protected | function | Builds an XPath query. | |
AssertLegacyTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertLegacyTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertLegacyTrait:: |
protected | function | Gets the current raw content. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | 1 | |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 39 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the Simpletest environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
BrowserTestBase:: |
protected | function | Gets the value of an HTTP response header. | |
BrowserTestBase:: |
protected | function | Returns all response headers. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. | 1 |
BrowserTestBase:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
protected | function |
Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the Simpletest site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for drupalPostForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | 1 | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | 1 |
FieldCreationTrait:: |
public | function | Attaches a file field to an entity. | |
FieldCreationTrait:: |
public | function | Creates a new ministe field. | |
FieldUiTestTrait:: |
public | function | Adds an existing field through the Field UI. | |
FieldUiTestTrait:: |
public | function | Creates a new field through the Field UI. | |
FieldUiTestTrait:: |
public | function | Deletes a field through the Field UI. | |
FixtureTrait:: |
protected | property | The directory where fixture files reside for this test. | |
FixtureTrait:: |
public | function | Create archive from an array of specified files. | |
FixtureTrait:: |
public | function | Create a single file with content. | |
FixtureTrait:: |
public | function | Create directories and files with content. | |
FixtureTrait:: |
public | function | Create a fixture HTML page. | |
FixtureTrait:: |
public | function | Create a fixture link. | |
FixtureTrait:: |
protected | function | Set up functionality. | |
FixtureTrait:: |
protected | function | Tear down functionality. | |
FixtureTrait:: |
public | function | Get the path to the directory with fixture files. | |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The config directories used in this test. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 23 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | |
MinisiteTestBase:: |
protected | property | An user with administration permissions. | |
MinisiteTestBase:: |
protected | property | Array of admin user permissions. | |
MinisiteTestBase:: |
protected | property | Content type used to create the field on. | |
MinisiteTestBase:: |
protected | property |
The theme to install as the default for testing. Overrides BrowserTestBase:: |
|
MinisiteTestBase:: |
protected static | property |
Modules to enable. Overrides BrowserTestBase:: |
5 |
MinisiteTestBase:: |
public | function | Assert archive file exists. | |
MinisiteTestBase:: |
public | function | Assert archive file does not exist. | |
MinisiteTestBase:: |
public | function | Assert assets paths exist. | |
MinisiteTestBase:: |
public | function | Assert assets paths not exist. | |
MinisiteTestBase:: |
public | function | Asserts that a file exists in the database. | |
MinisiteTestBase:: |
public | function | Asserts that a file does not exist in the database. | |
MinisiteTestBase:: |
public static | function | Asserts that a file exists physically on disk. | |
MinisiteTestBase:: |
public | function | Assert that a Minisite archive and assets were removed. | |
MinisiteTestBase:: |
public | function | Assert that Minisite archive file was uploaded and assets expanded. | |
MinisiteTestBase:: |
public | function | Helper to browse fixture pages. | |
MinisiteTestBase:: |
public | function | Helper to browse aliased fixture pages. | |
MinisiteTestBase:: |
protected | function | Convert file provided by absolute path to file entity. | |
MinisiteTestBase:: |
public | function | Create Minisite field through UI and upload a fixture archive. | |
MinisiteTestBase:: |
protected | function | Create a stub asset path. | |
MinisiteTestBase:: |
public | function | Shorthand to get an invalid archive file. | |
MinisiteTestBase:: |
public | function | Shorthand to get a valid archive file. | |
MinisiteTestBase:: |
public | function | Get valid test files stub. | |
MinisiteTestBase:: |
public | function | Get uploaded archive file. | |
MinisiteTestBase:: |
protected | function | Captures and saves a screenshot. | |
MinisiteTestBase:: |
protected | function |
Overrides BrowserTestBase:: |
5 |
MinisiteTestBase:: |
protected | function |
Overrides BrowserTestBase:: |
|
MinisiteTestBase:: |
public | function | Uploads a file to a node. | |
MinisiteTestBase:: |
public | function | Uploads multiple files to a node. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 3 |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 2 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 2 |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an a absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | 3 |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Executes a form submission. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |