public function FileUploadTest::testPostFileUpload in JSON:API 8.2

Tests using the file upload POST route; needs second request to "use" file.

File

tests/src/Functional/FileUploadTest.php, line 204

Class

FileUploadTest

Tests binary data file upload route.

Namespace

Drupal\Tests\jsonapi\Functional

Code

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());
}