Tests: Add more tests for the AudioSource primitive

Author: rdw-software

Tests/API/C_WebAudio/AudioSource.js

@@ -0,0 +1,86 @@
+describe("AudioSource", () => {
+	const testSoundFilePath = path.join(WEBCLIENT_FIXTURES_DIR, "WebAudio", "dumbo.ogg");
+	const instance = new AudioSource(testSoundFilePath);
+	it("should be exported into the global environment", () => {
+		assertEquals(typeof AudioSource.constructor, "function");
+	});
+
+	const exportedApiSurface = [
+		"getPlaybackRate",
+		"setPlaybackRate",
+		"fadeIn",
+		"fadeOut",
+		"pause",
+		"resume",
+		"getVolume",
+		"setVolume",
+		"isPlaying",
+		"startPlaying",
+		"stopPlaying",
+		"getFilePath",
+		"destroy",
+		"getUniqueID",
+	];
+
+	exportedApiSurface.forEach((namedExport) => {
+		it("should export function " + namedExport, () => {
+			assertEquals(typeof instance[namedExport], "function");
+		});
+	});
+
+	describe("setPlaybackRate", () => {
+		// Also covers getPlaybackRate, coincidentally
+		it("should be able to adjust the playback rate", () => {
+			instance.setPlaybackRate(0.15);
+			const newPlaybackRate = instance.getPlaybackRate();
+			assertEquals(newPlaybackRate, 0.15);
+		});
+
+		const rangeError = new RangeError(AudioSource.ERROR_INVALID_PLAYBACK_RATE);
+		it("should throw a RangeError if the playback rate is negative", () => {
+			assertThrows(() => instance.setPlaybackRate(-1), rangeError);
+		});
+
+		it("should throw a RangeError if the playback rate is zero", () => {
+			assertThrows(() => instance.setPlaybackRate(0), rangeError);
+		});
+
+		const typeError = new TypeError("Usage: AudioSource.setPlaybackRate(Number newPlaybackRate)");
+		it("should throw a TypeError if the playback rate is not a String", () => {
+			assertThrows(() => instance.setPlaybackRate(null), typeError);
+			assertThrows(() => instance.setPlaybackRate(undefined), typeError);
+			assertThrows(() => instance.setPlaybackRate("Hi"), typeError);
+			assertThrows(() => instance.setPlaybackRate([]), typeError);
+			assertThrows(() => instance.setPlaybackRate({}), typeError);
+			assertThrows(() => instance.setPlaybackRate(() => console.log("test")), typeError);
+			assertThrows(() => instance.setPlaybackRate(NaN), typeError);
+		});
+	});
+
+	describe("getUniqueID", () => {
+		it("should return a string identifier", () => {
+			// We can't guarantee it will be unique, just that it will be extremely unlikely to not be unique...
+			const guid = instance.getUniqueID();
+			assertEquals(typeof guid, "string");
+		});
+
+		it("should return the same identifier if called repeatedly", () => {
+			const guid1 = instance.getUniqueID();
+			const guid2 = instance.getUniqueID();
+			const guid3 = instance.getUniqueID();
+
+			assertEquals(guid1, guid2);
+			assertEquals(guid1, guid3);
+		});
+	});
+
+	describe("destroy", () => {
+		it("should return true when successfully disposing of the audio buffer", () => {
+			assertTrue(instance.destroy());
+		});
+
+		it("should return false when the audio buffer has already been disposed of", () => {
+			assertFalse(instance.destroy());
+		});
+	});
+});

Tests/Builtins/AudioSource.js

@@ -3,7 +3,6 @@ const testSuites = {
 	Builtins: [
 		"Builtins/Assertions.js",
 		"Builtins/LocalCacheTests.js",
-		"Builtins/AudioSource.js",
 		"Builtins/AudioTrack.js",
 		"Builtins/Decoder.js",
 		"Builtins/UniqueID.js",
@@ -15,6 +14,7 @@ const testSuites = {
 		"API/C_Settings/validateUserSettings.js",
 	],
 	C_WebAudio: [
+		"API/C_WebAudio/AudioSource.js",
 		"API/C_WebAudio/BuiltinAudioDecoder.js",
 		"API/C_WebAudio/createTrack.js",
 		"API/C_WebAudio/getTrackInfo.js",