This repository has been archived by the owner on Sep 14, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use TestService, update README to document usage, return results from…
… TestBootstrap:Run
- Loading branch information
Showing
8 changed files
with
67 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
root = true | ||
|
||
[*] | ||
indent_style = tab | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/luacov.* | ||
/testez-installer.lua |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
stds.roblox = { | ||
globals = { | ||
"game" | ||
}, | ||
read_globals = { | ||
-- Roblox globals | ||
"script", | ||
|
||
-- -- Extra functions | ||
"tick", "warn", | ||
} | ||
} | ||
|
||
std = "lua51+roblox" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
todo | ||
# Contributing to TestEZ | ||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,32 @@ | ||
# TestEZ | ||
TestEZ is a testing framework targeted at Roblox Lua. | ||
<h1 align="center">TestEZ</h1> | ||
<div align="center"> | ||
<!-- TODO: badges and stuff here --> | ||
</div> | ||
|
||
<div align="center"> | ||
BDD-style Roblox Lua testing framework | ||
</div> | ||
|
||
<div> </div> | ||
|
||
TestEZ can run within Roblox itself, as well as inside [Lemur](https://github.com/LPGhatguy/Lemur) for testing on CI systems. | ||
|
||
## Usage | ||
|
||
### Method 1: Installation Script (Roblox) | ||
* Download the latest release from the [GitHub releases page](https://github.com/Roblox/TestEZ/releases). | ||
* Use the 'Run Script' menu (located in the Test tab) to locate and run this script. | ||
* Follow the instructions in the installer | ||
|
||
This installation script is generated by a tool called [rbxpacker](https://github.com/LPGhatguy/rbxpacker). | ||
|
||
### Method 2: Filesystem (Roblox) | ||
If building a Roblox place by importing scripts from the filesystem, copy the `lib` directory into your project and use a plugin like [rbxfs](https://github.com/LPGhatguy/rbxfs) to synchronize the filesystem into a Roblox place. | ||
|
||
### Method 3: Lemur (CI Systems) | ||
You can use [Lemur](https://github.com/LPGhatguy/Lemur) paired together with a regular Lua 5.1 interpreter to run tests written with TestEZ. | ||
|
||
This is the best approach when testing Roblox Lua libraries using existing continuous integration systems like Travis-CI. We use this technique to run tests for [Rodux](https://github.com/Roblox/Rodux). | ||
|
||
## License | ||
TestEZ is available under the [todo] license. See [LICENSE.md](LICENSE.md) for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
#!/bin/sh | ||
|
||
rbxpacker --exclude **/*.spec.lua --folder TestEZ --name TestEZ lib > testez-installer.lua |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters