- Included a new launch config that supports running with code coverage.
- Coverage is stored in a coverage folder as both LCOV file and HTML report (in sub folder)
- Added new scripts in our build machine to run with code coverage. Will enable a run that uses code coverage once this is merged
- To view code coverage while developing, install the LCOV VSCode extension, enable it and then hit F1 -> LCOV Menu -> Enable Decorations. This will highlight covered / missed lines in green and red.
Note: The HTMLContent codebase is not currently covered. With recent changes to minify this it breaks the remapping tool we use.
Detailed notes
- Coverage uses a config file to load settings. This is copied at the start of each task
- If tests fail, the process exit code will be 1. We should still write out code coverage in these cases as this is a useful detail even on runs with some test failures.
- On Windows, the extension is loaded (pulling in all source files via require) before the test runner is configured. Since instrumentation happens by hooking the require call, this meant that instrumentation never happened on Windows. To resolve this, we invalidate the Module cache for our source files so they are reloaded the next time anything requires them. At this point they are instrumented as expected. There is a minor risk to this if we had some global state or deeper integration test, but this doesn't impact any existing unit tests and is needed to unblock code coverage
* Skip coverage of HTMLContent due to crash
- With the latest HTMLContent changes to minify & uglify the code, the remap-istanbul component responsible for js -> ts remapping crashes trying to parse the sourceMap entries in the file. This is due to lack of whitespace between code which it expects - basically, it's not set up to run against such compact code
- Disabling coverage of this part of the code until this issue is resolved
* Refactored the project to run the front end code as a separate npm package
* Added Slickgrid as UI component rather than Backgrid
* Added Gulp scripts for building
Kevin Cunnane
Karl Burtram
Leila Lali
Karl Burtram
Anthony Dresser