diff options
| author | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2018-11-12 21:34:59 +0100 |
|---|---|---|
| committer | Costa Tsaousis <costa@tsaousis.gr> | 2018-11-12 22:34:59 +0200 |
| commit | 3aae8f6c2ceea7f74cde61a2044aa50c5f252fae (patch) | |
| tree | 781412f323c0183c520e4ff1c9fdac53a900b463 /tests | |
| parent | a29b433526f56fe983d88dc4e86585bad65916c4 (diff) | |
Htmldoc (#4607)
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* fixes
* test
* test
* test
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* fixes
* test
* test
* test
* First set of major cleanup/deduplication
* 2nd major cleanup
* update getting started structure
* Cleanup in using netdata
* Final cleanup/deduplication
* Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators
* Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md
* First html documentation debug set
* Updated Makefile.am to ignore the new md and htmldoc generation files
* Removing files from rebase
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* fixes
* test
* test
* test
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* test
* test
* First set of major cleanup/deduplication
* 2nd major cleanup
* update getting started structure
* Cleanup in using netdata
* Final cleanup/deduplication
* Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators
* Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md
* First html documentation debug set
* Updated Makefile.am to ignore the new md and htmldoc generation files
* Removing files from rebase
* Fixed Makefile.am
* Same line header and badges
* Fixed broken link
* CPU monitoring is in apps plugin
* Removed obsolete files
* Remove obsolete files
* - Make the Health API part of health/README.md new file web/api/health/README.md
- Make installer/LAUNCH.md part of deamon/README.md
- Move installer/MAINTAINERS.md to packaging/maintainers/README.md
- Move installer/DOCKER.md to docker/README.md
- Move system/README.md to daemon/config/README.md
- Move web/CUSTOM-DASHBOARDS.md to web/gui/custom/README.md
- Move web/CONFLUENCE-DASHBOARDS.md to web/gui/confluence/README.md
* Resolve codacy issue $(..) syntax instead of `..`
* Fix following warnings and add svgs to the data_structures/README.md
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTORS.md
- REDISTRIBUTED.md
- diagrams/data_structures/README.md
- docker/README.md
WARNING - Documentation file 'README.md' contains a link to 'collectors/plugins.d' which does not exist in the documentation directory.
WARNING - Documentation file 'README.md' contains a link to 'collectors/statsd.plugin' which does not exist in the documentation directory.
WARNING - Documentation file 'CONTRIBUTING.md' contains a link to 'web/CUSTOM-DASHBOARDS.md' which does not exist in the documentation directory.
WARNING - Documentation file 'CONTRIBUTING.md' contains a link to 'web/CONFLUENCE-DASHBOARDS.md' which does not exist in the documentation directory.
* Wrong urls in data_structures/README.md svgs
* Fix svg URLs number 2
* Modify the first line of the main README.md, to enable proper static html generation. Executed after copying the file to htmldoc/src
* Added back Why Netdata
* Fixed link to registry in Why-Netdata.md
* Added Why-Netdata to buildyaml and to Makefile.am
* Replaced http links causing mixed content warnings
* Made buildhtml ignore the directory node_modules created by Netlify
* Corrected CONTRIBUTING.MD to CONTRIBUTING.md
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/README.md | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/tests/README.md b/tests/README.md index 4fc9b303b9..3dd8859a46 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,8 +1,9 @@ +# Testing This readme is a manual on how to get started with unit testing on javascript and nodejs Original author: BrainDoctor (github), July 2017 -# Installation +## Installation Tested on Linux Mint 18.2 Sara (Ubuntu/debian derivative) @@ -19,7 +20,7 @@ That should install the necessary node modules. Other browsers work too (Chrome, Firefox). However, only the Chromium Browser 59 has been tested for headless unit testing. -## Versions +### Versions The commands above leave me with the following versions (July 2017): @@ -28,21 +29,21 @@ The commands above leave me with the following versions (July 2017): - chromium-browser: 59.0.3071.109 - WebStorm (optional): 2017.1.4 -# Configuration +## Configuration -## NPM +### NPM The dependencies are installed in `netdata/package.json`. If you install a new NPM module, it gets added here. Future developers just need to execute `npm install` and every dep gets added automatically. -## Karma +### Karma Karma configuration is in `tests/web/karma.conf.js`. Documentation is provided via comments. -## WebStorm +### WebStorm If you use the JetBrains WebStorm IDE, you can integrate the karma runtime. -### for Karma (Client side testing) +#### for Karma (Client side testing) Headless Chromium: 1. Run > Edit Configurations @@ -66,7 +67,7 @@ You may add other browsers too (comma separated). With the "Browsers to start" f Also it is recommended to install WebStorm IDE Extension/Addon to Chrome/Chromium for awesome debugging. -### for node.d plugins (nodejs) +#### for node.d plugins (nodejs) 1. Run > Edit Configurations 2. "+" > Node.js @@ -75,23 +76,23 @@ Also it is recommended to install WebStorm IDE Extension/Addon to Chrome/Chromiu - JavaScript file: node_modules/jasmine-node/bin/jasmine-node - Application parameters: --captureExceptions tests/node.d -# Running +## Running -## In WebStorm +### In WebStorm -### Karma +#### Karma Just run the configured run configurations and they produce nice test trees:  -### node.js +#### node.js Debugging is awesome too!  -## From CLI +### From CLI -### Karma +#### Karma ```sh cd /path/to/your/netdata @@ -103,7 +104,7 @@ will start the karma server, start chromium in headless mode and exit. If a test fails, it produces even a stack trace:  -### Node.d plugins +#### Node.d plugins ```sh cd /path/to/your/netdata @@ -114,9 +115,9 @@ nodejs node_modules/jasmine-node/bin/jasmine-node --captureExceptions tests/node will run the tests in `tests/node.d` and produce a stacktrace too on error:  -## Coverage +### Coverage -### Karma +#### Karma A nice HTML is produced from Karma which shows which code paths were executed. It is located somewhere in `/path/to/your/netdata/coverage/` @@ -124,11 +125,11 @@ A nice HTML is produced from Karma which shows which code paths were executed. I and  -### Node.d +#### Node.d Apparently, jasmine-node can produce a junit report with the `--junitreport` flag. But that output was not very useful. Maybe it's configurable? -## CI +### CI The karma and node.d runners can be integrated in Travis (AFAIK), but that is outside my ability. |