MatomoSearchTest.php in Matomo Analytics 8

Namespace

Drupal\Tests\matomo\Functional

File

tests/src/Functional/MatomoSearchTest.php

<?php

namespace Drupal\Tests\matomo\Functional;

use Drupal\Tests\Traits\Core\CronRunTrait;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Tests\BrowserTestBase;

/**
 * Test search functionality of Matomo module.
 *
 * @group Matomo
 */
class MatomoSearchTest extends BrowserTestBase {
  use CronRunTrait;
  use StringTranslationTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'matomo',
    'search',
    'node',
  ];

  /**
   * Default theme.
   *
   * @var string
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'page',
      'name' => 'Basic page',
    ]);
    $permissions = [
      'access administration pages',
      'administer matomo',
      'search content',
      'create page content',
      'edit own page content',
    ];

    // User to set up matomo.
    $this->admin_user = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($this->admin_user);
  }

  /**
   * Tests if search tracking is properly added to the page.
   */
  public function testMatomoSearchTracking() {
    $site_id = '1';
    $this
      ->config('matomo.settings')
      ->set('site_id', $site_id)
      ->save();
    $this
      ->config('matomo.settings')
      ->set('url_http', 'http://www.example.com/matomo/')
      ->save();
    $this
      ->config('matomo.settings')
      ->set('url_https', 'https://www.example.com/matomo/')
      ->save();

    // Check tracking code visibility.
    $this
      ->drupalGet('');
    $this
      ->assertRaw($site_id, '[testMatomoSearch]: Tracking code is displayed for authenticated users.');
    $this
      ->drupalGet('search/node');
    $this
      ->assertNoRaw('_paq.push(["trackSiteSearch", ', '[testMatomoSearch]: Search tracker not added to page.');

    // Enable site search support.
    $this
      ->config('matomo.settings')
      ->set('track.site_search', 1)
      ->save();

    // Search for random string.
    $search = [];
    $search['keys'] = $this
      ->randomMachineName(8);

    // Create a node to search for.
    $edit = [];
    $edit['title[0][value]'] = 'This is a test title';
    $edit['body[0][value]'] = 'This test content contains ' . $search['keys'] . ' string.';

    // Fire a search, it's expected to get 0 results.
    $this
      ->drupalPostForm('search/node', $search, 'Search');
    $this
      ->assertRaw('_paq.push(["trackSiteSearch", ', '[testMatomoSearch]: Search results tracker is displayed.');
    $this
      ->assertRaw('window.matomo_search_results = 0;', '[testMatomoSearch]: Search yielded no results.');

    // Save the node.
    $this
      ->drupalPostForm('node/add/page', $edit, 'Save');
    $this
      ->assertText($this
      ->t('@type @title has been created.', [
      '@type' => 'Basic page',
      '@title' => $edit['title[0][value]'],
    ]), 'Basic page created.');

    // Index the node or it cannot found.
    $this
      ->cronRun();
    $this
      ->drupalPostForm('search/node', $search, 'Search');
    $this
      ->assertRaw('_paq.push(["trackSiteSearch", ', '[testMatomoSearch]: Search results tracker is displayed.');
    $this
      ->assertRaw('window.matomo_search_results = 1;', '[testMatomoSearch]: One search result found.');
    $this
      ->drupalPostForm('node/add/page', $edit, 'Save');
    $this
      ->assertText($this
      ->t('@type @title has been created.', [
      '@type' => 'Basic page',
      '@title' => $edit['title[0][value]'],
    ]), 'Basic page created.');

    // Index the node or it cannot found.
    $this
      ->cronRun();
    $this
      ->drupalPostForm('search/node', $search, 'Search');
    $this
      ->assertRaw('_paq.push(["trackSiteSearch", ', '[testMatomoSearch]: Search results tracker is displayed.');
    $this
      ->assertRaw('window.matomo_search_results = 2;', '[testMatomoSearch]: Two search results found.');
  }

}

Classes

Name	Description
MatomoSearchTest	Test search functionality of Matomo module.