Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maelcaldas/gs-test-runner
Google Apps Script library for testing and CI
https://github.com/maelcaldas/gs-test-runner
Last synced: 16 days ago
JSON representation
Google Apps Script library for testing and CI
- Host: GitHub
- URL: https://github.com/maelcaldas/gs-test-runner
- Owner: maelcaldas
- License: apache-2.0
- Created: 2015-04-20T13:29:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-14T13:31:28.000Z (almost 5 years ago)
- Last Synced: 2024-07-31T06:11:26.723Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-apps-script - GSTestRunner – Unit testing
README
[TDD]: http://en.wikipedia.org/wiki/Test-driven_development
[GSUnit]: https://sites.google.com/site/scriptsexamples/custom-methods/gsunit
[CI]: http://en.wikipedia.org/wiki/Continuous_integration
[Google Apps Script]: https://developers.google.com/apps-script/
[Development Mode]: https://developers.google.com/apps-script/guide_libraries#testAndDebug
[GSTestRunner]: http://developers.bkper.com/docs/GSTestRunner
[GSTestRunner.runSuite]: http://developers.bkper.com/docs/GSTestRunner/global.html#runSuite
[GSTestRunner.runTest]: http://developers.bkper.com/docs/GSTestRunner/global.html#runTest
[GSTestRunner.getSuiteResult]: http://developers.bkper.com/docs/GSTestRunner/global.html#getSuiteResult
# GSTestRunner [](https://script.google.com/macros/s/AKfycbyWJJFIwoqnNudRMGse18qVNWw5aa7g03-iLmL_rjqO8mg-MjI/exec?suite=GSTestRunner&namespace=bkper)
[Google Apps Script] library to **run tests**, **publish results** and send **email notifications** of test failures.
[GSTestRunner] helps with [TDD] and also let you set a lightweight [CI] for your Apps Script codebase.
It does NOT provide assertions. For that, we suggest [GSUnit].
#Get started
Add the library through project key: **Mv3gVv8-YsY7WWlQhoAGWgpNuZToV6OsP**
Create a script with test methods starting with `test`:
````javascript
function runSuite() {
GSTestRunner.runSuite(this, "Get Started");
}
function testA_() {
Logger.log("Good code!");
}
function testB_() {
Logger.log("Bad code!");
nonExistingFunction();
}
````
Then, run the suite passing `this` as the suite object, and set a trigger to periodically run the test suite, depending on your needs - every hour would be good ;)
The results based on code above can be found by clicking here: [](https://script.google.com/macros/s/AKfycbyWJJFIwoqnNudRMGse18qVNWw5aa7g03-iLmL_rjqO8mg-MjI/exec?suite=Get%20Started&namespace=bkper)
If you are testing another library, don't forget to let the [Development Mode] on, so the test will run always on latest code version.
#Suite names
To avoid conflicts, **the suiteName must be unique**. If someone already taken the name, you will get an error like this:
`Suite name "Get Started" already taken! Change the name and/or namespace, or ask one of those guys to include you as recipient: [[email protected]]`
You can do either:
- Change the name and/or namespace, on [options](#options)
- Ask the ones who already taken that suite name to include you, by adding your email to the [options](#options)**.recipient** and running the suite at least once.
#Befores and Afters
Sometimes you need to setup and cleanup fixtures before and after tests. If implemented, [GSTestRunner] run the following functions, in respective order:
Function | Order
------------- | -------------
beforeSuite_ | Before all tests
beforeTest_ | Before each test
afterTest_ | After each test
afterSuite_ | After all tests
Example:
````javascript
//Befores and Afters
function beforeSuite_() {
Logger.log("Run before all tests");
}
function beforeTest_() {
Logger.log("Run before each test");
}
function afterTest_() {
Logger.log("Run after each test");
}
function afterSuite_() {
Logger.log("Run after all tests");
}
````
When calling [GSTestRunner.runSuite] you can pass some options as the third parameter, that can change the behavior:
Option | Type | What it does
----------- | ------- | ------------
namespace | string | Define a namespace to avoid suite naming colisions
notify | boolean | Send email notifications to recipient when test fails
recipient | string | Comma separated emails to receive failure notifications
errorOnFail | boolean | Throw error when suite fails. Good for development.
testCodeUrl | string | The URL of test script code, to be linked on results
Example:
````javascript
function runSuite(event) {
//Trick to know if is triggered by time trigger
var isRunningByTimeTrigger = event != null;
var options = {
namespace: "bkper",
notify: isRunningByTimeTrigger,
recipient: "[email protected]",
errorOnFail: !isRunningByTimeTrigger,
testCodeUrl: "https://script.google.com/a/nimbustecnologia.com.br/d/19IiyKv3t5WlqDLcDWwMO8Y_eBeWaNJyP9kZiPSGECT8GCrbFlBw_28B-/edit",
}
GSTestRunner.runSuite(this, "Get Started");
}
````
Take a look at the trick to know if the suite is running by a time trigger, or manually. Its good to avoid unnecessary email notifications when running manually.
#Suite result
You can see the results of a test suite by checking the log after calling [GSTestRunner.runSuite].
Everytime you run a test suite, the results are stored for later retrieval by calling [GSTestRunner.getSuiteResult]:
````javascript
function logSuiteResult() {
var result = GSTestRunner.getSuiteResult("Get Started", "bkper");
Logger.log("status: " + result.status);
Logger.log("url: " + result.url);
}
````
Results are also published to a simple web view, and can be accessed through the url logged above.
#Running a single test
You can run a single test by calling [GSTestRunner.runTest]:
````javascript
function runASingleTest() {
GSTestRunner.runTest(this, "testA_");
}
function testA_() {
Logger.log("Good code!");
}
````
When you run a single test, the results are NOT stored neither published to web view.
#Status badges
With [GSTestRunner], you can embed little status badges into your project's README or general documentation. That way, visitors of your projects or site can immediately see its test status.
To get the links, on suite result page, just click on badge:
#Complete example
The complete code for this guide can be found [here](https://script.google.com/a/nimbustecnologia.com.br/d/19IiyKv3t5WlqDLcDWwMO8Y_eBeWaNJyP9kZiPSGECT8GCrbFlBw_28B-/edit)