Merge pull request #149 from ConMur/run-afterEach-when-it-fails

Run code in the afterEach block after failure in an it block

Author: benbrimeyer

CHANGELOG.md

@@ -1,6 +1,7 @@
 # TestEZ Changelog
 
 ## Unreleased Changes
+* `afterEach` blocks now run their code after `it` blocks fail or error
 
 
 ## 0.4.0 (2020-10-02)

docs/api-reference.md

@@ -135,6 +135,7 @@ afterEach(callback(context: table))
 ```
 
 Returns a function after each of the tests within its scope. This is useful if you want to cleanup some temporary state that is created by each test.
+It is always ran regardless of if the test failed or not.
 
 ```lua
 local DEFAULT_STATE = {

src/TestRunner.lua

@@ -113,20 +113,22 @@ function TestRunner.runPlanNode(session, planNode, lifecycleHooks)
 			end
 		end
 
-		do
-			local success, errorMessage = runCallback(childPlanNode.callback)
-			if not success then
-				return false, errorMessage
-			end
-		end
+		local testSuccess, testErrorMessage = runCallback(childPlanNode.callback)
 
 		for _, hook in ipairs(lifecycleHooks:getAfterEachHooks()) do
 			local success, errorMessage = runCallback(hook, "afterEach hook: ")
 			if not success then
+				if not testSuccess then
+					return false, testErrorMessage .. "\nWhile cleaning up the failed test another error was found:\n" .. errorMessage
+				end
 				return false, errorMessage
 			end
 		end
 
+		if not testSuccess then
+			return false, testErrorMessage
+		end
+
 		return true, nil
 	end
 

test/roblox-cli.sh

@@ -15,4 +15,4 @@ else
 fi
 
 rojo build test-place.project.json -o TestPlace.rbxlx
-roblox-cli run --load.place TestPlace.rbxlx --assetFolder "$CONTENT"
+roblox-cli run --load.place TestPlace.rbxlx --assetFolder "$CONTENT"

tests/e2e/afterEachAfterFailure/errorInAfterEachBlock/errorInAfterEachBlock.spec.lua

@@ -0,0 +1,12 @@
+return function()
+	describe("When an error occurs in an afterEach block", function()
+		it("Should pass", function()
+			expect(true).to.equal(true)
+		end)
+
+		afterEach(function()
+			-- Cause a failure to be picked up by the test harness
+			error("afterEach threw an error as expected")
+		end)
+	end)
+end

tests/e2e/afterEachAfterFailure/errorInItBlock/errorInItBlock.spec.lua

@@ -0,0 +1,12 @@
+return function()
+	describe("When an error occurs in an it block", function()
+		it("Should error", function()
+			error("Failure in it block")
+		end)
+
+		afterEach(function()
+			-- Cause an error to be picked up by the test harness
+			error("afterEach threw an error as expected")
+		end)
+	end)
+end

tests/e2e/afterEachAfterFailure/failureInItBlock/failureInItBlock.spec.lua

@@ -0,0 +1,12 @@
+return function()
+	describe("When a failure occurs in an it block", function()
+		it("Should fail", function()
+			fail("Failure in it block")
+		end)
+
+		afterEach(function()
+			-- Cause an error to be picked up by the test harness
+			error("afterEach threw an error as expected")
+		end)
+	end)
+end

tests/e2e/init.lua

@@ -14,6 +14,42 @@ return {
 		end)
 	end,
 
+	["run afterEach e2e with error in it block"] = function()
+		TestEZ.run(script:FindFirstChild("afterEachAfterFailure"):FindFirstChild("errorInItBlock"), function(results)
+			assert(#results.errors == 1, "Expected one error, got " .. tostring(#results.errors))
+
+			local afterEachError = string.find(results.errors[1], "afterEach threw an error as expected")
+			assert(afterEachError ~= nil, "Expected afterEach to be reached after it throws an error")
+
+			local cleaningUpError = string.find(results.errors[1], "While cleaning up the failed test another error was found")
+			assert(cleaningUpError ~= nil, "Expected 'While cleaning up...' msg to be shown when afterEach fails after it fails")
+		end)
+	end,
+
+	["run afterEach e2e with failure in it block"] = function()
+		TestEZ.run(script:FindFirstChild("afterEachAfterFailure"):FindFirstChild("failureInItBlock"), function(results)
+			assert(#results.errors == 1, "Expected one error, got " .. tostring(#results.errors))
+
+			local afterEachError = string.find(results.errors[1], "afterEach threw an error as expected")
+			assert(afterEachError ~= nil, "Expected afterEach to be reached after it throws an error")
+
+			local cleaningUpError = string.find(results.errors[1], "While cleaning up the failed test another error was found")
+			assert(cleaningUpError ~= nil, "Expected 'While cleaning up...' msg to be shown when afterEach fails after it fails")
+		end)
+	end,
+
+	["run afterEach e2e with failure in afterEach block"] = function()
+		TestEZ.run(script:FindFirstChild("afterEachAfterFailure"):FindFirstChild("errorInAfterEachBlock"), function(results)
+			assert(#results.errors == 1, "Expected one error, got " .. tostring(#results.errors))
+
+			local afterEachError = string.find(results.errors[1], "afterEach threw an error as expected")
+			assert(afterEachError ~= nil, "Expected afterEach to be reached after it throws an error")
+
+			local cleaningUpError = string.find(results.errors[1], "While cleaning up the failed test another error was found")
+			assert(cleaningUpError == nil, "Expected 'While cleaning up...' msg to not be shown when only afterEach fails")
+		end)
+	end,
+
 	["run lifecycle e2e w/ filter for describe block"] = function()
 		TestEZ.TestBootstrap:run({
 			script:FindFirstChild("lifecycle"):FindFirstChild("testNameFilterDescribeBlock"),