port wait-for, test-utils (#32)

Author: RoFlection Bot

bin/ci.sh

@@ -12,4 +12,4 @@ roblox-cli analyze analyze.project.json
 stylua -c src types jsHelpers
 
 echo "Run tests"
-roblox-cli run --load.place tests.project.json --run bin/spec.lua --lua.globals=__DEV__=true --fastFlags.allOnLuau
+roblox-cli run --load.place tests.project.json --run bin/spec.lua --lua.globals=__DEV__=true --fastFlags.allOnLuau --fastFlags.overrides EnableLoadModule=true

bin/spec.lua

@@ -1,18 +1,23 @@
-local ProcessService = game:GetService("ProcessService")
 local Root = game:GetService("ReplicatedStorage")
 
 local Packages = Root.Packages
--- Load JestGlobals source into Packages folder so it's next to Roact as expected
-local TestEZ = require(Root.Packages.Dev.JestGlobals).TestEZ
+
+local JestGlobals = require(Packages.Dev.JestGlobals)
+
+local TestEZ = JestGlobals.TestEZ
 
 -- Run all tests, collect results, and report to stdout.
-local result = TestEZ.TestBootstrap:run(
+TestEZ.TestBootstrap:run(
 	{ Packages.DomTestingLibrary },
-	TestEZ.Reporters.TextReporterQuiet
+	TestEZ.Reporters.pipe({
+		TestEZ.Reporters.JestDefaultReporter,
+		TestEZ.Reporters.JestSummaryReporter,
+	}),
+	{
+		extraEnvironment = JestGlobals.testEnv,
+	}
 )
+-- ROBLOX TODO: after converting jest-runner this should be included there
+JestGlobals.runtime:teardown()
 
-if result.failureCount == 0 and #result.errors == 0 then
-	ProcessService:ExitAsync(0)
-else
-	ProcessService:ExitAsync(1)
-end
+return nil

jsHelpers/document.lua

@@ -0,0 +1,3 @@
+local document = Instance.new("Folder")
+
+return document

jsHelpers/isCallable.lua

@@ -0,0 +1,21 @@
+-- ROBLOX upstream: no upstream
+
+-- ROBLOX comment: we use callable tables instead of functions sometimes, so typeof() == "function" isn't enough
+-- https://github.com/Roblox/roact-alignment/blob/2e9a4b4b4683da6c603d9c6a9b27b776c5a006c7/modules/react-reconciler/src/ReactFiberDevToolsHook.new.lua#L27-L42
+local function isCallable(value: any): boolean
+	if typeof(value) == "function" then
+		return true
+	end
+	if typeof(value) == "table" then
+		local mt = getmetatable(value)
+		if mt and rawget(mt, "__call") then
+			return true
+		end
+		if value._isMockFunction then
+			return true
+		end
+	end
+	return false
+end
+
+return isCallable

rotriever.toml

@@ -9,10 +9,10 @@ content_root = "src"
 [dependencies]
 LuauPolyfill = "github.com/roblox/luau-polyfill@0.3.4"
 LuauRegExp = "github.com/Roblox/luau-regexp@0.2.0"
+Promise = "github.com/evaera/roblox-lua-promise@4.0.0"
 JestGetType = { git = "https://github.com/roblox/jest-roblox.git", version="2.4.1", package="JestGetType"}
 PrettyFormat = { git = "https://github.com/roblox/jest-roblox.git", version="2.4.1", package="PrettyFormat"}
 RobloxShared = { git = "https://github.com/roblox/jest-roblox.git", version="2.4.1", package="RobloxShared"}
 
 [dev_dependencies]
-JestGlobals = "github.com/roblox/jest-roblox@2.4.1"
-Promise = "github.com/evaera/roblox-lua-promise@4.0.0"
+JestGlobals = { git = "https://github.com/roblox/jest-roblox.git", rev="master" }

src/__tests__/helpers.spec.lua

@@ -2,14 +2,14 @@
 return function()
 	local Packages = script.Parent.Parent.Parent
 
-	local Promise = require(Packages.Dev.Promise)
+	local Promise = require(Packages.Promise)
 
 	local JestGlobals = require(Packages.Dev.JestGlobals)
 	local jestExpect = JestGlobals.expect
 	local jest = JestGlobals.jest
 
-	-- ROBLOX deviation START: assume document to be nil
-	local document = nil
+	-- ROBLOX deviation START: assume constant document
+	local document = require(Packages.JsHelpers.document)
 	-- ROBLOX deviation END
 
 	-- ROBLOX TODO START: not ported yet. Mocked

src/__tests__/helpers/test-utils.lua

@@ -0,0 +1,65 @@
+-- ROBLOX upstream: https://github.com/testing-library/dom-testing-library/blob/v8.14.0/src/__tests__/helpers/test-utils.js
+-- ROBLOX deviation: wrapping in function to pass afterEach as an argument.
+return function(afterEach)
+	local Packages = script.Parent.Parent.Parent.Parent
+	local LuauPolyfill = require(Packages.LuauPolyfill)
+	local Object = LuauPolyfill.Object
+	type Array<T> = LuauPolyfill.Array<T>
+	type Object = LuauPolyfill.Object
+
+	local document = require(Packages.JsHelpers.document)
+
+	local exports = {}
+
+	-- ROBLOX FIXME: use when ready
+	-- local getQueriesForElement =
+	-- 	require(script.Parent.Parent.Parent["get-queries-for-element"]).getQueriesForElement
+	local getQueriesForElement = function(el: Instance)
+		return {}
+	end
+
+	local function render(html: Array<Instance>, ref_: Object?)
+		local ref = (if ref_ == nil then {} else ref_) :: Object
+		-- ROBLOX deviation START: use ROBLOX instances
+		-- local container = if ref.container == nil then document:createElement("div") else ref.container
+		local container
+		if ref.container == nil then
+			local div = Instance.new("Frame")
+			container = div
+			container.Parent = document
+		else
+			container = ref.container
+		end
+		container:ClearAllChildren()
+		for i = 1, #html do
+			html[i].Parent = container
+		end
+		-- ROBLOX deviation END
+		local containerQueries = getQueriesForElement(container)
+		local function rerender(newHtml: Array<Instance>)
+			return render(newHtml, { container = container })
+		end
+		return Object.assign({}, { container = container, rerender = rerender }, containerQueries)
+	end
+
+	local function renderIntoDocument(html: Array<Instance>)
+		-- ROBLOX START deviation: no document.body
+		return render(html, { container = document })
+		-- ROBLOX deviation END
+	end
+
+	local function cleanup()
+		-- ROBLOX deviation START:
+		-- document.body.innerHTML = ""
+		document:ClearAllChildren()
+		-- ROBLOX deviation END
+	end
+
+	afterEach(cleanup)
+
+	exports.render = render
+	exports.renderIntoDocument = renderIntoDocument
+	exports.cleanup = cleanup
+
+	return exports
+end