Skip to content

feat: Unit testing setup restructure #1595

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.

Sign up for GitHub

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

Merged
merged 14 commits into from
Apr 17, 2025
Merged

feat: Unit testing setup restructure #1595

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
83ac5a9
Restructured unit testing setup
matthewlipski Apr 7, 2025
ff63f61
Fixed build & formatted HTML snapshots
matthewlipski Apr 8, 2025
9fa6019
Small fix
matthewlipski Apr 8, 2025
0e418d5
Fixed react setup
matthewlipski Apr 8, 2025
96d202b
Made test functions pluggable for test cases
matthewlipski Apr 9, 2025
5d84e99
Removed accidentally added snapshots
matthewlipski Apr 10, 2025
d25e65e
Moved unit tests to `tests` package
matthewlipski Apr 10, 2025
d92dcac
Small fixes
matthewlipski Apr 11, 2025
97068ee
Separated tests for different formats
matthewlipski Apr 11, 2025
d7401c5
Merge branch 'main' into unit-tests-setup
matthewlipski Apr 11, 2025
c389810
Updated `package-lock.json`
matthewlipski Apr 11, 2025
bad1640
Small fix
matthewlipski Apr 11, 2025
411201c
Updated comments
matthewlipski Apr 12, 2025
4b4866c
Merge branch 'main' into unit-tests-setup
nperez0111 Apr 17, 2025
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
1 change: 1 addition & 0 deletions packages/core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
"@tiptap/pm": "^2.11.5",
"emoji-mart": "^5.6.0",
"hast-util-from-dom": "^5.0.1",
"htmlfy": "^0.6.7",
"prosemirror-dropcursor": "^1.8.1",
"prosemirror-highlight": "^0.13.0",
"prosemirror-model": "^1.24.1",
Expand Down
40 changes: 39 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/basicBlocks.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,39 @@
<p>Paragraph 1</p><h1>Heading 1</h1><ol><li><p>Numbered List Item 1</p></li></ol><ul><li><p>Bullet List Item 1</p></li><li><input type="checkbox"><p class="bn-inline-content">Check List Item 1</p></li></ul><pre><code class="bn-inline-content language-text" data-language="text">console.log("Hello World");</code></pre><table><tr><td colspan="1" rowspan="1"><p>Table Cell 1</p></td><td colspan="1" rowspan="1"><p>Table Cell 2</p></td></tr><tr><td colspan="1" rowspan="1"><p>Table Cell 3</p></td><td colspan="1" rowspan="1"><p>Table Cell 4</p></td></tr></table><p>Add image</p><p>Paragraph 2</p>
<p>Paragraph 1</p>
<h1>Heading 1</h1>
<ol>
<li>
<p>Numbered List Item 1</p>
</li>
</ol>
<ul>
<li>
<p>Bullet List Item 1</p>
</li>
<li>
<input type="checkbox" />
<p class="bn-inline-content">Check List Item 1</p>
</li>
</ul>
<pre>
<code class="bn-inline-content language-text" data-language="text">console.log("Hello World");</code>
</pre>
<table>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 1</p>
</td>
<td colspan="1" rowspan="1">
<p>Table Cell 2</p>
</td>
</tr>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 3</p>
</td>
<td colspan="1" rowspan="1">
<p>Table Cell 4</p>
</td>
</tr>
</table>
<p>Add image</p>
<p>Paragraph 2</p>
52 changes: 51 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/basicBlocksWithProps.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
<p data-text-color="red">Paragraph 1</p><h2 data-level="2">Heading 1</h2><ol start="2"><li><p data-start="2">Numbered List Item 1</p></li></ol><ul><li><p data-background-color="red">Bullet List Item 1</p></li><li><input type="checkbox" checked="" data-checked="true"><p class="bn-inline-content">Check List Item 1</p></li></ul><pre><code class="bn-inline-content language-typescript" data-language="typescript">console.log("Hello World");</code></pre><table><tr><td colspan="1" rowspan="1"><p>Table Cell 1</p></td><td colspan="1" rowspan="1"><p>Table Cell 2</p></td></tr><tr><td colspan="1" rowspan="1"><p>Table Cell 3</p></td><td colspan="1" rowspan="1"><p>Table Cell 4</p></td></tr></table><figure data-name="1280px-Placeholder_view_vector.svg.png" data-url="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3f/Placeholder_view_vector.svg/1280px-Placeholder_view_vector.svg.png" data-caption="Placeholder" data-preview-width="256"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3f/Placeholder_view_vector.svg/1280px-Placeholder_view_vector.svg.png" alt="1280px-Placeholder_view_vector.svg.png" width="256"><figcaption>Placeholder</figcaption></figure><p>Paragraph 2</p>
<p data-text-color="red">Paragraph 1</p>
<h2 data-level="2">Heading 1</h2>
<ol start="2">
<li>
<p data-start="2">Numbered List Item 1</p>
</li>
</ol>
<ul>
<li>
<p data-background-color="red">Bullet List Item 1</p>
</li>
<li>
<input type="checkbox" checked="" data-checked="true" />
<p class="bn-inline-content">Check List Item 1</p>
</li>
</ul>
<pre>
<code class="bn-inline-content language-typescript" data-language="typescript">console.log("Hello World");</code>
</pre>
<table>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 1</p>
</td>
<td colspan="1" rowspan="1">
<p>Table Cell 2</p>
</td>
</tr>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 3</p>
</td>
<td colspan="1" rowspan="1">
<p>Table Cell 4</p>
</td>
</tr>
</table>
<figure
data-name="1280px-Placeholder_view_vector.svg.png"
data-url="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3f/Placeholder_view_vector.svg/1280px-Placeholder_view_vector.svg.png"
data-caption="Placeholder"
data-preview-width="256"
>
<img
src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3f/Placeholder_view_vector.svg/1280px-Placeholder_view_vector.svg.png"
alt="1280px-Placeholder_view_vector.svg.png"
width="256"
/>
<figcaption>Placeholder</figcaption>
</figure>
<p>Paragraph 2</p>
3 changes: 2 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/childToParent.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
<p>Paragraph 1</p><p>Nested Paragraph 1</p>
<p>Paragraph 1</p>
<p>Nested Paragraph 1</p>
5 changes: 4 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/childrenToNextParent.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<p>Nested Paragraph 1</p><p>Nested Paragraph 2</p><p>Nested Paragraph 3</p><p>Paragraph 2</p>
<p>Nested Paragraph 1</p>
<p>Nested Paragraph 2</p>
<p>Nested Paragraph 3</p>
<p>Paragraph 2</p>
8 changes: 7 additions & 1 deletion ...e/src/api/tests/clipboard/copy/__snapshots__/text/html/childrenToNextParentsChildren.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
<p>Nested Paragraph 1</p><p>Nested Paragraph 2</p><p>Nested Paragraph 3</p><p>Paragraph 2</p><p>Nested Paragraph 4</p><p>Nested Paragraph 5</p><p>Nested Paragraph 6</p>
<p>Nested Paragraph 1</p>
<p>Nested Paragraph 2</p>
<p>Nested Paragraph 3</p>
<p>Paragraph 2</p>
<p>Nested Paragraph 4</p>
<p>Nested Paragraph 5</p>
<p>Nested Paragraph 6</p>
7 changes: 6 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/image.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
<img src="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg" alt="BlockNote image" width="512" data-url="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg">
<img
src="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg"
alt="BlockNote image"
width="512"
data-url="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg"
/>
4 changes: 3 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/multipleChildren.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<p>Nested Paragraph 1</p><p>Nested Paragraph 2</p><p>Nested Paragraph 3</p>
<p>Nested Paragraph 1</p>
<p>Nested Paragraph 2</p>
<p>Nested Paragraph 3</p>
4 changes: 3 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/multipleStyledText.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Unstyled Text<em>Italic Text</em><strong>Bold Text</strong>
Unstyled Text
<em>Italic Text</em>
<strong>Bold Text</strong>
9 changes: 8 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/nestedImage.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
<p>Paragraph 1</p><img src="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg" alt="BlockNote image" width="512" data-url="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg"><p>Nested Paragraph 1</p>
<p>Paragraph 1</p>
<img
src="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg"
alt="BlockNote image"
width="512"
data-url="https://ralfvanveen.com/wp-content/uploads/2021/06/Placeholder-_-Glossary.svg"
/>
<p>Nested Paragraph 1</p>
3 changes: 2 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/partialChildToParent.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
<p>aragraph 1</p><p>N</p>
<p>aragraph 1</p>
<p>N</p>
19 changes: 18 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/tableAllCells.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
<table><tr><td colspan="1" rowspan="1"><p>Table Cell 1</p></td><td colspan="1" rowspan="1"><p>Table Cell 2</p></td></tr><tr><td colspan="1" rowspan="1"><p>Table Cell 3</p></td><td colspan="1" rowspan="1"><p>Table Cell 4</p></td></tr></table>
<table>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 1</p>
</td>
<td colspan="1" rowspan="1">
<p>Table Cell 2</p>
</td>
</tr>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 3</p>
</td>
<td colspan="1" rowspan="1">
<p>Table Cell 4</p>
</td>
</tr>
</table>
8 changes: 7 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/tableCell.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
<table><tr><td colspan="1" rowspan="1"><p>Table Cell 1</p></td></tr></table>
<table>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 1</p>
</td>
</tr>
</table>
13 changes: 12 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/tableCol.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
<table><tr><td colspan="1" rowspan="1"><p>Table Cell 1</p></td></tr><tr><td colspan="1" rowspan="1"><p>Table Cell 3</p></td></tr></table>
<table>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 1</p>
</td>
</tr>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 3</p>
</td>
</tr>
</table>
11 changes: 10 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/__snapshots__/text/html/tableRow.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
<table><tr><td colspan="1" rowspan="1"><p>Table Cell 1</p></td><td colspan="1" rowspan="1"><p>Table Cell 2</p></td></tr></table>
<table>
<tr>
<td colspan="1" rowspan="1">
<p>Table Cell 1</p>
</td>
<td colspan="1" rowspan="1">
<p>Table Cell 2</p>
</td>
</tr>
</table>
1 change: 0 additions & 1 deletion packages/core/src/api/tests/clipboard/copy/getCopyTestCases.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,6 @@ export const getCopyTestCases = (): CopyTestCase[] => [
return TextSelection.create(doc, startPos, endPos);
},
},
// TODO: External HTML is wrapped in unnecessary `tr` element.
{
name: "tableCell",
clipboardDataType: "text/html",
Expand Down
9 changes: 7 additions & 2 deletions packages/core/src/api/tests/clipboard/copy/testCopy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { prettify } from "htmlfy";
import { describe, expect, it } from "vitest";

import { BlockNoteEditor } from "../../../../editor/BlockNoteEditor.js";
Expand Down Expand Up @@ -41,11 +42,15 @@ const testCopyTest = async (
);

if (testCase.clipboardDataType === "blocknote/html") {
await expect(clipboardHTML).toMatchFileSnapshot(
await expect(
prettify(clipboardHTML, { tag_wrap: true })
).toMatchFileSnapshot(
`./__snapshots__/${testCase.clipboardDataType}/${testCase.name}.html`
);
} else if (testCase.clipboardDataType === "text/html") {
await expect(externalHTML).toMatchFileSnapshot(
await expect(
prettify(externalHTML, { tag_wrap: true })
).toMatchFileSnapshot(
`./__snapshots__/${testCase.clipboardDataType}/${testCase.name}.html`
);
} else if (testCase.clipboardDataType === "text/plain") {
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/api/tests/clipboard/copyPaste/testCopyPaste.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const testCopyPasteTest = async (
);
};

describe("Copy/paste tests", async () => {
describe("Copy/paste tests", () => {
const getEditor = setupTestEditor();

for (const testCase of getCopyPasteTestCases()) {
Expand Down
14 changes: 11 additions & 3 deletions ...ests/formatConversion/export/__snapshots__/blocknoteHTML/codeBlock/contains-newlines.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
<div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="null"><div class="bn-block" data-node-type="blockContainer" data-id="null"><div class="bn-block-content" data-content-type="codeBlock"><pre><code class="bn-inline-content language-javascript" data-language="javascript">const hello = 'world';
console.log(hello);
</code></pre></div></div></div></div>
<div class="bn-block-group" data-node-type="blockGroup">
<div class="bn-block-outer" data-node-type="blockOuter" data-id="1">
<div class="bn-block" data-node-type="blockContainer" data-id="1">
<div class="bn-block-content" data-content-type="codeBlock">
<pre>
<code class="bn-inline-content language-javascript" data-language="javascript">const hello ='world';console.log(hello);</code>
</pre>
</div>
</div>
</div>
</div>
12 changes: 11 additions & 1 deletion .../tests/formatConversion/export/__snapshots__/blocknoteHTML/codeBlock/defaultLanguage.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
<div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="null"><div class="bn-block" data-node-type="blockContainer" data-id="null"><div class="bn-block-content" data-content-type="codeBlock"><pre><code class="bn-inline-content language-text" data-language="text">console.log('Hello, world!');</code></pre></div></div></div></div>
<div class="bn-block-group" data-node-type="blockGroup">
<div class="bn-block-outer" data-node-type="blockOuter" data-id="1">
<div class="bn-block" data-node-type="blockContainer" data-id="1">
<div class="bn-block-content" data-content-type="codeBlock">
<pre>
<code class="bn-inline-content language-text" data-language="text">console.log('Hello, world!');</code>
</pre>
</div>
</div>
</div>
</div>
12 changes: 11 additions & 1 deletion ...re/src/api/tests/formatConversion/export/__snapshots__/blocknoteHTML/codeBlock/empty.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
<div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="null"><div class="bn-block" data-node-type="blockContainer" data-id="null"><div class="bn-block-content" data-content-type="codeBlock"><pre><code class="bn-inline-content language-text" data-language="text"></code></pre></div></div></div></div>
<div class="bn-block-group" data-node-type="blockGroup">
<div class="bn-block-outer" data-node-type="blockOuter" data-id="1">
<div class="bn-block" data-node-type="blockContainer" data-id="1">
<div class="bn-block-content" data-content-type="codeBlock">
<pre>
<code class="bn-inline-content language-text" data-language="text"></code>
</pre>
</div>
</div>
</div>
</div>
12 changes: 11 additions & 1 deletion ...e/src/api/tests/formatConversion/export/__snapshots__/blocknoteHTML/codeBlock/python.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
<div class="bn-block-group" data-node-type="blockGroup"><div class="bn-block-outer" data-node-type="blockOuter" data-id="null"><div class="bn-block" data-node-type="blockContainer" data-id="null"><div class="bn-block-content" data-content-type="codeBlock"><pre><code class="bn-inline-content language-python" data-language="python">print('Hello, world!')</code></pre></div></div></div></div>
<div class="bn-block-group" data-node-type="blockGroup">
<div class="bn-block-outer" data-node-type="blockOuter" data-id="1">
<div class="bn-block" data-node-type="blockContainer" data-id="1">
<div class="bn-block-content" data-content-type="codeBlock">
<pre>
<code class="bn-inline-content language-python" data-language="python">print('Hello, world!')</code>
</pre>
</div>
</div>
</div>
</div>
Loading
Loading