-
Notifications
You must be signed in to change notification settings - Fork 30
Home
- Easy to integrate
- Simple, annotation-based, syntax for writing tests
- No need for special file names, or method names
- Common TDD methods such as Setup/TearDown/BeforeEach/AfterEach
- Organize tests by suites, groups and cases
- Readable test output
- Easily control test execution
- Simple assert syntax
- Node specific assertions
- Parameterized testing
- Mocks and stubs
- Mocks node
- Execute tests on scenegraph nodes
- Incorporate your own util methods
- Hook into your global setup mechanisms
- Only show output for failed tests
- Easily integrate into any CI system
- Generate code coverage
Rooibos is a brighterscript compiler and Visual Studio Extension plugin. That does not mean you need to write in brighterscript; the bsc compiler also parses regular brightscript projects.
The advantages of this are:
- you get warnings and errors for your tests as you write them in the ide.
- you do not have to install any thing in your projects, or maintain the rooibos libraries; it just works
- it is very easy to integrate into your CI toolchain.
Rooibos will not work if you do not use the brighterscript compiler. I have no plans to support any other toolchains.
Either click the select brighterscript button in the bottom right, or add this setting to your .vscode/settings.json
file:
"brightscript.bsdk": "node_modules/brighterscript"
You will need to setup a bsc project to use rooibos 4. Here is an example project you can clone.
The easiest thing to do is to clone that project and
- copy bsconfig.json
- merge the contents of the files in .vscode folder
- merge the contents of package.json into your project
You can do the setup from scratch as followes:
- Ensure your project is set up for use with npm (
npm init
, and follow the steps) - Install brighterscript:
npm install brighterscript --save-dev
- Install rooibos roku:
npm install rooibos-roku --save-dev
- Add a script to your package.json, e.g.
"scripts": {
"build-tests": "npx bsc"
}
- Add a bsconfig.json file. The easiest thing to do is copy the file from the example project
- Setup a task to run
npm run build-tests
, in.vscode/tasks.json
- Setup a launch task to run the build-tests task, from the previous step, in
.vscode/launch.json
- Create some tests
- ensure you have a bsconfig.json, as per: https://github.com/rokucommunity/brighterscript
npm install rooibos-roku --save-dev
- Add the rooibos plugin to your
bsconfig.json
file as follows:
"plugins": [
"rooibos-roku"
]
Rooibos will automatically inject the necessary source files into your project, at build time, and inject the hooks to run.
Note - you will likely use a seprate bsconfig.json
file for your tests, e.g. bsconfig-test.json
, which will be used by your CI/testing vscode launch target.
If you need to do some setup, like load some data from a service, before starting your tests:
- add a field
isReadyToStartTests
to your tests scene - set the value to true, when the tests are ready to start.
NOTE: this is not yet supported in rooibos 4! I will add it again soon.
Rooibos's configuration is controlled via the configuration passed into the bsconfig.json
via flags on the rooibos
json blob
e.g.
"rooibos": {
"isRecordingCodeCoverage": false,
"printTestTimes": true,
"testsFilePattern": null,
"tags": ["!integration", "!deprecated", "!fixme"],
"showOnlyFailures": true,
"catchCrashes": true,
"lineWidth": 70
},
The following options are supported:
- logLevel?: RooibosLogLevel - 0-4 (error, warn, info, debug)
- showOnlyFailures?: boolean - if true, then only failed tests are shown; but everything is show if no failures occurred
- printTestTimes?: boolean - if true then the time each test took is output
- lineWidth?: number - width of test output lines in columns
- catchCrashes? : boolean - if true, then any crashes will report CRASH statement, and note halt test execuction - very useful for running a whole suite
- sendHomeOnFinish? : boolean - if true, then the app will exit upon finish. The default is true. Useful to set to false for local test suites.
- testsFilePattern?: string - the pattern to use to find tests, this is a glob, the default is "**/*.spec.bs"
- tags?: string[] - the tags listed here control what is run - you can use !tagname to indicated any tests/suites that are skipped, all other tags are ANDed. This is very useful for having a bsconfig to run, say tests including long, and slow integration tests, or just running a certain subset of your suite.