islandora/tests/src/Kernel/FedoraAdapterTest.php

<?php

namespace Drupal\Tests\islandora\Kernel;

use GuzzleHttp\Psr7;
use GuzzleHttp\Psr7\Response;
use Drupal\islandora\Flysystem\Adapter\FedoraAdapter;
use Islandora\Chullo\IFedoraApi;
use League\Flysystem\Config;
use Prophecy\Argument;
use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface;

/**
 * Tests the Fedora adapter for Flysystem.
 *
 * @group islandora
 * @coversDefaultClass \Drupal\islandora\Flysystem\Adapter\FedoraAdapter
 */
class FedoraAdapterTest extends IslandoraKernelTestBase {

  /**
   * Mocks up an adapter for Fedora calls that return 404.
   */
  protected function createAdapterForFail() {
    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(404);
    $response = $prophecy->reveal();

    $prophecy = $this->prophesize(IFedoraApi::class);
    $prophecy->getResourceHeaders('')->willReturn($response);
    $prophecy->getResource('')->willReturn($response);
    $api = $prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Mocks up an adapter for Fedora LDP-NR response.
   */
  protected function createAdapterForFile() {
    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(200);
    $prophecy->getHeader('Last-Modified')->willReturn(["Wed, 25 Jul 2018 17:42:04 GMT"]);
    $prophecy->getHeader('Link')->willReturn(['<http://www.w3.org/ns/ldp#Resource>;rel="type"', '<http://www.w3.org/ns/ldp#NonRDFSource>;rel="type"']);
    $prophecy->getHeader('Content-Type')->willReturn(['text/plain']);
    $prophecy->getHeader('Content-Length')->willReturn([strlen("DERP")]);
    $prophecy->getBody()->willReturn(PSR7\stream_for("DERP"));
    $response = $prophecy->reveal();

    $prophecy = $this->prophesize(IFedoraApi::class);
    $prophecy->getResourceHeaders('')->willReturn($response);
    $prophecy->getResource('')->willReturn($response);
    $api = $prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Mocks up an adapter for Fedora LDP-RS response.
   */
  protected function createAdapterForDirectory() {
    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(200);
    $prophecy->getHeader('Last-Modified')->willReturn(["Wed, 25 Jul 2018 17:42:04 GMT"]);
    $prophecy->getHeader('Link')->willReturn(['<http://www.w3.org/ns/ldp#Resource>;rel="type"', '<http://www.w3.org/ns/ldp#RDFSource>;rel="type"']);
    $response = $prophecy->reveal();

    $prophecy = $this->prophesize(IFedoraApi::class);
    $prophecy->getResourceHeaders('')->willReturn($response);
    $api = $prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Mocks up an adapter for Fedora write requests.
   */
  protected function createAdapterForWrite() {
    $fedora_prophecy = $this->prophesize(IFedoraApi::class);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(201);

    $fedora_prophecy->saveResource('', '', Argument::any())->willReturn($prophecy->reveal());

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(200);
    $prophecy->getHeader('Last-Modified')->willReturn(["Wed, 25 Jul 2018 17:42:04 GMT"]);
    $prophecy->getHeader('Link')->willReturn(['<http://www.w3.org/ns/ldp#Resource>;rel="type"', '<http://www.w3.org/ns/ldp#NonRDFSource>;rel="type"']);
    $prophecy->getHeader('Content-Type')->willReturn(['text/plain']);
    $prophecy->getHeader('Content-Length')->willReturn([strlen("DERP")]);
    $prophecy->getBody()->willReturn(PSR7\stream_for("DERP"));

    $fedora_prophecy->getResourceHeaders('')->willReturn($prophecy->reveal());

    $api = $fedora_prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Mocks up an adapter for Fedora write requests that fail.
   */
  protected function createAdapterForWriteFail() {
    $fedora_prophecy = $this->prophesize(IFedoraApi::class);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(500);

    $fedora_prophecy->saveResource('', '', Argument::any())->willReturn($prophecy->reveal());

    $api = $fedora_prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Mocks up an adapter for creating directories requests.
   */
  protected function createAdapterForCreateDir() {
    $fedora_prophecy = $this->prophesize(IFedoraApi::class);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(201);

    $fedora_prophecy->saveResource('')->willReturn($prophecy->reveal());

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(200);
    $prophecy->getHeader('Last-Modified')->willReturn(["Wed, 25 Jul 2018 17:42:04 GMT"]);
    $prophecy->getHeader('Link')->willReturn(['<http://www.w3.org/ns/ldp#Resource>;rel="type"', '<http://www.w3.org/ns/ldp#RDFSource>;rel="type"']);

    $fedora_prophecy->getResourceHeaders('')->willReturn($prophecy->reveal());

    $api = $fedora_prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Mocks up an adapter for Delete requests.
   */
  protected function createAdapterForDelete() {
    $fedora_prophecy = $this->prophesize(IFedoraApi::class);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(204);

    $fedora_prophecy->deleteResource('')->willReturn($prophecy->reveal());
    $fedora_prophecy->getResourceHeaders('')->willReturn($prophecy->reveal());
    $api = $fedora_prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Mocks up an adapter for Delete requests that fail.
   */
  protected function createAdapterForDeleteFail() {
    $fedora_prophecy = $this->prophesize(IFedoraApi::class);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(500);

    $fedora_prophecy->deleteResource('')->willReturn($prophecy->reveal());

    $api = $fedora_prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    return new FedoraAdapter($api, $mime_guesser);
  }

  /**
   * Asserts the stucture/contents of a metadata response for a file.
   */
  protected function assertFileMetadata(array $metadata) {
    $this->assertTrue($metadata['type'] == 'file', "Expecting 'type' of 'file', received '" . $metadata['type'] . "'");
    $this->assertTrue($metadata['timestamp'] == '1532540524', "Expecting 'timestamp' of '1532540524', received '" . $metadata['timestamp'] . "'");
    $this->assertTrue($metadata['size'] == strlen("DERP"), "Expecting 'size' of '" . strlen("DERP") . "', received '" . $metadata['size'] . "'");
    $this->assertTrue($metadata['mimetype'] == 'text/plain', "Expecting 'mimetype' of 'image/png', received '" . $metadata['mimetype'] . "'");
  }

  /**
   * Asserts the stucture/contents of a metadata response for a directory.
   */
  protected function assertDirMetadata(array $metadata) {
    $this->assertTrue($metadata['type'] == 'dir', "Expecting 'type' of 'dir', received '" . $metadata['type'] . "'");
    $this->assertTrue($metadata['timestamp'] == '1532540524', "Expecting 'timestamp' of '1532540524', received '" . $metadata['timestamp'] . "'");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getMetadata
   */
  public function testGetMetadataFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->getMetadata('') == FALSE, "getMetadata() must return FALSE on non-200");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getMetadata
   */
  public function testGetMetadataForFile() {
    $adapter = $this->createAdapterForFile();

    $metadata = $adapter->getMetadata('');
    $this->assertFileMetadata($metadata);
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getMetadata
   */
  public function testGetMetadataForDirectory() {
    $adapter = $this->createAdapterForDirectory();

    $metadata = $adapter->getMetadata('');
    $this->assertDirMetadata($metadata);
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::readStream
   */
  public function testReadStream() {
    $adapter = $this->createAdapterForFile();

    $metadata = $adapter->readStream('');
    $this->assertFileMetadata($metadata);
    $this->assertTrue(is_resource($metadata['stream']), "Expecting a 'stream' that is a resource");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::readStream
   */
  public function testReadStreamFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->readStream('') == FALSE, "readStream() should return FALSE on non-200 from Fedora");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::read
   */
  public function testRead() {
    $adapter = $this->createAdapterForFile();

    $metadata = $adapter->read('');
    $this->assertFileMetadata($metadata);
    $this->assertTrue($metadata['contents'] == "DERP", "Expecting 'content' of 'DERP', received '${metadata['contents']}'");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::read
   */
  public function testReadFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->read('') == FALSE, "readStream() should return FALSE on non-200 from Fedora");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::has
   */
  public function testHasFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->has('') == FALSE, "has() must return FALSE on non-200");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::has
   */
  public function testHasSuccess() {
    $adapter = $this->createAdapterForFile();

    $this->assertTrue($adapter->has('') == TRUE, "has() must return TRUE on 200");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getSize
   */
  public function testGetSizeFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->getSize('') == FALSE, "getSize() must return FALSE on non-200");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getSize
   */
  public function testGetSizeSuccess() {
    $adapter = $this->createAdapterForFile();

    $metadata = $adapter->getSize('');
    $this->assertTrue($metadata['size'] == strlen("DERP"), "Expecting 'size' of '" . strlen("DERP") . "', received '" . $metadata['size'] . "'");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getMimetype
   */
  public function testGetMimetypeFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->getMimetype('') == FALSE, "getMimetype() must return FALSE on non-200");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getMimetype
   */
  public function testGetMimetypeSuccess() {
    $adapter = $this->createAdapterForFile();

    $metadata = $adapter->getMimetype('');
    $this->assertTrue($metadata['mimetype'] == 'text/plain', "Expecting 'mimetype' of 'text/plain', received '" . $metadata['mimetype'] . "'");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getTimestamp
   */
  public function testGetTimestampFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->getTimestamp('') == FALSE, "getTimestamp() must return FALSE on non-200");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::getTimestamp
   */
  public function testGetTimestampSuccess() {
    $adapter = $this->createAdapterForFile();

    $metadata = $adapter->getTimestamp('');
    $this->assertTrue($metadata['timestamp'] == '1532540524', "Expecting 'timestamp' of '1532540524', received '" . $metadata['timestamp'] . "'");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::write
   */
  public function testWriteFail() {
    $adapter = $this->createAdapterForWriteFail();

    $this->assertTrue($adapter->write('', '', $this->prophesize(Config::class)->reveal()) == FALSE, "write() must return FALSE on non-201 or non-204");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::write
   */
  public function testWrite() {
    $adapter = $this->createAdapterForWrite();

    $metadata = $adapter->write('', '', $this->prophesize(Config::class)->reveal());
    $this->assertFileMetadata($metadata);
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::writeStream
   */
  public function testWriteStreamFail() {
    $adapter = $this->createAdapterForWriteFail();

    $this->assertTrue($adapter->writeStream('', '', $this->prophesize(Config::class)->reveal()) == FALSE, "writeStream() must return FALSE on non-201 or non-204");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::writeStream
   */
  public function testWriteStream() {
    $adapter = $this->createAdapterForWrite();

    $metadata = $adapter->writeStream('', '', $this->prophesize(Config::class)->reveal());
    $this->assertFileMetadata($metadata);
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::update
   */
  public function testUpdateFail() {
    $adapter = $this->createAdapterForWriteFail();

    $this->assertTrue($adapter->update('', '', $this->prophesize(Config::class)->reveal()) == FALSE, "write() must return FALSE on non-201 or non-204");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::update
   */
  public function testUpdate() {
    $adapter = $this->createAdapterForWrite();

    $metadata = $adapter->update('', '', $this->prophesize(Config::class)->reveal());
    $this->assertFileMetadata($metadata);
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::updateStream
   */
  public function testUpdateStreamFail() {
    $adapter = $this->createAdapterForWriteFail();

    $this->assertTrue($adapter->updateStream('', '', $this->prophesize(Config::class)->reveal()) == FALSE, "writeStream() must return FALSE on non-201 or non-204");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::updateStream
   */
  public function testUpdateStream() {
    $adapter = $this->createAdapterForWrite();

    $metadata = $adapter->updateStream('', '', $this->prophesize(Config::class)->reveal());
    $this->assertFileMetadata($metadata);
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::delete
   */
  public function testDeleteFail() {
    $adapter = $this->createAdapterForDeleteFail();

    $this->assertTrue($adapter->delete('') == FALSE, "delete() must return FALSE on non-204 or non-404");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::delete
   */
  public function testDelete() {
    $adapter = $this->createAdapterForDelete();

    $this->assertTrue($adapter->delete('') == TRUE, "delete() must return TRUE on 204 or 404");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::deleteDir
   */
  public function testDeleteDirFail() {
    $adapter = $this->createAdapterForDeleteFail();

    $this->assertTrue($adapter->deleteDir('') == FALSE, "deleteDir() must return FALSE on non-204 or non-404");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::deleteDir
   */
  public function testDeleteDir() {
    $adapter = $this->createAdapterForDelete();

    $this->assertTrue($adapter->deleteDir('') == TRUE, "deleteDir() must return TRUE on 204 or 404");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::rename
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::copy
   */
  public function testRenameFail() {
    $adapter = $this->createAdapterForFail();

    $this->assertTrue($adapter->rename('', '') == FALSE, "rename() must return FALSE on Fedora error");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::rename
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::copy
   */
  public function testRename() {
    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(200);
    $prophecy->getHeader('Last-Modified')->willReturn(["Wed, 25 Jul 2018 17:42:04 GMT"]);
    $prophecy->getHeader('Link')->willReturn(['<http://www.w3.org/ns/ldp#Resource>;rel="type"', '<http://www.w3.org/ns/ldp#NonRDFSource>;rel="type"']);
    $prophecy->getHeader('Content-Type')->willReturn(['text/plain']);
    $prophecy->getHeader('Content-Length')->willReturn([strlen("DERP")]);
    $prophecy->getBody()->willReturn(PSR7\stream_for("DERP"));
    $response = $prophecy->reveal();

    $fedora_prophecy = $this->prophesize(IFedoraApi::class);
    $fedora_prophecy->getResource(Argument::any())->willReturn($response);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(201);
    $response = $prophecy->reveal();

    $fedora_prophecy->saveResource(Argument::any(), Argument::any(), Argument::any())->willReturn($response);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(200);
    $prophecy->getHeader('Last-Modified')->willReturn(["Wed, 25 Jul 2018 17:42:04 GMT"]);
    $prophecy->getHeader('Link')->willReturn(['<http://www.w3.org/ns/ldp#Resource>;rel="type"', '<http://www.w3.org/ns/ldp#NonRDFSource>;rel="type"']);
    $prophecy->getHeader('Content-Type')->willReturn(['text/plain']);
    $prophecy->getHeader('Content-Length')->willReturn([strlen("DERP")]);
    $response = $prophecy->reveal();

    $fedora_prophecy->getResourceHeaders(Argument::any())->willReturn($response);

    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(204);
    $response = $prophecy->reveal();

    $fedora_prophecy->deleteResource(Argument::any())->willReturn($response);

    $api = $fedora_prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    $adapter = new FedoraAdapter($api, $mime_guesser);

    $this->assertTrue($adapter->rename('', '') == TRUE, "rename() must return TRUE on success");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::createDir
   */
  public function testCreateDirFail() {
    $prophecy = $this->prophesize(Response::class);
    $prophecy->getStatusCode()->willReturn(500);

    $fedora_prophecy = $this->prophesize(IFedoraApi::class);
    $fedora_prophecy->saveResource('')->willReturn($prophecy->reveal());

    $api = $fedora_prophecy->reveal();

    $mime_guesser = $this->prophesize(MimeTypeGuesserInterface::class)->reveal();

    $adapter = new FedoraAdapter($api, $mime_guesser);

    $this->assertTrue($adapter->createDir('', $this->prophesize(Config::class)->reveal()) == FALSE, "createDir() must return FALSE on fail");
  }

  /**
   * @covers \Drupal\islandora\Flysystem\Adapter\FedoraAdapter::createDir
   */
  public function testCreateDir() {
    $adapter = $this->createAdapterForCreateDir();

    $metadata = $adapter->createDir('', $this->prophesize(Config::class)->reveal());
    $this->assertDirMetadata($metadata);
  }

}