class FileUploadTest in Drupal 8

Same name and namespace in other branches

9 core/modules/jsonapi/tests/src/Functional/FileUploadTest.php \Drupal\Tests\jsonapi\Functional\FileUploadTest
10 core/modules/jsonapi/tests/src/Functional/FileUploadTest.php \Drupal\Tests\jsonapi\Functional\FileUploadTest

Tests binary data file upload route.

@group jsonapi

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\jsonapi\Functional\ResourceTestBase uses ContentModerationTestTrait, JsonApiRequestTestTrait, ResourceResponseTestTrait
  - class \Drupal\Tests\jsonapi\Functional\FileUploadTest

Expanded class hierarchy of FileUploadTest

File

core/modules/jsonapi/tests/src/Functional/FileUploadTest.php, line 23

Namespace

Drupal\Tests\jsonapi\Functional

View source

class FileUploadTest extends ResourceTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'entity_test',
    'file',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   *
   * @see $entity
   */
  protected static $entityTypeId = 'entity_test';

  /**
   * {@inheritdoc}
   *
   * @see $entity
   */
  protected static $resourceTypeName = 'entity_test--entity_test';

  /**
   * The POST URI.
   *
   * @var string
   */
  protected static $postUri = '/jsonapi/entity_test/entity_test/field_rest_file_test';

  /**
   * Test file data.
   *
   * @var string
   */
  protected $testFileData = 'Hares sit on chairs, and mules sit on stools.';

  /**
   * The test field storage config.
   *
   * @var \Drupal\field\Entity\FieldStorageConfig
   */
  protected $fieldStorage;

  /**
   * The field config.
   *
   * @var \Drupal\field\Entity\FieldConfig
   */
  protected $field;

  /**
   * The parent entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $entity;

  /**
   * Created file entity.
   *
   * @var \Drupal\file\Entity\File
   */
  protected $file;

  /**
   * An authenticated user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $user;

  /**
   * The entity storage for the 'file' entity type.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $fileStorage;

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

    // Add a file field.
    $this->fieldStorage = FieldStorageConfig::create([
      'entity_type' => 'entity_test',
      'field_name' => 'field_rest_file_test',
      'type' => 'file',
      'settings' => [
        'uri_scheme' => 'public',
      ],
    ])
      ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this->fieldStorage
      ->save();
    $this->field = FieldConfig::create([
      'entity_type' => 'entity_test',
      'field_name' => 'field_rest_file_test',
      'bundle' => 'entity_test',
      'settings' => [
        'file_directory' => 'foobar',
        'file_extensions' => 'txt',
        'max_filesize' => '',
      ],
    ])
      ->setLabel('Test file field')
      ->setTranslatable(FALSE);
    $this->field
      ->save();

    // Reload entity so that it has the new field.
    $this->entity = $this->entityStorage
      ->loadUnchanged($this->entity
      ->id());
    $this
      ->rebuildAll();
  }

  /**
   * {@inheritdoc}
   *
   * @requires module irrelevant_for_this_test
   */
  public function testGetIndividual() {
  }

  /**
   * {@inheritdoc}
   *
   * @requires module irrelevant_for_this_test
   */
  public function testPostIndividual() {
  }

  /**
   * {@inheritdoc}
   *
   * @requires module irrelevant_for_this_test
   */
  public function testPatchIndividual() {
  }

  /**
   * {@inheritdoc}
   *
   * @requires module irrelevant_for_this_test
   */
  public function testDeleteIndividual() {
  }

  /**
   * {@inheritdoc}
   *
   * @requires module irrelevant_for_this_test
   */
  public function testCollection() {
  }

  /**
   * {@inheritdoc}
   *
   * @requires module irrelevant_for_this_test
   */
  public function testRelationships() {
  }

  /**
   * {@inheritdoc}
   */
  protected function createEntity() {

    // Create an entity that a file can be attached to.
    $entity_test = EntityTest::create([
      'name' => 'Llama',
      'type' => 'entity_test',
    ]);
    $entity_test
      ->setOwnerId($this->account
      ->id());
    $entity_test
      ->save();
    return $entity_test;
  }

  /**
   * Tests using the file upload POST route; needs second request to "use" file.
   */
  public function testPostFileUpload() {
    $uri = Url::fromUri('base:' . static::$postUri);

    // DX: 405 when read-only mode is enabled.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(405, sprintf("JSON:API is configured to accept only read operations. Site administrators can configure this at %s.", Url::fromUri('base:/admin/config/services/jsonapi')
      ->setAbsolute()
      ->toString(TRUE)
      ->getGeneratedUrl()), $uri, $response);
    $this
      ->assertSame([
      'GET',
    ], $response
      ->getHeader('Allow'));
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // DX: 403 when unauthorized.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(403, $this
      ->getExpectedUnauthorizedAccessMessage('POST'), $uri, $response);
    $this
      ->setUpAuthorization('POST');

    // 404 when the field name is invalid.
    $invalid_uri = Url::fromUri('base:' . static::$postUri . '_invalid');
    $response = $this
      ->fileRequest($invalid_uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(404, 'Field "field_rest_file_test_invalid" does not exist.', $invalid_uri, $response);

    // This request will have the default 'application/octet-stream' content
    // type header.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedDocument();
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data.
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/example.txt'));

    // Test the file again but using 'filename' in the Content-Disposition
    // header with no 'file' prefix.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'filename="example.txt"',
    ]);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedDocument(2, 'example_0.txt');
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data.
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/example_0.txt'));
    $this
      ->assertTrue($this->fileStorage
      ->loadUnchanged(1)
      ->isTemporary());

    // Verify that we can create an entity that references the uploaded file.
    $entity_test_post_url = Url::fromRoute('jsonapi.entity_test--entity_test.collection.post');
    $request_options = [];
    $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
    $request_options = NestedArray::mergeDeep($request_options, $this
      ->getAuthenticationRequestOptions());
    $request_options[RequestOptions::BODY] = Json::encode($this
      ->getPostDocument());
    $response = $this
      ->request('POST', $entity_test_post_url, $request_options);
    $this
      ->assertResourceResponse(201, FALSE, $response);
    $this
      ->assertTrue($this->fileStorage
      ->loadUnchanged(1)
      ->isPermanent());
    $this
      ->assertSame([
      [
        'target_id' => '1',
        'display' => NULL,
        'description' => "The most fascinating file ever!",
      ],
    ], EntityTest::load(2)
      ->get('field_rest_file_test')
      ->getValue());
  }

  /**
   * Tests using the 'file upload and "use" file in single request" POST route.
   */
  public function testPostFileUploadAndUseInSingleRequest() {

    // Update the test entity so it already has a file. This allows verifying
    // that this route appends files, and does not replace them.
    mkdir('public://foobar');
    file_put_contents('public://foobar/existing.txt', $this->testFileData);
    $existing_file = File::create([
      'uri' => 'public://foobar/existing.txt',
    ]);
    $existing_file
      ->setOwnerId($this->account
      ->id());
    $existing_file
      ->setPermanent();
    $existing_file
      ->save();
    $this->entity
      ->set('field_rest_file_test', [
      'target_id' => $existing_file
        ->id(),
    ])
      ->save();
    $uri = Url::fromUri('base:' . '/jsonapi/entity_test/entity_test/' . $this->entity
      ->uuid() . '/field_rest_file_test');

    // DX: 405 when read-only mode is enabled.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(405, sprintf("JSON:API is configured to accept only read operations. Site administrators can configure this at %s.", Url::fromUri('base:/admin/config/services/jsonapi')
      ->setAbsolute()
      ->toString(TRUE)
      ->getGeneratedUrl()), $uri, $response);
    $this
      ->assertSame([
      'GET',
    ], $response
      ->getHeader('Allow'));
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // DX: 403 when unauthorized.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(403, $this
      ->getExpectedUnauthorizedAccessMessage('PATCH'), $uri, $response);
    $this
      ->setUpAuthorization('PATCH');

    // 404 when the field name is invalid.
    $invalid_uri = Url::fromUri($uri
      ->getUri() . '_invalid');
    $response = $this
      ->fileRequest($invalid_uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(404, 'Field "field_rest_file_test_invalid" does not exist.', $invalid_uri, $response);

    // This request fails despite the upload succeeding, because we're not
    // allowed to view the entity we're uploading to.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(403, $this
      ->getExpectedUnauthorizedAccessMessage('GET'), $uri, $response, FALSE, [
      '4xx-response',
      'http_response',
    ], [
      'url.site',
      'user.permissions',
    ]);
    $this
      ->setUpAuthorization('GET');

    // Reuploading the same file will result in the file being uploaded twice
    // and referenced twice.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $expected = [
      'jsonapi' => [
        'meta' => [
          'links' => [
            'self' => [
              'href' => 'http://jsonapi.org/format/1.0/',
            ],
          ],
        ],
        'version' => '1.0',
      ],
      'links' => [
        'self' => [
          'href' => Url::fromUri('base:/jsonapi/entity_test/entity_test/' . $this->entity
            ->uuid() . '/field_rest_file_test')
            ->setAbsolute(TRUE)
            ->toString(),
        ],
      ],
      'data' => [
        0 => $this
          ->getExpectedDocument(1, 'existing.txt', TRUE, TRUE)['data'],
        1 => $this
          ->getExpectedDocument(2, 'example.txt', TRUE, TRUE)['data'],
        2 => $this
          ->getExpectedDocument(3, 'example_0.txt', FALSE, TRUE)['data'],
      ],
    ];
    $this
      ->assertResponseData($expected, $response);

    // The response document received for the POST request is identical to the
    // response document received by GETting the same URL.
    $request_options = [];
    $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
    $request_options = NestedArray::mergeDeep($request_options, $this
      ->getAuthenticationRequestOptions());
    $response = $this
      ->request('GET', $uri, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data.
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/example.txt'));
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/example_0.txt'));
  }

  /**
   * Returns the JSON:API POST document referencing the uploaded file.
   *
   * @return array
   *   A JSON:API request document.
   *
   * @see ::testPostFileUpload()
   * @see \Drupal\Tests\jsonapi\Functional\EntityTestTest::getPostDocument()
   */
  protected function getPostDocument() {
    return [
      'data' => [
        'type' => 'entity_test--entity_test',
        'attributes' => [
          'name' => 'Dramallama',
        ],
        'relationships' => [
          'field_rest_file_test' => [
            'data' => [
              'id' => File::load(1)
                ->uuid(),
              'meta' => [
                'description' => 'The most fascinating file ever!',
              ],
              'type' => 'file--file',
            ],
          ],
        ],
      ],
    ];
  }

  /**
   * Tests using the file upload POST route with invalid headers.
   */
  public function testPostFileUploadInvalidHeaders() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);

    // The wrong content type header should return a 415 code.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Type' => 'application/vnd.api+json',
    ]);
    $this
      ->assertSame(415, $response
      ->getStatusCode());

    // An empty Content-Disposition header should return a 400.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => FALSE,
    ]);
    $this
      ->assertResourceErrorResponse(400, '"Content-Disposition" header is required. A file name in the format "filename=FILENAME" must be provided.', $uri, $response);

    // An empty filename with a context in the Content-Disposition header should
    // return a 400.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'file; filename=""',
    ]);
    $this
      ->assertResourceErrorResponse(400, 'No filename found in "Content-Disposition" header. A file name in the format "filename=FILENAME" must be provided.', $uri, $response);

    // An empty filename without a context in the Content-Disposition header
    // should return a 400.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'filename=""',
    ]);
    $this
      ->assertResourceErrorResponse(400, 'No filename found in "Content-Disposition" header. A file name in the format "filename=FILENAME" must be provided.', $uri, $response);

    // An invalid key-value pair in the Content-Disposition header should return
    // a 400.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'not_a_filename="example.txt"',
    ]);
    $this
      ->assertResourceErrorResponse(400, 'No filename found in "Content-Disposition" header. A file name in the format "filename=FILENAME" must be provided.', $uri, $response);

    // Using filename* extended format is not currently supported.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'filename*="UTF-8 \' \' example.txt"',
    ]);
    $this
      ->assertResourceErrorResponse(400, 'The extended "filename*" format is currently not supported in the "Content-Disposition" header.', $uri, $response);
  }

  /**
   * Tests using the file upload POST route with a duplicate file name.
   *
   * A new file should be created with a suffixed name.
   */
  public function testPostFileUploadDuplicateFile() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);

    // This request will have the default 'application/octet-stream' content
    // type header.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertSame(201, $response
      ->getStatusCode());

    // Make the same request again. The file should be saved as a new file
    // entity that has the same file name but a suffixed file URI.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertSame(201, $response
      ->getStatusCode());

    // Loading expected normalized data for file 2, the duplicate file.
    $expected = $this
      ->getExpectedDocument(2, 'example_0.txt');
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data.
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/example_0.txt'));
  }

  /**
   * Tests using the file upload POST route twice, simulating a race condition.
   *
   * A validation error should occur when the filenames are not unique.
   */
  public function testPostFileUploadDuplicateFileRaceCondition() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);

    // This request will have the default 'application/octet-stream' content
    // type header.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertSame(201, $response
      ->getStatusCode());

    // Simulate a race condition where two files are uploaded at almost the same
    // time, by removing the first uploaded file from disk (leaving the entry in
    // the file_managed table) before trying to upload another file with the
    // same name.
    unlink(\Drupal::service('file_system')
      ->realpath('public://foobar/example.txt'));

    // Make the same request again. The upload should fail validation.
    $response = $this
      ->fileRequest($uri, $this->testFileData);
    $this
      ->assertResourceErrorResponse(422, PlainTextOutput::renderFromHtml("Unprocessable Entity: file validation failed.\nThe file public://foobar/example.txt already exists. Enter a unique file URI."), $uri, $response);
  }

  /**
   * Tests using the file upload route with any path prefixes being stripped.
   *
   * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#Directives
   */
  public function testFileUploadStrippedFilePath() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'file; filename="directory/example.txt"',
    ]);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedDocument();
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data. It should have been written to the configured
    // directory, not /foobar/directory/example.txt.
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/example.txt'));
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'file; filename="../../example_2.txt"',
    ]);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedDocument(2, 'example_2.txt', TRUE);
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data. It should have been written to the configured
    // directory, not /foobar/directory/example.txt.
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/example_2.txt'));
    $this
      ->assertFileNotExists('../../example_2.txt');

    // Check a path from the root. Extensions have to be empty to allow a file
    // with no extension to pass validation.
    $this->field
      ->setSetting('file_extensions', '')
      ->save();
    $this
      ->rebuildAll();
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'file; filename="/etc/passwd"',
    ]);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedDocument(3, 'passwd', TRUE);

    // This mime will be guessed as there is no extension.
    $expected['data']['attributes']['filemime'] = 'application/octet-stream';
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data. It should have been written to the configured
    // directory, not /foobar/directory/example.txt.
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/passwd'));
  }

  /**
   * Tests using the file upload route with a unicode file name.
   */
  public function testFileUploadUnicodeFilename() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);

    // It is important that the filename starts with a unicode character. See
    // https://bugs.php.net/bug.php?id=77239.
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'file; filename="Èxample-✓.txt"',
    ]);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedDocument(1, 'Èxample-✓.txt', TRUE);
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertSame($this->testFileData, file_get_contents('public://foobar/Èxample-✓.txt'));
  }

  /**
   * Tests using the file upload route with a zero byte file.
   */
  public function testFileUploadZeroByteFile() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);

    // Test with a zero byte file.
    $response = $this
      ->fileRequest($uri, NULL);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $expected = $this
      ->getExpectedDocument();

    // Modify the default expected data to account for the 0 byte file.
    $expected['data']['attributes']['filesize'] = 0;
    $this
      ->assertResponseData($expected, $response);

    // Check the actual file data.
    $this
      ->assertSame('', file_get_contents('public://foobar/example.txt'));
  }

  /**
   * Tests using the file upload route with an invalid file type.
   */
  public function testFileUploadInvalidFileType() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);

    // Test with a JSON file.
    $response = $this
      ->fileRequest($uri, '{"test":123}', [
      'Content-Disposition' => 'filename="example.json"',
    ]);
    $this
      ->assertResourceErrorResponse(422, PlainTextOutput::renderFromHtml("Unprocessable Entity: file validation failed.\nOnly files with the following extensions are allowed: <em class=\"placeholder\">txt</em>."), $uri, $response);

    // Make sure that no file was saved.
    $this
      ->assertEmpty(File::load(1));
    $this
      ->assertFileNotExists('public://foobar/example.txt');
  }

  /**
   * Tests using the file upload route with a file size larger than allowed.
   */
  public function testFileUploadLargerFileSize() {

    // Set a limit of 50 bytes.
    $this->field
      ->setSetting('max_filesize', 50)
      ->save();
    $this
      ->rebuildAll();
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);

    // Generate a string larger than the 50 byte limit set.
    $response = $this
      ->fileRequest($uri, $this
      ->randomString(100));
    $this
      ->assertResourceErrorResponse(422, PlainTextOutput::renderFromHtml("Unprocessable Entity: file validation failed.\nThe file is <em class=\"placeholder\">100 bytes</em> exceeding the maximum file size of <em class=\"placeholder\">50 bytes</em>."), $uri, $response);

    // Make sure that no file was saved.
    $this
      ->assertEmpty(File::load(1));
    $this
      ->assertFileNotExists('public://foobar/example.txt');
  }

  /**
   * Tests using the file upload POST route with malicious extensions.
   */
  public function testFileUploadMaliciousExtension() {

    // Allow all file uploads but system.file::allow_insecure_uploads is set to
    // FALSE.
    $this->field
      ->setSetting('file_extensions', '')
      ->save();
    $this
      ->rebuildAll();
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);
    $php_string = '<?php print "Drupal"; ?>';

    // Test using a masked exploit file.
    $response = $this
      ->fileRequest($uri, $php_string, [
      'Content-Disposition' => 'filename="example.php"',
    ]);

    // The filename is not munged because .txt is added and it is a known
    // extension to apache.
    $expected = $this
      ->getExpectedDocument(1, 'example.php_.txt', TRUE);

    // Override the expected filesize.
    $expected['data']['attributes']['filesize'] = strlen($php_string);
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example.php_.txt');

    // Add php as an allowed format. Allow insecure uploads still being FALSE
    // should still not allow this. So it should still have a .txt extension
    // appended even though it is not in the list of allowed extensions.
    $this->field
      ->setSetting('file_extensions', 'php')
      ->save();
    $this
      ->rebuildAll();
    $response = $this
      ->fileRequest($uri, $php_string, [
      'Content-Disposition' => 'filename="example_2.php"',
    ]);
    $expected = $this
      ->getExpectedDocument(2, 'example_2.php_.txt', TRUE);

    // Override the expected filesize.
    $expected['data']['attributes']['filesize'] = strlen($php_string);
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example_2.php_.txt');
    $this
      ->assertFileNotExists('public://foobar/example_2.php');

    // Allow .doc file uploads and ensure even a mis-configured apache will not
    // fallback to php because the filename will be munged.
    $this->field
      ->setSetting('file_extensions', 'doc')
      ->save();
    $this
      ->rebuildAll();

    // Test using a masked exploit file.
    $response = $this
      ->fileRequest($uri, $php_string, [
      'Content-Disposition' => 'filename="example_3.php.doc"',
    ]);

    // The filename is munged.
    $expected = $this
      ->getExpectedDocument(3, 'example_3.php_.doc', TRUE);

    // Override the expected filesize.
    $expected['data']['attributes']['filesize'] = strlen($php_string);

    // The file mime should be 'application/msword'.
    $expected['data']['attributes']['filemime'] = 'application/msword';
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example_3.php_.doc');
    $this
      ->assertFileNotExists('public://foobar/example_3.php.doc');

    // Test that a dangerous extension such as .php is munged even if it is in
    // the list of allowed extensions.
    $this->field
      ->setSetting('file_extensions', 'doc php')
      ->save();
    $this
      ->rebuildAll();

    // Test using a masked exploit file.
    $response = $this
      ->fileRequest($uri, $php_string, [
      'Content-Disposition' => 'filename="example_4.php.doc"',
    ]);

    // The filename is munged.
    $expected = $this
      ->getExpectedDocument(4, 'example_4.php_.doc', TRUE);

    // Override the expected filesize.
    $expected['data']['attributes']['filesize'] = strlen($php_string);

    // The file mime should be 'application/msword'.
    $expected['data']['attributes']['filemime'] = 'application/msword';
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example_4.php_.doc');
    $this
      ->assertFileNotExists('public://foobar/example_4.php.doc');

    // Dangerous extensions are munged even when all extensions are allowed.
    $this->field
      ->setSetting('file_extensions', '')
      ->save();
    $this
      ->rebuildAll();
    $response = $this
      ->fileRequest($uri, $php_string, [
      'Content-Disposition' => 'filename="example_5.php.png"',
    ]);
    $expected = $this
      ->getExpectedDocument(5, 'example_5.php_.png_.txt', TRUE);

    // Override the expected filesize.
    $expected['data']['attributes']['filesize'] = strlen($php_string);

    // The file mime should also now be text.
    $expected['data']['attributes']['filemime'] = 'text/plain';
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example_5.php_.png_.txt');

    // Dangerous extensions are munged if is renamed to end in .txt.
    $response = $this
      ->fileRequest($uri, $php_string, [
      'Content-Disposition' => 'filename="example_6.cgi.png.txt"',
    ]);
    $expected = $this
      ->getExpectedDocument(6, 'example_6.cgi_.png_.txt', TRUE);

    // Override the expected filesize.
    $expected['data']['attributes']['filesize'] = strlen($php_string);

    // The file mime should also now be text.
    $expected['data']['attributes']['filemime'] = 'text/plain';
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example_6.cgi_.png_.txt');

    // Now allow insecure uploads.
    \Drupal::configFactory()
      ->getEditable('system.file')
      ->set('allow_insecure_uploads', TRUE)
      ->save();

    // Allow all file uploads. This is very insecure.
    $this->field
      ->setSetting('file_extensions', '')
      ->save();
    $this
      ->rebuildAll();
    $response = $this
      ->fileRequest($uri, $php_string, [
      'Content-Disposition' => 'filename="example_7.php"',
    ]);
    $expected = $this
      ->getExpectedDocument(7, 'example_7.php', TRUE);

    // Override the expected filesize.
    $expected['data']['attributes']['filesize'] = strlen($php_string);

    // The file mime should also now be PHP.
    $expected['data']['attributes']['filemime'] = 'application/x-httpd-php';
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example_7.php');
  }

  /**
   * Tests using the file upload POST route no extension configured.
   */
  public function testFileUploadNoExtensionSetting() {
    $this
      ->setUpAuthorization('POST');
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $uri = Url::fromUri('base:' . static::$postUri);
    $this->field
      ->setSetting('file_extensions', '')
      ->save();
    $this
      ->rebuildAll();
    $response = $this
      ->fileRequest($uri, $this->testFileData, [
      'Content-Disposition' => 'filename="example.txt"',
    ]);
    $expected = $this
      ->getExpectedDocument(1, 'example.txt', TRUE);
    $this
      ->assertResponseData($expected, $response);
    $this
      ->assertFileExists('public://foobar/example.txt');
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedAccessMessage($method) {
    switch ($method) {
      case 'GET':
        return "The current user is not allowed to view this relationship. The 'view test entity' permission is required.";
      case 'POST':
        return "The current user is not permitted to upload a file for this field. The following permissions are required: 'administer entity_test content' OR 'administer entity_test_with_bundle content' OR 'create entity_test entity_test_with_bundle entities'.";
      case 'PATCH':
        return "The current user is not permitted to upload a file for this field. The 'administer entity_test content' permission is required.";
    }
  }

  /**
   * Returns the expected JSON:API document for the expected file entity.
   *
   * @param int $fid
   *   The file ID to load and create a JSON:API document for.
   * @param string $expected_filename
   *   The expected filename for the stored file.
   * @param bool $expected_as_filename
   *   Whether the expected filename should be the filename property too.
   * @param bool $expected_status
   *   The expected file status. Defaults to FALSE.
   *
   * @return array
   *   A JSON:API response document.
   */
  protected function getExpectedDocument($fid = 1, $expected_filename = 'example.txt', $expected_as_filename = FALSE, $expected_status = FALSE) {
    $author = User::load($this->account
      ->id());
    $file = File::load($fid);
    $self_url = Url::fromUri('base:/jsonapi/file/file/' . $file
      ->uuid())
      ->setAbsolute()
      ->toString(TRUE)
      ->getGeneratedUrl();
    return [
      'jsonapi' => [
        'meta' => [
          'links' => [
            'self' => [
              'href' => 'http://jsonapi.org/format/1.0/',
            ],
          ],
        ],
        'version' => '1.0',
      ],
      'links' => [
        'self' => [
          'href' => $self_url,
        ],
      ],
      'data' => [
        'id' => $file
          ->uuid(),
        'type' => 'file--file',
        'links' => [
          'self' => [
            'href' => $self_url,
          ],
        ],
        'attributes' => [
          'created' => (new \DateTime())
            ->setTimestamp($file
            ->getCreatedTime())
            ->setTimezone(new \DateTimeZone('UTC'))
            ->format(\DateTime::RFC3339),
          'changed' => (new \DateTime())
            ->setTimestamp($file
            ->getChangedTime())
            ->setTimezone(new \DateTimeZone('UTC'))
            ->format(\DateTime::RFC3339),
          'filemime' => 'text/plain',
          'filename' => $expected_as_filename ? $expected_filename : 'example.txt',
          'filesize' => strlen($this->testFileData),
          'langcode' => 'en',
          'status' => $expected_status,
          'uri' => [
            'value' => 'public://foobar/' . $expected_filename,
            'url' => base_path() . $this->siteDirectory . '/files/foobar/' . rawurlencode($expected_filename),
          ],
          'drupal_internal__fid' => (int) $file
            ->id(),
        ],
        'relationships' => [
          'uid' => [
            'data' => [
              'id' => $author
                ->uuid(),
              'type' => 'user--user',
            ],
            'links' => [
              'related' => [
                'href' => $self_url . '/uid',
              ],
              'self' => [
                'href' => $self_url . '/relationships/uid',
              ],
            ],
          ],
        ],
      ],
    ];
  }

  /**
   * Performs a file upload request. Wraps the Guzzle HTTP client.
   *
   * @param \Drupal\Core\Url $url
   *   URL to request.
   * @param string $file_contents
   *   The file contents to send as the request body.
   * @param array $headers
   *   Additional headers to send with the request. Defaults will be added for
   *   Content-Type and Content-Disposition. In order to remove the defaults set
   *   the header value to FALSE.
   *
   * @return \Psr\Http\Message\ResponseInterface
   *   The received response.
   *
   * @see \GuzzleHttp\ClientInterface::request()
   */
  protected function fileRequest(Url $url, $file_contents, array $headers = []) {
    $request_options = [];
    $headers = $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="example.txt"',
      // Set the required JSON:API Accept header.
      'Accept' => 'application/vnd.api+json',
    ];
    $request_options[RequestOptions::HEADERS] = array_filter($headers, function ($value) {
      return $value !== FALSE;
    });
    $request_options[RequestOptions::BODY] = $file_contents;
    $request_options = NestedArray::mergeDeep($request_options, $this
      ->getAuthenticationRequestOptions());
    return $this
      ->request('POST', $url, $request_options);
  }

  /**
   * {@inheritdoc}
   */
  protected function setUpAuthorization($method) {
    switch ($method) {
      case 'GET':
        $this
          ->grantPermissionsToTestedRole([
          'view test entity',
        ]);
        break;
      case 'POST':
        $this
          ->grantPermissionsToTestedRole([
          'create entity_test entity_test_with_bundle entities',
          'access content',
        ]);
        break;
      case 'PATCH':
        $this
          ->grantPermissionsToTestedRole([
          'administer entity_test content',
          'access content',
        ]);
        break;
    }
  }

  /**
   * Asserts expected normalized data matches response data.
   *
   * @param array $expected
   *   The expected data.
   * @param \Psr\Http\Message\ResponseInterface $response
   *   The file upload response.
   */
  protected function assertResponseData(array $expected, ResponseInterface $response) {
    static::recursiveKSort($expected);
    $actual = Json::decode((string) $response
      ->getBody());
    static::recursiveKSort($actual);
    $this
      ->assertSame($expected, $actual);
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedAccessCacheability() {

    // There is cacheability metadata to check as file uploads only allows POST
    // requests, which will not return cacheable responses.
  }

}

Members

Name	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.
ContentModerationTestTrait::addEntityTypeAndBundleToWorkflow	protected	function	Adds an entity type ID / bundle ID to the given workflow.	1
ContentModerationTestTrait::createEditorialWorkflow	protected	function	Creates the editorial workflow.	1
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
FileUploadTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FileUploadTest::$entity	protected	property	The parent entity. Overrides ResourceTestBase::$entity
FileUploadTest::$entityTypeId	protected static	property	Overrides ResourceTestBase::$entityTypeId
FileUploadTest::$field	protected	property	The field config.
FileUploadTest::$fieldStorage	protected	property	The test field storage config.
FileUploadTest::$file	protected	property	Created file entity.
FileUploadTest::$fileStorage	protected	property	The entity storage for the 'file' entity type.
FileUploadTest::$modules	public static	property	Modules to enable. Overrides ResourceTestBase::$modules
FileUploadTest::$postUri	protected static	property	The POST URI.
FileUploadTest::$resourceTypeName	protected static	property	Overrides ResourceTestBase::$resourceTypeName
FileUploadTest::$testFileData	protected	property	Test file data.
FileUploadTest::$user	protected	property	An authenticated user.
FileUploadTest::assertResponseData	protected	function	Asserts expected normalized data matches response data.
FileUploadTest::createEntity	protected	function	Creates the entity to be tested. Overrides ResourceTestBase::createEntity
FileUploadTest::fileRequest	protected	function	Performs a file upload request. Wraps the Guzzle HTTP client.
FileUploadTest::getExpectedDocument	protected	function	Returns the expected JSON:API document for the expected file entity. Overrides ResourceTestBase::getExpectedDocument
FileUploadTest::getExpectedUnauthorizedAccessCacheability	protected	function	Returns the expected cacheability for an unauthorized response. Overrides ResourceTestBase::getExpectedUnauthorizedAccessCacheability
FileUploadTest::getExpectedUnauthorizedAccessMessage	protected	function	Return the expected error message. Overrides ResourceTestBase::getExpectedUnauthorizedAccessMessage
FileUploadTest::getPostDocument	protected	function	Returns the JSON:API POST document referencing the uploaded file. Overrides ResourceTestBase::getPostDocument
FileUploadTest::setUp	public	function	Overrides ResourceTestBase::setUp
FileUploadTest::setUpAuthorization	protected	function	Sets up the necessary authorization. Overrides ResourceTestBase::setUpAuthorization
FileUploadTest::testCollection	public	function	@requires module irrelevant_for_this_test Overrides ResourceTestBase::testCollection
FileUploadTest::testDeleteIndividual	public	function	@requires module irrelevant_for_this_test Overrides ResourceTestBase::testDeleteIndividual
FileUploadTest::testFileUploadInvalidFileType	public	function	Tests using the file upload route with an invalid file type.
FileUploadTest::testFileUploadLargerFileSize	public	function	Tests using the file upload route with a file size larger than allowed.
FileUploadTest::testFileUploadMaliciousExtension	public	function	Tests using the file upload POST route with malicious extensions.
FileUploadTest::testFileUploadNoExtensionSetting	public	function	Tests using the file upload POST route no extension configured.
FileUploadTest::testFileUploadStrippedFilePath	public	function	Tests using the file upload route with any path prefixes being stripped.
FileUploadTest::testFileUploadUnicodeFilename	public	function	Tests using the file upload route with a unicode file name.
FileUploadTest::testFileUploadZeroByteFile	public	function	Tests using the file upload route with a zero byte file.
FileUploadTest::testGetIndividual	public	function	@requires module irrelevant_for_this_test Overrides ResourceTestBase::testGetIndividual
FileUploadTest::testPatchIndividual	public	function	@requires module irrelevant_for_this_test Overrides ResourceTestBase::testPatchIndividual
FileUploadTest::testPostFileUpload	public	function	Tests using the file upload POST route; needs second request to "use" file.
FileUploadTest::testPostFileUploadAndUseInSingleRequest	public	function	Tests using the 'file upload and "use" file in single request" POST route.
FileUploadTest::testPostFileUploadDuplicateFile	public	function	Tests using the file upload POST route with a duplicate file name.
FileUploadTest::testPostFileUploadDuplicateFileRaceCondition	public	function	Tests using the file upload POST route twice, simulating a race condition.
FileUploadTest::testPostFileUploadInvalidHeaders	public	function	Tests using the file upload POST route with invalid headers.
FileUploadTest::testPostIndividual	public	function	@requires module irrelevant_for_this_test Overrides ResourceTestBase::testPostIndividual
FileUploadTest::testRelationships	public	function	@requires module irrelevant_for_this_test Overrides ResourceTestBase::testRelationships
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.
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
ResourceResponseTestTrait::addOmittedObject	protected static	function	Add the omitted object to the document or merges it if one already exists.
ResourceResponseTestTrait::collectionHasResourceIdentifier	protected static	function	Determines if a given resource exists in a list of resources.
ResourceResponseTestTrait::errorsToOmittedObject	protected static	function	Maps error objects into an omitted object.
ResourceResponseTestTrait::extractLinks	protected static	function	Extracts links from a document using a list of relationship field names.
ResourceResponseTestTrait::getAccessDeniedResponse	protected static	function	Gets a generic forbidden response.
ResourceResponseTestTrait::getEmptyCollectionResponse	protected	function	Gets a generic empty collection response.
ResourceResponseTestTrait::getExpectedIncludedResourceResponse	protected	function	Gets an array of expected ResourceResponses for the given include paths.
ResourceResponseTestTrait::getLinkPaths	protected static	function	Turns a list of relationship field names into an array of link paths.
ResourceResponseTestTrait::getRelatedLink	protected static	function	Creates a related resource link for a given resource identifier and field.
ResourceResponseTestTrait::getRelatedResponses	protected	function	Gets an array of related responses for the given field names.
ResourceResponseTestTrait::getRelationshipLink	protected static	function	Creates a relationship link for a given resource identifier and field.
ResourceResponseTestTrait::getRelationshipResponses	protected	function	Gets an array of relationship responses for the given field names.
ResourceResponseTestTrait::getResourceLink	protected static	function	Creates an individual resource link for a given resource identifier.
ResourceResponseTestTrait::getResourceLinks	protected static	function	Creates individual resource links for a list of resource identifiers.
ResourceResponseTestTrait::getResponses	protected	function	Gets responses from an array of links.
ResourceResponseTestTrait::isResourceIdentifier	protected static	function	Checks if a given array is a resource identifier.
ResourceResponseTestTrait::mergeOmittedObjects	protected static	function	Merges the links of two omitted objects and returns a new omitted object.
ResourceResponseTestTrait::resetOmittedLinkKeys	protected static	function	Resets omitted link keys.
ResourceResponseTestTrait::sortOmittedLinks	protected static	function	Sorts an omitted link object array by href.
ResourceResponseTestTrait::sortResourceCollection	protected static	function	Sorts a collection of resources or resource identifiers.
ResourceResponseTestTrait::toCollectionResourceResponse	protected static	function	Merges individual responses into a collection response.
ResourceResponseTestTrait::toResourceIdentifier	protected static	function	Maps an entity to a resource identifier.
ResourceResponseTestTrait::toResourceResponse	protected static	function	Maps a response object to a JSON:API ResourceResponse.
ResourceResponseTestTrait::toResourceResponses	protected static	function	Maps an array of PSR responses to JSON:API ResourceResponses.
ResourceTestBase::$account	protected	property	The account to use for authentication.
ResourceTestBase::$anonymousUsersCanViewLabels	protected static	property	Whether anonymous users can view labels of this resource type.	3
ResourceTestBase::$anotherEntity	protected	property	Another entity of the same type used for testing.
ResourceTestBase::$entityStorage	protected	property	The entity storage.
ResourceTestBase::$firstCreatedEntityId	protected static	property	The entity ID for the first created entity in testPost().	1
ResourceTestBase::$jsonApiMember	protected static	property	The standard `jsonapi` top-level document member.
ResourceTestBase::$labelFieldName	protected static	property	Specify which field is the 'label' field for testing a POST edge case.	2
ResourceTestBase::$newRevisionsShouldBeAutomatic	protected static	property	Whether new revisions of updated entities should be created by default.	1
ResourceTestBase::$patchProtectedFieldNames	protected static	property	The fields that are protected against modification during PATCH requests.	14
ResourceTestBase::$resourceType	protected	property	The JSON:API resource type for the tested entity type plus bundle.
ResourceTestBase::$resourceTypeIsVersionable	protected static	property	Whether the tested JSON:API resource is versionable.	2
ResourceTestBase::$secondCreatedEntityId	protected static	property	The entity ID for the second created entity in testPost().	1
ResourceTestBase::$serializer	protected	property	The serializer service.
ResourceTestBase::$uniqueFieldNames	protected static	property	Fields that need unique values.	1
ResourceTestBase::$uuidKey	protected	property	The UUID key.
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::assertSameDocument	protected	function	Asserts that an expected document matches the response body.
ResourceTestBase::createAnotherEntity	protected	function	Creates another entity to be tested.	10
ResourceTestBase::decorateExpectedResponseForIncludedFields	protected static	function	Decorates the expected response with included data and cache metadata.
ResourceTestBase::doTestIncluded	protected	function	Tests included resources.
ResourceTestBase::doTestRelated	protected	function	Performs one round of related route testing.
ResourceTestBase::doTestRelationshipGet	protected	function	Performs one round of relationship route testing.
ResourceTestBase::doTestRelationshipMutation	protected	function	Performs one round of relationship POST, PATCH and DELETE route testing.	1
ResourceTestBase::doTestSparseFieldSets	protected	function	Tests sparse field sets.
ResourceTestBase::entityAccess	protected static	function	Checks access for the given operation on the given entity.	3
ResourceTestBase::entityFieldAccess	protected static	function	Checks access for the given field operation on the given entity.
ResourceTestBase::entityLoadUnchanged	protected	function	Loads an entity in the test container, ignoring the static cache.
ResourceTestBase::getAuthenticationRequestOptions	protected	function	Returns Guzzle request options for authentication.
ResourceTestBase::getData	protected	function	Sets up a collection of entities of the same type for testing.
ResourceTestBase::getEditorialPermissions	protected	function	Gets an array of permissions required to view and update any tested entity.	1
ResourceTestBase::getEntityDuplicate	protected	function
ResourceTestBase::getExpectedCacheContexts	protected	function	The expected cache contexts for the GET/HEAD response of the test entity.	7
ResourceTestBase::getExpectedCacheTags	protected	function	The expected cache tags for the GET/HEAD response of the test entity.	4
ResourceTestBase::getExpectedCollectionCacheability	protected static	function	Computes the cacheability for a given entity collection.	5
ResourceTestBase::getExpectedCollectionResponse	protected	function	Returns a JSON:API collection document for the expected entities.
ResourceTestBase::getExpectedGetIndividualResourceResponse	protected	function	Gets the expected individual ResourceResponse for GET.
ResourceTestBase::getExpectedGetRelationshipDocument	protected	function	Gets an expected document for the given relationship.
ResourceTestBase::getExpectedGetRelationshipDocumentData	protected	function	Gets the expected document data for the given relationship.	2
ResourceTestBase::getExpectedGetRelationshipResponse	protected	function	Gets an expected ResourceResponse for the given relationship.
ResourceTestBase::getExpectedRelatedResponse	protected	function	Builds an expected related ResourceResponse for the given field.
ResourceTestBase::getExpectedRelatedResponses	protected	function	Builds an array of expected related ResourceResponses, keyed by field name.
ResourceTestBase::getIncludePermissions	protected static	function	Authorize the user under test with additional permissions to view includes.	2
ResourceTestBase::getModifiedEntityForPatchTesting	protected static	function	Clones the given entity and modifies all PATCH-protected fields.
ResourceTestBase::getModifiedEntityForPostTesting	protected	function	Gets the normalized POST entity with random values for its unique fields.	1
ResourceTestBase::getNestedIncludePaths	protected	function	Gets an array of all nested include paths to be tested.
ResourceTestBase::getPatchDocument	protected	function	Returns the JSON:API PATCH document.
ResourceTestBase::getRelationshipFieldNames	protected	function	Gets a list of public relationship names for the resource type under test.
ResourceTestBase::getSparseFieldSets	protected	function	Returns an array of sparse fields sets to test.	2
ResourceTestBase::grantIncludedPermissions	protected	function	Grants authorization to view includes.
ResourceTestBase::grantPermissionsToTestedRole	protected	function	Grants permissions to the authenticated role.
ResourceTestBase::isReferenceFieldDefinition	protected static	function	Determines if a given field definition is a reference field.
ResourceTestBase::makeNormalizationInvalid	protected	function	Makes the given JSON:API document invalid.	1
ResourceTestBase::normalize	protected	function	Generates a JSON:API normalization for the given entity.
ResourceTestBase::recursiveKsort	protected static	function	Recursively sorts an array by key.
ResourceTestBase::removeResourceTypeFromDocument	protected	function	Makes the JSON:API document violate the spec by omitting the resource type.
ResourceTestBase::revokePermissionsFromTestedRole	protected	function	Revokes permissions from the authenticated role.
ResourceTestBase::setUpFields	protected	function	Sets up additional fields for testing.
ResourceTestBase::setUpRevisionAuthorization	protected	function	Sets up the necessary authorization for handling revisions.	2
ResourceTestBase::testRelated	public	function	Tests GETing related resource of an individual resource.	6
ResourceTestBase::testRevisions	public	function	Tests individual and collection revisions.	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.	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.

You are here

class FileUploadTest in Drupal 8

Hierarchy

File

Namespace

Members

API Navigation