class HandlePdfControllerTest in FillPDF 5.0.x

@coversDefaultClass \Drupal\fillpdf\Controller\HandlePdfController

Also covers \Drupal\fillpdf\Plugin\FillPdfActionPlugin and \Drupal\fillpdf\OutputHandler.

@group fillpdf

@todo Convert into a unit test.

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\file\Functional\FileFieldTestBase uses FileFieldCreationTrait, TestFileCreationTrait
    • class \Drupal\Tests\fillpdf\Functional\FillPdfTestBase uses TestFillPdfTrait, TestImageFieldTrait
      • class \Drupal\Tests\fillpdf\Functional\FillPdfUploadTestBase
        • class \Drupal\Tests\fillpdf\Functional\HandlePdfControllerTest

File

tests/src/Functional/HandlePdfControllerTest.php, line 19

Namespace

Drupal\Tests\fillpdf\Functional

class HandlePdfControllerTest extends FillPdfUploadTestBase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->testNodes[1] = $this
      ->createNode([
      'title' => 'Hello',
      'type' => 'article',
    ]);
    $this->testNodes[2] = $this
      ->createNode([
      'title' => 'Goodbye',
      'type' => 'article',
    ]);
  }

  /**
   * Tests DownloadAction.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testDownloadAction() {
    $this
      ->uploadTestPdf('fillpdf_test_v3.pdf');
    $form_id = $this
      ->getLatestFillPdfForm();
    $fid_before = $this
      ->getLastFileId();
    $fillpdf_route = Url::fromRoute('fillpdf.populate_pdf', [], [
      'query' => [
        'fid' => $form_id,
        'sample' => 1,
      ],
    ]);
    $this
      ->drupalGet($fillpdf_route);
    $fid_after = $this
      ->getLastFileId();

    // Make sure the PDF file has not been saved.
    $this
      ->assertEquals($fid_before, $fid_after);

    // Make sure we are seeing the downloaded PDF.
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $maybe_pdf = $this
      ->getSession()
      ->getPage()
      ->getContent();
    static::assertEquals('application/pdf', $this
      ->getMimeType($maybe_pdf), 'The file has the correct MIME type.');

    // Ensure the headers are set to make the PDF download.
    $this
      ->assertSession()
      ->responseHeaderContains('Content-Disposition', ResponseHeaderBag::DISPOSITION_ATTACHMENT);
    $this
      ->assertSession()
      ->responseHeaderContains('Content-Type', 'application/pdf');
    $this
      ->assertSession()
      ->responseHeaderContains('Content-Length', (string) strlen(file_get_contents($this
      ->getTestPdfPath('fillpdf_test_v3.pdf'))));
  }

  /**
   * Tests SaveAction.
   */
  public function testSaveAction() {
    $this
      ->uploadTestPdf('fillpdf_test_v3.pdf');
    $form_id = $this
      ->getLatestFillPdfForm();
    $edit = [
      'scheme' => 'public',
    ];
    $this
      ->drupalPostForm("admin/structure/fillpdf/{$form_id}", $edit, 'Save');
    $fid_before = $this
      ->getLastFileId();
    $fillpdf_route = Url::fromRoute('fillpdf.populate_pdf', [], [
      'query' => [
        'fid' => $form_id,
        'sample' => 1,
      ],
    ]);
    $this
      ->drupalGet($fillpdf_route);
    $fid_after = $this
      ->getLastFileId();

    // Make sure the PDF file has been saved.
    $this
      ->assertEquals($fid_before + 1, $fid_after);

    // Make sure we are /not/ redirected to the PDF.
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $maybe_pdf = $this
      ->getSession()
      ->getPage()
      ->getContent();
    static::assertNotEquals('application/pdf', $this
      ->getMimeType($maybe_pdf), "The file has the correct MIME type.");
  }

  /**
   * Tests RedirectAction.
   */
  public function testRedirectAction() {
    $this
      ->uploadTestPdf('fillpdf_test_v3.pdf');
    $form_id = $this
      ->getLatestFillPdfForm();
    $edit = [
      'scheme' => 'public',
      'destination_redirect[value]' => TRUE,
    ];
    $this
      ->drupalPostForm("admin/structure/fillpdf/{$form_id}", $edit, 'Save');
    $fid_before = $this
      ->getLastFileId();
    $fillpdf_route = Url::fromRoute('fillpdf.populate_pdf', [], [
      'query' => [
        'fid' => $form_id,
        'sample' => 1,
      ],
    ]);
    $this
      ->drupalGet($fillpdf_route);
    $fid_after = $this
      ->getLastFileId();

    // Make sure the PDF file has been saved.
    $this
      ->assertEquals($fid_before + 1, $fid_after);

    // Make sure we have been redirected to the PDF.
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $maybe_pdf = $this
      ->getSession()
      ->getPage()
      ->getContent();
    static::assertEquals('application/pdf', $this
      ->getMimeType($maybe_pdf), "The file has the correct MIME type.");
  }

  /**
   * Tests filename and destination of a populated PDF file.
   */
  public function testTokenFilenameDestination() {
    $this
      ->uploadTestPdf('fillpdf_test_v3.pdf');
    $form_id = $this
      ->getLatestFillPdfForm();
    $edit = [
      'title[0][value]' => '[current-date:html_year]-[user:account-name]-[node:title].pdf',
      'scheme' => 'public',
      'destination_path[0][value]' => '[current-date:html_year]-[user:account-name]-[node:title]',
    ];
    $this
      ->drupalPostForm("admin/structure/fillpdf/{$form_id}", $edit, 'Save');
    $year = date('Y');
    $node1_id = $this->testNodes[1]
      ->id();
    $node1_title = $this->testNodes[1]
      ->getTitle();
    $node2_id = $this->testNodes[2]
      ->id();
    $node2_title = $this->testNodes[2]
      ->getTitle();
    $user_id = $this->adminUser
      ->id();
    $user_name = $this->adminUser
      ->getAccountName();
    $testcases = [];

    // Test case 0: no entity.
    $testcases[1]['entities'] = [];
    $testcases[1]['expected'] = "{$year}--";

    // Test case 1: existing node.
    $testcases[1]['entities'] = [
      "node:{$node1_id}",
    ];
    $testcases[1]['expected'] = "{$year}--{$node1_title}";

    // Test case 2: two existing nodes.
    $testcases[2]['entities'] = [
      "node:{$node1_id}",
      "node:{$node2_id}",
    ];
    $testcases[2]['expected'] = "{$year}--{$node2_title}";

    // Test case 3: twice the same node.
    $testcases[3]['entities'] = [
      "node:{$node1_id}",
      "node:{$node1_id}",
    ];
    $testcases[3]['expected'] = "{$year}--{$node1_title}";

    // Test case 4: existing user.
    $testcases[4]['entities'] = [
      "user:{$user_id}",
    ];
    $testcases[4]['expected'] = "{$year}-{$user_name}-";

    // Test case 5: existing node and existing user.
    $testcases[5]['entities'] = [
      "node:{$node1_id}",
      "user:{$user_id}",
    ];
    $testcases[5]['expected'] = "{$year}-{$user_name}-{$node1_title}";

    // Test case 6: non-existing node.
    $testcases[6]['entities'] = [
      "node:123",
    ];
    $testcases[6]['expected'] = "{$year}--";

    // Test case 7: existing node and non-existing user.
    $testcases[7]['entities'] = [
      "node:{$node1_id}",
      "user:456",
    ];
    $testcases[7]['expected'] = "{$year}--{$node1_title}";
    foreach ($testcases as $id => $case) {

      // Hit the generation route.
      $entities = $case['entities'];
      $fillpdf_route = Url::fromRoute('fillpdf.populate_pdf', [], [
        'query' => [
          'fid' => $form_id,
          'entity_ids' => $entities,
        ],
      ]);
      $this
        ->drupalGet($fillpdf_route);

      // Get last file and check if filename and path are correct.
      $file = File::load($this
        ->getLastFileId());
      $filename = $file
        ->getFilename();
      $uri = $file
        ->getFileUri();
      $expected = $case['expected'];
      $this
        ->assertEquals("{$expected}.pdf", $filename, "Test case {$id}: The file has the filename {$filename}.");
      $this
        ->assertEquals("public://fillpdf/{$expected}/{$expected}.pdf", $uri, "Test case {$id}: The file has the expected URI.");

      // Check if file is permanent and has the right format.
      $this
        ->assertFileIsPermanent($file);
      $this
        ->drupalGet(file_create_url($uri));
      $maybe_pdf = $this
        ->getSession()
        ->getPage()
        ->getContent();
      static::assertEquals('application/pdf', $this
        ->getMimeType($maybe_pdf), "Test case {$id}: The file has the correct MIME type.");

      // Delete the file, so we don't run into conflicts with the next testcase.
      $file
        ->delete();
    }
  }

  /**
   * Tests handling of an no longer allowed storage scheme.
   */
  public function testStorageSchemeDisallowed() {
    $this
      ->uploadTestPdf('fillpdf_test_v3.pdf');
    $form_id = $this
      ->getLatestFillPdfForm();
    $previous_file_id = $this
      ->getLastFileId();
    $edit = [
      'admin_title[0][value]' => 'Scheme test',
      'scheme' => 'public',
      'destination_path[0][value]' => 'test',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $fillpdf_route = Url::fromRoute('fillpdf.populate_pdf', [], [
      'query' => [
        'fid' => $form_id,
      ],
    ]);

    // Hit the generation route. Make sure we are redirected to the front page.
    $this
      ->drupalGet($fillpdf_route);
    $this
      ->assertSession()
      ->addressNotEquals('/fillpdf');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Get back to the front page and make sure the file was stored in the
    // private storage.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextNotContains('File storage scheme public:// is unavailable');
    $this
      ->assertEquals(++$previous_file_id, $this
      ->getLastFileId(), 'Generated file was stored.');
    $this
      ->assertStringStartsWith('public://', File::load($this
      ->getLastFileId())
      ->getFileUri());

    // Now disallow the public scheme.
    $this
      ->configureFillPdf([
      'allowed_schemes' => [
        'private',
      ],
    ]);

    // Hit the generation route again. This time we should be redirected to the
    // PDF file. Make sure no PHP error occured.
    $this
      ->drupalGet($fillpdf_route);
    $this
      ->assertSession()
      ->addressEquals('/fillpdf');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Get back to the front page and check if an error was set, and we didn't
    // try to store the file.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains("File storage scheme public:// is unavailable, so a PDF file generated from FillPDF form Scheme test ({$form_id}) could not be stored.");
    $this
      ->assertEquals($previous_file_id, $this
      ->getLastFileId(), 'Generated file was not stored.');
  }

  /**
   * Tests handling of an unavailable storage scheme.
   */
  public function testStorageSchemeUnavailable() {
    $this
      ->uploadTestPdf('fillpdf_test_v3.pdf');
    $form_id = $this
      ->getLatestFillPdfForm();
    $previous_file_id = $this
      ->getLastFileId();
    $edit = [
      'admin_title[0][value]' => 'Scheme test',
      'scheme' => 'private',
      'destination_path[0][value]' => 'test',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $fillpdf_route = Url::fromRoute('fillpdf.populate_pdf', [], [
      'query' => [
        'fid' => $form_id,
      ],
    ]);

    // Hit the generation route. Make sure we are redirected to the front page.
    $this
      ->drupalGet($fillpdf_route);
    $this
      ->assertSession()
      ->addressNotEquals('/fillpdf');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Get back to the front page and make sure the file was stored in the
    // private storage.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextNotContains('File storage scheme private:// is unavailable');
    $this
      ->assertEquals(++$previous_file_id, $this
      ->getLastFileId(), 'Generated file was stored.');
    $this
      ->assertStringStartsWith('private://', File::load($this
      ->getLastFileId())
      ->getFileUri());

    // Now remove the private path from settings.php and rebuild the container.
    $this
      ->writeSettings([
      'settings' => [
        'file_private_path' => (object) [
          'value' => '',
          'required' => TRUE,
        ],
      ],
    ]);
    $this
      ->rebuildContainer();

    // Hit the generation route again. This time we should be redirected to the
    // PDF file. Make sure no PHP error occured.
    $this
      ->drupalGet($fillpdf_route);
    $this
      ->assertSession()
      ->addressEquals('/fillpdf');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Get back to the front page and check if an error was set, and we didn't
    // try to store the file.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains("File storage scheme private:// is unavailable, so a PDF file generated from FillPDF form Scheme test ({$form_id}) could not be stored.");
    $this
      ->assertEquals($previous_file_id, $this
      ->getLastFileId(), 'Generated file was not stored.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	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::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FileFieldCreationTrait::attachFileField	public	function	Attaches a file field to an entity.
FileFieldCreationTrait::createFileField	public	function	Creates a new file field.
FileFieldTestBase::$adminUser	protected	property	A user with administration permissions.
FileFieldTestBase::assertFileEntryExists	public	function	Asserts that a file exists in the database.
FileFieldTestBase::assertFileEntryNotExists	public	function	Asserts that a file does not exist in the database.
FileFieldTestBase::assertFileIsPermanent	public	function	Asserts that a file's status is set to permanent in the database.
FileFieldTestBase::getLastFileId	public	function	Retrieves the fid of the last inserted file.
FileFieldTestBase::getTestFile	public	function	Retrieves a sample file of the specified type.
FileFieldTestBase::removeNodeFile	public	function	Removes a file from a node.
FileFieldTestBase::replaceNodeFile	public	function	Replaces a file within a node.
FileFieldTestBase::updateFileField	public	function	Updates an existing file field with new settings.
FileFieldTestBase::uploadNodeFile	public	function	Uploads a file to a node.
FileFieldTestBase::uploadNodeFiles	public	function	Uploads multiple files to a node.
FillPdfTestBase::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FillPdfTestBase::$linkManipulator	protected	property	The FillPDF link manipulator service.
FillPdfTestBase::$modules	public static	property	Modules to enable. Overrides FileFieldTestBase::$modules	2
FillPdfTestBase::$testImage	protected	property	A test image.
FillPdfTestBase::mapFillPdfFieldsToEntityFields	public static	function	Maps FillPdf fields to entity fields.
FillPdfUploadTestBase::assertNotUploadTextFile	protected	function	Asserts that a text file may not be uploaded.
FillPdfUploadTestBase::assertUploadPdfFile	protected	function	Asserts that a PDF file may be properly uploaded as a template.
FillPdfUploadTestBase::OP_CREATE		constant	Create a new FillPdfForm. Submit button on FillPdfOverviewForm.
FillPdfUploadTestBase::OP_REMOVE		constant	Remove a file from the managed file widget.
FillPdfUploadTestBase::OP_SAVE		constant	Save and update the FillPdfForm. Submit button on FillPdfFormForm.
FillPdfUploadTestBase::OP_UPLOAD		constant	Upload a file in the managed file widget.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
HandlePdfControllerTest::setUp	protected	function	Overrides FillPdfTestBase::setUp
HandlePdfControllerTest::testDownloadAction	public	function	Tests DownloadAction.
HandlePdfControllerTest::testRedirectAction	public	function	Tests RedirectAction.
HandlePdfControllerTest::testSaveAction	public	function	Tests SaveAction.
HandlePdfControllerTest::testStorageSchemeDisallowed	public	function	Tests handling of an no longer allowed storage scheme.
HandlePdfControllerTest::testStorageSchemeUnavailable	public	function	Tests handling of an unavailable storage scheme.
HandlePdfControllerTest::testTokenFilenameDestination	public	function	Tests filename and destination of a populated PDF file.
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
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.	1
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.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestFileCreationTrait::$generatedTestFiles	protected	property	Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles	protected	function	Compares two files based on size and file name.
TestFileCreationTrait::generateFile	public static	function	Generates a test file.
TestFileCreationTrait::getTestFiles	protected	function	Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
TestFillPdfTrait::configureFillPdf	protected	function	Configures schemes and backend.
TestFillPdfTrait::configureFillPdfServiceBackend	protected	function	Configures the FillPdf service backend.
TestFillPdfTrait::configureLocalServiceBackend	protected	function	Configures the FillPdf local service backend.
TestFillPdfTrait::getLatestFillPdfForm	protected	function	Gets the ID of the latest fillpdf_form stored.
TestFillPdfTrait::getMimeType	protected	function	Gets the MIME type.
TestFillPdfTrait::getTestPdfPath	protected	function	Gets the absolute local filepath of a PDF test file.
TestFillPdfTrait::initializeUser	protected	function	Creates a privileged user account and logs in.
TestFillPdfTrait::uploadTestPdf	protected	function	Uploads a specified PDF testfile, if given.
TestImageFieldTrait::createImageField	protected	function	Create a new image field.
TestImageFieldTrait::createImageFieldEntity	public	function	Create an entity with an image.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.