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

Implement tests using Playwright #68

Merged
merged 9 commits into from
Dec 25, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
24 changes: 24 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Tests
on: [push, pull_request]

jobs:
test:
name: Run Playwright Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: latest
- name: Install dependencies
run: npm ci
- name: Install Playwright Browsers
run: npx playwright install --with-deps
- name: Run Playwright tests
run: npm run test
- uses: actions/upload-artifact@v4
if: always()
with:
name: playwright-report
path: playwright-report/
retention-days: 30
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ dist
dist-electron
release
.env
/test-results/
/playwright-report/
/blob-report/
/playwright/.cache/
76 changes: 73 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
"preview": "vite preview",
"build_grammar": "lezer-generator src/editor/lang-heynote/heynote.grammar -o src/editor/lang-heynote/parser.js",
"webapp:dev": "vite webapp",
"webapp:build": "vite build webapp"
"webapp:build": "vite build webapp",
"test": "playwright test",
"test:ui": "playwright test --ui"
},
"devDependencies": {
"@codemirror/autocomplete": "^6.11.1",
Expand All @@ -51,8 +53,10 @@
"@electron/asar": "^3.2.2",
"@lezer/generator": "^1.5.1",
"@lezer/markdown": "^1.1.2",
"@playwright/test": "^1.40.1",
"@replit/codemirror-lang-csharp": "^6.2.0",
"@rollup/plugin-node-resolve": "^15.0.1",
"@types/node": "^20.10.5",
"@vitejs/plugin-vue": "^4.0.0",
"debounce": "^1.2.1",
"electron": "^28.0.0",
Expand Down
78 changes: 78 additions & 0 deletions playwright.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import { defineConfig, devices } from '@playwright/test';

/**
* Read environment variables from file.
* https://github.com/motdotla/dotenv
*/
// require('dotenv').config();

/**
* See https://playwright.dev/docs/test-configuration.
*/
export default defineConfig({
testDir: './tests',
/* Run tests in files in parallel */
fullyParallel: true,
/* Fail the build on CI if you accidentally left test.only in the source code. */
forbidOnly: !!process.env.CI,
/* Retry on CI only */
retries: process.env.CI ? 2 : 0,
/* Opt out of parallel tests on CI. */
workers: process.env.CI ? 1 : undefined,
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
reporter: 'html',
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
use: {
/* Base URL to use in actions like `await page.goto('/')`. */
baseURL: 'http://localhost:3000',

/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
trace: 'on-first-retry',
},

/* Configure projects for major browsers */
projects: [
{
name: 'chromium',
use: { ...devices['Desktop Chrome'] },
},

{
name: 'firefox',
use: { ...devices['Desktop Firefox'] },
},

{
name: 'webkit',
use: { ...devices['Desktop Safari'] },
},

/* Test against mobile viewports. */
// {
// name: 'Mobile Chrome',
// use: { ...devices['Pixel 5'] },
// },
// {
// name: 'Mobile Safari',
// use: { ...devices['iPhone 12'] },
// },

/* Test against branded browsers. */
// {
// name: 'Microsoft Edge',
// use: { ...devices['Desktop Edge'], channel: 'msedge' },
// },
// {
// name: 'Google Chrome',
// use: { ...devices['Desktop Chrome'], channel: 'chrome' },
// },
],

/* Run your local dev server before starting the tests */
webServer: {
command: 'npx vite --port=3000 webapp',
url: 'http://localhost:3000',
timeout: 10 * 1000,
reuseExistingServer: !process.env.CI,
},
});
1 change: 1 addition & 0 deletions src/components/Editor.vue
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
showLineNumberGutter: this.showLineNumberGutter,
showFoldGutter: this.showFoldGutter,
})
window._heynote_editor = this.editor
window.document.addEventListener("currenciesLoaded", this.onCurrenciesLoaded)
})
// set up window close handler that will save the buffer and quit
Expand Down
1 change: 1 addition & 0 deletions src/editor/annotation.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ import { Annotation } from "@codemirror/state"
export const heynoteEvent = Annotation.define()
export const LANGUAGE_CHANGE = "heynote-change"
export const CURRENCIES_LOADED = "heynote-currencies-loaded"
export const SET_CONTENT = "heynote-set-content"

2 changes: 1 addition & 1 deletion src/editor/block/block.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { emptyBlockSelected } from "./select-all.js";
// tracks the size of the first delimiter
let firstBlockDelimiterSize

function getBlocks(state) {
export function getBlocks(state) {
const blocks = [];
const tree = ensureSyntaxTree(state, state.doc.length)
if (tree) {
Expand Down
22 changes: 21 additions & 1 deletion src/editor/editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ import { heynoteDark } from "./theme/dark.js"
import { heynoteBase } from "./theme/base.js"
import { customSetup } from "./setup.js"
import { heynoteLang } from "./lang-heynote/heynote.js"
import { noteBlockExtension, blockLineNumbers } from "./block/block.js"
import { noteBlockExtension, blockLineNumbers, getBlocks } from "./block/block.js"
import { heynoteEvent, SET_CONTENT } from "./annotation.js";
import { changeCurrentBlockLanguage, triggerCurrenciesLoaded } from "./block/commands.js"
import { formatBlockContent } from "./block/format-code.js"
import { heynoteKeymap } from "./keymap.js"
Expand Down Expand Up @@ -111,6 +112,25 @@ export class HeynoteEditor {
return this.view.state.sliceDoc()
}

setContent(content) {
this.view.dispatch({
changes: {
from: 0,
to: this.view.state.doc.length,
insert: content,
},
annotations: [heynoteEvent.of(SET_CONTENT)],
})
this.view.dispatch({
selection: {anchor: this.view.state.doc.length, head: this.view.state.doc.length},
scrollIntoView: true,
})
}

getBlocks() {
return getBlocks(this.view.state)
}

focus() {
this.view.focus()
}
Expand Down
40 changes: 40 additions & 0 deletions tests/basic-editing.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { test, expect } from "@playwright/test";
import { HeynotePage } from "./test-utils.js";

let heynotePage

test.beforeEach(async ({ page }) => {
console.log("beforeEach")
heynotePage = new HeynotePage(page)
await heynotePage.goto()
});

test("enter text and create new block", async ({ page }) => {
expect((await heynotePage.getBlocks()).length).toBe(1)
await page.locator("body").pressSequentially("Hello World!")
await page.locator("body").press("Enter")
await page.locator("body").press(heynotePage.isMac ? "Meta+Enter" : "Control+Enter")
await page.waitForTimeout(100);
expect((await heynotePage.getBlocks()).length).toBe(2)
expect(await heynotePage.getBlockContent(0)).toBe("Hello World!\n")
expect(await heynotePage.getBlockContent(1)).toBe("")

// check that visual block layers are created
expect(await page.locator("css=.heynote-blocks-layer > div").count()).toBe(2)
})

test("backspace", async ({ page }) => {

await page.locator("body").pressSequentially("Hello World!")
for (let i=0; i<5; i++) {
await page.locator("body").press("Backspace")
}
expect(await heynotePage.getBlockContent(0)).toBe("Hello W")
})

test("first block is protected", async ({ page }) => {
const initialContent = await heynotePage.getContent()
await page.locator("body").press("Backspace")
expect(await heynotePage.getBlockContent(0)).toBe("")
expect(await heynotePage.getContent()).toBe(initialContent)
})
35 changes: 35 additions & 0 deletions tests/markdown.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import { test, expect } from "@playwright/test";
import { HeynotePage } from "./test-utils.js";

let heynotePage

test.beforeEach(async ({ page }) => {
console.log("beforeEach")
heynotePage = new HeynotePage(page)
await heynotePage.goto()
});

test("test markdown mode", async ({ page }) => {
heynotePage.setContent(`
∞∞∞markdown
# Markdown!

- [ ] todo
- [x] done
`)
//await page.locator("body").pressSequentially("test")
expect(await page.locator("css=.status .status-block.lang")).toHaveText("Markdown")
})

test("checkbox toggle", async ({ page }) => {
heynotePage.setContent(`
∞∞∞markdown
- [ ] todo
`)
const checkbox = await page.locator("css=.cm-content input[type=checkbox]")
expect(checkbox).toHaveCount(1)
await checkbox.click()
expect(await heynotePage.getBlockContent(0)).toBe("- [x] todo\n")
await checkbox.click()
expect(await heynotePage.getBlockContent(0)).toBe("- [ ] todo\n")
})
Loading