@@ -27,126 +27,126 @@ export interface TestRunnerOptions {
2727
2828export class CoverageRunner {
2929
30- private coverageVar = `$$cov_${ new Date ( ) . getTime ( ) } ;
31- private transformer : any = undefined ;
32- private matchFn : any = undefined ;
33- private instrumenter : any = undefined ;
34-
35- constructor ( private options : TestRunnerOptions , private testsRoot : string ) {
36- if ( ! options . relativeSourcePath ) {
37- return ;
38- }
30+ private coverageVar = `$$cov_${ new Date ( ) . getTime ( ) } ;
31+ private transformer : any = undefined ;
32+ private matchFn : any = undefined ;
33+ private instrumenter : any = undefined ;
34+
35+ constructor ( private options : TestRunnerOptions , private testsRoot : string ) {
36+ if ( ! options . relativeSourcePath ) {
37+ return ;
3938 }
39+ }
4040
41- public setupCoverage ( ) : void {
42- // Set up Code Coverage, hooking require so that instrumented code is returned
43- // eslint-disable-next-line @typescript-eslint/no-this-alias
44- const self = this ;
45- self . instrumenter = new istanbul . Instrumenter ( { coverageVariable : self . coverageVar } ) ;
46- const sourceRoot = paths . join ( self . testsRoot , self . options . relativeSourcePath ) ;
47-
48- // Glob source files
49- const srcFiles = glob . sync ( '**/**.js' , {
50- cwd : sourceRoot ,
51- ignore : self . options . ignorePatterns
52- } ) ;
53-
54- // Create a match function - taken from the run-with-cover.js in istanbul.
55- // eslint-disable-next-line @typescript-eslint/no-var-requires
56- const decache = require ( 'decache' ) ;
57- const fileMap : any = { } ;
58- srcFiles . forEach ( ( file ) => {
59- const fullPath = paths . join ( sourceRoot , file ) ;
60- fileMap [ fullPath ] = true ;
61-
62- // On Windows, extension is loaded pre-test hooks and this mean we lose
63- // our chance to hook the Require call. In order to instrument the code
64- // we have to decache the JS file so on next load it gets instrumented.
65- // This doesn't impact tests, but is a concern if we had some integration
66- // tests that relied on VSCode accessing our module since there could be
67- // some shared global state that we lose.
68- decache ( fullPath ) ;
69- } ) ;
70-
71- self . matchFn = ( file : string ) : boolean => fileMap [ file ] ;
72- self . matchFn . files = Object . keys ( fileMap ) ;
73-
74- // Hook up to the Require function so that when this is called, if any of our source files
75- // are required, the instrumented version is pulled in instead. These instrumented versions
76- // write to a global coverage variable with hit counts whenever they are accessed
77- self . transformer = self . instrumenter . instrumentSync . bind ( self . instrumenter ) ;
78- const hookOpts = { verbose : false , extensions : [ '.js' ] } ;
79- istanbul . hook . hookRequire ( self . matchFn , self . transformer , hookOpts ) ;
80-
81- // initialize the global variable to stop mocha from complaining about leaks
82- global [ self . coverageVar ] = { } ;
83- }
41+ public setupCoverage ( ) : void {
42+ // Set up Code Coverage, hooking require so that instrumented code is returned
43+ // eslint-disable-next-line @typescript-eslint/no-this-alias
44+ const self = this ;
45+ self . instrumenter = new istanbul . Instrumenter ( { coverageVariable : self . coverageVar } ) ;
46+ const sourceRoot = paths . join ( self . testsRoot , self . options . relativeSourcePath ) ;
47+
48+ // Glob source files
49+ const srcFiles = glob . sync ( '**/**.js' , {
50+ cwd : sourceRoot ,
51+ ignore : self . options . ignorePatterns
52+ } ) ;
53+
54+ // Create a match function - taken from the run-with-cover.js in istanbul.
55+ // eslint-disable-next-line @typescript-eslint/no-var-requires
56+ const decache = require ( 'decache' ) ;
57+ const fileMap : any = { } ;
58+ srcFiles . forEach ( ( file ) => {
59+ const fullPath = paths . join ( sourceRoot , file ) ;
60+ fileMap [ fullPath ] = true ;
61+
62+ // On Windows, extension is loaded pre-test hooks and this mean we lose
63+ // our chance to hook the Require call. In order to instrument the code
64+ // we have to decache the JS file so on next load it gets instrumented.
65+ // This doesn't impact tests, but is a concern if we had some integration
66+ // tests that relied on VSCode accessing our module since there could be
67+ // some shared global state that we lose.
68+ decache ( fullPath ) ;
69+ } ) ;
70+
71+ self . matchFn = ( file : string ) : boolean => fileMap [ file ] ;
72+ self . matchFn . files = Object . keys ( fileMap ) ;
73+
74+ // Hook up to the Require function so that when this is called, if any of our source files
75+ // are required, the instrumented version is pulled in instead. These instrumented versions
76+ // write to a global coverage variable with hit counts whenever they are accessed
77+ self . transformer = self . instrumenter . instrumentSync . bind ( self . instrumenter ) ;
78+ const hookOpts = { verbose : false , extensions : [ '.js' ] } ;
79+ istanbul . hook . hookRequire ( self . matchFn , self . transformer , hookOpts ) ;
80+
81+ // initialize the global variable to stop mocha from complaining about leaks
82+ global [ self . coverageVar ] = { } ;
83+ }
8484
85- /**
85+ /**
8686 * Writes a coverage report.
8787 * Note that as this is called in the process exit callback, all calls must be synchronous.
8888 *
8989 * @returns {void }
9090 *
9191 * @memberOf CoverageRunner
9292 */
93- public reportCoverage ( ) : void {
94- // eslint-disable-next-line @typescript-eslint/no-this-alias
95- const self = this ;
96- istanbul . hook . unhookRequire ( ) ;
97- let cov : any ;
98- if ( typeof global [ self . coverageVar ] === 'undefined' || Object . keys ( global [ self . coverageVar ] ) . length === 0 ) {
99- console . error ( 'No coverage information was collected, exit without writing coverage information' ) ;
93+ public reportCoverage ( ) : void {
94+ // eslint-disable-next-line @typescript-eslint/no-this-alias
95+ const self = this ;
96+ istanbul . hook . unhookRequire ( ) ;
97+ let cov : any ;
98+ if ( typeof global [ self . coverageVar ] === 'undefined' || Object . keys ( global [ self . coverageVar ] ) . length === 0 ) {
99+ console . error ( 'No coverage information was collected, exit without writing coverage information' ) ;
100+ return ;
101+ } else {
102+ cov = global [ self . coverageVar ] ;
103+ }
104+
105+ // TODO consider putting this under a conditional flag
106+ // Files that are not touched by code ran by the test runner is manually instrumented, to
107+ // illustrate the missing coverage.
108+ self . matchFn . files . forEach ( ( file : any ) => {
109+ if ( cov [ file ] ) {
100110 return ;
101- } else {
102- cov = global [ self . coverageVar ] ;
103111 }
112+ self . transformer ( fs . readFileSync ( file , 'utf-8' ) , file ) ;
104113
105- // TODO consider putting this under a conditional flag
106- // Files that are not touched by code ran by the test runner is manually instrumented, to
107- // illustrate the missing coverage.
108- self . matchFn . files . forEach ( ( file : any ) => {
109- if ( cov [ file ] ) {
110- return ;
111- }
112- self . transformer ( fs . readFileSync ( file , 'utf-8' ) , file ) ;
113-
114- // When instrumenting the code, istanbul will give each FunctionDeclaration a value of 1 in coverState.s,
115- // presumably to compensate for function hoisting. We need to reset this, as the function was not hoisted,
116- // as it was never loaded.
117- Object . keys ( self . instrumenter . coverState . s ) . forEach ( ( key ) => {
118- self . instrumenter . coverState . s [ key ] = 0 ;
119- } ) ;
120-
121- cov [ file ] = self . instrumenter . coverState ;
114+ // When instrumenting the code, istanbul will give each FunctionDeclaration a value of 1 in coverState.s,
115+ // presumably to compensate for function hoisting. We need to reset this, as the function was not hoisted,
116+ // as it was never loaded.
117+ Object . keys ( self . instrumenter . coverState . s ) . forEach ( ( key ) => {
118+ self . instrumenter . coverState . s [ key ] = 0 ;
122119 } ) ;
123120
124- // TODO Allow config of reporting directory with
125- const reportingDir = paths . join ( self . testsRoot , self . options . relativeCoverageDir ) ;
126- const includePid = self . options . includePid ;
127- const pidExt = includePid ? ( '-' + process . pid ) : '' ;
128- const coverageFile = paths . resolve ( reportingDir , `coverage${ pidExt } ) ;
121+ cov [ file ] = self . instrumenter . coverState ;
122+ } ) ;
129123
130- // yes, do this again since some test runners could clean the dir initially created
131- _mkDirIfExists ( reportingDir ) ;
124+ // TODO Allow config of reporting directory with
125+ const reportingDir = paths . join ( self . testsRoot , self . options . relativeCoverageDir ) ;
126+ const includePid = self . options . includePid ;
127+ const pidExt = includePid ? ( '-' + process . pid ) : '' ;
128+ const coverageFile = paths . resolve ( reportingDir , `coverage${ pidExt } ) ;
132129
133- fs . writeFileSync ( coverageFile , JSON . stringify ( cov ) , 'utf8' ) ;
130+ // yes, do this again since some test runners could clean the dir initially created
131+ _mkDirIfExists ( reportingDir ) ;
134132
135- const remappedCollector = remapIstanbul . remap ( cov , {
136- warn : ( warning : any ) => {
137- // We expect some warnings as any JS file without a typescript mapping will cause this.
138- // By default, we'll skip printing these to the console as it clutters it up
139- if ( self . options . verbose ) {
140- console . warn ( warning ) ;
141- }
142- }
143- } ) ;
133+ fs . writeFileSync ( coverageFile , JSON . stringify ( cov ) , 'utf8' ) ;
144134
145- const reporter = new istanbul . Reporter ( undefined , reportingDir ) ;
146- const reportTypes = ( self . options . reports instanceof Array ) ? self . options . reports : [ 'lcov' ] ;
147- reporter . addAll ( reportTypes ) ;
148- reporter . write ( remappedCollector , true , ( ) => {
149- console . log ( `reports written to ${ reportingDir } ) ;
150- } ) ;
151- }
135+ const remappedCollector = remapIstanbul . remap ( cov , {
136+ warn : ( warning : any ) => {
137+ // We expect some warnings as any JS file without a typescript mapping will cause this.
138+ // By default, we'll skip printing these to the console as it clutters it up
139+ if ( self . options . verbose ) {
140+ console . warn ( warning ) ;
141+ }
142+ }
143+ } ) ;
144+
145+ const reporter = new istanbul . Reporter ( undefined , reportingDir ) ;
146+ const reportTypes = ( self . options . reports instanceof Array ) ? self . options . reports : [ 'lcov' ] ;
147+ reporter . addAll ( reportTypes ) ;
148+ reporter . write ( remappedCollector , true , ( ) => {
149+ console . log ( `reports written to ${ reportingDir } ) ;
150+ } ) ;
151+ }
152152}
0 commit comments