Runit

pronounced "R Unit"

A unit testing library for Roblox heavily inspired by xUnit from C#

Example

src/scripts/run-tests.server.ts

1import { TestRunner } from "@rbxts/runit";
2import { ServerScriptService } from "@rbxts/services";
3
4const testRunner = new TestRunner(
5  ServerScriptService.WaitForChild("Tests")
6);
7
8testRunner.run();

src/tests/number-utility-test.ts

1import { Fact, Theory, InlineData, Assert } from "@rbxts/runit";
2
3function toNearestFiveOrTen(n: number): number {
4  const nearestFive = round(n / 5) * 5;
5  const lowerTen = floor(nearestFive / 10) * 10;
6  const upperTen = lowerTen + 10;
7
8  if (abs(n - lowerTen) <= abs(n - nearestFive))
9    return lowerTen;
10  else if (abs(n - upperTen) <= abs(n - nearestFive))
11    return upperTen;
12
13  return nearestFive;
14}
15
16class NumberUtilityTest {
17  // tests one case
18  @Fact
19  public eightBecomesTen(): void {
20    Assert.equal(10, toNearestFiveOrTen(8));
21  }
22
23  // tests multiple cases
24  @Theory
25  @InlineData(8, 10)
26  @InlineData(14, 15)
27  @InlineData(18, 20)
28  @InlineData(3, 5)
29  @InlineData(2, 0)
30  public roundsToNearestFiveOrTen(input: number, expected: number): void {
31    Assert.equal(expected, toNearestFiveOrTen(input));
32  }
33}
34
35export = NumberUtilityTest;

Setup/Teardown

Setup can be done via the constructor. Teardown is done using the destroy method, which is automatically called after all tests have completed.

1class MyTest {
2  private readonly junk = new Junk;
3
4  public destroy(): void {
5    this.junk.destroy();
6  }
7}