You are here

Home » API reference » Entity Share 8.3 » FileTest.php

class FileTest in Entity Share 8.3

Same name and namespace in other branches
  1. 8.2 modules/entity_share_client/tests/src/Functional/FileTest.php \Drupal\Tests\entity_share_client\Functional\FileTest

Functional test class for file field.

@group entity_share @group entity_share_client

Hierarchy

Expanded class hierarchy of FileTest

File

modules/entity_share_client/tests/src/Functional/FileTest.php, line 16

Namespace

Drupal\Tests\entity_share_client\Functional
View source 
class FileTest extends EntityShareClientFunctionalTestBase {
  use TestFileCreationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $entityTypeId = 'node';

  /**
   * {@inheritdoc}
   */
  protected static $entityBundleId = 'es_test';

  /**
   * {@inheritdoc}
   */
  protected static $entityLangcode = 'en';

  /**
   * An array of data to generate physical files.
   *
   * @var array
   */
  protected static $filesData = [
    'public_file' => [
      'filename' => 'test.txt',
      'filemime' => 'text/plain',
      'uri' => 'public://test.txt',
      'file_content' => 'Drupal',
    ],
    'public_file_sub_directory' => [
      'filename' => 'test_sub_directory.txt',
      'filemime' => 'text/plain',
      'uri' => 'public://sub-directory/test_sub_directory.txt',
      'file_content_callback' => 'generateBigFile',
    ],
    'private_file_sub_directory' => [
      'filename' => 'test_private.txt',
      'filemime' => 'text/plain',
      'uri' => 'private://sub-directory/test_private.txt',
      'file_content' => 'Drupal',
    ],
    'public_jpg' => [
      'filename' => 'image-test.jpg',
      'filemime' => 'image/jpeg',
      'uri' => 'public://image-test.jpg',
    ],
    'public_png' => [
      'filename' => 'image-test.png',
      'filemime' => 'image/png',
      'uri' => 'public://image-test.png',
    ],
  ];

  /**
   * An array of file size keyed by file UUID.
   *
   * @var array
   */
  protected $filesSize = [];

  /**
   * {@inheritdoc}
   *
   * @SuppressWarnings(PHPMD.UndefinedVariable)
   * Bug in PHPMD, @see https://github.com/phpmd/phpmd/issues/714
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->getTestFiles('image');

    // Special case for the images created using native helper method.
    if (isset(static::$filesData['public_jpg'])) {
      $this->filesSize['public_jpg'] = filesize(static::$filesData['public_jpg']['uri']);
    }
    if (isset(static::$filesData['public_png'])) {
      $this->filesSize['public_png'] = filesize(static::$filesData['public_png']['uri']);
    }
    $this
      ->postSetupFixture();
  }

  /**
   * {@inheritdoc}
   */
  protected function getImportConfigProcessorSettings() {
    $processors = parent::getImportConfigProcessorSettings();
    $processors['physical_file'] = [
      'rename' => FALSE,
      'weights' => [
        'process_entity' => 0,
      ],
    ];
    return $processors;
  }

  /**
   * {@inheritdoc}
   */
  protected function postSetupFixture() {
    $this
      ->prepareContent();
    $this
      ->populateRequestService();

    // Delete the physical file after populating the request service.
    foreach (static::$filesData as $file_data) {
      $this->fileSystem
        ->delete($file_data['uri']);
    }
    $this
      ->deleteContent();
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntitiesDataArray() {
    return [
      'file' => [
        'en' => $this
          ->preparePhysicalFilesAndFileEntitiesData(),
      ],
      'node' => [
        'en' => [
          // Basic public file.
          'es_test_public_file' => $this
            ->getCompleteNodeInfos([
            'field_es_test_file' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_file'),
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // Public file with hidden description.
          'es_test_public_file_description_hidden' => $this
            ->getCompleteNodeInfos([
            'field_es_test_file' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_file'),
                    'display' => 0,
                    // Can't use faker because it is a value_callback to handle
                    // the target_id.
                    'description' => 'Description 1',
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // Public file with shown description.
          'es_test_public_file_description_shown' => $this
            ->getCompleteNodeInfos([
            'field_es_test_file' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_file'),
                    'display' => 1,
                    // Can't use faker because it is a value_callback to handle
                    // the target_id.
                    'description' => 'Description 2',
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // Public file in sub-directory.
          'es_test_public_file_sub_directory' => $this
            ->getCompleteNodeInfos([
            'field_es_test_file' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_file_sub_directory'),
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // Private file in sub-directory.
          'es_test_private_file_sub_directory' => $this
            ->getCompleteNodeInfos([
            'field_es_test_file' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'private_file_sub_directory'),
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // PNG.
          'es_test_png' => $this
            ->getCompleteNodeInfos([
            'field_es_test_image' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_png'),
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // JPEG + alt text.
          'es_test_jpeg_alt' => $this
            ->getCompleteNodeInfos([
            'field_es_test_image' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_jpg'),
                    // Can't use faker because it is a value_callback to handle
                    // the target_id.
                    'alt' => 'Alt text 1',
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // JPEG + title text.
          'es_test_jpeg_title' => $this
            ->getCompleteNodeInfos([
            'field_es_test_image' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_jpg'),
                    // Can't use faker because it is a value_callback to handle
                    // the target_id.
                    'title' => 'Title text 1',
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
          // JPEG + alt text + title text.
          'es_test_jpeg_alt_title' => $this
            ->getCompleteNodeInfos([
            'field_es_test_image' => [
              'value_callback' => function () {
                return [
                  [
                    'target_id' => $this
                      ->getEntityId('file', 'public_jpg'),
                    // Can't use faker because it is a value_callback to handle
                    // the target_id.
                    'alt' => 'Alt text 2',
                    'title' => 'Title text 2',
                  ],
                ];
              },
              'checker_callback' => 'getFilteredStructureValues',
            ],
            'status' => [
              'value' => NodeInterface::PUBLISHED,
              'checker_callback' => 'getValue',
            ],
          ]),
        ],
      ],
    ];
  }

  /**
   * Test basic pull feature.
   */
  public function testBasicPull() {
    $this
      ->commonBasicPull();

    // Test again without the import plugin "Physical file".
    $this
      ->removePluginFromImportConfig('physical_file');

    // Need to remove all imported content (and files) prior to that.
    $this
      ->resetImportedContent();
    foreach (static::$filesData as $file_data) {
      $this
        ->assertFalse(file_exists($file_data['uri']), 'The physical file ' . $file_data['filename'] . ' has been deleted.');
    }

    // Pull just one entity with attached file, and without this plugin
    // the file should not exist.
    $this
      ->pullEveryChannels();
    $this
      ->checkCreatedEntities();
    foreach (static::$filesData as $file_data) {
      $this
        ->assertFalse(file_exists($file_data['uri']), 'The physical file ' . $file_data['filename'] . ' has not been pulled and recreated.');
    }

    // Test rename option.
    // Re-enable the plugin.
    $this
      ->mergePluginsToImportConfig([
      'physical_file' => [
        'rename' => FALSE,
        'weights' => [
          'process_entity' => 0,
        ],
      ],
    ]);

    // Need to remove all imported content (and files) prior to that.
    $this
      ->resetImportedContent();

    // Pull twice to test that by default there are no duplicated physical
    // files.
    $this
      ->pullEveryChannels();
    $this->importService
      ->getRuntimeImportContext()
      ->clearImportedEntities();
    $this
      ->pullEveryChannels();

    // Test that the files had been recreated without rename.
    foreach (static::$filesData as $file_data) {
      $this
        ->assertTrue(file_exists($file_data['uri']), 'The physical file ' . $file_data['filename'] . ' has been pulled and recreated.');
      $replaced_file_info = $this
        ->getReplacedFileInfo($file_data);
      $this
        ->assertFalse(file_exists($replaced_file_info['uri']), 'The physical file ' . $replaced_file_info['filename'] . ' has not been renamed.');
    }

    // Need to remove all imported content (and files) prior to that.
    $this
      ->resetImportedContent();

    // Update the 'rename' setting.
    $this
      ->mergePluginsToImportConfig([
      'physical_file' => [
        'rename' => TRUE,
        'weights' => [
          'process_entity' => 0,
        ],
      ],
    ]);
    $this
      ->pullEveryChannels();
    $this->importService
      ->getRuntimeImportContext()
      ->clearImportedEntities();

    // At the first import there should not be duplicated files.
    foreach (static::$filesData as $file_data) {
      $this
        ->assertTrue(file_exists($file_data['uri']), 'The physical file ' . $file_data['filename'] . ' has been pulled and recreated.');
      $replaced_file_info = $this
        ->getReplacedFileInfo($file_data);
      $this
        ->assertFalse(file_exists($replaced_file_info['uri']), 'The physical file ' . $replaced_file_info['filename'] . ' has not been renamed.');
    }
    $this
      ->pullEveryChannels();

    // At the second import there should be duplicated files.
    foreach (static::$filesData as $file_data) {
      $this
        ->assertTrue(file_exists($file_data['uri']), 'The physical file ' . $file_data['filename'] . ' still exists.');
      $replaced_file_info = $this
        ->getReplacedFileInfo($file_data);
      $this
        ->assertTrue(file_exists($replaced_file_info['uri']), 'The physical file ' . $replaced_file_info['filename'] . ' has been created.');
    }
  }

  /**
   * Helper function.
   *
   * @param string $file_uuid
   *   The file UUID.
   * @param array $file_data
   *   The file data as in static::filesData.
   */
  protected function generateBigFile($file_uuid, array $file_data) {

    // 100 MB.
    $size = 100000000;
    $file_pointer = fopen($file_data['uri'], 'w');
    fseek($file_pointer, $size - 1, SEEK_CUR);
    fwrite($file_pointer, 'a');
    fclose($file_pointer);
    $this->filesSize[$file_uuid] = filesize($file_data['uri']);
  }

  /**
   * Get the replaced file infos.
   *
   * @param array $file_data
   *   The file's data with the same structure as in static::$filesData.
   *
   * @return array
   *   The array of data for the replaced file. Same structure as input.
   */
  protected function getReplacedFileInfo(array $file_data) {
    $replaced_file_data = $file_data;
    $uri = $file_data['uri'];
    $filename = $file_data['filename'];

    // Generate replaced file name.
    $parts = pathinfo($filename);
    $replaced_file_name = $parts['filename'] . '_0.' . $parts['extension'];
    $replaced_file_data['filename'] = $replaced_file_name;

    // Generate replaced URI.
    $replaced_file_data['uri'] = str_replace($filename, $replaced_file_name, $uri);
    return $replaced_file_data;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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::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
BrowserTestBase::$minkDefaultDriverClass protected property 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
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
EntityFieldHelperTrait::getFilteredStructureValues public function Retrieve the value from a field.
EntityFieldHelperTrait::getTargetId public function Retrieve the value from a field where the value key is target_id.
EntityFieldHelperTrait::getValue public function Retrieve the value from a field.
EntityFieldHelperTrait::getValues public function Retrieve the value from a field.
EntityShareClientFunctionalTestBase::$adminUser protected property A test user with administrative privileges.
EntityShareClientFunctionalTestBase::$authPluginManager protected property The client authorization manager service.
EntityShareClientFunctionalTestBase::$channels protected property The channels used for the test.
EntityShareClientFunctionalTestBase::$channelUser protected property A test user with access to the channel list.
EntityShareClientFunctionalTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
EntityShareClientFunctionalTestBase::$entities protected property A mapping of the entities created for the test.
EntityShareClientFunctionalTestBase::$entitiesData protected property A mapping of the entity data used for the test.
EntityShareClientFunctionalTestBase::$entityDefinitions protected property The entity type definitions.
EntityShareClientFunctionalTestBase::$entityTypeManager protected property The entity type manager service.
EntityShareClientFunctionalTestBase::$faker protected property Faker generator.
EntityShareClientFunctionalTestBase::$fileSystem protected property The file system service.
EntityShareClientFunctionalTestBase::$importConfig protected property The import config used for the test.
EntityShareClientFunctionalTestBase::$importService protected property The import service.
EntityShareClientFunctionalTestBase::$keyValueStore protected property The key value store to use.
EntityShareClientFunctionalTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 9
EntityShareClientFunctionalTestBase::$remote protected property The remote used for the test.
EntityShareClientFunctionalTestBase::$remoteManager protected property The remote manager service.
EntityShareClientFunctionalTestBase::$streamWrapperManager protected property The stream wrapper manager.
EntityShareClientFunctionalTestBase::$visitedUrlsDuringSetup protected property The visited URLs during setup.
EntityShareClientFunctionalTestBase::checkCreatedEntities protected function Helper function that test that the entities had been recreated.
EntityShareClientFunctionalTestBase::commonBasicPull protected function Common parts between FileTest and MediaEntityReferenceTest classes.
EntityShareClientFunctionalTestBase::createAuthenticationPlugin protected function Helper function to create the authentication plugin. 2
EntityShareClientFunctionalTestBase::createChannel protected function Helper function to create the channel used for the test. 6
EntityShareClientFunctionalTestBase::createImportConfig protected function Helper function to create the import config used for the test.
EntityShareClientFunctionalTestBase::createRemote protected function Helper function to create the remote that point to the site itself.
EntityShareClientFunctionalTestBase::deleteContent protected function Helper function to delete the prepared content.
EntityShareClientFunctionalTestBase::discoverJsonApiEndpoints protected function Helper function to populate the request service with responses.
EntityShareClientFunctionalTestBase::getAdministratorPermissions protected function Gets the permissions for the admin user. 1
EntityShareClientFunctionalTestBase::getAuthenticationRequestOptions protected function Returns Guzzle request options for authentication.
EntityShareClientFunctionalTestBase::getChannelUserPermissions protected function Gets the permissions for the channel user. 1
EntityShareClientFunctionalTestBase::getCompleteBlockInfos protected function Helper function.
EntityShareClientFunctionalTestBase::getCompleteMediaInfos protected function Helper function.
EntityShareClientFunctionalTestBase::getCompleteNodeInfos protected function Helper function.
EntityShareClientFunctionalTestBase::getCompleteParagraphInfos protected function Helper function.
EntityShareClientFunctionalTestBase::getCompleteTaxonomyTermInfos protected function Helper function.
EntityShareClientFunctionalTestBase::getEntitiesData protected function Helper function to get a mapping of the entities data.
EntityShareClientFunctionalTestBase::getEntityId protected function Helper function.
EntityShareClientFunctionalTestBase::getEntityJsonData protected function Helper function to get the JSON:API data of an entity.
EntityShareClientFunctionalTestBase::getEntityRevisionId protected function Helper function.
EntityShareClientFunctionalTestBase::getMediaEntityReferenceTestFiles protected function Helper function.
EntityShareClientFunctionalTestBase::importSelectedEntities protected function Helper function.
EntityShareClientFunctionalTestBase::IMPORT_CONFIG_ID constant The import config ID.
EntityShareClientFunctionalTestBase::loadEntity protected function Helper function.
EntityShareClientFunctionalTestBase::mergePluginsToImportConfig protected function Helper function to add/modify plugins in import config, runtime.
EntityShareClientFunctionalTestBase::populateRequestService protected function Helper function to populate the request service with responses. 7
EntityShareClientFunctionalTestBase::prepareContent protected function Helper function to create the content required for the tests. 1
EntityShareClientFunctionalTestBase::prepareEntityData protected function Helper function to prepare entity data.
EntityShareClientFunctionalTestBase::preparePhysicalFilesAndFileEntitiesData protected function Helper function.
EntityShareClientFunctionalTestBase::prepareUrlFilteredOnUuids protected function Helper function.
EntityShareClientFunctionalTestBase::pullChannel protected function Helper function to import one channel.
EntityShareClientFunctionalTestBase::pullEveryChannels protected function Helper function to import all channels.
EntityShareClientFunctionalTestBase::removePluginFromImportConfig protected function Helper function to remove a plugin from import config, runtime.
EntityShareClientFunctionalTestBase::resetImportedContent protected function Helper function to delete all (prepared or imported) content.
EntityShareServerRequestTestTrait::request protected function Performs a HTTP request. Wraps the Guzzle HTTP client.
FileTest::$entityBundleId protected static property The tested entity type bundle. Overrides EntityShareClientFunctionalTestBase::$entityBundleId
FileTest::$entityLangcode protected static property The tested entity langcode. Overrides EntityShareClientFunctionalTestBase::$entityLangcode
FileTest::$entityTypeId protected static property The tested entity type. Overrides EntityShareClientFunctionalTestBase::$entityTypeId
FileTest::$filesData protected static property An array of data to generate physical files. 1
FileTest::$filesSize protected property An array of file size keyed by file UUID.
FileTest::generateBigFile protected function Helper function.
FileTest::getEntitiesDataArray protected function Helper function to get a mapping of the entities data. Overrides EntityShareClientFunctionalTestBase::getEntitiesDataArray 1
FileTest::getImportConfigProcessorSettings protected function Helper function to create the import config used for the test. Overrides EntityShareClientFunctionalTestBase::getImportConfigProcessorSettings
FileTest::getReplacedFileInfo protected function Get the replaced file infos.
FileTest::postSetupFixture protected function Helper function. Overrides EntityShareClientFunctionalTestBase::postSetupFixture 1
FileTest::setUp protected function @SuppressWarnings(PHPMD.UndefinedVariable) Bug in PHPMD, Overrides EntityShareClientFunctionalTestBase::setUp
FileTest::testBasicPull public function Test basic pull feature. 1
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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. 23
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.
JsonApiRequestTestTrait::decorateWithXdebugCookie protected function Adds the Xdebug cookie to the request options.
JsonApiRequestTestTrait::request protected function Performs a HTTP request. Wraps the Guzzle HTTP client. Aliased as: parentRequest
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 3
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.
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. 2
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. 2
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 a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
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 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::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.