Add tests

Author: Sleitnick

.gitignore

@@ -2,3 +2,4 @@
 packages/*/Packages
 /build
 /Packages
+/test/Packages

default.project.json

@@ -0,0 +1,19 @@
+{
+	"name": "rbx-util",
+	"tree": {
+		"$className": "DataModel",
+		"ReplicatedStorage": {
+			"$className": "ReplicatedStorage",
+			"Modules": {
+				"$path": "modules"
+			}
+		},
+		"TestService": {
+			"$className": "TestService",
+			"$properties": {
+				"ExecuteWithStudioRun": true
+			},
+			"$path": "test"
+		}
+	}
+}

modules/signal/init.spec.lua

@@ -0,0 +1,160 @@
+local function AwaitCondition(predicate, timeout)
+	local start = os.clock()
+	timeout = (timeout or 10)
+	while true do
+		if predicate() then return true end
+		if (os.clock() - start) > timeout then return false end
+		task.wait()
+	end
+end
+
+return function()
+
+	local Signal = require(script.Parent)
+
+	local signal
+
+	local function NumConns(sig)
+		sig = sig or signal
+		return #sig:GetConnections()
+	end
+
+	beforeEach(function()
+		signal = Signal.new()
+	end)
+
+	afterEach(function()
+		signal:Destroy()
+	end)
+
+	describe("Constructor", function()
+
+		it("should create a new signal and fire it", function()
+			expect(Signal.Is(signal)).to.equal(true)
+			task.defer(function()
+				signal:Fire(10, 20)
+			end)
+			local n1, n2 = signal:Wait()
+			expect(n1).to.equal(10)
+			expect(n2).to.equal(20)
+		end)
+
+		it("should create a proxy signal and connect to it", function()
+			local signalWrap = Signal.Wrap(game:GetService("RunService").Heartbeat)
+			expect(Signal.Is(signalWrap)).to.equal(true)
+			local fired = false
+			signalWrap:Connect(function()
+				fired = true
+			end)
+			expect(AwaitCondition(function() return fired end, 2)).to.equal(true)
+			signalWrap:Destroy()
+		end)
+
+	end)
+
+	describe("FireDeferred", function()
+
+		it("should be able to fire primitive argument", function()
+			local send = 10
+			local value
+			signal:Connect(function(v)
+				value = v
+			end)
+			signal:FireDeferred(send)
+			expect(AwaitCondition(function() return (send == value) end, 1)).to.equal(true)
+		end)
+
+		it("should be able to fire a reference based argument", function()
+			local send = {10, 20}
+			local value
+			signal:Connect(function(v)
+				value = v
+			end)
+			signal:FireDeferred(send)
+			expect(AwaitCondition(function() return (send == value) end, 1)).to.equal(true)
+		end)
+
+	end)
+
+	describe("Fire", function()
+
+		it("should be able to fire primitive argument", function()
+			local send = 10
+			local value
+			signal:Connect(function(v)
+				value = v
+			end)
+			signal:Fire(send)
+			expect(value).to.equal(send)
+		end)
+
+		it("should be able to fire a reference based argument", function()
+			local send = {10, 20}
+			local value
+			signal:Connect(function(v)
+				value = v
+			end)
+			signal:Fire(send)
+			expect(value).to.equal(send)
+		end)
+
+	end)
+
+	describe("Wait", function()
+
+		it("should be able to wait for a signal to fire", function()
+			task.defer(function()
+				signal:Fire(10, 20, 30)
+			end)
+			local n1, n2, n3 = signal:Wait()
+			expect(n1).to.equal(10)
+			expect(n2).to.equal(20)
+			expect(n3).to.equal(30)
+		end)
+
+	end)
+
+	describe("DisconnectAll", function()
+
+		it("should disconnect all connections", function()
+			signal:Connect(function() end)
+			signal:Connect(function() end)
+			expect(NumConns()).to.equal(2)
+			signal:DisconnectAll()
+			expect(NumConns()).to.equal(0)
+		end)
+
+	end)
+
+	describe("Disconnect", function()
+
+		it("should disconnect connection", function()
+			local con = signal:Connect(function() end)
+			expect(NumConns()).to.equal(1)
+			con:Disconnect()
+			expect(NumConns()).to.equal(0)
+		end)
+
+		it("should still work if connections disconnected while firing", function()
+			local a = 0
+			local c
+			signal:Connect(function() a += 1 end)
+			c = signal:Connect(function() c:Disconnect() a += 1 end)
+			signal:Connect(function() a += 1 end)
+			signal:Fire()
+			expect(a).to.equal(3)
+		end)
+
+		it("should still work if connections disconnected while firing deferred", function()
+			local a = 0
+			local c
+			signal:Connect(function() a += 1 end)
+			c = signal:Connect(function() c:Disconnect() a += 1 end)
+			signal:Connect(function() a += 1 end)
+			signal:FireDeferred()
+			expect(AwaitCondition(function() return a == 3 end)).to.equal(true)
+		end)
+
+	end)
+
+end

selene.toml

@@ -1,4 +1,5 @@
-std = "roblox"
+std = "roblox+testez"
 
 [config]
 unused_variable = {allow_unused_self = true}
+multiple_statements = "allow"

test/RunTests.server.lua

@@ -0,0 +1,2 @@
+print("Running unit tests...")
+require(script.Parent.Packages.TestEZ).TestBootstrap:run({game:GetService("ReplicatedStorage").Modules})

testez.toml

@@ -0,0 +1,66 @@
+[[afterAll.args]]
+type = "function"
+
+[[afterEach.args]]
+type = "function"
+
+[[beforeAll.args]]
+type = "function"
+
+[[beforeEach.args]]
+type = "function"
+
+[[describe.args]]
+type = "string"
+
+[[describe.args]]
+type = "function"
+
+[[describeFOCUS.args]]
+type = "string"
+
+[[describeFOCUS.args]]
+type = "function"
+
+[[describeSKIP.args]]
+type = "string"
+
+[[describeSKIP.args]]
+type = "function"
+
+[[expect.args]]
+type = "any"
+
+[[FIXME.args]]
+type = "string"
+required = false
+
+[FOCUS]
+args = []
+
+[[it.args]]
+type = "string"
+
+[[it.args]]
+type = "function"
+
+[[itFIXME.args]]
+type = "string"
+
+[[itFIXME.args]]
+type = "function"
+
+[[itFOCUS.args]]
+type = "string"
+
+[[itFOCUS.args]]
+type = "function"
+
+[[itSKIP.args]]
+type = "string"
+
+[[itSKIP.args]]
+type = "function"
+
+[SKIP]
+args = []