@fboes/aerofly-custom-missions/src/index.test.ts

Builder for Aerofly FS4 Custom Missions Files

import { strict as assert } from "node:assert";
import { AeroflyConfigFileSet } from "./dto/AeroflyConfigFileSet.js";
import { AeroflyLocalizedText } from "./index.js";
import { AeroflyMission } from "./index.js";
import { AeroflyMissionCheckpoint } from "./index.js";
import { AeroflyMissionConditions } from "./index.js";
import { AeroflyMissionConditionsCloud } from "./index.js";
import { AeroflyMissionsList } from "./index.js";
import { AeroflyMissionTargetPlane } from "./index.js";

const assertValidAeroflyStructure = (aeroflyString: string): void => {
    const openingBrackets = aeroflyString.match(/</g);
    const closingBrackets = aeroflyString.match(/>/g);
    const openingBrackets2 = aeroflyString.match(/\[/g);
    const closingBrackets2 = aeroflyString.match(/\]/g);

    assert.strictEqual(openingBrackets?.length, closingBrackets?.length, "Number of <> matches");
    assert.strictEqual(openingBrackets2?.length, closingBrackets2?.length, "Number of [] matches");
};

const assertIncludes = (string: string, includes: string): void => {
    assert.ok(string.includes(includes), `Includes "${includes}"`);
};

{
    const file = new AeroflyConfigFileSet(0, "file", "");
    file.pushRaw(
        new AeroflyConfigFileSet(1, "tmmissions_list", "")
            .pushRaw(
                new AeroflyConfigFileSet(2, "list_tmmission_definition", "missions")
                    .pushRaw(
                        new AeroflyConfigFileSet(3, "tmmission_definition", "mission")
                            .push("string8", "title", "KCCR #1: Concord / Buchanan Field")
                            .push("float64", "origin_alt", 1066.799965862401, "3500 ft MSL")
                            .toString(),
                    )
                    .pushRaw(new AeroflyConfigFileSet(3, "tmmission_definition", "mission").toString())
                    .toString(),
            )
            .toString(),
    );
    assertValidAeroflyStructure(file.toString());
    console.log("✅ AeroflyMission test successful");
}

{
    const mission = new AeroflyMission("Title", {
        origin: {
            icao: "XXXX",
            longitude: 0,
            latitude: 0,
            dir: 0,
            alt: 0,
        },
        destination: {
            icao: "XXXX",
            longitude: 0,
            latitude: 0,
            dir: 0,
            alt: 0,
        },
    });
    assert.deepStrictEqual(mission.title, "Title");
    assertValidAeroflyStructure(mission.toString());
    //console.log(mission.toString());
    console.log("✅ AeroflyMission test successful");
}

{
    const conditions = new AeroflyMissionConditions();
    conditions.visibility = 15_000;
    assert.deepStrictEqual(conditions.visibility, 15_000);

    conditions.visibility_sm = 10;
    assert.notDeepStrictEqual(conditions.visibility, 10);
    assert.deepStrictEqual(Math.round(conditions.visibility_sm), 10);
    assertValidAeroflyStructure(conditions.toString());
    console.log("✅ AeroflyMissionConditions test successful");
}

{
    const conditions = new AeroflyMissionConditions({
        visibility: 15_000,
    });
    assert.deepStrictEqual(conditions.visibility, 15_000);
    assertValidAeroflyStructure(conditions.toString());
    console.log("✅ AeroflyMissionConditions test successful");
}

{
    const conditions = new AeroflyMissionConditions({
        visibility_sm: 10,
    });
    assert.notDeepStrictEqual(conditions.visibility, 10);
    assert.deepStrictEqual(Math.round(conditions.visibility_sm), 10);
    assertValidAeroflyStructure(conditions.toString());
    console.log("✅ AeroflyMissionConditions test successful");
}

{
    const cloud = new AeroflyMissionConditionsCloud(0, 0);
    assert.deepStrictEqual(cloud.cover, 0);
    assert.deepStrictEqual(cloud.base, 0);
    assertValidAeroflyStructure(cloud.toString());
    assertValidAeroflyStructure(cloud.toString(0));
    assertValidAeroflyStructure(cloud.toString(1));
    assertValidAeroflyStructure(cloud.toString(2));
    assertValidAeroflyStructure(cloud.toString(3));

    console.log("✅ AeroflyMissionConditionsCloud test successful");
}

{
    const cloud = new AeroflyMissionConditionsCloud(1, 1000);
    assert.deepStrictEqual(cloud.cover, 1);
    assert.deepStrictEqual(cloud.base, 1000);

    cloud.base_feet = 1000;
    assert.notDeepStrictEqual(cloud.base, 1000);
    assert.deepStrictEqual(Math.round(cloud.base_feet), 1000);
    assertValidAeroflyStructure(cloud.toString());
    console.log("✅ AeroflyMissionConditionsCloud test successful");
}

{
    const localizedText = new AeroflyLocalizedText("de", "Test", "Test2");
    assert.deepStrictEqual(localizedText.language, "de");
    assert.deepStrictEqual(localizedText.title, "Test");
    assert.deepStrictEqual(localizedText.description, "Test2");
    assertValidAeroflyStructure(localizedText.toString());
    console.log("✅ AeroflyLocalizedText test successful");
}

{
    const targetPlane = new AeroflyMissionTargetPlane(0, 1, 2, "Test2");
    assert.deepStrictEqual(targetPlane.longitude, 0);
    assert.deepStrictEqual(targetPlane.latitude, 1);
    assert.deepStrictEqual(targetPlane.dir, 2);
    assert.deepStrictEqual(targetPlane.name, "Test2");
    assertValidAeroflyStructure(targetPlane.toString());
    console.log("✅ AeroflyMissionTargetPlane test successful");
}

{
    const checkpoint = new AeroflyMissionCheckpoint("TEST", "waypoint", 15, 20);
    let checkpointString = checkpoint.toString();

    assertIncludes(checkpointString, "[type]");
    assertIncludes(checkpointString, "[name]");
    assertIncludes(checkpointString, "[lon_lat]");
    assertIncludes(checkpointString, "15 20");
    assertIncludes(checkpointString, "[altitude]");
    assert.ok(!checkpointString.includes("[fly_over]"));
    assert.ok(!checkpointString.includes("[alt_cst]"));

    checkpoint.altitudeConstraint = false;
    checkpoint.flyOver = false;
    checkpointString = checkpoint.toString();

    assertIncludes(checkpointString, "[fly_over]");
    assertIncludes(checkpointString, "[alt_cst]");

    console.log("✅ AeroflyMissionCheckpoint test successful");
}

{
    const conditions = new AeroflyMissionConditions({
        time: new Date(Date.UTC(2024, 5, 14, 13, 15, 38)),
        wind: {
            direction: 190,
            speed: 11,
            gusts: 22,
        },
        turbulenceStrength: 1,
        temperature: 21,
        visibility: 14484.096000000001,
        clouds: [
            AeroflyMissionConditionsCloud.createInFeet(0.1, 5000),
            AeroflyMissionConditionsCloud.createInFeet(0.2, 7500),
        ],
    });

    assert.strictEqual(conditions.wind.direction, 190);
    assert.strictEqual(conditions.wind.speed, 11);
    assert.strictEqual(conditions.wind.gusts, 22);
    assert.strictEqual(conditions.turbulenceStrength, 1);
    assert.strictEqual(conditions.temperature, 21);
    assert.strictEqual(conditions.visibility, 14484.096000000001);

    const checkpoints = [
        new AeroflyMissionCheckpoint("KCCR", "origin", -122.057, 37.9897, {
            altitude: 8,
        }),
        new AeroflyMissionCheckpoint("19L", "departure_runway", -122.05504061196366, 37.993168229891225, {
            length: 844.2959729825288,
        }),
        new AeroflyMissionCheckpoint("24", "destination_runway", -70.60730234370952, 41.399093035543366, {
            altitude: 20,
            length: 1677.6191463161874,
            frequency: 108700000,
        }),
        new AeroflyMissionCheckpoint("KMVY", "destination", -70.6139, 41.3934, {
            altitude: 20,
            flyOver: false,
        }),
    ];

    const mission = new AeroflyMission("KCCR #1: Concord / Buchanan Field", {
        checkpoints,
        conditions,
        description: `It is a gusty, clear early morning, and you are 8 NM to the north of the towered airport Concord / Buchanan Field (27ft). As the wind is 11 kts from 190°, the main landing runway is 19L (191° / 844m). Fly the pattern and land safely.

- Local tower / CTAF frequency: 123.90
- Local navigational aids: VOR/DME CCR (117.00) 3.4 NM to the north`,
        flightSetting: "cruise",
        aircraft: {
            name: "c172",
            livery: "",
            icao: "C172",
        },
        callsign: "N51911",
        origin: {
            icao: "KCCR",
            longitude: -122.0736009331662,
            latitude: 38.122300745843944,
            dir: 174.37511511143452,
            alt: 1066.799965862401,
        },
        destination: {
            icao: "KMVY",
            longitude: -70.6139,
            latitude: 41.3934,
            dir: 221,
            alt: 20,
        },
    });

    const missionList = new AeroflyMissionsList([mission]);

    assert.strictEqual(missionList.missions.length, 1);
    assert.strictEqual(missionList.missions[0].aircraft.name, "c172");
    assert.strictEqual(missionList.missions[0].aircraft.icao, "C172");

    let missionListString = missionList.toString();

    assertIncludes(missionListString, "[origin]");
    assertIncludes(missionListString, "[tmmission_definition]");
    assertIncludes(missionListString, "[list_tmmission_checkpoint]");
    assertIncludes(missionListString, "[tmmission_checkpoint]");
    assertIncludes(missionListString, "[departure_runway]");
    assertIncludes(missionListString, "[cloud_cover]");
    assertIncludes(missionListString, "[cirrus_cover]");
    assertIncludes(missionListString, "[tmmission_checkpoint][element][0]");
    assertIncludes(missionListString, "[tmmission_checkpoint][element][1]");
    assertIncludes(missionListString, "[tmmission_checkpoint][element][2]");
    assertIncludes(missionListString, "[tmmission_checkpoint][element][3]");
    assertIncludes(missionListString, "<[float64][length][844.2959729825288]>");
    assert.ok(!missionListString.includes("[tags]"));
    assert.ok(!missionListString.includes("[difficulty]"));
    assert.ok(!missionListString.includes("[is_featured]"));
    assert.ok(!missionListString.includes("[tmmission_definition_localized]"));
    assert.ok(!missionListString.includes("[distance]"));
    assert.ok(!missionListString.includes("[duration]"));
    assert.ok(!missionListString.includes("[alt_cst]"));
    assertValidAeroflyStructure(missionListString);

    //console.log(missionListString);

    mission.difficulty = 1.0;
    mission.isFeatured = true;
    mission.localizedTexts.push(new AeroflyLocalizedText("de", "Landeübung #1", "Probier die Landung"));
    mission.distance = 1400;
    mission.duration = 2 * 60 * 60;
    mission.tags.push("approach");
    mission.tags.push("pattern");
    mission.finish = new AeroflyMissionTargetPlane(0, 1, 2);
    mission.tutorialName = "c172";
    mission.isScheduled = true;
    missionListString = missionList.toString();

    assertIncludes(missionListString, "[tags]");
    assertIncludes(missionListString, "[difficulty]");
    assertIncludes(missionListString, "[is_featured]");
    assertIncludes(missionListString, "true");
    assertIncludes(missionListString, "[tmmission_definition_localized]");
    assertIncludes(missionListString, "Landeübung");
    assertIncludes(missionListString, "[distance]");
    assertIncludes(missionListString, "[duration]");
    assertIncludes(missionListString, "[finish]");
    assertIncludes(missionListString, "[tutorial_name]");
    assertIncludes(missionListString, "[is_scheduled]");
    assertValidAeroflyStructure(missionListString);

    //console.dir(missionList.missions[0], { depth: null });
    //console.log(missionListString);

    console.log("✅ AeroflyMissionsList test successful");
}