entity_to_text-1.0.x-dev/modules/entity_to_text_tika/tests/src/Kernel/LocalFileStorageTest.php

<?php

namespace Drupal\Tests\entity_to_text_tika\Kernel;

use Drupal\Core\File\FileSystemInterface;
use Drupal\entity_to_text_tika\Storage\LocalFileStorage;
use Drupal\file\Entity\File;
use Drupal\KernelTests\Core\File\FileTestBase;
use Drupal\Core\File\FileExists;

/**
 * Tests the Plaintext File Storage.
 *
 * @coversDefaultClass \Drupal\entity_to_text_tika\Storage\LocalFileStorage
 *
 * @group entity_to_text
 * @group entity_to_text_tika
 *
 * @internal
 */
final class LocalFileStorageTest extends FileTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = ['system', 'file', 'entity_to_text_tika', 'user'];

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The plain-text storage processor.
   *
   * @var \Drupal\entity_to_text_tika\Storage\LocalFileStorage
   */
  protected LocalFileStorage $localFileStorage;

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();

    $this->installEntitySchema('file');
    $this->installEntitySchema('user');
    $this->installSchema('file', ['file_usage']);

    $this->fileSystem = $this->container->get('file_system');
    $this->localFileStorage = $this->container->get('entity_to_text_tika.storage.local_file');

    $destination = LocalFileStorage::DESTINATION;
    $this->fileSystem->prepareDirectory($destination, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
  }

  /**
   * @covers ::load
   */
  public function testloadPublic(): void {
    // Create an OCR file for testing.
    $file_uri = $this->createUri('390-foo.txt.en.ocr.txt', 'Ipsum excepteur id cupidatat commodo', 'private');
    $this->fileSystem->move($file_uri, 'private://entity-to-text/ocr/390-foo.txt.en.ocr.txt', FileExists::Replace);

    // Create a file that correspond to the previous OCR file.
    $file = File::create([
      'uri' => 'public://foo.txt',
      'name' => 'foo',
    ]);
    $file->set('fid', 390);

    self::assertEquals('Ipsum excepteur id cupidatat commodo', $this->localFileStorage->load($file, 'en'));
  }

  /**
   * @covers ::load
   */
  public function testloadPrivate(): void {
    // Create an OCR file for testing.
    $file_uri = $this->createUri('390-foo.txt.en.ocr.txt', 'Ipsum excepteur id cupidatat commodo', 'private');
    $this->fileSystem->move($file_uri, 'private://entity-to-text/ocr/390-foo.txt.en.ocr.txt', FileExists::Replace);

    // Create a file that correspond to the previous OCR file.
    $file = File::create([
      'uri' => 'private://foo.txt',
      'name' => 'foo',
    ]);
    $file->set('fid', 390);

    self::assertEquals('Ipsum excepteur id cupidatat commodo', $this->localFileStorage->load($file, 'en'));
  }

  /**
   * @covers ::load
   */
  public function testloadSubDirectory(): void {
    // Create an OCR file for testing.
    $file_uri = $this->createUri('420-foo.txt.en.ocr.txt', 'Ipsum excepteur id cupidatat commodo', 'private');
    $this->fileSystem->move($file_uri, 'private://entity-to-text/ocr/420-foo.txt.en.ocr.txt', FileExists::Replace);

    // Create a file that correspond to the previous OCR file.
    $file = File::create([
      'uri' => 'public://documents/2024/foo.txt',
      'name' => 'foo',
    ]);
    $file->set('fid', 420);

    self::assertEquals('Ipsum excepteur id cupidatat commodo', $this->localFileStorage->load($file, 'en'));
  }

  /**
   * @covers ::load
   */
  public function testloadWhenOcrFileNotExists(): void {
    // Create a file that has not been already processed and
    // therefore does not havean OCR associated file.
    $file = File::create([
      'uri' => 'public://foo.txt',
      'name' => 'foo',
    ]);
    $file->set('fid', 380);

    // When the OCR file does not exists, then nothing can be retreived.
    self::assertNull($this->localFileStorage->load($file, 'en'));
  }

  /**
   * @covers ::save
   */
  public function testSave(): void {
    // Create a file for testing.
    $file = File::create([
      'uri' => $this->createUri('foo.txt', 'veniam consequat duis'),
      'name' => 'foo',
    ]);
    $file->set('fid', 399);

    $file_path = $this->localFileStorage->save($file, 'veniam consequat duis', 'en');
    self::assertStringEndsWith('private/entity-to-text/ocr/399-foo.txt.en.ocr.txt', $file_path);
    self::assertFileExists($file_path);
    self::assertEquals('veniam consequat duis', file_get_contents($file_path));
  }

  /**
   * @covers ::save
   */
  public function testSaveWhenOcrFileAlreadyExists(): void {
    // Create an OCR file for testing.
    $file_ocr_uri = $this->createUri('400-foo.txt.en.ocr.txt', 'Ipsum excepteur id cupidatat commodo', 'private');
    $this->fileSystem->move($file_ocr_uri, 'private://entity-to-text/ocr/400-foo.txt.en.ocr.txt', FileExists::Replace);

    // Create a file for testing.
    $file = File::create([
      'uri' => $this->createUri('foo.txt', 'veniam consequat duis'),
      'name' => 'foo',
    ]);
    $file->set('fid', 400);

    // When the file already exists, it will be overriden.
    $file_path = $this->localFileStorage->save($file, 'veniam consequat duis', 'en');
    self::assertStringEndsWith('private/entity-to-text/ocr/400-foo.txt.en.ocr.txt', $file_path);
    self::assertFileExists($file_path);
    self::assertEquals('veniam consequat duis', file_get_contents($file_path));
  }

}