matomo/plugins/Referrers/tests/UI/ReferrersPages_spec.js

/*!
 * Matomo - free/libre analytics platform
 *
 * Screenshot integration tests.
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

describe("ReferrersPages", function () {

  var generalParams = 'idSite=1&period=year&date=2012-08-09',
    urlBaseGeneric = 'module=CoreHome&action=index&',
    urlBase = urlBaseGeneric + generalParams;

  before(function() {
    testEnvironment.ignoreClearAllViewDataTableParameters = 1;
    testEnvironment.save();
  });

  after(function() {
    delete testEnvironment.ignoreClearAllViewDataTableParameters;
    testEnvironment.save();
  });

  it('should load the referrers > overview page correctly', async function () {
    await page.goto("?" + urlBase + "#?" + generalParams + "&category=Referrers_Referrers&subcategory=General_Overview");
    await page.waitForNetworkIdle();

    pageWrap = await page.$('.pageWrap');
    expect(await pageWrap.screenshot()).to.matchImage('overview');
  });

  it("should display the another row when selected", async function () {
    await page.hover('.jqplot-seriespicker');

    await page.waitForSelector('.jqplot-seriespicker-popover .pickRow input');
    const element = await page.jQuery('.jqplot-seriespicker-popover .pickRow input:not(:checked):first');
    await element.click();
    await page.waitForNetworkIdle();
    await page.waitForTimeout(250);

    pageWrap = await page.$('#widgetReferrersgetEvolutionGraphforceView1viewDataTablegraphEvolutioncolumnsArray .theWidgetContent');
    expect(await pageWrap.screenshot()).to.matchImage('overview_another_row');
  });

  it('should show previously selected rows on reload', async function () {
    await page.reload();
    await page.waitForNetworkIdle();

    pageWrap = await page.$('#widgetReferrersgetEvolutionGraphforceView1viewDataTablegraphEvolutioncolumnsArray .theWidgetContent');
    expect(await pageWrap.screenshot()).to.matchImage('overview_reloaded');
  });

  it('should load the referrers > overview page correctly', async function () {
    await page.goto("?" + urlBase + "#?" + generalParams + "&category=Referrers_Referrers&subcategory=Referrers_WidgetGetAll");
    await page.waitForNetworkIdle();

    pageWrap = await page.$('.pageWrap');
    expect(await pageWrap.screenshot()).to.matchImage('allreferrers');
  });

  it('should display metric tooltip correctly', async function () {
    let elem = await page.jQuery('[data-report="Referrers.getReferrerType"] #nb_visits .thDIV');
    await elem.hover();

    let tip = await page.jQuery('.columnDocumentation:visible', {waitFor: true});

    // manipulate the styles a bit, as it's otherwise not visible on screenshot
    await page.evaluate(function () {
      var style = document.createElement('style');
      style.innerHTML = '.permadocs { display: block !important;z-index:150!important;margin-top:0!important; } .dataTable thead{ z-index:150 !important; }';
      $('body').append(style);

      //add index not overlap others
      $('.columnDocumentation:visible').addClass('permadocs');
    });

    await page.waitForTimeout(100);

    expect(await tip.screenshot()).to.matchImage({
      imageName: 'metric_tooltip',
      comparisonThreshold: 0.008
    });
  });

  it('should load the referrers > search engines & keywords page correctly', async function () {
    await page.goto("?" + urlBase + "#?" + generalParams + "&category=Referrers_Referrers&subcategory=Referrers_SubmenuSearchEngines");
    await page.waitForNetworkIdle();
    await page.mouse.move(-10, -10);

    pageWrap = await page.$('.pageWrap');
    expect(await pageWrap.screenshot()).to.matchImage('search_engines_keywords');
  });

  it('should load the referrers > websites correctly', async function () {
    await page.goto("?" + urlBase + "#?" + generalParams + "&category=Referrers_Referrers&subcategory=Referrers_SubmenuWebsitesOnly");
    await page.waitForNetworkIdle();
    await page.mouse.move(-10, -10);

    pageWrap = await page.$('.pageWrap');
    expect(await pageWrap.screenshot()).to.matchImage('websites');
  });

  it('should load the referrers > social page correctly', async function () {
    await page.goto("?" + urlBase + "#?" + generalParams + "&category=Referrers_Referrers&subcategory=Referrers_Socials");
    await page.waitForNetworkIdle();

    pageWrap = await page.$('.pageWrap');
    expect(await pageWrap.screenshot()).to.matchImage('socials');
  });

  it('should load the referrers > campaigns page correctly', async function () {
    await page.goto("?" + urlBase + "#?" + generalParams + "&category=Referrers_Referrers&subcategory=Referrers_Campaigns");
    await page.waitForNetworkIdle();

    pageWrap = await page.$('.pageWrap');
    expect(await pageWrap.screenshot()).to.matchImage('campaigns');
  });
});