abstract class MediaResourceTestBase in Drupal 10

Same name and namespace in other branches

8 core/modules/media/tests/src/Functional/Rest/MediaResourceTestBase.php \Drupal\Tests\media\Functional\Rest\MediaResourceTestBase
9 core/modules/media/tests/src/Functional/Rest/MediaResourceTestBase.php \Drupal\Tests\media\Functional\Rest\MediaResourceTestBase

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\rest\Functional\ResourceTestBase
  - class \Drupal\Tests\rest\Functional\EntityResource\EntityResourceTestBase
    class \Drupal\Tests\media\Functional\Rest\MediaResourceTestBase

Expanded class hierarchy of MediaResourceTestBase

File

core/modules/media/tests/src/Functional/Rest/MediaResourceTestBase.php, line 17

Namespace

Drupal\Tests\media\Functional\Rest

View source

abstract class MediaResourceTestBase extends EntityResourceTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'media',
  ];

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

  /**
   * @var \Drupal\media\MediaInterface
   */
  protected $entity;

  /**
   * {@inheritdoc}
   */
  protected static $patchProtectedFieldNames = [
    'changed' => NULL,
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    \Drupal::configFactory()
      ->getEditable('media.settings')
      ->set('standalone_url', TRUE)
      ->save(TRUE);

    // Provisioning the Media REST resource without the File REST resource does
    // not make sense.
    $this->resourceConfigStorage
      ->create([
      'id' => 'entity.file',
      'granularity' => RestResourceConfigInterface::RESOURCE_GRANULARITY,
      'configuration' => [
        'methods' => [
          'GET',
        ],
        'formats' => [
          static::$format,
        ],
        'authentication' => isset(static::$auth) ? [
          static::$auth,
        ] : [],
      ],
      'status' => TRUE,
    ])
      ->save();
    $this->container
      ->get('router.builder')
      ->rebuild();
  }

  /**
   * {@inheritdoc}
   */
  protected function setUpAuthorization($method) {
    switch ($method) {
      case 'GET':
        $this
          ->grantPermissionsToTestedRole([
          'view media',
        ]);
        break;
      case 'POST':
        $this
          ->grantPermissionsToTestedRole([
          'create camelids media',
          'access content',
        ]);
        break;
      case 'PATCH':
        $this
          ->grantPermissionsToTestedRole([
          'edit any camelids media',
        ]);

        // @todo Remove this in https://www.drupal.org/node/2824851.
        $this
          ->grantPermissionsToTestedRole([
          'access content',
        ]);
        break;
      case 'DELETE':
        $this
          ->grantPermissionsToTestedRole([
          'delete any camelids media',
        ]);
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function createEntity() {
    if (!MediaType::load('camelids')) {

      // Create a "Camelids" media type.
      $media_type = MediaType::create([
        'name' => 'Camelids',
        'id' => 'camelids',
        'description' => 'Camelids are large, strictly herbivorous animals with slender necks and long legs.',
        'source' => 'file',
      ]);
      $media_type
        ->save();

      // Create the source field.
      $source_field = $media_type
        ->getSource()
        ->createSourceField($media_type);
      $source_field
        ->getFieldStorageDefinition()
        ->save();
      $source_field
        ->save();
      $media_type
        ->set('source_configuration', [
        'source_field' => $source_field
          ->getName(),
      ])
        ->save();
    }

    // Create a file to upload.
    $file = File::create([
      'uri' => 'public://llama.txt',
    ]);
    $file
      ->setPermanent();
    $file
      ->save();

    // Create a "Llama" media item.
    $media = Media::create([
      'bundle' => 'camelids',
      'field_media_file' => [
        'target_id' => $file
          ->id(),
      ],
    ]);
    $media
      ->setName('Llama')
      ->setPublished()
      ->setCreatedTime(123456789)
      ->setOwnerId(static::$auth ? $this->account
      ->id() : 0)
      ->setRevisionUserId(static::$auth ? $this->account
      ->id() : 0)
      ->save();
    return $media;
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedNormalizedEntity() {
    $file = File::load(1);
    $thumbnail = File::load(2);
    $author = User::load($this->entity
      ->getOwnerId());
    return [
      'mid' => [
        [
          'value' => 1,
        ],
      ],
      'uuid' => [
        [
          'value' => $this->entity
            ->uuid(),
        ],
      ],
      'vid' => [
        [
          'value' => 1,
        ],
      ],
      'langcode' => [
        [
          'value' => 'en',
        ],
      ],
      'bundle' => [
        [
          'target_id' => 'camelids',
          'target_type' => 'media_type',
          'target_uuid' => MediaType::load('camelids')
            ->uuid(),
        ],
      ],
      'name' => [
        [
          'value' => 'Llama',
        ],
      ],
      'field_media_file' => [
        [
          'description' => NULL,
          'display' => NULL,
          'target_id' => (int) $file
            ->id(),
          'target_type' => 'file',
          'target_uuid' => $file
            ->uuid(),
          'url' => $file
            ->createFileUrl(FALSE),
        ],
      ],
      'thumbnail' => [
        [
          'alt' => '',
          'width' => 180,
          'height' => 180,
          'target_id' => (int) $thumbnail
            ->id(),
          'target_type' => 'file',
          'target_uuid' => $thumbnail
            ->uuid(),
          'title' => NULL,
          'url' => $thumbnail
            ->createFileUrl(FALSE),
        ],
      ],
      'status' => [
        [
          'value' => TRUE,
        ],
      ],
      'created' => [
        [
          'value' => (new \DateTime())
            ->setTimestamp(123456789)
            ->setTimezone(new \DateTimeZone('UTC'))
            ->format(\DateTime::RFC3339),
          'format' => \DateTime::RFC3339,
        ],
      ],
      'changed' => [
        [
          'value' => (new \DateTime())
            ->setTimestamp((int) $this->entity
            ->getChangedTime())
            ->setTimezone(new \DateTimeZone('UTC'))
            ->format(\DateTime::RFC3339),
          'format' => \DateTime::RFC3339,
        ],
      ],
      'revision_created' => [
        [
          'value' => (new \DateTime())
            ->setTimestamp((int) $this->entity
            ->getRevisionCreationTime())
            ->setTimezone(new \DateTimeZone('UTC'))
            ->format(\DateTime::RFC3339),
          'format' => \DateTime::RFC3339,
        ],
      ],
      'default_langcode' => [
        [
          'value' => TRUE,
        ],
      ],
      'uid' => [
        [
          'target_id' => (int) $author
            ->id(),
          'target_type' => 'user',
          'target_uuid' => $author
            ->uuid(),
          'url' => base_path() . 'user/' . $author
            ->id(),
        ],
      ],
      'revision_user' => [
        [
          'target_id' => (int) $author
            ->id(),
          'target_type' => 'user',
          'target_uuid' => $author
            ->uuid(),
          'url' => base_path() . 'user/' . $author
            ->id(),
        ],
      ],
      'revision_log_message' => [],
      'revision_translation_affected' => [
        [
          'value' => TRUE,
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getNormalizedPostEntity() {
    return [
      'bundle' => [
        [
          'target_id' => 'camelids',
        ],
      ],
      'name' => [
        [
          'value' => 'Dramallama',
        ],
      ],
      'field_media_file' => [
        [
          'description' => NULL,
          'display' => NULL,
          'target_id' => 3,
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getNormalizedPatchEntity() {
    return array_diff_key($this
      ->getNormalizedPostEntity(), [
      'field_media_file' => TRUE,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedAccessMessage($method) {
    switch ($method) {
      case 'GET':
        return "The 'view media' permission is required when the media item is published.";
      case 'POST':
        return "The following permissions are required: 'administer media' OR 'create media' OR 'create camelids media'.";
      case 'PATCH':
        return "The following permissions are required: 'update any media' OR 'update own media' OR 'camelids: edit any media' OR 'camelids: edit own media'.";
      case 'DELETE':
        return "The following permissions are required: 'delete any media' OR 'delete own media' OR 'camelids: delete any media' OR 'camelids: delete own media'.";
      default:
        return parent::getExpectedUnauthorizedAccessMessage($method);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function testPost() {
    $file_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('file');

    // Step 1: upload file, results in File entity marked temporary.
    $this
      ->uploadFile();
    $file = $file_storage
      ->loadUnchanged(3);
    $this
      ->assertTrue($file
      ->isTemporary());
    $this
      ->assertFalse($file
      ->isPermanent());

    // Step 2: create Media entity using the File, makes File entity permanent.
    parent::testPost();
    $file = $file_storage
      ->loadUnchanged(3);
    $this
      ->assertFalse($file
      ->isTemporary());
    $this
      ->assertTrue($file
      ->isPermanent());
  }

  /**
   * This duplicates some of the 'file_upload' REST resource plugin test
   * coverage, to be able to test it on a concrete use case.
   */
  protected function uploadFile() {

    // Enable the 'file_upload' REST resource for the current format + auth.
    $this->resourceConfigStorage
      ->create([
      'id' => 'file.upload',
      'granularity' => RestResourceConfigInterface::RESOURCE_GRANULARITY,
      'configuration' => [
        'methods' => [
          'POST',
        ],
        'formats' => [
          static::$format,
        ],
        'authentication' => isset(static::$auth) ? [
          static::$auth,
        ] : [],
      ],
      'status' => TRUE,
    ])
      ->save();
    $this
      ->refreshTestStateAfterRestConfigChange();
    $this
      ->initAuthentication();

    // POST to create a File entity.
    $url = Url::fromUri('base:file/upload/media/camelids/field_media_file');
    $url
      ->setOption('query', [
      '_format' => static::$format,
    ]);
    $request_options = [];
    $request_options[RequestOptions::HEADERS] = [
      // Set the required (and only accepted) content type for the request.
      'Content-Type' => 'application/octet-stream',
      // Set the required Content-Disposition header for the file name.
      'Content-Disposition' => 'file; filename="drupal rocks 🤘.txt"',
    ];
    $request_options[RequestOptions::BODY] = 'Drupal is the best!';
    $request_options = NestedArray::mergeDeep($request_options, $this
      ->getAuthenticationRequestOptions('POST'));
    $response = $this
      ->request('POST', $url, $request_options);
    $this
      ->assertResourceErrorResponse(403, $this
      ->getExpectedUnauthorizedAccessMessage('POST'), $response);

    // Grant necessary permission, retry.
    $this
      ->grantPermissionsToTestedRole([
      'create camelids media',
    ]);
    $response = $this
      ->request('POST', $url, $request_options);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedNormalizedFileEntity();
    static::recursiveKSort($expected);
    $actual = $this->serializer
      ->decode((string) $response
      ->getBody(), static::$format);
    static::recursiveKSort($actual);
    $this
      ->assertSame($expected, $actual);

    // To still run the complete test coverage for POSTing a Media entity, we
    // must revoke the additional permissions that we granted.
    $role = Role::load(static::$auth ? RoleInterface::AUTHENTICATED_ID : RoleInterface::ANONYMOUS_ID);
    $role
      ->revokePermission('create camelids media');
    $role
      ->trustData()
      ->save();
  }

  /**
   * Gets the expected file entity.
   *
   * @return array
   *   The expected normalized data array.
   */
  protected function getExpectedNormalizedFileEntity() {
    $file = File::load(3);
    $owner = static::$auth ? $this->account : User::load(0);
    return [
      'fid' => [
        [
          'value' => 3,
        ],
      ],
      'uuid' => [
        [
          'value' => $file
            ->uuid(),
        ],
      ],
      'langcode' => [
        [
          'value' => 'en',
        ],
      ],
      'uid' => [
        [
          'target_id' => (int) $owner
            ->id(),
          'target_type' => 'user',
          'target_uuid' => $owner
            ->uuid(),
          'url' => base_path() . 'user/' . $owner
            ->id(),
        ],
      ],
      'filename' => [
        [
          'value' => 'drupal rocks 🤘.txt',
        ],
      ],
      'uri' => [
        [
          'value' => 'public://' . date('Y-m') . '/drupal rocks 🤘.txt',
          'url' => base_path() . $this->siteDirectory . '/files/' . date('Y-m') . '/drupal%20rocks%20%F0%9F%A4%98.txt',
        ],
      ],
      'filemime' => [
        [
          'value' => 'text/plain',
        ],
      ],
      'filesize' => [
        [
          'value' => 19,
        ],
      ],
      'status' => [
        [
          'value' => FALSE,
        ],
      ],
      'created' => [
        [
          'value' => (new \DateTime())
            ->setTimestamp($file
            ->getCreatedTime())
            ->setTimezone(new \DateTimeZone('UTC'))
            ->format(\DateTime::RFC3339),
          'format' => \DateTime::RFC3339,
        ],
      ],
      'changed' => [
        [
          'value' => (new \DateTime())
            ->setTimestamp($file
            ->getChangedTime())
            ->setTimezone(new \DateTimeZone('UTC'))
            ->format(\DateTime::RFC3339),
          'format' => \DateTime::RFC3339,
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedEntityAccessCacheability($is_authenticated) {

    // @see \Drupal\media\MediaAccessControlHandler::checkAccess()
    return parent::getExpectedUnauthorizedEntityAccessCacheability($is_authenticated)
      ->addCacheTags([
      'media:1',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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 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::$defaultTheme	protected	property	The theme to install as the default for testing.	525
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.	14
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 test environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
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 test 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
BrowserTestBase::tearDown	protected	function		2
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
EntityResourceTestBase::$anotherEntity	protected	property	Another entity of the same type used for testing.
EntityResourceTestBase::$entityStorage	protected	property	The entity storage.
EntityResourceTestBase::$firstCreatedEntityId	protected static	property	The entity ID for the first created entity in testPost().	2
EntityResourceTestBase::$labelFieldName	protected static	property	Optionally specify which field is the 'label' field. Some entities do not specify a 'label' entity key. For example: User.	1
EntityResourceTestBase::$secondCreatedEntityId	protected static	property	The entity ID for the second created entity in testPost().	2
EntityResourceTestBase::$uniqueFieldNames	protected static	property	The fields that need a different (random) value for each new entity created by a POST request.	1
EntityResourceTestBase::assert406Response	protected	function	Asserts a 406 response… or in some cases a 403 response, because weirdness.
EntityResourceTestBase::assertEntityArraySubset	protected	function	Recursively asserts that the expected items are set in the tested entity.
EntityResourceTestBase::assertNormalizationEdgeCases	protected	function	Asserts normalization-specific edge cases. Overrides ResourceTestBase::assertNormalizationEdgeCases
EntityResourceTestBase::assertPatchProtectedFieldNamesStructure	protected	function	Asserts structure of $patchProtectedFieldNames.
EntityResourceTestBase::assertResourceNotAvailable	protected	function	Asserts that a resource is unavailable: 404, 406 if it has canonical route.
EntityResourceTestBase::assertStoredEntityMatchesSentNormalization	protected	function	Asserts that the stored entity matches the sent normalization.
EntityResourceTestBase::castToString	protected static	function	Transforms a normalization: casts all non-string types to strings.
EntityResourceTestBase::createAnotherEntity	protected	function	Creates another entity to be tested.	1
EntityResourceTestBase::getEntityResourcePostUrl	protected	function	Gets an entity resource's POST URL.
EntityResourceTestBase::getEntityResourceUrl	protected	function	Gets an entity resource's GET/PATCH/DELETE URL.
EntityResourceTestBase::getExpectedCacheContexts	protected	function	The expected cache contexts for the GET/HEAD response of the test entity.	9
EntityResourceTestBase::getExpectedCacheTags	protected	function	The expected cache tags for the GET/HEAD response of the test entity.	2
EntityResourceTestBase::getExpectedUnauthorizedAccessCacheability	protected	function	Returns the expected cacheability of an unauthorized access response. Overrides ResourceTestBase::getExpectedUnauthorizedAccessCacheability
EntityResourceTestBase::getModifiedEntityForPatchTesting	protected static	function	Clones the given entity and modifies all PATCH-protected fields.
EntityResourceTestBase::getModifiedEntityForPostTesting	protected	function	Gets the normalized POST entity with random values for its unique fields.
EntityResourceTestBase::makeNormalizationInvalid	protected	function	Makes the given entity normalization invalid.
EntityResourceTestBase::provisionEntityResource	protected	function	Provides an entity resource.
EntityResourceTestBase::testDelete	public	function	Tests a DELETE request for an entity, plus edge cases to ensure good DX.	1
EntityResourceTestBase::testGet	public	function	Tests a GET request for an entity, plus edge cases to ensure good DX.	2
EntityResourceTestBase::testPatch	public	function	Tests a PATCH request for an entity, plus edge cases to ensure good DX.	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
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.
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 the test installs Drupal.	4
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	21
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.	3
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
MediaResourceTestBase::$entity	protected	property	Overrides EntityResourceTestBase::$entity
MediaResourceTestBase::$entityTypeId	protected static	property	The tested entity type. Overrides EntityResourceTestBase::$entityTypeId
MediaResourceTestBase::$modules	protected static	property	Modules to install. Overrides EntityResourceTestBase::$modules	2
MediaResourceTestBase::$patchProtectedFieldNames	protected static	property	The fields that are protected against modification during PATCH requests. Overrides EntityResourceTestBase::$patchProtectedFieldNames
MediaResourceTestBase::createEntity	protected	function	Creates the entity to be tested. Overrides EntityResourceTestBase::createEntity
MediaResourceTestBase::getExpectedNormalizedEntity	protected	function	Returns the expected normalization of the entity. Overrides EntityResourceTestBase::getExpectedNormalizedEntity
MediaResourceTestBase::getExpectedNormalizedFileEntity	protected	function	Gets the expected file entity.
MediaResourceTestBase::getExpectedUnauthorizedAccessMessage	protected	function	Return the expected error message. Overrides EntityResourceTestBase::getExpectedUnauthorizedAccessMessage
MediaResourceTestBase::getExpectedUnauthorizedEntityAccessCacheability	protected	function	The cacheability of unauthorized 'view' entity access. Overrides EntityResourceTestBase::getExpectedUnauthorizedEntityAccessCacheability
MediaResourceTestBase::getNormalizedPatchEntity	protected	function	Returns the normalized PATCH entity. Overrides EntityResourceTestBase::getNormalizedPatchEntity
MediaResourceTestBase::getNormalizedPostEntity	protected	function	Returns the normalized POST entity. Overrides EntityResourceTestBase::getNormalizedPostEntity
MediaResourceTestBase::setUp	protected	function	Overrides EntityResourceTestBase::setUp
MediaResourceTestBase::setUpAuthorization	protected	function	Sets up the necessary authorization. Overrides ResourceTestBase::setUpAuthorization
MediaResourceTestBase::testPost	public	function	Tests a POST request for an entity, plus edge cases to ensure good DX. Overrides EntityResourceTestBase::testPost
MediaResourceTestBase::uploadFile	protected	function	This duplicates some of the 'file_upload' REST resource plugin test coverage, to be able to test it on a concrete use case.
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.
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
ResourceTestBase::$account	protected	property	The account to use for authentication, if any.
ResourceTestBase::$auth	protected static	property	The authentication mechanism to use in this test.	100
ResourceTestBase::$format	protected static	property	The format to use in this test.	151
ResourceTestBase::$mimeType	protected static	property	The MIME type that corresponds to $format.	151
ResourceTestBase::$resourceConfigId	protected static	property	The REST Resource Config entity ID under test (i.e. a resource type).	1
ResourceTestBase::$resourceConfigStorage	protected	property	The REST resource config entity storage.
ResourceTestBase::$serializer	protected	property	The serializer service.
ResourceTestBase::assertAuthenticationEdgeCases	abstract protected	function	Asserts authentication provider-specific edge cases.
ResourceTestBase::assertResourceErrorResponse	protected	function	Asserts that a resource error response has the given message.
ResourceTestBase::assertResourceResponse	protected	function	Asserts that a resource response has the given status code and body.
ResourceTestBase::assertResponseWhenMissingAuthentication	abstract protected	function	Verifies the error response in case of missing authentication.
ResourceTestBase::decorateWithXdebugCookie	protected	function	Adds the Xdebug cookie to the request options.
ResourceTestBase::getAuthenticationRequestOptions	protected	function	Returns Guzzle request options for authentication.
ResourceTestBase::grantPermissionsToAnonymousRole	protected	function	Grants permissions to the anonymous role.
ResourceTestBase::grantPermissionsToAuthenticatedRole	protected	function	Grants permissions to the authenticated role.
ResourceTestBase::grantPermissionsToTestedRole	protected	function	Grants permissions to the tested role: anonymous or authenticated.
ResourceTestBase::initAuthentication	protected	function	Initializes authentication.
ResourceTestBase::provisionResource	protected	function	Provisions the REST resource under test.
ResourceTestBase::recursiveKSort	protected static	function	Recursively sorts an array by key.
ResourceTestBase::refreshTestStateAfterRestConfigChange	protected	function	Refreshes the state of the tester to be in sync with the testee.
ResourceTestBase::request	protected	function	Performs a HTTP request. Wraps the Guzzle HTTP client.	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.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.
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 under test.
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.
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::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.

You are here

abstract class MediaResourceTestBase in Drupal 10

Hierarchy

File

Namespace

Members

API Navigation