Update and add new tests

Author: encode42

tests/consisdency/exact/customInstruments.test.ts

@@ -0,0 +1,13 @@
+import { readFile } from "node:fs/promises";
+import { fromArrayBuffer, toArrayBuffer } from "../../../src";
+
+test("Import and export identical complex songs", async () => {
+	const originalFile = await readFile("tests/sample/full.nbs");
+	const originalArray = new Uint8Array(originalFile);
+	const originalSong = fromArrayBuffer(originalArray.buffer);
+
+	const exportedBuffer = toArrayBuffer(originalSong);
+	const exportedArray = new Uint8Array(exportedBuffer);
+
+	expect(Buffer.compare(originalArray, exportedArray)).toBe(0);
+});

tests/consisdency/exact/simple.test.ts

@@ -0,0 +1,13 @@
+import { readFile } from "node:fs/promises";
+import { fromArrayBuffer, toArrayBuffer } from "../../../src";
+
+test("Import and export identical songs", async () => {
+	const originalFile = await readFile("tests/sample/simple.nbs");
+	const originalArray = new Uint8Array(originalFile);
+	const originalSong = fromArrayBuffer(originalArray.buffer);
+
+	const exportedBuffer = toArrayBuffer(originalSong);
+	const exportedArray = new Uint8Array(exportedBuffer);
+
+	expect(Buffer.compare(originalArray, exportedArray)).toBe(0);
+});

tests/consisdency/transform.test.ts

@@ -0,0 +1,89 @@
+import { readFile, writeFile } from "node:fs/promises";
+import { Layer, fromArrayBuffer, toArrayBuffer } from "../../src";
+
+test("Transform a file to an expected result", async () => {
+	const originalFile = await readFile("tests/sample/simple.nbs");
+	const originalArray = new Uint8Array(originalFile);
+	const originalSong = fromArrayBuffer(originalArray.buffer);
+
+	const expectedFile = await readFile("tests/sample/simpleAdded.nbs");
+	const expectedArray = new Uint8Array(expectedFile);
+
+	const harp = originalSong.layers[0];
+
+	const topPling = new Layer(5);
+	topPling.volume = 80;
+
+	const middlePling = new Layer(6);
+	middlePling.volume = 30;
+	middlePling.stereo = -40;
+
+	const bottomPling = new Layer(7);
+	bottomPling.volume = 30;
+	bottomPling.stereo = 40;
+
+	originalSong.addNote(harp, 64, 0, {
+		"key": 46,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+	topPling.addNote(64, 8, {
+		"key": 46,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+	middlePling.addNote(64, 8, {
+		"key": 41,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+	bottomPling.addNote(64, 8, {
+		"key": 38,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+
+	originalSong.addNote(harp, 72, 0, {
+		"key": 45,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+	topPling.addNote(72, 8, {
+		"key": 45,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+	middlePling.addNote(72, 8, {
+		"key": 38,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+	bottomPling.addNote(72, 8, {
+		"key": 41,
+		"velocity": 100,
+		"panning": 0,
+		"pitch": 0
+	});
+
+	originalSong.addLayer(topPling);
+	originalSong.addLayer(middlePling);
+	originalSong.addLayer(bottomPling);
+
+	originalSong.meta.description = "A simple melody used for testing NBS.js. Adds two leading notes at the end of the initial melody.";
+	originalSong.stats.minutesSpent = 9;
+	originalSong.stats.leftClicks = 324;
+	originalSong.stats.rightClicks = 4;
+	originalSong.stats.blocksAdded = 40;
+
+	const exportedBuffer = toArrayBuffer(originalSong);
+	const exportedArray = new Uint8Array(exportedBuffer);
+
+	expect(Buffer.compare(exportedArray, expectedArray)).toBe(0);
+});

tests/fromArrayBuffer/fromArrayBuffer.test.ts tests/read/basicMetadata.test.ts

@@ -1,44 +1,18 @@
 import { readFile } from "node:fs/promises";
 import { fromArrayBuffer } from "../../src";
 
-/**
- * Options for the test results.
- */
 interface TestOptions {
-	/**
-	 * The version of the song.
-	 */
 	"version": number;
-
-	/**
-	 * The length of the song.
-	 */
 	"length": number;
-
-	/**
-	 * The amount of instruments in the song.
-	 */
 	"instruments": number;
-
-	/**
-	 * The amount of layers in the song.
-	 */
 	"layers": number;
-
-	/**
-	 * The tempo of the song.
-	 */
 	"tempo": number;
-
-	/**
-	 * The last measure of the song.
-	 */
 	"lastMeasure": number | undefined;
 }
 
-test("Read song from file", async () => {
-	const songFile = await readFile("tests/sample/test.nbs");
-	const buffer = new Uint8Array(songFile).buffer;
+test("Read song from file, compare metadata", async () => {
+	const file = await readFile("tests/sample/simple.nbs");
+	const buffer = new Uint8Array(file).buffer;
 	const song = fromArrayBuffer(buffer, {
 		"ignoreEmptyLayers": true
 	});
@@ -54,11 +28,11 @@ test("Read song from file", async () => {
 
 	const target: TestOptions = {
 		"version": 5,
-		"length": 12,
+		"length": 62,
 		"instruments": 16,
-		"layers": 5,
-		"tempo": 7.5,
-		"lastMeasure": 12
+		"layers": 4,
+		"tempo": 10,
+		"lastMeasure": 64
 	};
 
 	expect(input).toStrictEqual(target);