browser/src/run_tests.zig

// Copyright (C) 2023-2024  Lightpanda (Selecy SAS)
//
// Francis Bouvier <francis@lightpanda.io>
// Pierre Tachoire <pierre@lightpanda.io>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

const std = @import("std");
const builtin = @import("builtin");

const jsruntime = @import("jsruntime");
const generate = @import("generate.zig");
const pretty = @import("pretty");

const parser = @import("netsurf");
const apiweb = @import("apiweb.zig");
const Window = @import("html/window.zig").Window;
const xhr = @import("xhr/xhr.zig");
const storage = @import("storage/storage.zig");
const url = @import("url/url.zig");
const urlquery = @import("url/query.zig");
const Client = @import("asyncio").Client;

const documentTestExecFn = @import("dom/document.zig").testExecFn;
const HTMLDocumentTestExecFn = @import("html/document.zig").testExecFn;
const nodeTestExecFn = @import("dom/node.zig").testExecFn;
const characterDataTestExecFn = @import("dom/character_data.zig").testExecFn;
const textTestExecFn = @import("dom/text.zig").testExecFn;
const elementTestExecFn = @import("dom/element.zig").testExecFn;
const HTMLCollectionTestExecFn = @import("dom/html_collection.zig").testExecFn;
const DOMExceptionTestExecFn = @import("dom/exceptions.zig").testExecFn;
const DOMImplementationExecFn = @import("dom/implementation.zig").testExecFn;
const NamedNodeMapExecFn = @import("dom/namednodemap.zig").testExecFn;
const DOMTokenListExecFn = @import("dom/token_list.zig").testExecFn;
const NodeListTestExecFn = @import("dom/nodelist.zig").testExecFn;
const AttrTestExecFn = @import("dom/attribute.zig").testExecFn;
const EventTargetTestExecFn = @import("dom/event_target.zig").testExecFn;
const ProcessingInstructionTestExecFn = @import("dom/processing_instruction.zig").testExecFn;
const CommentTestExecFn = @import("dom/comment.zig").testExecFn;
const DocumentFragmentTestExecFn = @import("dom/document_fragment.zig").testExecFn;
const EventTestExecFn = @import("events/event.zig").testExecFn;
const XHRTestExecFn = xhr.testExecFn;
const ProgressEventTestExecFn = @import("xhr/progress_event.zig").testExecFn;
const StorageTestExecFn = storage.testExecFn;
const URLTestExecFn = url.testExecFn;
const HTMLElementTestExecFn = @import("html/elements.zig").testExecFn;
const MutationObserverTestExecFn = @import("dom/mutation_observer.zig").testExecFn;

pub const Types = jsruntime.reflect(apiweb.Interfaces);
pub const UserContext = @import("user_context.zig").UserContext;
pub const IO = @import("asyncio").Wrapper(jsruntime.Loop);

var doc: *parser.DocumentHTML = undefined;

fn testExecFn(
    alloc: std.mem.Allocator,
    js_env: *jsruntime.Env,
    comptime execFn: jsruntime.ContextExecFn,
) anyerror!void {
    try parser.init();
    defer parser.deinit();

    // start JS env
    try js_env.start();
    defer js_env.stop();

    var storageShelf = storage.Shelf.init(alloc);
    defer storageShelf.deinit();

    // document
    const file = try std.fs.cwd().openFile("test.html", .{});
    defer file.close();

    doc = try parser.documentHTMLParse(file.reader(), "UTF-8");
    defer parser.documentHTMLClose(doc) catch |err| {
        std.debug.print("documentHTMLClose error: {s}\n", .{@errorName(err)});
    };

    var cli = Client{ .allocator = alloc };
    defer cli.deinit();

    try js_env.setUserContext(.{
        .document = doc,
        .httpClient = &cli,
    });

    // alias global as self and window
    var window = Window.create(null, null);

    try window.replaceDocument(doc);
    window.setStorageShelf(&storageShelf);

    try js_env.bindGlobal(window);

    // run test
    try execFn(alloc, js_env);
}

fn testsAllExecFn(
    alloc: std.mem.Allocator,
    js_env: *jsruntime.Env,
) anyerror!void {
    const testFns = [_]jsruntime.ContextExecFn{
        documentTestExecFn,
        HTMLDocumentTestExecFn,
        nodeTestExecFn,
        characterDataTestExecFn,
        textTestExecFn,
        elementTestExecFn,
        HTMLCollectionTestExecFn,
        DOMExceptionTestExecFn,
        DOMImplementationExecFn,
        NamedNodeMapExecFn,
        DOMTokenListExecFn,
        NodeListTestExecFn,
        AttrTestExecFn,
        CommentTestExecFn,
        DocumentFragmentTestExecFn,
        EventTargetTestExecFn,
        EventTestExecFn,
        XHRTestExecFn,
        ProgressEventTestExecFn,
        ProcessingInstructionTestExecFn,
        StorageTestExecFn,
        URLTestExecFn,
        HTMLElementTestExecFn,
        MutationObserverTestExecFn,
        @import("polyfill/fetch.zig").testExecFn,
        @import("html/navigator.zig").testExecFn,
        @import("html/history.zig").testExecFn,
        @import("html/location.zig").testExecFn,
    };

    inline for (testFns) |testFn| {
        try testExecFn(alloc, js_env, testFn);
    }
}

const usage =
    \\usage: test [options]
    \\  Run the tests. By default the command will run both js and unit tests.
    \\
    \\  -h, --help       Print this help message and exit.
    \\  --browser        run only browser js tests
    \\  --unit           run only js unit tests
    \\  --json           bench result is formatted in JSON.
    \\                   only browser tests are benchmarked.
    \\
;

// Out list all the ouputs handled by benchmark result and written on stdout.
const Out = enum {
    text,
    json,
};

// Which tests must be run.
const Run = enum {
    all,
    browser,
    unit,
};

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();
    const gpa_alloc = gpa.allocator();

    var args = try std.process.argsWithAllocator(gpa_alloc);
    defer args.deinit();

    // ignore the exec name.
    _ = args.next().?;

    var out: Out = .text;
    var run: Run = .all;

    while (args.next()) |arg| {
        if (std.mem.eql(u8, "-h", arg) or std.mem.eql(u8, "--help", arg)) {
            try std.io.getStdErr().writer().print(usage, .{});
            std.posix.exit(0);
        }
        if (std.mem.eql(u8, "--json", arg)) {
            out = .json;
            continue;
        }
        if (std.mem.eql(u8, "--browser", arg)) {
            run = .browser;
            continue;
        }
        if (std.mem.eql(u8, "--unit", arg)) {
            run = .unit;
            continue;
        }
    }

    // run js tests
    if (run == .all or run == .browser) try run_js(out);

    // run standard unit tests.
    if (run == .all or run == .unit) {
        std.debug.print("\n", .{});
        for (builtin.test_functions) |test_fn| {
            try parser.init();
            defer parser.deinit();

            try test_fn.func();
            std.debug.print("{s}\tOK\n", .{test_fn.name});
        }
    }
}

// Run js test and display the output depending of the output parameter.
fn run_js(out: Out) !void {
    var bench_alloc = jsruntime.bench_allocator(std.testing.allocator);

    const start = try std.time.Instant.now();

    // run js exectuion tests
    try testJSRuntime(bench_alloc.allocator());

    const duration = std.time.Instant.since(try std.time.Instant.now(), start);
    const stats = bench_alloc.stats();

    // get and display the results
    if (out == .json) {
        const res = [_]struct {
            name: []const u8,
            bench: struct {
                duration: u64,

                alloc_nb: usize,
                realloc_nb: usize,
                alloc_size: usize,
            },
        }{
            .{ .name = "browser", .bench = .{
                .duration = duration,
                .alloc_nb = stats.alloc_nb,
                .realloc_nb = stats.realloc_nb,
                .alloc_size = stats.alloc_size,
            } },
            // TODO get libdom bench info.
            .{ .name = "libdom", .bench = .{
                .duration = duration,
                .alloc_nb = 0,
                .realloc_nb = 0,
                .alloc_size = 0,
            } },
            // TODO get v8 bench info.
            .{ .name = "v8", .bench = .{
                .duration = duration,
                .alloc_nb = 0,
                .realloc_nb = 0,
                .alloc_size = 0,
            } },
            // TODO get main bench info.
            .{ .name = "main", .bench = .{
                .duration = duration,
                .alloc_nb = 0,
                .realloc_nb = 0,
                .alloc_size = 0,
            } },
        };

        try std.json.stringify(res, .{ .whitespace = .indent_2 }, std.io.getStdOut().writer());
        return;
    }

    // display console result by default
    const dur = pretty.Measure{ .unit = "ms", .value = duration / ms };
    const size = pretty.Measure{ .unit = "kb", .value = stats.alloc_size / kb };

    const zerosize = pretty.Measure{ .unit = "kb", .value = 0 };

    // benchmark table
    const row_shape = .{ []const u8, pretty.Measure, u64, u64, pretty.Measure };
    const table = try pretty.GenerateTable(4, row_shape, pretty.TableConf{ .margin_left = "  " });
    const header = .{ "FUNCTION", "DURATION", "ALLOCATIONS (nb)", "RE-ALLOCATIONS (nb)", "HEAP SIZE" };
    var t = table.init("Benchmark lightpanda 🚀", header);
    try t.addRow(.{ "browser", dur, stats.alloc_nb, stats.realloc_nb, size });
    try t.addRow(.{ "libdom", dur, 0, 0, zerosize }); // TODO get libdom bench info.
    try t.addRow(.{ "v8", dur, 0, 0, zerosize }); // TODO get v8 bench info.
    try t.addRow(.{ "main", dur, 0, 0, zerosize }); // TODO get main bench info.
    try t.render(std.io.getStdOut().writer());
}

const kb = 1024;
const ms = std.time.ns_per_ms;

test {
    const msgTest = @import("msg.zig");
    std.testing.refAllDecls(msgTest);

    const dumpTest = @import("browser/dump.zig");
    std.testing.refAllDecls(dumpTest);

    const mimeTest = @import("browser/mime.zig");
    std.testing.refAllDecls(mimeTest);

    const cssTest = @import("css/css.zig");
    std.testing.refAllDecls(cssTest);

    const cssParserTest = @import("css/parser.zig");
    std.testing.refAllDecls(cssParserTest);

    const cssMatchTest = @import("css/match_test.zig");
    std.testing.refAllDecls(cssMatchTest);

    const cssLibdomTest = @import("css/libdom_test.zig");
    std.testing.refAllDecls(cssLibdomTest);

    const queryTest = @import("url/query.zig");
    std.testing.refAllDecls(queryTest);

    std.testing.refAllDecls(@import("cdp/msg.zig"));
}

fn testJSRuntime(alloc: std.mem.Allocator) !void {
    // generate tests
    try generate.tests();

    // create JS vm
    const vm = jsruntime.VM.init();
    defer vm.deinit();

    var arena_alloc = std.heap.ArenaAllocator.init(alloc);
    defer arena_alloc.deinit();

    try jsruntime.loadEnv(&arena_alloc, null, testsAllExecFn);
}

test "DocumentHTMLParseFromStr" {
    const file = try std.fs.cwd().openFile("test.html", .{});
    defer file.close();

    const str = try file.readToEndAlloc(std.testing.allocator, std.math.maxInt(u32));
    defer std.testing.allocator.free(str);

    doc = try parser.documentHTMLParseFromStr(str);
    parser.documentHTMLClose(doc) catch {};
}

// https://github.com/lightpanda-io/libdom/issues/4
test "bug document html parsing #4" {
    const file = try std.fs.cwd().openFile("tests/html/bug-html-parsing-4.html", .{});
    defer file.close();

    doc = try parser.documentHTMLParse(file.reader(), "UTF-8");
    parser.documentHTMLClose(doc) catch {};
}

test "Window is a libdom event target" {
    var window = Window.create(null, null);

    const event = try parser.eventCreate();
    try parser.eventInit(event, "foo", .{});

    const et = parser.toEventTarget(Window, &window);
    _ = try parser.eventTargetDispatchEvent(et, event);
}

test "DocumentHTML is a libdom event target" {
    doc = try parser.documentHTMLParseFromStr("<body></body>");
    parser.documentHTMLClose(doc) catch {};

    const event = try parser.eventCreate();
    try parser.eventInit(event, "foo", .{});

    const et = parser.toEventTarget(parser.DocumentHTML, doc);
    _ = try parser.eventTargetDispatchEvent(et, event);
}

test "XMLHttpRequest.validMethod" {
    // valid methods
    for ([_][]const u8{ "get", "GET", "head", "HEAD" }) |tc| {
        _ = try xhr.XMLHttpRequest.validMethod(tc);
    }

    // forbidden
    for ([_][]const u8{ "connect", "CONNECT" }) |tc| {
        try std.testing.expectError(parser.DOMError.Security, xhr.XMLHttpRequest.validMethod(tc));
    }

    // syntax
    for ([_][]const u8{ "foo", "BAR" }) |tc| {
        try std.testing.expectError(parser.DOMError.Syntax, xhr.XMLHttpRequest.validMethod(tc));
    }
}