7 |
16 |
8 |
9 |
11 |
12 |
13 |
15 |
23 |
24 |
25 |
12 |
14 |
4 |
9 |
10 |
25 |
8 |
13 |
10 |
12 |
4 |
13 |
4 |
31 |
5 |
27 |
4 |
5 |
12 |
13 |
6 |
8 |
11 |
4 |
10 |
7 |
13 |
23 | more rows at the bottom
24 |
26 |
9 |
24 |
12 |
17 |
18 |
23 |
4 |
5 |
12 |
13 |
21 |
22 |
10 |
12 |
4 |
5 |
12 |
27 |
4 |
19 |
4 |
19 |
4 |
16 |
4 |
5 |
19 |
34 |
4 |
19 |
4 |
5 |
12 |
13 |
14 |
4 |
28 |
5 |
19 |
11 |
12 |
18 |
15 |
17 |
23 |
27 |
24 |
26 |
8 |
9 |
22 |
23 |
24 |
4 |
5 |
9 |
11 |
6 |
8 |
4 |
5 |
16 |
21 |
22 |
8 |
15 |
4 |
5 |
11 |
12 |
14 |
15 |
4 |
5 |
17 |
18 |
20 |
21 |
6 |
7 |
12 |
13 |
16 | and
10 |
4 |
18 |
24 |
25 | Display style
11 |
17 |
4 |
16 |
5 |
15 |
6 |
7 |
8 |
9 |
14 |
4 |
17 |
11 |
14 |
15 |
16 |
5 |
6 |
7 |
8 |
12 |
17 |
23 |
24 |
7 |
8 |
17 |
6 |
30 |
7 |
28 |
8 |
9 |
19 |
20 |
27 |
4 |
22 |
5 |
21 | Granularity
7 |
20 |
4 |
20 |
5 |
19 | Order by
6 |
18 |
6 | Name
7 |
9 |
8 |
9 |
11 |
12 |
32 |
33 |
18 |
19 |
29 |
20 |
22 |
23 |
25 |
26 |
28 |
4 |
22 |
5 |
6 |
15 |
16 |
19 |
21 |
10 |
21 |
27 |
11 |
12 |
13 |
20 |
3 |
17 |
18 |
5 |
20 |
6 |
19 |
9 |
17 |
18 |
5 |
14 | `;
15 |
--------------------------------------------------------------------------------
/tests/__xlsx__/read_demo_xlsx.ts:
--------------------------------------------------------------------------------
1 | import { readFileSync } from "fs";
2 | import JsZip from "jszip";
3 | import { ImportedFiles } from "../../src/types/xlsx";
4 |
5 | const PATH = "./tests/__xlsx__/xlsx_demo_data.xlsx";
6 |
7 | export async function getTextXlsxFiles(): Promise
8 |
11 |
12 |
13 |
5 |
18 | `;
19 |
--------------------------------------------------------------------------------
/tests/composer/__snapshots__/composer_integration_component.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`Grid composer grid composer basic style Grid composer snapshot 1`] = `
4 |
8 |
17 |
11 |
15 |
16 |
8 |
28 | `;
29 |
--------------------------------------------------------------------------------
/tests/composer/__snapshots__/content_editable_helpers.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`ContentEditableHelper setText only applies a diff to the current content Adding some text 1`] = `
4 |
11 |
27 |
14 |
15 |
25 |
26 |
22 | A
23 |
24 |
5 |
11 | `;
12 |
13 | exports[`ContentEditableHelper setText only applies a diff to the current content Adding some text 2`] = `
14 | 6 | 7 | hello 8 | 9 |
10 |
15 |
24 | `;
25 |
26 | exports[`ContentEditableHelper setText only applies a diff to the current content Removing some text 1`] = `
27 | 16 | 17 | hello 18 | 19 | 20 | test 21 | 22 |
23 |
28 |
37 | `;
38 |
39 | exports[`ContentEditableHelper setText only applies a diff to the current content Removing some text 2`] = `
40 | 29 | 30 | hello 31 | 32 | 33 | test 34 | 35 |
36 |
41 |
47 | `;
48 |
--------------------------------------------------------------------------------
/tests/functions/module_engineering.test.ts:
--------------------------------------------------------------------------------
1 | import { evaluateCell } from "../test_helpers/helpers";
2 |
3 | describe("DELTA formula", () => {
4 | test("take 1 or 2 arguments", () => {
5 | expect(evaluateCell("A1", { A1: "=DELTA()" })).toBe("#BAD_EXPR");
6 | expect(evaluateCell("A1", { A1: "=DELTA(0)" })).toBe(1);
7 | expect(evaluateCell("A1", { A1: "=DELTA(0,0)" })).toBe(1);
8 | expect(evaluateCell("A1", { A1: "=DELTA(1,2,3)" })).toBe("#BAD_EXPR");
9 | });
10 |
11 | test.each([
12 | ["0", "1", 0],
13 | ["1", "1", 1],
14 | ["-1", "-1", 1],
15 | ])("delta value", (value1, value2, result) => {
16 | expect(evaluateCell("A1", { A1: "=DELTA(A2, A3)", A2: value1, A3: value2 })).toBe(result);
17 | });
18 |
19 | test("default value for arg 2 is 0", () => {
20 | expect(evaluateCell("A1", { A1: "=DELTA(0)" })).toBe(1);
21 | });
22 |
23 | test("empty cell are considered as 0", () => {
24 | expect(evaluateCell("A1", { A1: "=DELTA(A2)" })).toBe(1);
25 | });
26 | });
27 |
--------------------------------------------------------------------------------
/tests/helpers/positions_map.test.ts:
--------------------------------------------------------------------------------
1 | import { PositionMap } from "../../src/plugins/ui_core_views/cell_evaluation/position_map";
2 |
3 | describe("PositionMap", () => {
4 | test("set an element", () => {
5 | const map = new PositionMap42 | 43 | hello 44 | 45 |
46 |
8 |
24 | `;
25 |
--------------------------------------------------------------------------------
/tests/readme.md:
--------------------------------------------------------------------------------
1 | # Tests
2 |
3 | o-spreadsheet is a well tested library with a plethora of tests, using the Jest testing framework.
4 |
5 | ## Running tests
6 |
7 | ```bash
8 | # install dependencies
9 | npm install
10 | # run the test suite
11 | npm run test
12 | ```
13 |
14 | ## Writing tests guidelines
15 |
16 | - Tests should be located in `tests/` folder.
17 | - Test files should be suffixed by `.test.ts` (eg. `my_feature.test.ts`)
18 | - Test file name should be suffixed by `_component` or `_plugin` where this is relevant.
19 | - this means that a feature should split into separate files testing the components and the plugins
20 | - Test files for the same feature should be grouped inside a single folder
21 |
22 | Example:
23 |
24 | ```
25 | tests/
26 | ├─ find_and_replace/
27 | │ ├─ find_and_replace_plugin.test.ts
28 | │ ├─ find_and_replace_component.test.ts
29 | ├─ readme.md
30 | ```
31 |
32 | ## Owl Templates
33 |
34 | In an effort to run the tests faster, we pre-compile the owl templates before running the tests. This is done by running the `compileOwlTemplates` script in the `package.json` file. This script compiles all the owl templates in the `src` folder into the `tools/owl_templates/_compiled/owl_compiled_templates.cjs` file.
35 |
--------------------------------------------------------------------------------
/tests/setup/jest_global_setup.ts:
--------------------------------------------------------------------------------
1 | import { writeTemplatesToFile } from "../../tools/owl_templates/compile_templates.cjs";
2 |
3 | module.exports = function () {
4 | writeTemplatesToFile();
5 | };
6 |
--------------------------------------------------------------------------------
/tests/setup/jest_global_teardown.ts:
--------------------------------------------------------------------------------
1 | import { deleteCompiledTemplatesFile } from "../../tools/owl_templates/compile_templates.cjs";
2 |
3 | module.exports = function () {
4 | deleteCompiledTemplatesFile();
5 | };
6 |
--------------------------------------------------------------------------------
/tests/setup/polyfill.ts:
--------------------------------------------------------------------------------
1 | //@ts-ignore
2 | Object.groupBy ??= function (values, keyFinder) {
3 | // using reduce to aggregate values
4 | //@ts-ignore
5 | return values.reduce((a, b) => {
6 | // depending upon the type of keyFinder
7 | // if it is function, pass the value to it
8 | // if it is a property, access the property
9 | //@ts-ignore
10 | const key = typeof keyFinder === "function" ? keyFinder(b) : b[keyFinder];
11 |
12 | // aggregate values based on the keys
13 | if (!a[key]) {
14 | a[key] = [b];
15 | } else {
16 | a[key] = [...a[key], b];
17 | }
18 |
19 | return a;
20 | }, {});
21 | };
22 |
--------------------------------------------------------------------------------
/tests/setup/resize_observer.mock.ts:
--------------------------------------------------------------------------------
1 | class MockResizeObserver {
2 | public cb: Function;
3 | constructor(cb: Function) {
4 | this.cb = cb;
5 | }
6 | observe() {
7 | window.resizers.add(this);
8 | Promise.resolve().then(() => this.cb());
9 | }
10 |
11 | unobserve() {
12 | window.resizers.remove(this);
13 | }
14 |
15 | disconnect() {
16 | window.resizers.remove(this);
17 | }
18 | }
19 | window.ResizeObserver = MockResizeObserver;
20 |
21 | export class Resizers {
22 | private resizers: Set
11 |
23 |
14 | Error
15 |
16 |
21 |
22 |
5 |
51 | `;
52 |
--------------------------------------------------------------------------------
/tests/side_panels/building_blocks/__snapshots__/round_color_picker.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`Panel color picker Can render a panel color picker component 1`] = `
4 |
8 |
50 |
11 | Data series
12 |
13 |
14 |
17 |
48 |
49 |
20 |
34 |
35 |
36 |
23 |
30 |
31 |
32 |
33 |
39 |
44 |
45 |
46 |
47 |
5 |
15 | `;
16 |
--------------------------------------------------------------------------------
/tests/side_panels/building_blocks/error_section.test.ts:
--------------------------------------------------------------------------------
1 | import { ChartErrorSection } from "../../../src/components/side_panel/chart/building_blocks/error_section/error_section";
2 | import { mountComponent } from "../../test_helpers/helpers";
3 |
4 | let fixture: HTMLElement;
5 |
6 | async function mountChartErrorSection(props: ChartErrorSection["props"]) {
7 | ({ fixture } = await mountComponent(ChartErrorSection, { props }));
8 | }
9 |
10 | describe("Chart error section", () => {
11 | test("Can render a chart error section component", async () => {
12 | await mountChartErrorSection({
13 | messages: ["error_1", "error_2"],
14 | });
15 | expect(fixture).toMatchSnapshot();
16 | });
17 |
18 | test("Error section does not have a title", async () => {
19 | await mountChartErrorSection({
20 | messages: ["error_1", "error_2"],
21 | });
22 | expect(fixture.querySelector(".o-section-title")).toBeNull();
23 | });
24 |
25 | test("Messages are in error", async () => {
26 | await mountChartErrorSection({
27 | messages: ["error_1", "error_2"],
28 | });
29 | expect(fixture.querySelectorAll(".o-validation-error")).toHaveLength(2);
30 | });
31 | });
32 |
--------------------------------------------------------------------------------
/tests/side_panels/building_blocks/label_range.test.ts:
--------------------------------------------------------------------------------
1 | import { ChartLabelRange } from "../../../src/components/side_panel/chart/building_blocks/label_range/label_range";
2 | import { mountComponent } from "../../test_helpers/helpers";
3 |
4 | let fixture: HTMLElement;
5 |
6 | async function mountLabelRange(props: ChartLabelRange["props"]) {
7 | ({ fixture } = await mountComponent(ChartLabelRange, { props }));
8 | }
9 |
10 | describe("Label range", () => {
11 | test("Can render a label range component", async () => {
12 | await mountLabelRange({
13 | range: "A1:B1",
14 | isInvalid: false,
15 | onSelectionChanged: () => {},
16 | onSelectionConfirmed: () => {},
17 | });
18 | expect(fixture).toMatchSnapshot();
19 | });
20 |
21 | test("Can add options to the label range component", async () => {
22 | await mountLabelRange({
23 | range: "A1:B1",
24 | isInvalid: false,
25 | onSelectionChanged: () => {},
26 | onSelectionConfirmed: () => {},
27 | options: [
28 | {
29 | name: "my_option",
30 | label: "My option",
31 | value: true,
32 | onChange: () => {},
33 | },
34 | ],
35 | });
36 | expect(fixture).toMatchSnapshot();
37 | });
38 | });
39 |
--------------------------------------------------------------------------------
/tests/side_panels/components/__snapshots__/checkbox.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`Checkbox Can render a checkbox 1`] = `
4 |
8 |
12 |
13 |
14 |
5 |
14 |
15 | `;
16 |
--------------------------------------------------------------------------------
/tests/side_panels/components/__snapshots__/section.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`Section Can render a section with a title 1`] = `
4 |
5 |
26 | `;
27 |
28 | exports[`Section Can render a section without a title 1`] = `
29 |
8 |
25 |
11 |
24 |
14 | My title
15 |
16 |
17 |
20 | My content
21 |
22 |
23 |
30 |
46 | `;
47 |
--------------------------------------------------------------------------------
/tests/test_helpers/chart_helpers.ts:
--------------------------------------------------------------------------------
1 | import { Model, SpreadsheetChildEnv, UID } from "../../src";
2 | import { simulateClick } from "./dom_helper";
3 | import { nextTick } from "./helpers";
4 |
5 | export function isChartAxisStacked(model: Model, chartId: UID, axis: "x" | "y"): boolean {
6 | return getChartConfiguration(model, chartId).options?.scales?.[axis]?.stacked;
7 | }
8 |
9 | export function getChartConfiguration(model: Model, chartId: UID) {
10 | const runtime = model.getters.getChartRuntime(chartId) as any;
11 | return runtime.chartJsConfig;
12 | }
13 |
14 | export async function openChartConfigSidePanel(model: Model, env: SpreadsheetChildEnv, id: UID) {
15 | model.dispatch("SELECT_FIGURE", { id });
16 | env.openSidePanel("ChartPanel");
17 | await nextTick();
18 | }
19 |
20 | export async function openChartDesignSidePanel(
21 | model: Model,
22 | env: SpreadsheetChildEnv,
23 | fixture: HTMLElement,
24 | id: UID
25 | ) {
26 | if (!fixture.querySelector(".o-chart")) {
27 | await openChartConfigSidePanel(model, env, id);
28 | }
29 | await simulateClick(".o-panel-element.inactive");
30 | }
31 |
--------------------------------------------------------------------------------
/tests/test_helpers/index.ts:
--------------------------------------------------------------------------------
1 | export * from "./commands_helpers";
2 | export * from "./dom_helper";
3 | export * from "./getters_helpers";
4 | export * from "./mock_helpers";
5 |
--------------------------------------------------------------------------------
/tests/test_helpers/stores.ts:
--------------------------------------------------------------------------------
1 | import { Model } from "../../src";
2 | import { DependencyContainer, StoreConstructor, StoreParams } from "../../src/store_engine";
3 | import { ModelStore } from "../../src/stores";
4 | import { NotificationStore } from "../../src/stores/notification_store";
5 | import { makeTestNotificationStore } from "./helpers";
6 |
7 | export function makeStore
33 |
45 |
36 |
37 |
44 |
40 | My content
41 |
42 |
43 |