You are here

Home » API reference » Link checker 8 » LinkcheckerLinkCheckerServiceTest.php

class LinkcheckerLinkCheckerServiceTest in Link checker 8

Test for LinkCheckerService.

@group linkchecker

Hierarchy

Expanded class hierarchy of LinkcheckerLinkCheckerServiceTest

File

tests/src/Kernel/LinkcheckerLinkCheckerServiceTest.php, line 18

Namespace

Drupal\Tests\linkchecker\Kernel
View source 
class LinkcheckerLinkCheckerServiceTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'system',
    'dynamic_entity_reference',
    'linkchecker',
  ];

  /**
   * Link checker service.
   *
   * @var \Drupal\linkchecker\LinkCheckerService
   */
  protected $checkerService;

  /**
   * The http client.
   *
   * @var \GuzzleHttp\Client
   */
  protected $httpClient;

  /**
   * The time.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * The Linkchecker settings.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $linkcheckerSetting;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installSchema('system', 'sequences');
    $this
      ->installEntitySchema('linkcheckerlink');
    $this
      ->installConfig('linkchecker');

    // Create a mock and queue the responses.
    $mock = new MockHandler([
      new Response(200, []),
      new Response(200, [
        'Content-Type' => 'text/html',
        'Link' => [
          'bar',
          'foo',
        ],
      ], '<div id="foo"></div>'),
      new Response(200, [
        'Content-Type' => 'text/html',
        'Link' => [
          'foo',
          'baz',
        ],
      ], '<div id="foo"></div>'),
      new Response(200, [
        'Content-type' => 'text/html',
        'Link' => '<https://drupal.org>; rel="my-rel", <https://drupal.org>; rel=shortlink',
      ], '<div id="bar">This is bar</div>'),
      new Response(301, []),
      new Response(404, []),
      new Response(405, []),
      new Response(500, []),
      new Response(100, []),
    ]);
    $handler = HandlerStack::create($mock);
    $client = new Client([
      'handler' => $handler,
    ]);

    // Second client for comparing results.
    // @see http://docs.guzzlephp.org/en/stable/testing.html
    $handler2 = HandlerStack::create(clone $mock);
    $client2 = new Client([
      'handler' => $handler2,
    ]);
    $this->container
      ->set('http_client', $client);
    $this->checkerService = $this->container
      ->get('linkchecker.checker');
    $this->httpClient = $client2;
    $this->time = $this->container
      ->get('datetime.time');
    $this->linkcheckerSetting = $this->container
      ->get('config.factory')
      ->getEditable('linkchecker.settings');
  }

  /**
   * Test link checker service status handling.
   */
  public function testStatusHandling() {
    $ignoreResponseCodes = preg_split('/(\\r\\n?|\\n)/', $this->linkcheckerSetting
      ->get('error.ignore_response_codes'));
    $urls = [
      '200',
      '200#foo',
      '200#baz',
      '200#bar',
      '301',
      '404',
      '405',
      '500',
      '100',
    ];
    $links = [];
    foreach ($urls as $url) {
      $links[] = $this
        ->createDummyLink($url);
    }

    // Create duplicate link.
    $duplicateLink = $this
      ->createDummyLink(reset($urls));

    /** @var \Drupal\linkchecker\LinkCheckerLinkInterface $link */
    foreach ($links as $link) {
      $linkBeforeUpdate = clone $link;
      $this->checkerService
        ->check($link)
        ->wait();

      // We use mocked http client where URL and status code are same.
      $response = $this->httpClient
        ->request($linkBeforeUpdate
        ->getRequestMethod(), $linkBeforeUpdate
        ->getUrl(), [
        'http_errors' => FALSE,
      ]);
      $expectedStatusCode = $response
        ->getStatusCode();
      $expectedErrorMessage = $response
        ->getReasonPhrase();
      if ($link
        ->getUrl() == '200#baz') {
        $expectedStatusCode = 404;
        $expectedErrorMessage = 'URL fragment identifier not found in content';
      }
      $this
        ->assertEquals($expectedStatusCode, $link
        ->getStatusCode(), new FormattableMarkup('Expected status code is @expected. @actual is given', [
        '@expected' => $expectedStatusCode,
        '@actual' => $link
          ->getStatusCode(),
      ]));
      $this
        ->assertEquals($expectedErrorMessage, $link
        ->getErrorMessage(), new FormattableMarkup('Expected error message is @expected. "@actual" is given', [
        '@expected' => $expectedErrorMessage,
        '@actual' => $link
          ->getErrorMessage(),
      ]));
      $this
        ->assertGreaterThan(0, $link
        ->getLastCheckTime(), new FormattableMarkup('Expected last check time is greater than @expected. @actual is given', [
        '@expected' => 0,
        '@actual' => $link
          ->getLastCheckTime(),
      ]));
      if (in_array($expectedStatusCode, $ignoreResponseCodes)) {
        $this
          ->assertEquals(0, $link
          ->getFailCount(), new FormattableMarkup('Expected fail count is @expected. @actual is given', [
          '@expected' => 0,
          '@actual' => $link
            ->getFailCount(),
        ]));
      }
      else {
        $this
          ->assertEquals($linkBeforeUpdate
          ->getFailCount() + 1, $link
          ->getFailCount(), new FormattableMarkup('Expected fail count is @expected. @actual is given', [
          '@expected' => $linkBeforeUpdate
            ->getFailCount() + 1,
          '@actual' => $link
            ->getFailCount(),
        ]));
      }
    }

    // Check if duplicate link was updated.
    $link = reset($links);
    $duplicateLink = LinkCheckerLink::load($duplicateLink
      ->id());
    $this
      ->assertEquals($duplicateLink
      ->getStatusCode(), $link
      ->getStatusCode(), new FormattableMarkup('Expected status code is @expected. @actual is given', [
      '@expected' => $duplicateLink
        ->getStatusCode(),
      '@actual' => $link
        ->getStatusCode(),
    ]));
    $this
      ->assertEquals($duplicateLink
      ->getErrorMessage(), $link
      ->getErrorMessage(), new FormattableMarkup('Expected error message is @expected. "@actual" is given', [
      '@expected' => $duplicateLink
        ->getErrorMessage(),
      '@actual' => $link
        ->getErrorMessage(),
    ]));
    $this
      ->assertEquals($duplicateLink
      ->getLastCheckTime(), $link
      ->getLastCheckTime(), new FormattableMarkup('Expected last check time is @expected. @actual is given', [
      '@expected' => $duplicateLink
        ->getLastCheckTime(),
      '@actual' => $link
        ->getLastCheckTime(),
    ]));
    $this
      ->assertEquals($duplicateLink
      ->getFailCount(), $link
      ->getFailCount(), new FormattableMarkup('Expected fail count is @expected. @actual is given', [
      '@expected' => $duplicateLink
        ->getFailCount(),
      '@actual' => $link
        ->getFailCount(),
    ]));
  }

  /**
   * Helper function for link creation.
   */
  protected function createDummyLink($url) {
    $link = LinkCheckerLink::create([
      'url' => $url,
      'entity_id' => [
        'target_id' => 1,
        'target_type' => 'dummy_type',
      ],
      'entity_field' => 'dummy_field',
      'entity_langcode' => 'en',
    ]);
    $link
      ->save();
    return $link;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
LinkcheckerLinkCheckerServiceTest::$checkerService protected property Link checker service.
LinkcheckerLinkCheckerServiceTest::$httpClient protected property The http client.
LinkcheckerLinkCheckerServiceTest::$linkcheckerSetting protected property The Linkchecker settings.
LinkcheckerLinkCheckerServiceTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
LinkcheckerLinkCheckerServiceTest::$time protected property The time.
LinkcheckerLinkCheckerServiceTest::createDummyLink protected function Helper function for link creation.
LinkcheckerLinkCheckerServiceTest::setUp public function Overrides KernelTestBase::setUp
LinkcheckerLinkCheckerServiceTest::testStatusHandling public function Test link checker service status handling.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.