test.js

"use strict";
import * as utils from "../utils.js";
import { Video } from "../video.js";
import * as fdc from "../fdc.js";
import * as Tokeniser from "../basic-tokenise.js";
import { fake6502 } from "../fake6502.js";
import { findModel } from "../models.js";

var processor;
var video;
var MaxCyclesPerIter = 100 * 1000;
var hexword = utils.hexword;
var failures = 0;
var anyFailures = false;
var log, beginTest, endTest;

// TODO, should really use a consistent test harness for this...
var tests = [
    { test: "Test NOPs", func: testNops, model: "Master" },
    { test: "Test RMX.x (65C12)", func: testRmw, model: "Master" },
    { test: "Test RMW,x (6502)", func: testRmw },
    { test: "Test BCD (65C12)", func: testBCD, model: "Master" },
    { test: "Test BCD (6502)", func: testBCD },
    { test: "Test timings", func: testTimings },
    {
        test: "Alien8 protection",
        func: function () {
            return testKevinEdwards("ALIEN8");
        },
    },
    {
        test: "Nightshade protection",
        func: function () {
            return testKevinEdwards("NIGHTSH");
        },
    },
    {
        test: "Lunar Jetman protection",
        func: function () {
            return testKevinEdwards("JETMAN");
        },
    },
];

export function run(log_, beginTest_, endTest_, frameBuffer, paint) {
    log = log_;
    beginTest = beginTest_;
    endTest = endTest_;
    video = new Video(false, frameBuffer, paint);

    return tests
        .reduce(function (p, test) {
            return p.then(function () {
                return runTest(test.test, test.func, test.model);
            });
        }, Promise.resolve())
        .then(function () {
            return anyFailures;
        })
        .catch(function (err) {
            anyFailures = true;
            log(err);
        });
}

function runFor(cycles) {
    var left = cycles;
    var stopped = false;
    return new Promise(function (resolve) {
        var runAnIter = function () {
            var todo = Math.max(0, Math.min(left, MaxCyclesPerIter));
            if (todo) {
                stopped = !processor.execute(todo);
                left -= todo;
            }
            if (left && !stopped) {
                setTimeout(runAnIter, 0);
            } else {
                resolve();
            }
        };
        runAnIter();
    });
}

export function runUntilInput(secs) {
    if (!secs) secs = 120;
    log("Running until keyboard input requested");
    var idleAddr = processor.model.isMaster ? 0xe7e6 : 0xe581;
    var hit = false;
    var hook = processor.debugInstruction.add(function (addr) {
        if (addr === idleAddr) {
            hit = true;
            return true;
        }
    });
    return runFor(secs * 2 * 1000 * 1000).then(function () {
        hook.remove();
        if (!hit) log("Failed to hit breakpoint");
        return runFor(10 * 1000);
    });
}

function runUntilAddress(targetAddr, maxInstr) {
    log("Running until $" + hexword(targetAddr));
    var hit = false;
    var hook = processor.debugInstruction.add(function (addr) {
        if (addr === targetAddr) {
            hit = true;
            return true;
        }
    });
    return runFor(maxInstr).then(function () {
        hook.remove();
        return hit;
    });
}

export function type(text) {
    log("Typing '" + text + "'");
    var cycles = 40 * 1000;

    function kd(ch) {
        processor.sysvia.keyDown(ch);
        return runFor(cycles).then(function () {
            processor.sysvia.keyUp(ch);
            return runFor(cycles);
        });
    }

    function typeChar(ch) {
        var shift = false;
        if (ch === '"') {
            ch = 50;
            shift = true;
        } else if (ch === "*") {
            ch = utils.keyCodes.APOSTROPHE;
            shift = true;
        } else if (ch === ".") {
            ch = utils.keyCodes.PERIOD;
        } else ch = ch.toUpperCase().charCodeAt(0);
        if (shift) {
            processor.sysvia.keyDown(16);
            return runFor(cycles).then(function () {
                return kd(ch).then(function () {
                    processor.sysvia.keyUp(16);
                    return runFor(cycles);
                });
            });
        } else {
            return kd(ch);
        }
    }

    return text
        .split("")
        .reduce(function (p, char) {
            return p.then(function () {
                return typeChar(char);
            });
        }, Promise.resolve())
        .then(function () {
            return kd(13);
        });
}

var currentTest = null;

log = function () {
    console.log.apply(console, arguments);
    var msg = Array.prototype.join.call(arguments, " ");
    if (currentTest) {
        currentTest.find(".template").clone().removeClass("template").text(msg).appendTo(currentTest);
    }
};

function expectEq(expected, actual, msg) {
    if (actual !== expected) {
        log(msg, "failure - actual", hexword(actual), "expected", hexword(expected));
        failures++;
    }
}

function testTimings() {
    // prettier-ignore
    var expected = [
        0x4436, 0x00, 0xDD,
        0x4443, 0x00, 0xDD,
        0x4450, 0x00, 0xDD,
        0x445E, 0x00, 0xDD,
        0x0000, 0x00, 0x00,
        0x0000, 0x00, 0x00,
        0x4488, 0x00, 0xFF,
        0x4497, 0x00, 0x00,
        0x0000, 0x00, 0x00,
        0x44B8, 0xC0, 0xFF,
        0x44C5, 0xC0, 0xFF,
        0x0000, 0x00, 0x00,
        0x0000, 0x00, 0x00,
        0x44F6, 0xC0, 0xDB,
        0x4506, 0xC0, 0xDC,
        0x4516, 0xC0, 0xFF,
        0x4527, 0xC0, 0x00,
        0x453A, 0xC0, 0x01,
        0x454A, 0xC0, 0x01,
        0x4559, 0xC0, 0x00,
        0x4569, 0xC0, 0x00,
        0x4578, 0xC0, 0x01,
        0x458A, 0xC0, 0xFF,
        0x4599, 0xC0, 0x00,
        0x45A6, 0xC0, 0x00,
        0x0000, 0x00, 0x00,
    ];
    return fdc
        .load("discs/TestTimings.ssd")
        .then(function (data) {
            processor.fdc.loadDisc(0, fdc.discFor(processor.fdc, "", data));
            return runUntilInput();
        })
        .then(function () {
            return type('CHAIN "TEST"');
        })
        .then(runUntilInput)
        .then(function () {
            var num = processor.readmem(0x71) + 1;
            expectEq(expected.length / 3, num, "Different number of timings");
            for (var i = 0; i < num; ++i) {
                var irqAddr = (processor.readmem(0x4300 + i) << 8) | processor.readmem(0x4000 + i);
                var a = processor.readmem(0x4100 + i);
                var b = processor.readmem(0x4200 + i);
                expectEq(expected[i * 3 + 0], irqAddr, "IRQ address wrong at " + i);
                expectEq(expected[i * 3 + 1], a, "A differed at " + i);
                expectEq(expected[i * 3 + 2], b, "B differed at " + i);
            }
        });
}

function Capturer(cpu, onElement) {
    var attributes = {
        x: 0,
        y: 0,
        text: "",
        foreground: 7,
        background: 0,
        mode: 7,
    };
    var currentText = "";
    var params = [];
    var nextN = 0;
    var vduProc = null;

    function flush() {
        if (currentText.length) {
            attributes.text = currentText;
            onElement(attributes);
            attributes.x += currentText.length; // Approximately...anyway
        }
        currentText = "";
    }

    function onChar(c) {
        if (nextN) {
            params.push(c);
            if (--nextN === 0) {
                if (vduProc) vduProc(params);
                params = [];
                vduProc = null;
            }
            return;
        }
        switch (c) {
            case 1: // Next char to printer
                nextN = 1;
                break;
            case 10:
                attributes.y++;
                break;
            case 12: // CLS
                attributes.x = 0;
                attributes.y = 0;
                break;
            case 13:
                attributes.x = 0;
                break;
            case 17: // Text colour
                nextN = 1;
                vduProc = function (params) {
                    if (params[0] & 0x80) attributes.background = params[0] & 0xf;
                    else attributes.foreground = params[0] & 0xf;
                };
                break;
            case 18: // GCOL
                nextN = 2;
                break;
            case 19: // logical colour
                nextN = 5;
                break;
            case 22: // mode
                nextN = 1;
                vduProc = function (params) {
                    attributes.mode = params[0];
                    attributes.x = 0;
                    attributes.y = 0;
                };
                break;
            case 25: // plot
                nextN = 5;
                break;
            case 28: // text window
                nextN = 4;
                break;
            case 29: // origin
                nextN = 4;
                break;
            case 31: // text location
                nextN = 2;
                vduProc = function (params) {
                    attributes.x = params[0];
                    attributes.y = params[1];
                };
        }
        if (c >= 32 && c < 0x7f) {
            currentText += String.fromCharCode(c);
        } else flush();
        return false;
    }

    processor.debugInstruction.add(function (addr) {
        var wrchv = processor.readmem(0x20e) | (processor.readmem(0x20f) << 8);
        if (addr === wrchv) onChar(processor.a);
        return false;
    });

    return this;
}

function testNops() {
    var numCaptures = 0;
    return Promise.all([utils.loadData("tests/unit/nops.bas"), Tokeniser.create(), runUntilInput()])
        .then(function (results) {
            var data = utils.uint8ArrayToString(results[0]);
            var tokeniser = results[1];
            return tokeniser.tokenise(data);
        })
        .then(function (tokenised) {
            // TODO: dedupe from main.js
            var page = processor.readmem(0x18) << 8;
            for (var i = 0; i < tokenised.length; ++i) {
                processor.writemem(page + i, tokenised.charCodeAt(i));
            }
            // Set VARTOP (0x12/3) and TOP(0x02/3)
            var end = page + tokenised.length;
            var endLow = end & 0xff;
            var endHigh = (end >>> 8) & 0xff;
            processor.writemem(0x02, endLow);
            processor.writemem(0x03, endHigh);
            processor.writemem(0x12, endLow);
            processor.writemem(0x13, endHigh);
            new Capturer(processor, function (elem) {
                if (elem.background === 1) {
                    log("ERROR: " + JSON.stringify(elem));
                    failures++;
                } else {
                    log("Emulation> " + elem.text);
                }
                numCaptures++;
            });
            return type("RUN");
        })
        .then(function () {
            return runUntilInput(5 * 60);
        })
        .then(function () {
            if (numCaptures !== 97) {
                log("Missing output (" + numCaptures + ")");
                failures++;
            } else {
                log("Pass!");
            }
        });
}

function testRmw() {
    return fdc
        .load("discs/RmwX.ssd")
        .then(function (data) {
            processor.fdc.loadDisc(0, fdc.discFor(processor.fdc, "", data));
            return runUntilInput();
        })
        .then(function () {
            return type("*TIMINGS");
        })
        .then(runUntilInput)
        .then(function () {
            var result = "";
            for (var i = 0x100; i < 0x110; i += 4) {
                if (i !== 0x100) result += " ";
                for (var j = 3; j >= 0; --j) {
                    result += utils.hexbyte(processor.readmem(i + j));
                }
            }
            var expected = processor.model.isMaster
                ? "f4ff0a16 eaeadee9 f2fe0a16 c3ced9e5"
                : "f2fe0a16 eaeadae6 f2fe0a16 c1cdd9e5";
            if (result !== expected) {
                log("failed! got:\n" + result + " expected:\n" + expected);
                failures++;
            }
        });
}

function testBCD() {
    var output = "";
    var hook;
    return fdc
        .load("discs/bcdtest.ssd")
        .then(function (data) {
            processor.fdc.loadDisc(0, fdc.discFor(processor.fdc, "", data));
            return runUntilInput();
        })
        .then(function () {
            return type("*BCDTEST");
        })
        .then(function () {
            var printAddr = processor.model.isMaster ? 0xce52 : 0xc4c0;
            hook = processor.debugInstruction.add(function (addr) {
                if (addr === printAddr) {
                    output += String.fromCharCode(processor.a);
                }
            });
            return runUntilInput();
        })
        .then(function () {
            hook.remove();
            if (output.indexOf("PASSED") < 0) {
                log("Failed: ", output);
                failures++;
            }
        });
}

function testKevinEdwards(name) {
    // Well, at least his protection system...
    return fdc
        .load("discs/Protection.ssd")
        .then(function (data) {
            processor.fdc.loadDisc(0, fdc.discFor(processor.fdc, "", data));
            return runUntilInput();
        })
        .then(function () {
            return type('CHAIN "B.' + name + '"');
        })
        .then(function () {
            var hook = processor.debugInstruction.add(function (addr) {
                if (addr === 0xfff4 && processor.a === 200 && processor.x === 3) {
                    log("Failed");
                    return true;
                }
                return false;
            });
            return runUntilAddress(0xe00, 100 * 1000 * 1000).then(function (hit) {
                hook.remove();
                expectEq(true, hit, "Decoded and hit end of protection");
            });
        });
}

function runTest(name, func, model) {
    model = model || "B";
    log("Running", name);
    beginTest(name);
    processor = fake6502(findModel(model), { video: video });
    failures = 0;
    return processor
        .initialise()
        .then(func)
        .then(function () {
            log("Finished", name);
            if (failures) anyFailures = true;
            endTest(name, failures);
        })
        .catch(function (err) {
            log("Caught error in", name, err, err.stack);
            anyFailures = true;
            endTest(name, true);
        });
}