FileValidatorTest.php in Mini site 8

Namespace

Drupal\Tests\minisite\Unit

File

tests/src/Unit/FileValidatorTest.php

<?php

namespace Drupal\Tests\minisite\Unit;

use Drupal\minisite\Exception\InvalidExtensionValidatorException;
use Drupal\minisite\FileValidator;
use Drupal\Tests\minisite\Traits\MockHelperTrait;
use Drupal\Tests\UnitTestCase;

/**
 * Class FileValidatorTest.
 *
 * Tests file validator.
 *
 * @group minisite
 *
 * @package Drupal\testmode\Tests
 */
class FileValidatorTest extends UnitTestCase {
  use MockHelperTrait;

  /**
   * Test validateFileExtension() method.
   *
   * @dataProvider dataProviderValidateFileExtension
   * @covers \Drupal\minisite\FileValidator::validateFileExtension
   */
  public function testValidateFileExtension($filename, $extensions) {
    $this
      ->expectException(InvalidExtensionValidatorException::class);
    $this
      ->expectExceptionMessage(sprintf('File %s has invalid extension.', $filename));
    FileValidator::validateFileExtension($filename, $extensions);
  }

  /**
   * Data provider for testValidateFileExtension().
   */
  public function dataProviderValidateFileExtension() {
    return [
      [
        'file.txt',
        [
          'ext',
        ],
      ],
      [
        'file.txt',
        [
          'ext',
          'ext2',
        ],
      ],
      [
        'file',
        [
          'ext',
          'ext2',
        ],
      ],
      [
        'file.ext.txt',
        [
          'ext',
          'ext2',
        ],
      ],
    ];
  }

  /**
   * Test normaliseExtensions() method.
   *
   * @dataProvider dataProviderNormaliseExtensions
   * @covers \Drupal\minisite\FileValidator::normaliseExtensions
   */
  public function testNormaliseExtensions($extensions, $expected) {
    $actual = FileValidator::normaliseExtensions($extensions);
    $this
      ->assertEquals($expected, $actual);
  }

  /**
   * Data provider for testNormaliseExtensions().
   */
  public function dataProviderNormaliseExtensions() {
    return [
      [
        [],
        [],
      ],
      [
        '',
        [],
      ],
      [
        ' ',
        [],
      ],
      [
        ', ',
        [],
      ],
      [
        ' , ',
        [],
      ],
      [
        '  , ',
        [],
      ],
      [
        '  ,',
        [],
      ],
      [
        'a b c',
        [
          'a',
          'b',
          'c',
        ],
      ],
      [
        'a,b,c',
        [
          'a',
          'b',
          'c',
        ],
      ],
      [
        'a, b, c',
        [
          'a',
          'b',
          'c',
        ],
      ],
      [
        'a, b , c',
        [
          'a',
          'b',
          'c',
        ],
      ],
      [
        'a, b c',
        [
          'a',
          'b',
          'c',
        ],
      ],
      [
        '   a,    b   c',
        [
          'a',
          'b',
          'c',
        ],
      ],
    ];
  }

  /**
   * Test filesToTree() method.
   *
   * @dataProvider dataProviderFilesToTree
   * @covers \Drupal\minisite\FileValidator::filesToTree
   */
  public function testFilesToTree($files, $expected, $expectException = FALSE) {
    if ($expectException) {
      $this
        ->expectException(\RuntimeException::class);
      $this
        ->expectExceptionMessage('Invalid file list provided');
    }
    $actual = FileValidator::filesToTree($files);
    $this
      ->assertEquals($expected, $actual);
  }

  /**
   * Data provider for testFilesToTree().
   */
  public function dataProviderFilesToTree() {
    return [
      // Root files.
      [
        [
          'file.txt',
        ],
        [
          'file.txt' => 'file.txt',
        ],
      ],
      [
        [
          'file1.txt',
          'file2.txt',
        ],
        [
          'file1.txt' => 'file1.txt',
          'file2.txt' => 'file2.txt',
        ],
      ],
      // Simple dirs.
      [
        [
          'dir1/',
        ],
        [
          'dir1' => [
            '.' => 'dir1/',
          ],
        ],
      ],
      [
        [
          'dir1/',
          'dir2/',
        ],
        [
          'dir1' => [
            '.' => 'dir1/',
          ],
          'dir2' => [
            '.' => 'dir2/',
          ],
        ],
      ],
      // Dirs with files.
      [
        [
          'dir1/file1.txt',
          'dir2/file2.txt',
        ],
        [
          'dir1' => [
            '.' => 'dir1/',
            'file1.txt' => 'dir1/file1.txt',
          ],
          'dir2' => [
            '.' => 'dir2/',
            'file2.txt' => 'dir2/file2.txt',
          ],
        ],
      ],
      [
        [
          'dir1/dir11/dir111/',
        ],
        [
          'dir1' => [
            '.' => 'dir1/',
            'dir11' => [
              '.' => 'dir1/dir11/',
              'dir111' => [
                '.' => 'dir1/dir11/dir111/',
              ],
            ],
          ],
        ],
      ],
      [
        [
          'dir1/file11.txt',
          'dir2/file21.txt',
          'dir2/file22.txt',
          'dir3/',
          'dir4/dir41/',
        ],
        [
          'dir1' => [
            '.' => 'dir1/',
            'file11.txt' => 'dir1/file11.txt',
          ],
          'dir2' => [
            '.' => 'dir2/',
            'file21.txt' => 'dir2/file21.txt',
            'file22.txt' => 'dir2/file22.txt',
          ],
          'dir3' => [
            '.' => 'dir3/',
          ],
          'dir4' => [
            '.' => 'dir4/',
            'dir41' => [
              '.' => 'dir4/dir41/',
            ],
          ],
        ],
      ],
      // Mixed dirs, files, order.
      [
        [
          'dir1/',
          'dir1/dir11/dir111/',
          'dir1/dir11/',
          'dir1/dir11/dir111/file111.txt',
          'dir1/dir11/dir111/file112.txt',
          'file1.txt',
          'file2.txt',
          'dir2/file21.txt',
          'dir2/dir21/file211.txt',
          'dir2/file22.txt',
          'dir2/dir21/file212.txt',
          'dir2/file23.txt',
        ],
        [
          'file1.txt' => 'file1.txt',
          'file2.txt' => 'file2.txt',
          'dir1' => [
            '.' => 'dir1/',
            'dir11' => [
              '.' => 'dir1/dir11/',
              'dir111' => [
                '.' => 'dir1/dir11/dir111/',
                'file111.txt' => 'dir1/dir11/dir111/file111.txt',
                'file112.txt' => 'dir1/dir11/dir111/file112.txt',
              ],
            ],
          ],
          'dir2' => [
            '.' => 'dir2/',
            'dir21' => [
              '.' => 'dir2/dir21/',
              'file211.txt' => 'dir2/dir21/file211.txt',
              'file212.txt' => 'dir2/dir21/file212.txt',
            ],
            'file21.txt' => 'dir2/file21.txt',
            'file22.txt' => 'dir2/file22.txt',
            'file23.txt' => 'dir2/file23.txt',
          ],
        ],
      ],
      // Edge case - dirs provided as files and then as dirs.
      [
        [
          'dir1',
          'dir1/file1.txt',
        ],
        [],
        TRUE,
      ],
      [
        [
          'dir1/file1.txt',
          'dir1',
        ],
        [],
        TRUE,
      ],
      [
        [
          'dir1/dir11/dir111/file111.txt',
          'dir1/dir11/dir111',
        ],
        [],
        TRUE,
      ],
      // Repeating files.
      [
        [
          'file1.txt',
          'file1.txt',
        ],
        [
          'file1.txt' => 'file1.txt',
        ],
      ],
      [
        [
          'dir1/file1.txt',
          'dir1/file1.txt',
        ],
        [
          'dir1' => [
            '.' => 'dir1/',
            'file1.txt' => 'dir1/file1.txt',
          ],
        ],
      ],
    ];
  }

}

Classes

Name	Description
FileValidatorTest	Class FileValidatorTest.