LinkExternalProtocolsConstraintValidatorTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\link\Unit\Plugin\Validation\Constraint;

use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Url;
use Drupal\link\Plugin\Validation\Constraint\LinkExternalProtocolsConstraint;
use Drupal\link\Plugin\Validation\Constraint\LinkExternalProtocolsConstraintValidator;
use Drupal\Tests\UnitTestCase;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

/**
 * @coversDefaultClass \Drupal\link\Plugin\Validation\Constraint\LinkExternalProtocolsConstraintValidator
 * @group Link
 */
class LinkExternalProtocolsConstraintValidatorTest extends UnitTestCase {
  
  /**
   * @covers ::validate
   * @dataProvider providerValidate
   * @runInSeparateProcess
   */
  public function testValidate($url, $valid) : void {
    $link = $this->createMock('Drupal\\link\\LinkItemInterface');
    $link->expects($this->any())
      ->method('getUrl')
      ->willReturn(Url::fromUri($url));
    $context = $this->createMock(ExecutionContextInterface::class);
    if ($valid) {
      $context->expects($this->never())
        ->method('addViolation');
    }
    else {
      $context->expects($this->once())
        ->method('addViolation');
    }
    // Setup some more allowed protocols.
    UrlHelper::setAllowedProtocols([
      'http',
      'https',
      'magnet',
    ]);
    $constraint = new LinkExternalProtocolsConstraint();
    $validator = new LinkExternalProtocolsConstraintValidator();
    $validator->initialize($context);
    $validator->validate($link, $constraint);
  }
  
  /**
   * Data provider for ::testValidate.
   */
  public static function providerValidate() {
    $data = [];
    // Test allowed protocols.
    $data[] = [
      'http://www.example.com',
      TRUE,
    ];
    $data[] = [
      'https://www.example.com',
      TRUE,
    ];
    // cSpell:disable-next-line
    $data[] = [
      'magnet:?xt=urn:sha1:YNCKHTQCWBTRNJIV4WNAE52SJUQCZO5C',
      TRUE,
    ];
    // Invalid protocols.
    $data[] = [
      'ftp://ftp.funet.fi/pub/standards/RFC/rfc959.txt',
      FALSE,
    ];
    return $data;
  }
  
  /**
   * @covers ::validate
   *
   * @see \Drupal\Core\Url::fromUri
   */
  public function testValidateWithMalformedUri() : void {
    $link = $this->createMock('Drupal\\link\\LinkItemInterface');
    $link->expects($this->any())
      ->method('getUrl')
      ->willThrowException(new \InvalidArgumentException());
    $context = $this->createMock(ExecutionContextInterface::class);
    $context->expects($this->never())
      ->method('addViolation');
    $constraint = new LinkExternalProtocolsConstraint();
    $validator = new LinkExternalProtocolsConstraintValidator();
    $validator->initialize($context);
    $validator->validate($link, $constraint);
  }
  
  /**
   * @covers ::validate
   */
  public function testValidateIgnoresInternalUrls() : void {
    $link = $this->createMock('Drupal\\link\\LinkItemInterface');
    $link->expects($this->any())
      ->method('getUrl')
      ->willReturn(Url::fromRoute('example.test'));
    $context = $this->createMock(ExecutionContextInterface::class);
    $context->expects($this->never())
      ->method('addViolation');
    $constraint = new LinkExternalProtocolsConstraint();
    $validator = new LinkExternalProtocolsConstraintValidator();
    $validator->initialize($context);
    $validator->validate($link, $constraint);
  }

}