Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

e2e-test: add editor-action-bar test #5726

Merged
merged 5 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 136 additions & 0 deletions test/e2e/features/action-bar/editor-action-bar.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
/*---------------------------------------------------------------------------------------------
* Copyright (C) 2024 Posit Software, PBC. All rights reserved.
* Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
*--------------------------------------------------------------------------------------------*/

import { test, expect, tags } from '../_test.setup';
import path = require('path');

test.use({
suiteId: __filename
});

test.describe('Editor Action Bar', {
tag: [tags.WEB, tags.ACTION_BAR, tags.EDITOR]
}, () => {
test.beforeAll(async function ({ userSettings }) {
await userSettings.set([['editor.actionBar.enabled', 'true']], false);
});

test.afterEach(async function ({ app }) {
await app.workbench.quickaccess.runCommand('workbench.action.closeAllEditors');
});

test('Quarto Document', {
tag: [tags.QUARTO]
}, async function ({ app, page }) {
await openFile(app, 'workspaces/quarto_basic/quarto_basic.qmd');

await test.step('verify \'preview\' button renders html', async () => {
await page.getByLabel('Preview', { exact: true }).click();
const viewerFrame = app.workbench.positronViewer.getViewerFrame().frameLocator('iframe');
await expect(viewerFrame.locator('h1')).toHaveText('Diamond sizes', { timeout: 30000 });
});

await verifySplitEditor(page, 'quarto_basic.qmd');
await verifyOpenInNewWindow(page, 'Diamond sizes');
});

test.skip('HTML Document', { tag: [tags.HTML] }, async function ({ app, page }) {
await openFile(app, 'workspaces/dash-py-example/data/OilandGasMetadata.html');

await test.step('verify \'open in viewer\' button renders html', async () => {
await page.getByLabel('Open in Viewer').nth(1).click();
const viewerFrame = page.locator('iframe.webview').contentFrame().locator('#active-frame').contentFrame();
const cellLocator = app.web
? viewerFrame.frameLocator('iframe').getByRole('cell', { name: 'Oil, Gas, and Other Regulated' })
: viewerFrame.getByRole('cell', { name: 'Oil, Gas, and Other Regulated' });

await expect(cellLocator).toBeVisible({ timeout: 30000 });
});

await verifySplitEditor(page, 'OilandGasMetadata.html');
await verifyOpenInNewWindow(page, '<title> Oil &amp; Gas Wells - Metadata</title>');

});

test('Jupyter Notebook', {
tag: [tags.NOTEBOOK],
annotation: [{ type: 'info', description: 'electron test unable to interact with dropdown native menu' }],
}, async function ({ app, page }) {
await app.workbench.positronQuickaccess.openDataFile(
path.join(app.workspacePathOrFolder, 'workspaces', 'large_r_notebook', 'spotify.ipynb')
);

if (app.web) {
await test.step('verify \'customize notebook\' button adjusts settings (web only)', async () => {
const dropdownButton = page.getByLabel('Customize Notebook...').nth(1);
await dropdownButton.evaluate((button) => (button as HTMLElement).click());

// native menu so can't interact with it in Electron
const toggleLineNumbers = page.getByRole('menuitemcheckbox', { name: 'Toggle Notebook Line Numbers' });
await toggleLineNumbers.hover();
// await toggleLineNumbers.focus();
await page.waitForTimeout(500);
await toggleLineNumbers.click();

for (const lineNum of [1, 2, 3, 4, 5]) {
await expect(page.locator('.line-numbers').getByText(lineNum.toString(), { exact: true })).toBeVisible();
}

});
}

await verifySplitEditor(page, 'spotify.ipynb');
});

test('R Markdown Document', {
tag: [tags.R_MARKDOWN]
}, async function ({ app, page }) {
await openFile(app, 'workspaces/basic-rmd-file/basicRmd.rmd');

await test.step('verify \'preview\' button renders html', async () => {
await page.getByLabel('Preview', { exact: true }).click();
const viewerFrame = app.workbench.positronViewer.getViewerFrame().frameLocator('iframe');
await expect(viewerFrame.getByRole('heading', { name: 'Getting startedAnchor' })).toBeVisible({ timeout: 30000 });
});

await verifySplitEditor(page, 'basicRmd.rmd');
await verifyOpenInNewWindow(page, 'This post examines the features');
});
});

async function openFile(app, filePath: string) {
const fileName = path.basename(filePath);
await test.step(`open file: ${fileName}`, async () => {
await app.workbench.quickaccess.openFile(path.join(app.workspacePathOrFolder, filePath));
});
}

async function verifySplitEditor(page, tabName: string) {
await test.step(`verify \'split editor\' button opens another tab`, async () => {
// Split editor right
await page.getByLabel('Split Editor Right', { exact: true }).click();
await expect(page.getByRole('tab', { name: tabName })).toHaveCount(2);

// Close one tab
await page.getByRole('tab', { name: tabName }).getByLabel('Close').first().click();

// Split editor down
await page.keyboard.down('Alt');
await page.getByLabel('Split Editor Down').nth(1).click();
await page.keyboard.up('Alt');
await expect(page.getByRole('tab', { name: tabName })).toHaveCount(2);
});
}

async function verifyOpenInNewWindow(page, expectedText: string) {
await test.step(`verify \'open new window\' contains: '${expectedText}'`, async () => {
const [newPage] = await Promise.all([
page.context().waitForEvent('page'),
page.getByLabel('Move into new window').nth(1).click(),
]);
await newPage.waitForLoadState();
await expect(newPage.getByText(expectedText)).toBeVisible();
});
}
2 changes: 2 additions & 0 deletions test/e2e/helpers/test-tags.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@
* which are not currently configured to run in PR workflows.
*/
export enum TestTags {
ACTION_BAR = '@action-bar',
APPS = '@apps',
CONNECTIONS = '@connections',
CONSOLE = '@console',
CRITICAL = '@critical',
DATA_EXPLORER = '@data-explorer',
DUCK_DB = '@duck-db',
HELP = '@help',
HTML = '@html',
LAYOUTS = '@layouts',
VIEWER = '@viewer',
EDITOR = '@editor',
Expand Down
Loading