CodeChatEditor-test.mts

// Copyright (C) 2023 Bryan A. Jones.
//
// This file is part of the CodeChat Editor. The CodeChat Editor is free
// software: you can redistribute it and/or modify it under the terms of the GNU
// General Public License as published by the Free Software Foundation, either
// version 3 of the License, or (at your option) any later version.
//
// The CodeChat Editor is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// the CodeChat Editor. If not, see
// [http://www.gnu.org/licenses](http://www.gnu.org/licenses).
//
// # `CodeChatEditor-test.mts` -- Tests for the CodeChat Editor client
//
// To run tests, add a `?test` to any web page served by the CodeChat Editor
// server.
//
// ## Imports
//
// I can't get Mocha to work with ESBuild, so I import it using a script tag.
import { assert } from "chai";
import { exportedForTesting, page_init } from "./CodeChatEditor.mjs";

// Re-export everything that [CodeChatEditor.mts](CodeChatEditor.mts) exports.
// Otherwise, including [CodeChatEditor.mts](CodeChatEditor.mts) elsewhere would
// double-define everything (producing complaints about two attempts to define
// each web component).
export { page_init };
// Provide convenient access to all functions tested here.
const { codechat_html_to_markdown } = exportedForTesting;

// ## Tests
//
// <a id="CodeChatEditor_test"></a>Defining this global variable signals the
// CodeChat Editor to [run tests](CodeChatEditor.mts#CodeChatEditor_test).
window.CodeChatEditor_test = () => {
    // See the [Mocha docs](https://mochajs.org/#browser-configuration).
    mocha.setup({
        ui: "tdd",
        // This is required to use Mocha's global teardown from the browser,
        // AFAIK.
        /// @ts-ignore
        globalTeardown: [
            () => {
                // On teardown, put the Mocha div at the beginning of the body.
                // Testing causes body to be wiped, so don't do this until all
                // tests are done.
                const mocha_div = document.getElementById("mocha")!;
                const ccb = document.getElementById("CodeChat-body")!;
                ccb.insertBefore(mocha_div, ccb.firstChild);
            },
        ],
    });

    // Define some tests. See the [Mocha TDD docs](https://mochajs.org/#tdd) and
    // the [Chai assert API](https://www.chaijs.com/api/assert/).
    suite("CodeChatEditor.mts", function () {
        suite("codechat_html_to_markdown", function () {
            test("Translate an empty comment", async function () {
                const db: [DocBlockJSON] = [[0, 0, "", "//", ""]];
                const source = {
                    doc_blocks: db,
                };
                await codechat_html_to_markdown(source);
                assert.deepEqual(source, {
                    doc_blocks: [[0, 0, "", "//", "\n"]],
                });
            });

            test("Translate non-breaking space", async function () {
                const db: [DocBlockJSON] = [[0, 0, "", "//", "&nbsp;"]];
                const source = {
                    doc_blocks: db,
                };
                await codechat_html_to_markdown(source);
                assert.deepEqual(source, {
                    doc_blocks: [[0, 0, "", "//", "\n"]],
                });
            });

            test("Translate two empty comments", async function () {
                const db: DocBlockJSON[] = [
                    [0, 0, "", "//", ""],
                    [2, 2, "", "//", ""],
                ];
                const source = {
                    doc_blocks: db,
                };
                await codechat_html_to_markdown(source);
                assert.deepEqual(source, {
                    doc_blocks: [
                        [0, 0, "", "//", "\n"],
                        [2, 2, "", "//", "\n"],
                    ],
                });
            });

            test("Translate unclosed HTML", async function () {
                const db: DocBlockJSON[] = [
                    [0, 0, "", "//", "<h1><u>A<u></h1>\n"],
                    [2, 2, "", "//", "<h2>Ax</h2>"],
                ];
                const source = {
                    doc_blocks: db,
                };
                await codechat_html_to_markdown(source);
                assert.deepEqual(source, {
                    doc_blocks: [
                        [0, 0, "", "//", "# <u>A<u></u></u>\n\n<u><u>\n"],
                        [2, 2, "", "//", "<h2>Ax</h2></u></u>\n"],
                    ],
                });
            });
        });
    });

    // Avoid an infinite loop of tests calling this again.
    delete window.CodeChatEditor_test;
    mocha.run();
};