test: add unit and e2e tests (#244)

* test: add unit and e2e tests

* test: add cli to deps

* test: remove start from test as not stable

Author: Exeloo

.github/workflows/tests.yml

@@ -20,7 +20,7 @@ jobs:
         uses: ./.github/actions/prepare
 
       - name: "Run tests"
-        run: pnpm test:unit
+        run: pnpm test
 
       - name: "Run linter"
         run: pnpm lint

.husky/pre-push

@@ -1,3 +1,3 @@
-pnpm lint
-pnpm build
-pnpm test:unit
+pnpm run build
+pnpm run lint
+pnpm run test

.prettierignore

@@ -10,6 +10,7 @@ packages/
 example/
 utils/
 releases/
+.nanoforge/
 
 .turbo/
 node_modules/

e2e/game.test.ts

@@ -0,0 +1,36 @@
+import { execSync } from "child_process";
+import { existsSync, rmSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+import { afterAll, beforeAll, describe, expect, it } from "vitest";
+
+const PROJECT_DIR = join(dirname(fileURLToPath(import.meta.url)), "./game");
+
+describe("E2E Game", () => {
+  beforeAll(() => {
+    rmSync(join(PROJECT_DIR, ".nanoforge"), { recursive: true, force: true });
+    execSync("pnpm run build", {
+      cwd: PROJECT_DIR,
+      stdio: "pipe",
+      timeout: 120_000,
+    });
+  }, 130_000);
+
+  afterAll(() => {
+    rmSync(join(PROJECT_DIR, ".nanoforge"), { recursive: true, force: true });
+  }, 130_000);
+
+  describe("Build", () => {
+    it("should produce a server bundle", () => {
+      expect(existsSync(join(PROJECT_DIR, ".nanoforge/server/main.js"))).toBe(true);
+    });
+
+    it("should produce a client bundle directory", () => {
+      expect(existsSync(join(PROJECT_DIR, ".nanoforge/client"))).toBe(true);
+    });
+
+    it("should include the WASM file in the server bundle", () => {
+      expect(existsSync(join(PROJECT_DIR, ".nanoforge/server/libecs.wasm"))).toBe(true);
+    });
+  });
+});

e2e/game/.gitignore

@@ -0,0 +1 @@
+.nanoforge/

e2e/game/client/components/example.component.ts

@@ -0,0 +1,55 @@
+import { type EditorComponentManifest } from "@nanoforge-dev/ecs-client";
+
+export class ExampleComponent {
+  name = this.constructor.name;
+
+  constructor(
+    public paramA: string,
+    public paramB: number,
+    public paramC: boolean = false,
+  ) {}
+
+  get foo() {
+    return "bar";
+  }
+
+  get paramAOrDefault() {
+    return this.paramC ? this.paramA : "default";
+  }
+
+  addOne() {
+    this.paramB += 1;
+  }
+}
+
+// * Required to generate code
+export default ExampleComponent.name;
+
+// * Required for the editor to display the component and generate code
+export const EDITOR_COMPONENT_MANIFEST: EditorComponentManifest = {
+  name: "Example",
+  description: "Example component description",
+  params: {
+    paramA: {
+      type: "string",
+      name: "Param A",
+      description: "Param A description",
+      example: "Example value",
+    },
+    paramB: {
+      type: "number",
+      name: "Param B",
+      description: "Param B description",
+      example: 3,
+    },
+    paramC: {
+      type: "boolean",
+      name: "Param C",
+      description: "Param C description",
+      example: true,
+      default: false,
+      // Not required because it has a default value
+      optional: true,
+    },
+  },
+};

e2e/game/client/main.ts

@@ -0,0 +1,50 @@
+import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager";
+import { type IRunOptions } from "@nanoforge-dev/common";
+import { NanoforgeFactory } from "@nanoforge-dev/core";
+import { ECSClientLibrary } from "@nanoforge-dev/ecs-client";
+import { Graphics2DLibrary } from "@nanoforge-dev/graphics-2d";
+import { InputLibrary } from "@nanoforge-dev/input";
+import { MusicLibrary } from "@nanoforge-dev/music";
+import { NetworkClientLibrary } from "@nanoforge-dev/network-client";
+import { SoundLibrary } from "@nanoforge-dev/sound";
+
+import { ExampleComponent } from "./components/example.component";
+import { exampleSystem } from "./systems/example.system";
+
+export async function main(options: IRunOptions) {
+  const app = NanoforgeFactory.createClient({
+    tickRate: 60,
+    environment: {
+      serverAddress: "127.0.0.1",
+      serverTcpPort: "4445",
+      serverUdpPort: "4444",
+    },
+  });
+
+  const assetManager = new AssetManagerLibrary();
+  const ecs = new ECSClientLibrary();
+  const graphics = new Graphics2DLibrary();
+  const input = new InputLibrary();
+  const music = new MusicLibrary();
+  const network = new NetworkClientLibrary();
+  const sound = new SoundLibrary();
+
+  app.useAssetManager(assetManager);
+  app.useComponentSystem(ecs);
+  app.useGraphics(graphics);
+  app.useInput(input);
+  app.useSound(sound);
+  app.useNetwork(network);
+  app.use(Symbol("music"), music);
+
+  await app.init(options);
+
+  const registry = ecs.registry;
+
+  const exampleEntity = registry.spawnEntity();
+  registry.addComponent(exampleEntity, new ExampleComponent("example", 10));
+
+  registry.addSystem(exampleSystem);
+
+  await app.run();
+}

e2e/game/client/systems/example.system.ts

@@ -0,0 +1,31 @@
+import { type Context } from "@nanoforge-dev/common";
+import { type EditorSystemManifest, type Registry } from "@nanoforge-dev/ecs-client";
+
+import { ExampleComponent } from "../components/example.component";
+
+export const exampleSystem = (registry: Registry, ctx: Context) => {
+  const entities = registry.getZipper([ExampleComponent]);
+
+  entities.forEach((entity) => {
+    if (entity.ExampleComponent.paramA === "end") {
+      ctx.app.setIsRunning(false);
+      return;
+    }
+
+    if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end";
+
+    if (entity.ExampleComponent.paramB >= 0)
+      entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1;
+  });
+};
+
+// * Required to generate code
+export default exampleSystem.name;
+
+// * Required for the editor to display the system and generate code
+export const EDITOR_SYSTEM_MANIFEST: EditorSystemManifest = {
+  name: "Example",
+  description:
+    "This system end the game when paramB reaches 0 for any entity with ExampleComponent",
+  dependencies: ["ExampleComponent"],
+};

e2e/game/nanoforge.config.json

@@ -0,0 +1,21 @@
+{
+  "client": {
+    "build": {
+      "entryFile": "client/main.ts",
+      "outDir": ".nanoforge/client"
+    },
+    "runtime": {
+      "dir": ".nanoforge/client"
+    }
+  },
+  "server": {
+    "enable": true,
+    "build": {
+      "entryFile": "server/main.ts",
+      "outDir": ".nanoforge/server"
+    },
+    "runtime": {
+      "dir": ".nanoforge/server"
+    }
+  }
+}

e2e/game/package.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@nanoforge-dev/e2e-game",
+  "version": "0.0.0",
+  "description": "NanoForge Engine - End-to-End test game",
+  "type": "module",
+  "scripts": {
+    "build": "nf build",
+    "start": "nf start"
+  },
+  "devDependencies": {
+    "@nanoforge-dev/asset-manager": "workspace:*",
+    "@nanoforge-dev/cli": "latest",
+    "@nanoforge-dev/common": "workspace:*",
+    "@nanoforge-dev/core": "workspace:*",
+    "@nanoforge-dev/ecs-client": "workspace:*",
+    "@nanoforge-dev/ecs-server": "workspace:*",
+    "@nanoforge-dev/graphics-2d": "workspace:*",
+    "@nanoforge-dev/input": "workspace:*",
+    "@nanoforge-dev/music": "workspace:*",
+    "@nanoforge-dev/network-client": "workspace:*",
+    "@nanoforge-dev/network-server": "workspace:*",
+    "@nanoforge-dev/sound": "workspace:*",
+    "typescript": "catalog:core",
+    "vitest": "catalog:test"
+  },
+  "private": true,
+  "engines": {
+    "node": "25"
+  }
+}