class MediaLibraryStateTest

class MediaLibraryStateTest extends KernelTestBase {
  use MediaTypeCreationTrait;
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'media',
    'media_library',
    'file',
    'field',
    'image',
    'system',
    'views',
    'user',
  ];
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->installEntitySchema('user');
    $this->installEntitySchema('file');
    $this->installSchema('file', 'file_usage');
    $this->installEntitySchema('media');
    $this->installConfig([
      'field',
      'system',
      'file',
      'image',
      'media',
      'media_library',
    ]);
    // Create some media types to validate against.
    $this->createMediaType('file', [
      'id' => 'document',
    ]);
    $this->createMediaType('image', [
      'id' => 'image',
    ]);
    $this->createMediaType('video_file', [
      'id' => 'video',
    ]);
  }
  
  /**
   * Tests the media library state methods.
   */
  public function testMethods() : void {
    $opener_id = 'test';
    $allowed_media_type_ids = [
      'document',
      'image',
    ];
    $selected_media_type_id = 'image';
    $remaining_slots = 2;
    $state = MediaLibraryState::create($opener_id, $allowed_media_type_ids, $selected_media_type_id, $remaining_slots);
    $this->assertSame($opener_id, $state->getOpenerId());
    $this->assertSame($allowed_media_type_ids, $state->getAllowedTypeIds());
    $this->assertSame($selected_media_type_id, $state->getSelectedTypeId());
    $this->assertSame($remaining_slots, $state->getAvailableSlots());
    $this->assertTrue($state->hasSlotsAvailable());
    $state = MediaLibraryState::create($opener_id, $allowed_media_type_ids, $selected_media_type_id, 0);
    $this->assertFalse($state->hasSlotsAvailable());
  }
  
  /**
   * Tests the media library state creation.
   *
   * @param string $opener_id
   *   The opener ID.
   * @param string[] $allowed_media_type_ids
   *   The allowed media type IDs.
   * @param string $selected_type_id
   *   The selected media type ID.
   * @param int $remaining_slots
   *   The number of remaining items the user is allowed to select or add in the
   *   library.
   * @param string $exception_message
   *   The expected exception message.
   */
  public function testCreate($opener_id, array $allowed_media_type_ids, $selected_type_id, $remaining_slots, $exception_message = '') : void {
    if ($exception_message) {
      $this->expectException(\InvalidArgumentException::class);
      $this->expectExceptionMessage($exception_message);
    }
    $state = MediaLibraryState::create($opener_id, $allowed_media_type_ids, $selected_type_id, $remaining_slots);
    $this->assertInstanceOf(MediaLibraryState::class, $state);
    // Ensure that the state object carries cache metadata.
    $this->assertInstanceOf(CacheableDependencyInterface::class, $state);
    $this->assertSame([
      'url.query_args',
    ], $state->getCacheContexts());
    $this->assertSame(Cache::PERMANENT, $state->getCacheMaxAge());
  }
  
  /**
   * Data provider for testCreate().
   *
   * @return array
   *   The data sets to test.
   */
  public static function providerCreate() : array {
    $test_data = [];
    // Assert no exception is thrown when we add the parameters as expected.
    $test_data['valid parameters'] = [
      'test',
      [
        'document',
        'image',
      ],
      'image',
      2,
    ];
    // Assert an exception is thrown when the opener ID parameter is empty.
    $test_data['empty opener ID'] = [
      '',
      [
        'document',
        'image',
      ],
      'image',
      2,
      'The opener ID parameter is required and must be a string.',
    ];
    // Assert an exception is thrown when the opener ID parameter is not a
    // valid string.
    $test_data['integer opener ID'] = [
      1,
      [
        'document',
        'image',
      ],
      'image',
      2,
      'The opener ID parameter is required and must be a string.',
    ];
    $test_data['boolean opener ID'] = [
      TRUE,
      [
        'document',
        'image',
      ],
      'image',
      2,
      'The opener ID parameter is required and must be a string.',
    ];
    $test_data['spaces opener ID'] = [
      '   ',
      [
        'document',
        'image',
      ],
      'image',
      2,
      'The opener ID parameter is required and must be a string.',
    ];
    // Assert an exception is thrown when the allowed types parameter is empty.
    $test_data['empty allowed types'] = [
      'test',
      [],
      'image',
      2,
      'The allowed types parameter is required and must be an array of strings.',
    ];
    // It is not possible to assert a non-array allowed types parameter, since
    // that would throw a TypeError which is not a subclass of Exception.
    // Continue asserting an exception is thrown when the allowed types
    // parameter contains elements that are not a valid string.
    $test_data['integer in allowed types'] = [
      'test',
      [
        1,
        'image',
      ],
      'image',
      2,
      'The allowed types parameter is required and must be an array of strings.',
    ];
    $test_data['boolean in allowed types'] = [
      'test',
      [
        TRUE,
        'image',
      ],
      'image',
      2,
      'The allowed types parameter is required and must be an array of strings.',
    ];
    $test_data['spaces in allowed types'] = [
      'test',
      [
        '   ',
        'image',
      ],
      'image',
      2,
      'The allowed types parameter is required and must be an array of strings.',
    ];
    // Assert an exception is thrown when the selected type parameter is empty.
    $test_data['empty selected type'] = [
      'test',
      [
        'document',
        'image',
      ],
      '',
      2,
      'The selected type parameter is required and must be a string.',
    ];
    // Assert an exception is thrown when the selected type parameter is not a
    // valid string.
    $test_data['numeric selected type'] = [
      'test',
      [
        'document',
        'image',
      ],
      1,
      2,
      'The selected type parameter is required and must be a string.',
    ];
    $test_data['boolean selected type'] = [
      'test',
      [
        'document',
        'image',
      ],
      TRUE,
      2,
      'The selected type parameter is required and must be a string.',
    ];
    $test_data['spaces selected type'] = [
      'test',
      [
        'document',
        'image',
      ],
      '   ',
      2,
      'The selected type parameter is required and must be a string.',
    ];
    // Assert an exception is thrown when the selected type parameter is not in
    // the list of allowed types.
    $test_data['non-present selected type'] = [
      'test',
      [
        'document',
        'image',
      ],
      'video',
      2,
      'The selected type parameter must be present in the list of allowed types.',
    ];
    // Assert an exception is thrown when the remaining slots parameter is
    // empty.
    $test_data['empty remaining slots'] = [
      'test',
      [
        'document',
        'image',
      ],
      'image',
      '',
      'The remaining slots parameter is required and must be numeric.',
    ];
    // Assert an exception is thrown when the remaining slots parameter is
    // not numeric.
    $test_data['string remaining slots'] = [
      'test',
      [
        'document',
        'image',
      ],
      'image',
      'fail',
      'The remaining slots parameter is required and must be numeric.',
    ];
    $test_data['boolean remaining slots'] = [
      'test',
      [
        'document',
        'image',
      ],
      'image',
      TRUE,
      'The remaining slots parameter is required and must be numeric.',
    ];
    return $test_data;
  }
  
  /**
   * Tests the hash validation when the state is created from a request.
   *
   * @param array $query_overrides
   *   The query parameters to override.
   * @param bool $exception_expected
   *   Whether an AccessDeniedHttpException is expected or not.
   */
  public function testFromRequest(array $query_overrides, $exception_expected) : void {
    // Override the query parameters and verify an exception is thrown when
    // required state parameters are changed.
    $query = MediaLibraryState::create('test', [
      'file',
      'image',
    ], 'image', 2)->all();
    $query = array_merge($query, $query_overrides);
    if ($exception_expected) {
      $this->expectException(BadRequestHttpException::class);
      $this->expectExceptionMessage("Invalid media library parameters specified.");
    }
    $state = MediaLibraryState::fromRequest(new Request($query));
    $this->assertInstanceOf(MediaLibraryState::class, $state);
  }
  
  /**
   * Tests from request query less.
   */
  public function testFromRequestQueryLess() : void {
    $this->expectException(\InvalidArgumentException::class);
    $this->expectExceptionMessage('The opener ID parameter is required and must be a string.');
    $state = MediaLibraryState::fromRequest(new Request());
    $this->assertInstanceOf(MediaLibraryState::class, $state);
  }
  
  /**
   * Data provider for testFromRequest().
   *
   * @return array
   *   The data sets to test.
   */
  public static function providerFromRequest() : array {
    $test_data = [];
    // Assert no exception is thrown when we use valid state parameters.
    $test_data['valid parameters'] = [
      [],
      FALSE,
    ];
    // Assert no exception is thrown when we override all query parameters with
    // the same data.
    $test_data['changed with same values'] = [
      [
        'media_library_opener_id' => 'test',
        'media_library_allowed_types' => [
          'file',
          'image',
        ],
        'media_library_selected_type' => 'image',
        'media_library_remaining' => 2,
      ],
      FALSE,
    ];
    // Assert an exception is thrown when we change the opener ID parameter.
    $test_data['changed opener ID'] = [
      [
        'media_library_opener_id' => 'fail',
      ],
      TRUE,
    ];
    // Assert an exception is thrown when we change the allowed types parameter.
    $test_data['changed allowed types'] = [
      [
        'media_library_allowed_types' => [
          'audio',
          'image',
        ],
      ],
      TRUE,
    ];
    // Assert an exception is thrown when we change the selected type parameter.
    $test_data['changed selected type'] = [
      [
        'media_library_selected_type' => 'file',
      ],
      TRUE,
    ];
    // Assert an exception is thrown when we change the remaining slots
    // parameter.
    $test_data['changed remaining'] = [
      [
        'media_library_remaining' => 4,
      ],
      TRUE,
    ];
    // Assert an exception is thrown when we change the actual hash.
    $test_data['changed hash'] = [
      [
        'hash' => 'fail',
      ],
      TRUE,
    ];
    return $test_data;
  }
  
  /**
   * Tests opener parameters.
   *
   * @legacy-covers ::getOpenerParameters
   */
  public function testOpenerParameters() : void {
    $state = MediaLibraryState::create('test', [
      'file',
    ], 'file', -1, [
      'foo' => 'baz',
    ]);
    $this->assertSame([
      'foo' => 'baz',
    ], $state->getOpenerParameters());
  }
  
  /**
   * Tests that hash is unaffected by allowed media type order.
   */
  public function testHashUnaffectedByMediaTypeOrder() : void {
    $state1 = MediaLibraryState::create('test', [
      'file',
      'image',
    ], 'image', 2);
    $state2 = MediaLibraryState::create('test', [
      'image',
      'file',
    ], 'image', 2);
    $this->assertSame($state1->getHash(), $state2->getHash());
  }
  
  /**
   * Tests that hash is unaffected by opener parameter order.
   */
  public function testHashUnaffectedByOpenerParamOrder() : void {
    $state1 = MediaLibraryState::create('test', [
      'file',
    ], 'file', -1, [
      'foo' => 'baz',
      'baz' => 'foo',
    ]);
    $state2 = MediaLibraryState::create('test', [
      'file',
    ], 'file', -1, [
      'baz' => 'foo',
      'foo' => 'baz',
    ]);
    $this->assertSame($state1->getHash(), $state2->getHash());
  }

}