roblox-opencode 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. package/README.md +112 -122
  2. package/commands/setup-game.md +108 -108
  3. package/commands/sync-check.md +53 -53
  4. package/core/roblox-core.md +93 -93
  5. package/dist/server.js +189 -167
  6. package/package.json +35 -35
  7. package/skills/roblox-analytics/SKILL.md +277 -277
  8. package/skills/roblox-analytics/references/event-batcher.luau +75 -75
  9. package/skills/roblox-animation-vfx/SKILL.md +1325 -1325
  10. package/skills/roblox-architecture/SKILL.md +877 -863
  11. package/skills/roblox-architecture/references/combat-systems.md +1381 -1381
  12. package/skills/roblox-code-review/SKILL.md +686 -686
  13. package/skills/roblox-data/SKILL.md +889 -889
  14. package/skills/roblox-data/references/inventory-systems.md +1729 -1729
  15. package/skills/roblox-debug/SKILL.md +98 -98
  16. package/skills/roblox-gui/SKILL.md +1103 -1103
  17. package/skills/roblox-gui-fusion/SKILL.md +150 -150
  18. package/skills/roblox-gui-fusion/references/inventory.luau +427 -427
  19. package/skills/roblox-gui-fusion/references/settings-menu.luau +579 -579
  20. package/skills/roblox-gui-fusion/references/shop.luau +411 -411
  21. package/skills/roblox-luau-mastery/SKILL.md +1618 -1519
  22. package/skills/roblox-monetization/SKILL.md +1084 -1084
  23. package/skills/roblox-monetization/references/process-receipt.luau +131 -131
  24. package/skills/roblox-networking/SKILL.md +669 -669
  25. package/skills/roblox-networking/references/remote-validator.luau +193 -193
  26. package/skills/roblox-publish-checklist/SKILL.md +127 -127
  27. package/skills/roblox-runtime/SKILL.md +753 -753
  28. package/skills/roblox-sharp-edges/SKILL.md +294 -294
  29. package/skills/roblox-sync/SKILL.md +126 -126
  30. package/skills/roblox-testing/SKILL.md +943 -943
  31. package/skills/roblox-tooling/SKILL.md +149 -149
  32. package/vendor/LICENSES/ProfileStore-LICENSE +201 -201
  33. package/vendor/LICENSES/RbxUtil-LICENSE +7 -7
  34. package/vendor/LICENSES/promise-LICENSE +20 -20
  35. package/vendor/LICENSES/t-LICENSE +21 -21
  36. package/vendor/LICENSES/testez-LICENSE +200 -200
  37. package/vendor/README.md +83 -83
  38. package/vendor/fusion/Animation/ExternalTime.luau +83 -83
  39. package/vendor/fusion/Animation/Spring.luau +321 -321
  40. package/vendor/fusion/Animation/Stopwatch.luau +127 -127
  41. package/vendor/fusion/Animation/Tween.luau +187 -187
  42. package/vendor/fusion/Animation/getTweenDuration.luau +27 -27
  43. package/vendor/fusion/Animation/getTweenRatio.luau +47 -47
  44. package/vendor/fusion/Animation/lerpType.luau +163 -163
  45. package/vendor/fusion/Animation/packType.luau +99 -99
  46. package/vendor/fusion/Animation/springCoefficients.luau +80 -80
  47. package/vendor/fusion/Animation/unpackType.luau +102 -102
  48. package/vendor/fusion/Colour/Oklab.luau +70 -70
  49. package/vendor/fusion/Colour/sRGB.luau +54 -54
  50. package/vendor/fusion/External.luau +167 -167
  51. package/vendor/fusion/ExternalDebug.luau +69 -69
  52. package/vendor/fusion/Graph/Observer.luau +113 -113
  53. package/vendor/fusion/Graph/castToGraph.luau +28 -28
  54. package/vendor/fusion/Graph/change.luau +80 -80
  55. package/vendor/fusion/Graph/depend.luau +32 -32
  56. package/vendor/fusion/Graph/evaluate.luau +55 -55
  57. package/vendor/fusion/Instances/Attribute.luau +57 -57
  58. package/vendor/fusion/Instances/AttributeChange.luau +46 -46
  59. package/vendor/fusion/Instances/AttributeOut.luau +63 -63
  60. package/vendor/fusion/Instances/Child.luau +21 -21
  61. package/vendor/fusion/Instances/Children.luau +147 -147
  62. package/vendor/fusion/Instances/Hydrate.luau +32 -32
  63. package/vendor/fusion/Instances/New.luau +52 -52
  64. package/vendor/fusion/Instances/OnChange.luau +49 -49
  65. package/vendor/fusion/Instances/OnEvent.luau +53 -53
  66. package/vendor/fusion/Instances/Out.luau +69 -69
  67. package/vendor/fusion/Instances/applyInstanceProps.luau +148 -148
  68. package/vendor/fusion/Instances/defaultProps.luau +194 -194
  69. package/vendor/fusion/LICENSE +21 -21
  70. package/vendor/fusion/Logging/formatError.luau +48 -48
  71. package/vendor/fusion/Logging/messages.luau +51 -51
  72. package/vendor/fusion/Logging/parseError.luau +24 -24
  73. package/vendor/fusion/Memory/checkLifetime.luau +133 -133
  74. package/vendor/fusion/Memory/deriveScope.luau +23 -23
  75. package/vendor/fusion/Memory/deriveScopeImpl.luau +44 -44
  76. package/vendor/fusion/Memory/doCleanup.luau +78 -78
  77. package/vendor/fusion/Memory/innerScope.luau +33 -33
  78. package/vendor/fusion/Memory/legacyCleanup.luau +17 -17
  79. package/vendor/fusion/Memory/needsDestruction.luau +16 -16
  80. package/vendor/fusion/Memory/poisonScope.luau +33 -33
  81. package/vendor/fusion/Memory/scopePool.luau +54 -54
  82. package/vendor/fusion/Memory/scoped.luau +26 -26
  83. package/vendor/fusion/Memory/whichLivesLonger.luau +74 -74
  84. package/vendor/fusion/RobloxExternal.luau +97 -97
  85. package/vendor/fusion/State/Computed.luau +138 -138
  86. package/vendor/fusion/State/For/Disassembly.luau +210 -210
  87. package/vendor/fusion/State/For/ForTypes.luau +30 -30
  88. package/vendor/fusion/State/For/init.luau +109 -109
  89. package/vendor/fusion/State/ForKeys.luau +93 -93
  90. package/vendor/fusion/State/ForPairs.luau +96 -96
  91. package/vendor/fusion/State/ForValues.luau +93 -93
  92. package/vendor/fusion/State/Value.luau +87 -87
  93. package/vendor/fusion/State/castToState.luau +25 -25
  94. package/vendor/fusion/State/peek.luau +30 -30
  95. package/vendor/fusion/Types.luau +314 -314
  96. package/vendor/fusion/Utility/Contextual.luau +90 -90
  97. package/vendor/fusion/Utility/Safe.luau +22 -22
  98. package/vendor/fusion/Utility/isSimilar.luau +29 -29
  99. package/vendor/fusion/Utility/merge.luau +35 -35
  100. package/vendor/fusion/Utility/nameOf.luau +34 -34
  101. package/vendor/fusion/Utility/never.luau +13 -13
  102. package/vendor/fusion/Utility/nicknames.luau +10 -10
  103. package/vendor/fusion/Utility/xtypeof.luau +26 -26
  104. package/vendor/fusion/init.luau +82 -82
  105. package/vendor/profilestore/init.luau +2242 -2242
  106. package/vendor/promise/init.luau +1982 -1982
  107. package/vendor/rbxutil/buffer-util/Buffer.test.luau +25 -25
  108. package/vendor/rbxutil/buffer-util/BufferReader.luau +228 -228
  109. package/vendor/rbxutil/buffer-util/BufferWriter.luau +269 -269
  110. package/vendor/rbxutil/buffer-util/DataTypeBuffer.luau +223 -223
  111. package/vendor/rbxutil/buffer-util/Types.luau +60 -60
  112. package/vendor/rbxutil/buffer-util/index.d.ts +153 -153
  113. package/vendor/rbxutil/buffer-util/init.luau +41 -41
  114. package/vendor/rbxutil/buffer-util/package.json +16 -16
  115. package/vendor/rbxutil/buffer-util/wally.toml +9 -9
  116. package/vendor/rbxutil/comm/Client/ClientComm.luau +232 -232
  117. package/vendor/rbxutil/comm/Client/ClientRemoteProperty.luau +156 -156
  118. package/vendor/rbxutil/comm/Client/ClientRemoteSignal.luau +109 -109
  119. package/vendor/rbxutil/comm/Client/init.luau +135 -135
  120. package/vendor/rbxutil/comm/Server/RemoteProperty.luau +295 -295
  121. package/vendor/rbxutil/comm/Server/RemoteSignal.luau +211 -211
  122. package/vendor/rbxutil/comm/Server/ServerComm.luau +211 -211
  123. package/vendor/rbxutil/comm/Server/init.luau +140 -140
  124. package/vendor/rbxutil/comm/Types.luau +18 -18
  125. package/vendor/rbxutil/comm/Util.luau +27 -27
  126. package/vendor/rbxutil/comm/init.luau +35 -35
  127. package/vendor/rbxutil/comm/wally.toml +13 -13
  128. package/vendor/rbxutil/component/init.luau +759 -759
  129. package/vendor/rbxutil/component/init.test.luau +311 -311
  130. package/vendor/rbxutil/component/wally.toml +14 -14
  131. package/vendor/rbxutil/concur/init.luau +542 -542
  132. package/vendor/rbxutil/concur/init.test.luau +364 -364
  133. package/vendor/rbxutil/concur/wally.toml +8 -8
  134. package/vendor/rbxutil/enum-list/init.luau +101 -101
  135. package/vendor/rbxutil/enum-list/init.test.luau +91 -91
  136. package/vendor/rbxutil/enum-list/wally.toml +8 -8
  137. package/vendor/rbxutil/find/index.d.ts +20 -20
  138. package/vendor/rbxutil/find/init.luau +44 -44
  139. package/vendor/rbxutil/find/package.json +17 -17
  140. package/vendor/rbxutil/find/wally.toml +8 -8
  141. package/vendor/rbxutil/input/Gamepad.luau +559 -559
  142. package/vendor/rbxutil/input/Keyboard.luau +124 -124
  143. package/vendor/rbxutil/input/Mouse.luau +278 -278
  144. package/vendor/rbxutil/input/PreferredInput.luau +91 -91
  145. package/vendor/rbxutil/input/Touch.luau +120 -120
  146. package/vendor/rbxutil/input/init.luau +33 -33
  147. package/vendor/rbxutil/input/wally.toml +12 -12
  148. package/vendor/rbxutil/loader/index.d.ts +15 -15
  149. package/vendor/rbxutil/loader/init.luau +137 -137
  150. package/vendor/rbxutil/loader/wally.toml +8 -8
  151. package/vendor/rbxutil/log/index.d.ts +38 -38
  152. package/vendor/rbxutil/log/init.luau +746 -746
  153. package/vendor/rbxutil/log/wally.toml +8 -8
  154. package/vendor/rbxutil/net/init.luau +190 -190
  155. package/vendor/rbxutil/net/wally.toml +8 -8
  156. package/vendor/rbxutil/option/index.d.ts +44 -44
  157. package/vendor/rbxutil/option/init.luau +489 -489
  158. package/vendor/rbxutil/option/init.test.luau +342 -342
  159. package/vendor/rbxutil/option/wally.toml +8 -8
  160. package/vendor/rbxutil/pid/index.d.ts +53 -53
  161. package/vendor/rbxutil/pid/init.luau +195 -195
  162. package/vendor/rbxutil/pid/package.json +16 -16
  163. package/vendor/rbxutil/pid/wally.toml +9 -9
  164. package/vendor/rbxutil/quaternion/index.d.ts +117 -117
  165. package/vendor/rbxutil/quaternion/init.luau +570 -570
  166. package/vendor/rbxutil/quaternion/package.json +16 -16
  167. package/vendor/rbxutil/quaternion/wally.toml +9 -9
  168. package/vendor/rbxutil/query/index.d.ts +43 -43
  169. package/vendor/rbxutil/query/init.luau +117 -117
  170. package/vendor/rbxutil/query/package.json +18 -18
  171. package/vendor/rbxutil/query/wally.toml +9 -9
  172. package/vendor/rbxutil/sequent/index.d.ts +28 -28
  173. package/vendor/rbxutil/sequent/init.luau +340 -340
  174. package/vendor/rbxutil/sequent/package.json +16 -16
  175. package/vendor/rbxutil/sequent/wally.toml +9 -9
  176. package/vendor/rbxutil/ser/init.luau +175 -175
  177. package/vendor/rbxutil/ser/init.test.luau +50 -50
  178. package/vendor/rbxutil/ser/wally.toml +11 -11
  179. package/vendor/rbxutil/shake/index.d.ts +36 -36
  180. package/vendor/rbxutil/shake/init.luau +532 -532
  181. package/vendor/rbxutil/shake/init.test.luau +267 -267
  182. package/vendor/rbxutil/shake/package.json +16 -16
  183. package/vendor/rbxutil/shake/wally.toml +9 -9
  184. package/vendor/rbxutil/signal/index.d.ts +100 -100
  185. package/vendor/rbxutil/signal/init.luau +432 -432
  186. package/vendor/rbxutil/signal/init.test.luau +190 -190
  187. package/vendor/rbxutil/signal/package.json +17 -17
  188. package/vendor/rbxutil/signal/wally.toml +9 -9
  189. package/vendor/rbxutil/silo/TableWatcher.luau +65 -65
  190. package/vendor/rbxutil/silo/Util.luau +55 -55
  191. package/vendor/rbxutil/silo/init.luau +338 -338
  192. package/vendor/rbxutil/silo/init.test.luau +215 -215
  193. package/vendor/rbxutil/silo/wally.toml +8 -8
  194. package/vendor/rbxutil/spring/index.d.ts +40 -40
  195. package/vendor/rbxutil/spring/init.luau +97 -97
  196. package/vendor/rbxutil/spring/package.json +17 -17
  197. package/vendor/rbxutil/spring/wally.toml +8 -8
  198. package/vendor/rbxutil/stream/index.d.ts +88 -88
  199. package/vendor/rbxutil/stream/init.luau +597 -597
  200. package/vendor/rbxutil/stream/package.json +18 -18
  201. package/vendor/rbxutil/stream/wally.toml +9 -9
  202. package/vendor/rbxutil/streamable/Streamable.luau +202 -202
  203. package/vendor/rbxutil/streamable/StreamableUtil.luau +80 -80
  204. package/vendor/rbxutil/streamable/init.luau +8 -8
  205. package/vendor/rbxutil/streamable/wally.toml +12 -12
  206. package/vendor/rbxutil/symbol/init.luau +56 -56
  207. package/vendor/rbxutil/symbol/init.test.luau +37 -37
  208. package/vendor/rbxutil/symbol/wally.toml +8 -8
  209. package/vendor/rbxutil/table-util/init.luau +938 -938
  210. package/vendor/rbxutil/table-util/init.test.luau +439 -439
  211. package/vendor/rbxutil/task-queue/index.d.ts +27 -27
  212. package/vendor/rbxutil/task-queue/init.luau +97 -97
  213. package/vendor/rbxutil/task-queue/wally.toml +8 -8
  214. package/vendor/rbxutil/timer/index.d.ts +81 -81
  215. package/vendor/rbxutil/timer/init.luau +249 -249
  216. package/vendor/rbxutil/timer/init.test.luau +73 -73
  217. package/vendor/rbxutil/timer/wally.toml +11 -11
  218. package/vendor/rbxutil/tree/index.d.ts +15 -15
  219. package/vendor/rbxutil/tree/init.luau +137 -137
  220. package/vendor/rbxutil/tree/wally.toml +8 -8
  221. package/vendor/rbxutil/trove/index.d.ts +46 -46
  222. package/vendor/rbxutil/trove/init.luau +787 -787
  223. package/vendor/rbxutil/trove/init.test.luau +203 -203
  224. package/vendor/rbxutil/trove/wally.toml +8 -8
  225. package/vendor/rbxutil/typed-remote/init.luau +196 -196
  226. package/vendor/rbxutil/typed-remote/wally.toml +8 -8
  227. package/vendor/rbxutil/wait-for/index.d.ts +17 -17
  228. package/vendor/rbxutil/wait-for/init.luau +257 -257
  229. package/vendor/rbxutil/wait-for/init.test.luau +182 -182
  230. package/vendor/rbxutil/wait-for/wally.toml +11 -11
  231. package/vendor/t/t.lua +1350 -1350
  232. package/vendor/testez/Context.lua +26 -26
  233. package/vendor/testez/Expectation.lua +311 -311
  234. package/vendor/testez/ExpectationContext.lua +38 -38
  235. package/vendor/testez/LifecycleHooks.lua +89 -89
  236. package/vendor/testez/Reporters/TeamCityReporter.lua +101 -101
  237. package/vendor/testez/Reporters/TextReporter.lua +105 -105
  238. package/vendor/testez/Reporters/TextReporterQuiet.lua +96 -96
  239. package/vendor/testez/TestBootstrap.lua +146 -146
  240. package/vendor/testez/TestEnum.lua +27 -27
  241. package/vendor/testez/TestPlan.lua +304 -304
  242. package/vendor/testez/TestPlanner.lua +39 -39
  243. package/vendor/testez/TestResults.lua +111 -111
  244. package/vendor/testez/TestRunner.lua +188 -188
  245. package/vendor/testez/TestSession.lua +243 -243
  246. package/vendor/testez/init.lua +39 -39
@@ -1,243 +1,243 @@
1
- --[[
2
- Represents the state relevant while executing a test plan.
3
-
4
- Used by TestRunner to produce a TestResults object.
5
-
6
- Uses the same tree building structure as TestPlanBuilder; TestSession keeps
7
- track of a stack of nodes that represent the current path through the tree.
8
- ]]
9
-
10
- local TestEnum = require(script.Parent.TestEnum)
11
- local TestResults = require(script.Parent.TestResults)
12
- local Context = require(script.Parent.Context)
13
- local ExpectationContext = require(script.Parent.ExpectationContext)
14
-
15
- local TestSession = {}
16
-
17
- TestSession.__index = TestSession
18
-
19
- --[[
20
- Create a TestSession related to the given TestPlan.
21
-
22
- The resulting TestResults object will be linked to this TestPlan.
23
- ]]
24
- function TestSession.new(plan)
25
- local self = {
26
- results = TestResults.new(plan),
27
- nodeStack = {},
28
- contextStack = {},
29
- expectationContextStack = {},
30
- hasFocusNodes = false
31
- }
32
-
33
- setmetatable(self, TestSession)
34
-
35
- return self
36
- end
37
-
38
- --[[
39
- Calculate success, failure, and skipped test counts in the tree at the
40
- current point in the execution.
41
- ]]
42
- function TestSession:calculateTotals()
43
- local results = self.results
44
-
45
- results.successCount = 0
46
- results.failureCount = 0
47
- results.skippedCount = 0
48
-
49
- results:visitAllNodes(function(node)
50
- local status = node.status
51
- local nodeType = node.planNode.type
52
-
53
- if nodeType == TestEnum.NodeType.It then
54
- if status == TestEnum.TestStatus.Success then
55
- results.successCount = results.successCount + 1
56
- elseif status == TestEnum.TestStatus.Failure then
57
- results.failureCount = results.failureCount + 1
58
- elseif status == TestEnum.TestStatus.Skipped then
59
- results.skippedCount = results.skippedCount + 1
60
- end
61
- end
62
- end)
63
- end
64
-
65
- --[[
66
- Gathers all of the errors reported by tests and puts them at the top level
67
- of the TestResults object.
68
- ]]
69
- function TestSession:gatherErrors()
70
- local results = self.results
71
-
72
- results.errors = {}
73
-
74
- results:visitAllNodes(function(node)
75
- if #node.errors > 0 then
76
- for _, message in ipairs(node.errors) do
77
- table.insert(results.errors, message)
78
- end
79
- end
80
- end)
81
- end
82
-
83
- --[[
84
- Calculates test totals, verifies the tree is valid, and returns results.
85
- ]]
86
- function TestSession:finalize()
87
- if #self.nodeStack ~= 0 then
88
- error("Cannot finalize TestResults with nodes still on the stack!", 2)
89
- end
90
-
91
- self:calculateTotals()
92
- self:gatherErrors()
93
-
94
- return self.results
95
- end
96
-
97
- --[[
98
- Create a new test result node and push it onto the navigation stack.
99
- ]]
100
- function TestSession:pushNode(planNode)
101
- local node = TestResults.createNode(planNode)
102
- local lastNode = self.nodeStack[#self.nodeStack] or self.results
103
- table.insert(lastNode.children, node)
104
- table.insert(self.nodeStack, node)
105
-
106
- local lastContext = self.contextStack[#self.contextStack]
107
- local context = Context.new(lastContext)
108
- table.insert(self.contextStack, context)
109
-
110
- local lastExpectationContext = self.expectationContextStack[#self.expectationContextStack]
111
- local expectationContext = ExpectationContext.new(lastExpectationContext)
112
- table.insert(self.expectationContextStack, expectationContext)
113
- end
114
-
115
- --[[
116
- Pops a node off of the navigation stack.
117
- ]]
118
- function TestSession:popNode()
119
- assert(#self.nodeStack > 0, "Tried to pop from an empty node stack!")
120
- table.remove(self.nodeStack, #self.nodeStack)
121
- table.remove(self.contextStack, #self.contextStack)
122
- table.remove(self.expectationContextStack, #self.expectationContextStack)
123
- end
124
-
125
- --[[
126
- Gets the Context object for the current node.
127
- ]]
128
- function TestSession:getContext()
129
- assert(#self.contextStack > 0, "Tried to get context from an empty stack!")
130
- return self.contextStack[#self.contextStack]
131
- end
132
-
133
-
134
- function TestSession:getExpectationContext()
135
- assert(#self.expectationContextStack > 0, "Tried to get expectationContext from an empty stack!")
136
- return self.expectationContextStack[#self.expectationContextStack]
137
- end
138
-
139
- --[[
140
- Tells whether the current test we're in should be skipped.
141
- ]]
142
- function TestSession:shouldSkip()
143
- -- If our test tree had any exclusive tests, then normal tests are skipped!
144
- if self.hasFocusNodes then
145
- for i = #self.nodeStack, 1, -1 do
146
- local node = self.nodeStack[i]
147
-
148
- -- Skipped tests are still skipped
149
- if node.planNode.modifier == TestEnum.NodeModifier.Skip then
150
- return true
151
- end
152
-
153
- -- Focused tests are the only ones that aren't skipped
154
- if node.planNode.modifier == TestEnum.NodeModifier.Focus then
155
- return false
156
- end
157
- end
158
-
159
- return true
160
- else
161
- for i = #self.nodeStack, 1, -1 do
162
- local node = self.nodeStack[i]
163
-
164
- if node.planNode.modifier == TestEnum.NodeModifier.Skip then
165
- return true
166
- end
167
- end
168
- end
169
-
170
- return false
171
- end
172
-
173
- --[[
174
- Set the current node's status to Success.
175
- ]]
176
- function TestSession:setSuccess()
177
- assert(#self.nodeStack > 0, "Attempting to set success status on empty stack")
178
- self.nodeStack[#self.nodeStack].status = TestEnum.TestStatus.Success
179
- end
180
-
181
- --[[
182
- Set the current node's status to Skipped.
183
- ]]
184
- function TestSession:setSkipped()
185
- assert(#self.nodeStack > 0, "Attempting to set skipped status on empty stack")
186
- self.nodeStack[#self.nodeStack].status = TestEnum.TestStatus.Skipped
187
- end
188
-
189
- --[[
190
- Set the current node's status to Failure and adds a message to its list of
191
- errors.
192
- ]]
193
- function TestSession:setError(message)
194
- assert(#self.nodeStack > 0, "Attempting to set error status on empty stack")
195
- local last = self.nodeStack[#self.nodeStack]
196
- last.status = TestEnum.TestStatus.Failure
197
- table.insert(last.errors, message)
198
- end
199
-
200
- --[[
201
- Add a dummy child node to the current node to hold the given error. This
202
- allows an otherwise empty describe node to report an error in a more natural
203
- way.
204
- ]]
205
- function TestSession:addDummyError(phrase, message)
206
- self:pushNode({type = TestEnum.NodeType.It, phrase = phrase})
207
- self:setError(message)
208
- self:popNode()
209
- self.nodeStack[#self.nodeStack].status = TestEnum.TestStatus.Failure
210
- end
211
-
212
- --[[
213
- Set the current node's status based on that of its children. If all children
214
- are skipped, mark it as skipped. If any are fails, mark it as failed.
215
- Otherwise, mark it as success.
216
- ]]
217
- function TestSession:setStatusFromChildren()
218
- assert(#self.nodeStack > 0, "Attempting to set status from children on empty stack")
219
-
220
- local last = self.nodeStack[#self.nodeStack]
221
- local status = TestEnum.TestStatus.Success
222
- local skipped = true
223
-
224
- -- If all children were skipped, then we were skipped
225
- -- If any child failed, then we failed!
226
- for _, child in ipairs(last.children) do
227
- if child.status ~= TestEnum.TestStatus.Skipped then
228
- skipped = false
229
-
230
- if child.status == TestEnum.TestStatus.Failure then
231
- status = TestEnum.TestStatus.Failure
232
- end
233
- end
234
- end
235
-
236
- if skipped then
237
- status = TestEnum.TestStatus.Skipped
238
- end
239
-
240
- last.status = status
241
- end
242
-
243
- return TestSession
1
+ --[[
2
+ Represents the state relevant while executing a test plan.
3
+
4
+ Used by TestRunner to produce a TestResults object.
5
+
6
+ Uses the same tree building structure as TestPlanBuilder; TestSession keeps
7
+ track of a stack of nodes that represent the current path through the tree.
8
+ ]]
9
+
10
+ local TestEnum = require(script.Parent.TestEnum)
11
+ local TestResults = require(script.Parent.TestResults)
12
+ local Context = require(script.Parent.Context)
13
+ local ExpectationContext = require(script.Parent.ExpectationContext)
14
+
15
+ local TestSession = {}
16
+
17
+ TestSession.__index = TestSession
18
+
19
+ --[[
20
+ Create a TestSession related to the given TestPlan.
21
+
22
+ The resulting TestResults object will be linked to this TestPlan.
23
+ ]]
24
+ function TestSession.new(plan)
25
+ local self = {
26
+ results = TestResults.new(plan),
27
+ nodeStack = {},
28
+ contextStack = {},
29
+ expectationContextStack = {},
30
+ hasFocusNodes = false
31
+ }
32
+
33
+ setmetatable(self, TestSession)
34
+
35
+ return self
36
+ end
37
+
38
+ --[[
39
+ Calculate success, failure, and skipped test counts in the tree at the
40
+ current point in the execution.
41
+ ]]
42
+ function TestSession:calculateTotals()
43
+ local results = self.results
44
+
45
+ results.successCount = 0
46
+ results.failureCount = 0
47
+ results.skippedCount = 0
48
+
49
+ results:visitAllNodes(function(node)
50
+ local status = node.status
51
+ local nodeType = node.planNode.type
52
+
53
+ if nodeType == TestEnum.NodeType.It then
54
+ if status == TestEnum.TestStatus.Success then
55
+ results.successCount = results.successCount + 1
56
+ elseif status == TestEnum.TestStatus.Failure then
57
+ results.failureCount = results.failureCount + 1
58
+ elseif status == TestEnum.TestStatus.Skipped then
59
+ results.skippedCount = results.skippedCount + 1
60
+ end
61
+ end
62
+ end)
63
+ end
64
+
65
+ --[[
66
+ Gathers all of the errors reported by tests and puts them at the top level
67
+ of the TestResults object.
68
+ ]]
69
+ function TestSession:gatherErrors()
70
+ local results = self.results
71
+
72
+ results.errors = {}
73
+
74
+ results:visitAllNodes(function(node)
75
+ if #node.errors > 0 then
76
+ for _, message in ipairs(node.errors) do
77
+ table.insert(results.errors, message)
78
+ end
79
+ end
80
+ end)
81
+ end
82
+
83
+ --[[
84
+ Calculates test totals, verifies the tree is valid, and returns results.
85
+ ]]
86
+ function TestSession:finalize()
87
+ if #self.nodeStack ~= 0 then
88
+ error("Cannot finalize TestResults with nodes still on the stack!", 2)
89
+ end
90
+
91
+ self:calculateTotals()
92
+ self:gatherErrors()
93
+
94
+ return self.results
95
+ end
96
+
97
+ --[[
98
+ Create a new test result node and push it onto the navigation stack.
99
+ ]]
100
+ function TestSession:pushNode(planNode)
101
+ local node = TestResults.createNode(planNode)
102
+ local lastNode = self.nodeStack[#self.nodeStack] or self.results
103
+ table.insert(lastNode.children, node)
104
+ table.insert(self.nodeStack, node)
105
+
106
+ local lastContext = self.contextStack[#self.contextStack]
107
+ local context = Context.new(lastContext)
108
+ table.insert(self.contextStack, context)
109
+
110
+ local lastExpectationContext = self.expectationContextStack[#self.expectationContextStack]
111
+ local expectationContext = ExpectationContext.new(lastExpectationContext)
112
+ table.insert(self.expectationContextStack, expectationContext)
113
+ end
114
+
115
+ --[[
116
+ Pops a node off of the navigation stack.
117
+ ]]
118
+ function TestSession:popNode()
119
+ assert(#self.nodeStack > 0, "Tried to pop from an empty node stack!")
120
+ table.remove(self.nodeStack, #self.nodeStack)
121
+ table.remove(self.contextStack, #self.contextStack)
122
+ table.remove(self.expectationContextStack, #self.expectationContextStack)
123
+ end
124
+
125
+ --[[
126
+ Gets the Context object for the current node.
127
+ ]]
128
+ function TestSession:getContext()
129
+ assert(#self.contextStack > 0, "Tried to get context from an empty stack!")
130
+ return self.contextStack[#self.contextStack]
131
+ end
132
+
133
+
134
+ function TestSession:getExpectationContext()
135
+ assert(#self.expectationContextStack > 0, "Tried to get expectationContext from an empty stack!")
136
+ return self.expectationContextStack[#self.expectationContextStack]
137
+ end
138
+
139
+ --[[
140
+ Tells whether the current test we're in should be skipped.
141
+ ]]
142
+ function TestSession:shouldSkip()
143
+ -- If our test tree had any exclusive tests, then normal tests are skipped!
144
+ if self.hasFocusNodes then
145
+ for i = #self.nodeStack, 1, -1 do
146
+ local node = self.nodeStack[i]
147
+
148
+ -- Skipped tests are still skipped
149
+ if node.planNode.modifier == TestEnum.NodeModifier.Skip then
150
+ return true
151
+ end
152
+
153
+ -- Focused tests are the only ones that aren't skipped
154
+ if node.planNode.modifier == TestEnum.NodeModifier.Focus then
155
+ return false
156
+ end
157
+ end
158
+
159
+ return true
160
+ else
161
+ for i = #self.nodeStack, 1, -1 do
162
+ local node = self.nodeStack[i]
163
+
164
+ if node.planNode.modifier == TestEnum.NodeModifier.Skip then
165
+ return true
166
+ end
167
+ end
168
+ end
169
+
170
+ return false
171
+ end
172
+
173
+ --[[
174
+ Set the current node's status to Success.
175
+ ]]
176
+ function TestSession:setSuccess()
177
+ assert(#self.nodeStack > 0, "Attempting to set success status on empty stack")
178
+ self.nodeStack[#self.nodeStack].status = TestEnum.TestStatus.Success
179
+ end
180
+
181
+ --[[
182
+ Set the current node's status to Skipped.
183
+ ]]
184
+ function TestSession:setSkipped()
185
+ assert(#self.nodeStack > 0, "Attempting to set skipped status on empty stack")
186
+ self.nodeStack[#self.nodeStack].status = TestEnum.TestStatus.Skipped
187
+ end
188
+
189
+ --[[
190
+ Set the current node's status to Failure and adds a message to its list of
191
+ errors.
192
+ ]]
193
+ function TestSession:setError(message)
194
+ assert(#self.nodeStack > 0, "Attempting to set error status on empty stack")
195
+ local last = self.nodeStack[#self.nodeStack]
196
+ last.status = TestEnum.TestStatus.Failure
197
+ table.insert(last.errors, message)
198
+ end
199
+
200
+ --[[
201
+ Add a dummy child node to the current node to hold the given error. This
202
+ allows an otherwise empty describe node to report an error in a more natural
203
+ way.
204
+ ]]
205
+ function TestSession:addDummyError(phrase, message)
206
+ self:pushNode({type = TestEnum.NodeType.It, phrase = phrase})
207
+ self:setError(message)
208
+ self:popNode()
209
+ self.nodeStack[#self.nodeStack].status = TestEnum.TestStatus.Failure
210
+ end
211
+
212
+ --[[
213
+ Set the current node's status based on that of its children. If all children
214
+ are skipped, mark it as skipped. If any are fails, mark it as failed.
215
+ Otherwise, mark it as success.
216
+ ]]
217
+ function TestSession:setStatusFromChildren()
218
+ assert(#self.nodeStack > 0, "Attempting to set status from children on empty stack")
219
+
220
+ local last = self.nodeStack[#self.nodeStack]
221
+ local status = TestEnum.TestStatus.Success
222
+ local skipped = true
223
+
224
+ -- If all children were skipped, then we were skipped
225
+ -- If any child failed, then we failed!
226
+ for _, child in ipairs(last.children) do
227
+ if child.status ~= TestEnum.TestStatus.Skipped then
228
+ skipped = false
229
+
230
+ if child.status == TestEnum.TestStatus.Failure then
231
+ status = TestEnum.TestStatus.Failure
232
+ end
233
+ end
234
+ end
235
+
236
+ if skipped then
237
+ status = TestEnum.TestStatus.Skipped
238
+ end
239
+
240
+ last.status = status
241
+ end
242
+
243
+ return TestSession
@@ -1,40 +1,40 @@
1
- local Expectation = require(script.Expectation)
2
- local TestBootstrap = require(script.TestBootstrap)
3
- local TestEnum = require(script.TestEnum)
4
- local TestPlan = require(script.TestPlan)
5
- local TestPlanner = require(script.TestPlanner)
6
- local TestResults = require(script.TestResults)
7
- local TestRunner = require(script.TestRunner)
8
- local TestSession = require(script.TestSession)
9
- local TextReporter = require(script.Reporters.TextReporter)
10
- local TextReporterQuiet = require(script.Reporters.TextReporterQuiet)
11
- local TeamCityReporter = require(script.Reporters.TeamCityReporter)
12
-
13
- local function run(testRoot, callback)
14
- local modules = TestBootstrap:getModules(testRoot)
15
- local plan = TestPlanner.createPlan(modules)
16
- local results = TestRunner.runPlan(plan)
17
-
18
- callback(results)
19
- end
20
-
21
- local TestEZ = {
22
- run = run,
23
-
24
- Expectation = Expectation,
25
- TestBootstrap = TestBootstrap,
26
- TestEnum = TestEnum,
27
- TestPlan = TestPlan,
28
- TestPlanner = TestPlanner,
29
- TestResults = TestResults,
30
- TestRunner = TestRunner,
31
- TestSession = TestSession,
32
-
33
- Reporters = {
34
- TextReporter = TextReporter,
35
- TextReporterQuiet = TextReporterQuiet,
36
- TeamCityReporter = TeamCityReporter,
37
- },
38
- }
39
-
1
+ local Expectation = require(script.Expectation)
2
+ local TestBootstrap = require(script.TestBootstrap)
3
+ local TestEnum = require(script.TestEnum)
4
+ local TestPlan = require(script.TestPlan)
5
+ local TestPlanner = require(script.TestPlanner)
6
+ local TestResults = require(script.TestResults)
7
+ local TestRunner = require(script.TestRunner)
8
+ local TestSession = require(script.TestSession)
9
+ local TextReporter = require(script.Reporters.TextReporter)
10
+ local TextReporterQuiet = require(script.Reporters.TextReporterQuiet)
11
+ local TeamCityReporter = require(script.Reporters.TeamCityReporter)
12
+
13
+ local function run(testRoot, callback)
14
+ local modules = TestBootstrap:getModules(testRoot)
15
+ local plan = TestPlanner.createPlan(modules)
16
+ local results = TestRunner.runPlan(plan)
17
+
18
+ callback(results)
19
+ end
20
+
21
+ local TestEZ = {
22
+ run = run,
23
+
24
+ Expectation = Expectation,
25
+ TestBootstrap = TestBootstrap,
26
+ TestEnum = TestEnum,
27
+ TestPlan = TestPlan,
28
+ TestPlanner = TestPlanner,
29
+ TestResults = TestResults,
30
+ TestRunner = TestRunner,
31
+ TestSession = TestSession,
32
+
33
+ Reporters = {
34
+ TextReporter = TextReporter,
35
+ TextReporterQuiet = TextReporterQuiet,
36
+ TeamCityReporter = TeamCityReporter,
37
+ },
38
+ }
39
+
40
40
  return TestEZ