notebook/ui-tests/test/general.spec.ts

// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.

import path from 'path';

import { expect } from '@playwright/test';

import { test } from './fixtures';

import { waitForKernelReady } from './utils';

test.describe('General', () => {
  test('The notebook should render', async ({ page, tmpPath }) => {
    const notebook = 'simple.ipynb';
    await page.contents.uploadFile(
      path.resolve(__dirname, `./notebooks/${notebook}`),
      `${tmpPath}/${notebook}`
    );
    await page.goto(`notebooks/${tmpPath}/${notebook}`);

    // wait for the kernel status animations to be finished
    await waitForKernelReady(page);
    await page.waitForSelector(
      ".jp-Notebook-ExecutionIndicator[data-status='idle']"
    );

    const checkpointLocator = '.jp-NotebookCheckpoint';
    // wait for the checkpoint indicator to be displayed
    await page.waitForSelector(checkpointLocator);

    // remove the amount of seconds manually since it might display strings such as "3 seconds ago"
    await page
      .locator(checkpointLocator)
      .evaluate(
        (element) => (element.innerHTML = 'Last Checkpoint: 3 seconds ago')
      );

    // force switching back to command mode to avoid capturing the cursor in the screenshot
    await page.evaluate(async () => {
      await window.jupyterapp.commands.execute('notebook:enter-command-mode');
    });

    // make sure the mouse does not hover on the footer
    await page.mouse.move(0, 0);

    expect(await page.screenshot()).toMatchSnapshot('notebook.png');
  });
});