Add kcd-scripts test configurations (#38)

RoFlection Bot · RoFlection Bot · commit deeab868405c · 2022-09-06T14:59:11.000-03:00
diff --git a/analyze.project.json b/analyze.project.json
@@ -6,6 +6,9 @@
       "$path": "Packages",
       "ReactTestingLibrary": {
         "$path": "src"
+      },
+      "TestsSetup": {
+        "$path": "tests"
       }
     }
   }
diff --git a/default.project.json b/default.project.json
@@ -6,6 +6,9 @@
       "$path": "Packages",
       "ReactTestingLibrary": {
         "$path": "src"
+      },
+      "TestsSetup": {
+        "$path": "tests"
       }
     }
   }
diff --git a/src/__tests__/auto-cleanup.spec.lua b/src/__tests__/auto-cleanup.spec.lua
@@ -17,7 +17,7 @@ test("first", function()
 	render(React.createElement("TextLabel", { Text = "hi" }))
 end)
 
-test.only("second", function()
+test("second", function()
 	expect(document).toBeEmptyDOMElement()
 end)
 
diff --git a/src/__tests__/cleanup.spec.lua b/src/__tests__/cleanup.spec.lua
@@ -68,7 +68,6 @@ test("cleanup runs effect cleanup functions", function()
 end)
 
 describe("fake timers and missing act warnings", function()
-	local originalConsoleError = console.error
 	beforeEach(function()
 		jest.resetAllMocks()
 		-- ROBLOX deviation START: replace spyOn
@@ -80,9 +79,6 @@ describe("fake timers and missing act warnings", function()
 	end)
 
 	afterEach(function()
-		-- ROBLOX deviation START: replace spyOn
-		console.error = originalConsoleError
-		-- ROBLOX deviation END
 		jest.useRealTimers()
 	end)
 
@@ -147,7 +143,7 @@ describe("fake timers and missing act warnings", function()
 			return nil
 		end
 		render(React.createElement(Test, nil))
-		task.wait(2)
+		task.wait()
 
 		jest.runAllTimers()
 		cleanup()
diff --git a/src/__tests__/new-act.spec.lua b/src/__tests__/new-act.spec.lua
@@ -15,7 +15,7 @@ type Promise<T> = LuauPolyfill.Promise<T>
 
 local Promise = require(Packages.Promise)
 
-local asyncAct, _consoleErrorMock
+local asyncAct, consoleErrorMock
 
 -- ROBLOX deviation: Mock is not supported
 -- local _testUtils = require(script.Parent.Parent.jsHelpers["react-dom"]["test-utils"])
@@ -27,18 +27,17 @@ local asyncAct, _consoleErrorMock
 -- 	}
 -- end)
 
-local originalConsoleError = console.error
-
 beforeEach(function()
-	console.error = jest.fn()
-
 	jest.resetModules()
 	asyncAct = require(script.Parent.Parent["act-compat"]).asyncAct
+	-- ROBLOX deviation START: replace spyOn
+	consoleErrorMock = jest.fn()
+	console.error = consoleErrorMock
+	-- ROBLOX deviation END
 end)
 
 afterEach(function()
-	(console.error :: any):mockRestore()
-	console.error = originalConsoleError
+	consoleErrorMock:mockRestore()
 end)
 
 test("async act works when it does not exist (older versions of react)", function()
diff --git a/src/__tests__/render.spec.lua b/src/__tests__/render.spec.lua
@@ -15,7 +15,7 @@ local ParentModule = require(script.Parent.Parent)
 local render = ParentModule.render
 local screen = ParentModule.screen
 
-test.only("renders div into document", function()
+test("renders div into document", function()
 	local ref = React.createRef()
 	local container = render(React.createElement("Frame", { ref = ref })).container
 	-- ROBLOX deviation START: replace firstChild with Instance equivalent
diff --git a/src/__tests__/setup/init.lua b/src/__tests__/setup/init.lua
diff --git a/src/__tests__/stopwatch.spec.lua b/src/__tests__/stopwatch.spec.lua
@@ -73,7 +73,6 @@ end
 test("unmounts a component", function()
 	return Promise.resolve():andThen(function()
 		-- ROBLOX deviation START: replace spyOn with jest.fn
-		local originalConsoleError = console.error
 		console.error = jest.fn(function() end)
 		-- ROBLOX deviation END
 		local ref = render(React.createElement(StopWatch, nil))
@@ -95,9 +94,6 @@ test("unmounts a component", function()
 			0
 			-- ROBLOX deviation END
 		)
-		-- ROBLOX deviation START: restore console.error
-		console.error = originalConsoleError
-		-- ROBLOX deviation END
 	end)
 end)
 return {}
diff --git a/src/jest.config.lua b/src/jest.config.lua
@@ -1,5 +1,6 @@
+local Packages = script.Parent.Parent
 return {
 	displayName = "Jest",
-	setupFiles = { script.Parent.__tests__.setup },
-	testMatch = { "**/*.spec" },
+	setupFilesAfterEnv = { Packages.TestsSetup["setup-env"] },
+	testMatch = { "**/__tests__/**/*.spec" },
 }
diff --git a/tests.project.json b/tests.project.json
@@ -15,6 +15,9 @@
         "$path": "Packages",
         "ReactTestingLibrary": {
           "$path": "src"
+        },
+        "TestsSetup": {
+          "$path": "tests"
         }
       }
     }
diff --git a/tests/setup-env.lua b/tests/setup-env.lua
@@ -0,0 +1,49 @@
+-- ROBLOX upstream: https://github.com/testing-library/react-testing-library/blob/v12.1.5/tests/setup-env.js
+
+local Packages = script.Parent.Parent
+local LuauPolyfill = require(Packages.LuauPolyfill)
+local console = LuauPolyfill.console
+
+local JestGlobals = require(Packages.JestGlobals)
+local jest = JestGlobals.jest
+local expect = JestGlobals.expect
+local afterEach = JestGlobals.afterEach
+local beforeEach = JestGlobals.beforeEach
+
+-- ROBLOX deviation START: explicitly extend expect
+local jestDomMatchers = require(Packages.ReactTestingLibrary.jsHelpers["jest-dom"])
+expect.extend(jestDomMatchers)
+-- ROBLOX deviation END
+
+-- ROBLOX deviation START: extend with missing matchers from jest
+local matchers = require(Packages.ReactTestingLibrary.jsHelpers.matchers)
+expect.extend(matchers)
+-- ROBLOX deviation END
+
+local consoleErrorMock
+-- ROBLOX deviation START: replace spyOn and String.indexof (both unavailable)
+local originalConsoleError = console.error
+beforeEach(function()
+	consoleErrorMock = jest.fn(function(
+		message,
+		...: any
+	)
+		local optionalParams = table.pack(...)
+		-- Ignore ReactDOM.render/ReactDOM.hydrate deprecation warning
+		if
+			string.find(message, "Use createRoot instead.", 1, true) 
+		then
+			return
+		end
+		originalConsoleError(message, table.unpack(optionalParams))
+	end)
+	console.error = consoleErrorMock
+end)
+
+afterEach(function()
+	consoleErrorMock:mockRestore()
+	console.error = originalConsoleError
+end)
+-- ROBLOX deviation END
+
+return {}

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`	`"$path": "Packages",`
`7`	`7`	`"ReactTestingLibrary": {`
`8`	`8`	`"$path": "src"`
	`9`	`+ },`
	`10`	`+ "TestsSetup": {`
	`11`	`+ "$path": "tests"`
`9`	`12`	`}`
`10`	`13`	`}`
`11`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
	`1`	`+local Packages = script.Parent.Parent`
`1`	`2`	`return {`
`2`	`3`	`displayName = "Jest",`
`3`		`- setupFiles = { script.Parent.__tests__.setup },`
`4`		`- testMatch = { "*/.spec" },`
	`4`	`+ setupFilesAfterEnv = { Packages.TestsSetup["setup-env"] },`
	`5`	`+ testMatch = { "/__tests__//*.spec" },`
`5`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,9 @@`
`15`	`15`	`"$path": "Packages",`
`16`	`16`	`"ReactTestingLibrary": {`
`17`	`17`	`"$path": "src"`
	`18`	`+ },`
	`19`	`+ "TestsSetup": {`
	`20`	`+ "$path": "tests"`
`18`	`21`	`}`
`19`	`22`	`}`
`20`	`23`	`}`