https://github.com/ganchrowscientific/gs-lua-unit
"Ganchrow Scientific Embedded Lua Unit Testing Framework
https://github.com/ganchrowscientific/gs-lua-unit
lua redis test testing unit
Last synced: about 2 months ago
JSON representation
"Ganchrow Scientific Embedded Lua Unit Testing Framework
- Host: GitHub
- URL: https://github.com/ganchrowscientific/gs-lua-unit
- Owner: GanchrowScientific
- Created: 2018-02-16T23:38:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-16T20:46:52.000Z (over 2 years ago)
- Last Synced: 2025-06-29T18:51:00.694Z (9 months ago)
- Topics: lua, redis, test, testing, unit
- Language: Lua
- Size: 1.52 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create lua unit tests
```lua
-- test.lua
dofile('./node_modules/gs-lua-unit/lua-src/common.lua')
-- lua setup stuff
runTests(generateTests({
foo = {{
tag = 'Testing file foo',
doTest = function(fooModule)
return fooModule.doStuff()
end,
expect = function(resultFromDoTest, expector, fooModule)
-- expector has all sorts of goodies
expector:expectStrictEqual(resultFromDoTest.result1, 'fooResult1')
expector:expectTruthy(resultFromDoTest.result2)
expector:expectFalsy(resultFromDoTest.result3)
expector:expectDeepEqual(resultFromDoTest.resultObj, {foo = 1, bar = 2})
return true -- must return true here
-- its not required to use the expector, you can do stuff like
-- return result and result[1].foo == 'bar'
-- but the expector provides detailed assertion failures
end
}, {
-- more tests
}},
bar = {{
-- more tests
}}
})
```
And then
```bash
lua /path/to/test.lua
```
# What are foo and bar
`foo = ...` and `bar = ...` point to files that exist in a directory with lua scripts named *foo* and *bar*.
By default, **gs-lua-unit** looks in the directory "target/test_scripts/", but this directory can also be specified with the third argument to `runTests`.
# What about [Redis](https://redis.io/)?
A redis.call method is provided for you, and works on an **active** redis.
**gs-lua-unit** looks for redis in a "redis.yaml" of the current working directory.
```yaml
# redis.yaml
mockRedis:
host: localhost
port: 6379
```
Redis location can also be passed as the second argument to `runTests` above
```lua
runTests(generateTests({ ... }), redisConfig)
```