Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/cordova-plugin-test-framework
Apache Cordova
https://github.com/apache/cordova-plugin-test-framework
cordova cplusplus csharp java javascript library mobile nodejs objective-c
Last synced: 2 months ago
JSON representation
Apache Cordova
- Host: GitHub
- URL: https://github.com/apache/cordova-plugin-test-framework
- Owner: apache
- License: apache-2.0
- Created: 2014-07-09T07:00:07.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T23:09:04.000Z (over 1 year ago)
- Last Synced: 2024-05-21T07:20:54.371Z (6 months ago)
- Topics: cordova, cplusplus, csharp, java, javascript, library, mobile, nodejs, objective-c
- Language: HTML
- Homepage:
- Size: 2.94 MB
- Stars: 73
- Watchers: 20
- Forks: 34
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/apache/cordova-plugin-test-framework/actions?query=branch%3Amaster)
[](https://github.com/apache/cordova-plugin-test-framework/releases)
[](https://www.npmjs.com/package/cordova-plugin-test-framework)
# Cordova Plugin Test Framework
The `cordova-plugin-test-framework` plugin allows plugin authors to add tests (manual and automated) to their plugins. To achieve this it
1. [defines the interface for Cordova plugins to write tests](#interface) and
2. [provides a test harness for actually running those tests](#harness)
Tests run directly inside existing Cordova projects, so you can rapidly switch between testing and development. You can also be sure that your test suite is testing the exact versions of plugins and platforms that your app is using.
# TLDR; Try it
1. Use your existing Cordova app, or create a new one.
2. Plugins bundle their tests using a nested plugin in a `/tests` directory. Here are a few examples how install both:
```shell
cordova plugin add cordova-plugin-device
cordova plugin add plugins/cordova-plugin-device/tests
cordova plugin add cordova-plugin-device-motion
cordova plugin add plugins/cordova-plugin-device-motion/tests
cordova plugin add cordova-plugin-geolocation
cordova plugin add plugins/cordova-plugin-geolocation/tests
```
To install the plugin from `master` on GitHub instead of npm, replace e.g. `cordova-plugin-device` with `https://github.com/apache/cordova-plugin-device.git`
3. Follow the docs for [Setting up the test harness](#harness).
## Writing Plugin Tests
### Where do tests live?
Add a directory named `tests` to the root of your plugin. Within this directory, create a nested `plugin.xml` for the tests plugin. It should have a plugin id with the form `pluginid-tests` (e.g. the `cordova-plugin-device` plugin has the nested id `cordova-plugin-device-tests`) and should contain a `` named `tests`. E.g:
```
```
For example, the `cordova-plugin-device` plugin has this nested [`plugin.xml`](https://github.com/apache/cordova-plugin-device/blob/master/tests/plugin.xml).
Create a `package.json` inside your project's `tests/` folder. Plugins require a `package.json` now and tests are considered their own plugins. The latest version of the tools ensure to run `npm install` on any plugin added to a project and pull in any dependencies. Therefore, plugin authors can now put npm dependencies around their tests into the `package.json` file.
For example, the `cordova-plugin-device` plugin contains a [`package.json`](https://github.com/apache/cordova-plugin-device/blob/master/tests/package.json).
The `cordova-plugin-test-framework` plugin will automatically find all `tests` modules across all plugins for which the nested tests plugin is installed.
### Defining Auto Tests
Export a function named `defineAutoTests`, which defines your auto-tests when run. Use the [`jasmine-2.9`](https://jasmine.github.io/2.9/introduction.html) format. E.g.:
```
exports.defineAutoTests = function() {
describe('awesome tests', function() {
it('do something sync', function() {
expect(1).toBe(1);
...
});
it('do something async using callbacks', function(done) {
setTimeout(function() {
expect(1).toBe(1);
...
done();
}, 100);
});
it("do something async using promises", function() {
return soon().then(function() {
value++;
expect(value).toBeGreaterThan(0);
});
});
it("do something async using async/await", async function() {
await soon();
value++;
expect(value).toBeGreaterThan(0);
});
});
describe('more awesome tests', function() {
...
});
};
```
Note: Your tests will automatically be labeled with your plugin id, so do not prefix your test descriptions.
### Defining Manual Tests
Export a function named `defineManualTests`, which defines your manual-tests when run. Manual tests do *not* any test runner, and success/failure results are not officially reported in any standard way. Instead, create buttons to run arbitrary javascript when clicked, and display output to user using `console` or by manipulating a provided DOM element. E.g.:
```
exports.defineManualTests = function(contentEl, createActionButton) {
createActionButton('Simple Test', function() {
console.log(JSON.stringify(foo, null, '\t'));
});
createActionButton('Complex Test', function() {
contentEl.innerHTML = ...;
});
};
```
Make sure to document the expected outcome.
Note: Your tests will automatically be labeled with your plugin id, so do not prefix your test descriptions.
### Example
See: [`cordova-plugin-device` tests](https://github.com/apache/cordova-plugin-device/blob/master/tests/tests.js).
## Running Plugin Tests
1. Use your existing Cordova app, or create a new one.
2. Add this plugin:
```
cordova plugin add cordova-plugin-test-framework
// or
cordova plugin add https://github.com/apache/cordova-plugin-test-framework.git
```
3. Change the start page in `config.xml` with `` or add a link to `cdvtests/index.html` from within your app.
4. Thats it!
## FAQ
* Q: Should I add `cordova-plugin-test-framework` as a `` of my plugin?
* A: No. The end-user should decide if they want to install the test framework, not your plugin (most users won't).
* Q: What do I do if my plugin tests must have very large assets?
* A: Don't bundle those assets with your plugin. If you can, have your tests fail gracefully if those assets don't don't exist (perhaps log a warning, perhaps fail a single asset-checking test, and skip the rest). Then, ideally download those assets automatically into local storage the first time tests run. Or create a manual test step to download and install assets. As a final alternative, split those test assets into a separate plugin, and instruct users to install that plugin to run your full test suite.
* Q: Should I ship my app with the test framework plugin installed?
* A: Not likely. If you want, you can. Then your app could even embed a link to the test page (`cdvtests/index.html`) from a help section of your app, to give end users a way to run your test suite out in the feild. That may help diagnose causes of issues within your app. Maybe.