Skip to content

Commit 6f06252

Browse files
author
RoFlection Bot
committed
Switch tests to use Jest - Purge TestEZ (#36)
1 parent edf0897 commit 6f06252

23 files changed

+1057
-1108
lines changed

‎bin/spec.lua‎

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,16 @@
11
local Root = game:GetService("ReplicatedStorage")
2-
32
local Packages = Root.Packages
43

5-
local JestGlobals = require(Packages.Dev.JestGlobals)
4+
local runCLI = require(Packages.Dev.Jest).runCLI
65

7-
local TestEZ = JestGlobals.TestEZ
6+
local status, result = runCLI(Root, {
7+
verbose = _G.verbose == "true",
8+
ci = _G.CI == "true",
9+
updateSnapshot = _G.UPDATESNAPSHOT == "true",
10+
}, { Packages.ReactTestingLibrary }):awaitStatus()
811

9-
-- Run all tests, collect results, and report to stdout.
10-
TestEZ.TestBootstrap:run(
11-
{ Packages.ReactTestingLibrary },
12-
TestEZ.Reporters.pipe({
13-
TestEZ.Reporters.JestDefaultReporter,
14-
TestEZ.Reporters.JestSummaryReporter,
15-
}),
16-
{
17-
extraEnvironment = JestGlobals.testEnv,
18-
}
19-
)
20-
-- ROBLOX TODO: after converting jest-runner this should be included there
21-
JestGlobals.runtime:teardown()
12+
if status == "Rejected" then
13+
print(result)
14+
end
2215

2316
return nil

‎foreman.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[tools]
22
rotrieve = { source = "roblox/rotriever", version = "0.5.4" }
3-
selene = { source = "Kampfkarren/selene", version = "0.18.2" }
3+
selene = { source = "Kampfkarren/selene", version = "0.20.0" }
44
stylua = { source = "JohnnyMorganz/StyLua", version = "=0.14.2" }

‎rotriever.toml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ React = { git = "https://github.com/roblox/roact-alignment.git", package = "Reac
1414
ReactRoblox = { git = "https://github.com/roblox/roact-alignment.git", package = "ReactRoblox" }
1515
Scheduler = { git = "https://github.com/roblox/roact-alignment.git", package = "Scheduler" }
1616
Shared = { git = "https://github.com/roblox/roact-alignment.git", package = "Shared" }
17+
JestGlobals = "github.com/roblox/jest-roblox@3.0.0-alpha"
1718

1819
[dev_dependencies]
19-
JestGlobals = { git = "https://github.com/roblox/jest-roblox.git", rev="master" }
20+
Jest = { git = "https://github.com/roblox/jest-roblox.git", version="3.0.0-alpha", package="Jest" }
2021
LuauRegExp = "github.com/Roblox/luau-regexp@0.2.0"
22+

‎selene.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
std = "roblox+testez"
1+
std = "roblox"
22

33
[config]
44
empty_if = { comments_count = true }

‎src/__tests__/act.spec.lua‎

Lines changed: 61 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,69 @@
11
-- ROBLOX upstream: https://github.com/testing-library/react-testing-library/blob/v12.1.5/src/__tests__/act.js
2-
return function()
3-
local Packages = script.Parent.Parent.Parent
2+
local Packages = script.Parent.Parent.Parent
43

5-
local JestGlobals = require(Packages.Dev.JestGlobals)
6-
local jestExpect = JestGlobals.expect
7-
local jest = JestGlobals.jest
4+
local JestGlobals = require(Packages.JestGlobals)
5+
local expect = JestGlobals.expect
6+
local test = JestGlobals.test
7+
local jest = JestGlobals.jest
88

9-
local Promise = require(Packages.Promise)
9+
local Promise = require(Packages.Promise)
1010

11-
local React = require(Packages.React)
12-
local ParentModule = require(script.Parent.Parent)(afterEach)
13-
local render = ParentModule.render
14-
local fireEvent = ParentModule.fireEvent
15-
local screen = ParentModule.screen
11+
local React = require(Packages.React)
12+
local ParentModule = require(script.Parent.Parent)
13+
local render = ParentModule.render
14+
local fireEvent = ParentModule.fireEvent
15+
local screen = ParentModule.screen
1616

17-
it("render calls useEffect immediately", function()
18-
local effectCb = jest.fn()
19-
local function MyUselessComponent()
20-
React.useEffect(effectCb)
21-
return nil
22-
end
23-
render(React.createElement(MyUselessComponent, nil))
24-
jestExpect(effectCb).toHaveBeenCalledTimes(1)
25-
end)
17+
test("render calls useEffect immediately", function()
18+
local effectCb = jest.fn()
19+
local function MyUselessComponent()
20+
React.useEffect(effectCb)
21+
return nil
22+
end
23+
render(React.createElement(MyUselessComponent, nil))
24+
expect(effectCb).toHaveBeenCalledTimes(1)
25+
end)
2626

27-
it("findByTestId returns the element", function()
28-
return Promise.resolve()
29-
:andThen(function()
30-
local ref = React.createRef()
31-
render(React.createElement("Frame", { ref = ref, [React.Tag] = "data-testid=foo" }))
32-
jestExpect(screen.findByTestId("foo"):expect()).toBe(ref.current)
33-
end)
34-
:expect()
35-
end)
27+
test("findByTestId returns the element", function()
28+
return Promise.resolve()
29+
:andThen(function()
30+
local ref = React.createRef()
31+
render(React.createElement("Frame", { ref = ref, [React.Tag] = "data-testid=foo" }))
32+
expect(screen.findByTestId("foo"):expect()).toBe(ref.current)
33+
end)
34+
:expect()
35+
end)
3636

37-
it("fireEvent triggers useEffect calls", function()
38-
local effectCb = jest.fn()
39-
local function Counter()
40-
React.useEffect(effectCb)
41-
local count, setCount = React.useState(0)
42-
return React.createElement("TextButton", {
43-
Size = UDim2.new(0, 100, 0, 100),
44-
[React.Event.Activated] = function()
45-
return setCount(count + 1)
46-
end,
47-
Text = count,
48-
})
49-
end
50-
local buttonNode = render(React.createElement(Counter, nil)).container:GetChildren()[1]
51-
task.wait()
52-
effectCb:mockClear()
53-
fireEvent.click(buttonNode)
54-
jestExpect(buttonNode).toHaveTextContent("1")
55-
jestExpect(effectCb).toHaveBeenCalledTimes(1)
56-
end)
37+
test("fireEvent triggers useEffect calls", function()
38+
local effectCb = jest.fn()
39+
local function Counter()
40+
React.useEffect(effectCb)
41+
local count, setCount = React.useState(0)
42+
return React.createElement("TextButton", {
43+
Size = UDim2.new(0, 100, 0, 100),
44+
[React.Event.Activated] = function()
45+
return setCount(count + 1)
46+
end,
47+
Text = count,
48+
})
49+
end
50+
local buttonNode = render(React.createElement(Counter, nil)).container:GetChildren()[1]
51+
task.wait()
52+
effectCb:mockClear()
53+
fireEvent.click(buttonNode)
54+
expect(buttonNode).toHaveTextContent("1")
55+
expect(effectCb).toHaveBeenCalledTimes(1)
56+
end)
5757

58-
-- ROBLOX deviation START: hydrate is not supported
59-
-- it("calls to hydrate will run useEffects", function()
60-
-- local effectCb = jest.fn()
61-
-- local function MyUselessComponent()
62-
-- React.useEffect(effectCb)
63-
-- return nil
64-
-- end
65-
-- render(React.createElement(MyUselessComponent, nil), { hydrate = true })
66-
-- jestExpect(effectCb).toHaveBeenCalledTimes(1)
67-
-- end)
68-
-- ROBLOX deviation END
69-
end
58+
-- ROBLOX deviation START: hydrate is not supported
59+
-- it("calls to hydrate will run useEffects", function()
60+
-- local effectCb = jest.fn()
61+
-- local function MyUselessComponent()
62+
-- React.useEffect(effectCb)
63+
-- return nil
64+
-- end
65+
-- render(React.createElement(MyUselessComponent, nil), { hydrate = true })
66+
-- expect(effectCb).toHaveBeenCalledTimes(1)
67+
-- end)
68+
-- ROBLOX deviation END
69+
return {}

‎src/__tests__/auto-cleanup-skip.spec.lua‎

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,40 @@
11
-- ROBLOX upstream: https://github.com/testing-library/react-testing-library/blob/v12.1.5/src/__tests__/auto-cleanup-skip.js
2-
return function()
3-
local Packages = script.Parent.Parent.Parent
2+
local Packages = script.Parent.Parent.Parent
43

5-
local JestGlobals = require(Packages.Dev.JestGlobals)
6-
local jestExpect = JestGlobals.expect
4+
local JestGlobals = require(Packages.JestGlobals)
5+
local expect = JestGlobals.expect
6+
local test = JestGlobals.test
7+
local beforeAll = JestGlobals.beforeAll
8+
local afterAll = JestGlobals.afterAll
79

8-
local document = require(Packages.DomTestingLibrary).document
10+
local document = require(Packages.DomTestingLibrary).document
911

10-
local React = require(Packages.React)
11-
local render, cleanup
12-
beforeAll(function()
13-
_G.RTL_SKIP_AUTO_CLEANUP = "true"
14-
local rtl = require(script.Parent.Parent)(afterEach)
15-
render = rtl.render
16-
-- ROBLOX deviation START: force cleanup
17-
cleanup = rtl.cleanup
18-
-- ROBLOX deviation END
19-
end)
20-
21-
-- ROBLOX deviation START: restore so it cleans up after this test
22-
afterAll(function()
23-
_G.RTL_SKIP_AUTO_CLEANUP = nil
24-
cleanup()
25-
end)
12+
local React = require(Packages.React)
13+
local render, cleanup
14+
beforeAll(function()
15+
_G.RTL_SKIP_AUTO_CLEANUP = "true"
16+
local rtl = require(script.Parent.Parent)
17+
render = rtl.render
18+
-- ROBLOX deviation START: force cleanup
19+
cleanup = rtl.cleanup
2620
-- ROBLOX deviation END
21+
end)
22+
23+
-- ROBLOX deviation START: restore so it cleans up after this test
24+
afterAll(function()
25+
_G.RTL_SKIP_AUTO_CLEANUP = nil
26+
cleanup()
27+
end)
28+
-- ROBLOX deviation END
2729

28-
-- This one verifies that if RTL_SKIP_AUTO_CLEANUP is set
29-
-- then we DON'T auto-wire up the afterEach for folks
30-
it("first", function()
31-
render(React.createElement("TextLabel", { Text = "hi" }))
32-
end)
30+
-- This one verifies that if RTL_SKIP_AUTO_CLEANUP is set
31+
-- then we DON'T auto-wire up the afterEach for folks
32+
test("first", function()
33+
render(React.createElement("TextLabel", { Text = "hi" }))
34+
end)
3335

34-
it("second", function()
35-
jestExpect(document:GetChildren()[1]:GetChildren()[1]:IsA("TextLabel")).toBe(true)
36-
jestExpect(document:GetChildren()[1]:GetChildren()[1].Text).toBe("hi")
37-
end)
38-
end
36+
test("second", function()
37+
expect(document:GetChildren()[1]:GetChildren()[1]:IsA("TextLabel")).toBe(true)
38+
expect(document:GetChildren()[1]:GetChildren()[1].Text).toBe("hi")
39+
end)
40+
return {}

‎src/__tests__/auto-cleanup.spec.lua‎

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
-- ROBLOX upstream: https://github.com/testing-library/react-testing-library/blob/v12.1.5/src/__tests__/auto-cleanup.js
2-
return function()
3-
local Packages = script.Parent.Parent.Parent
2+
local Packages = script.Parent.Parent.Parent
43

5-
local JestGlobals = require(Packages.Dev.JestGlobals)
6-
local jestExpect = JestGlobals.expect
4+
local JestGlobals = require(Packages.JestGlobals)
5+
local expect = JestGlobals.expect
6+
local test = JestGlobals.test
77

8-
local document = require(Packages.DomTestingLibrary).document
8+
local document = require(Packages.DomTestingLibrary).document
99

10-
local React = require(Packages.React)
11-
local render = require(script.Parent.Parent)(afterEach).render -- This just verifies that by importing RTL in an
12-
-- environment which supports afterEach (like jest)
13-
-- we'll get automatic cleanup between tests.
14-
it("first", function()
15-
render(React.createElement("TextLabel", { Text = "hi" }))
16-
end)
10+
local React = require(Packages.React)
11+
local render = require(script.Parent.Parent).render
1712

18-
it("second", function()
19-
jestExpect(document).toBeEmptyDOMElement()
20-
end)
21-
end
13+
-- This just verifies that by importing RTL in an
14+
-- environment which supports afterEach (like jest)
15+
-- we'll get automatic cleanup between tests.
16+
test("first", function()
17+
render(React.createElement("TextLabel", { Text = "hi" }))
18+
end)
19+
20+
test.only("second", function()
21+
expect(document).toBeEmptyDOMElement()
22+
end)
23+
24+
return {}

0 commit comments

Comments
 (0)