tasks.js 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. /* jshint node: true, esnext: true */
  2. 'use strict';
  3. const gulp = require( 'gulp' );
  4. const istanbul = require( 'gulp-istanbul' );
  5. const gutil = require( 'gulp-util' );
  6. const mocha = require( 'gulp-mocha' );
  7. const chai = require( 'chai' );
  8. const filterBy = require( 'gulp-filter-by' );
  9. const filter = require( 'gulp-filter' );
  10. const sinon = require( 'sinon' );
  11. const devTools = require( '../dev/utils/tools' );
  12. const semver = require( 'semver' );
  13. const buildUtils = require( '../build/utils' );
  14. const benderConfig = require( '../../../bender' );
  15. /**
  16. * Defines Node.js testing task and development tools testing tasks.
  17. *
  18. * To run tests under Node.js:
  19. *
  20. * gulp test:node
  21. *
  22. * To run build under Node.js before testing:
  23. *
  24. * gulp test:node:build
  25. *
  26. * To run testing under Node.js with code coverage:
  27. *
  28. * gulp test:node:coverage
  29. *
  30. * To run development tools tests:
  31. *
  32. * gulp test:dev
  33. *
  34. * To run development tools tests with coverage:
  35. *
  36. * gulp test:dev:coverage
  37. */
  38. module.exports = () => {
  39. const ignoreRegexp = /\/\* ?bender-tags:.*\bbrowser-only\b.*\*\//;
  40. // Inject globals before running tests.
  41. global.should = chai.should;
  42. global.expect = chai.expect;
  43. global.assert = chai.assert;
  44. global.sinon = sinon;
  45. const tasks = {
  46. /**
  47. * Is set to `true` when code coverage report will be displayed.
  48. *
  49. * @type {Boolean}
  50. */
  51. coverage: false,
  52. /**
  53. * Prepares files for coverage report.
  54. *
  55. * @returns {Stream}
  56. */
  57. prepareNodeCoverage() {
  58. const src = benderConfig.coverage.paths.map( ( item ) => {
  59. return item.replace( 'build/amd/', 'build/cjs/' );
  60. } );
  61. tasks.coverage = true;
  62. return gulp.src( src )
  63. .pipe( istanbul() )
  64. .pipe( istanbul.hookRequire() );
  65. },
  66. /**
  67. * Runs tests in Node.js environment.
  68. *
  69. * @returns {Stream}
  70. */
  71. testInNode() {
  72. const minVersion = '6.0.0';
  73. if ( semver.lt( process.version, minVersion ) ) {
  74. throw new gutil.PluginError( {
  75. plugin: 'test-node',
  76. message: `Wrong Node.js version. Please use Node.js in version v${ minVersion } or higher.`
  77. } );
  78. }
  79. const benderSrc = benderConfig.tests.all.paths.map( ( item ) => {
  80. return item.replace( 'build/amd/', 'build/cjs/' ) + '/*.js' ;
  81. } );
  82. const src = [
  83. ...benderSrc,
  84. '!build/cjs/tests/{ui,ui-*}/**/*.js',
  85. '!build/cjs/tests/theme-*/**/*.js',
  86. '!build/cjs/tests/creator-*/**/*.js'
  87. ];
  88. return gulp.src( src )
  89. .pipe( tasks.skipManual() )
  90. .pipe( tasks.skipIgnored() )
  91. .pipe( mocha( { reporter: 'progress' } ) )
  92. .pipe( tasks.coverage ? istanbul.writeReports() : buildUtils.noop() );
  93. },
  94. /**
  95. * Removes manual test files from source stream. It checks if the markdown file with the same name exists.
  96. *
  97. * @returns {Stream}
  98. */
  99. skipManual() {
  100. return filter( ( file ) => {
  101. return !devTools.isFile( file.path.slice( 0, -3 ) + '.md' );
  102. } );
  103. },
  104. /**
  105. * Skips test files that are marked to be ignored when testing outside browser.
  106. * To ignore file, add `browser-only` to bender-tags comment in test file.
  107. *
  108. * @returns {Stream}
  109. */
  110. skipIgnored() {
  111. return filterBy( file => !file.contents.toString().match( ignoreRegexp ) );
  112. },
  113. /**
  114. * Runs dev unit tests.
  115. *
  116. * @returns {Stream}
  117. */
  118. devTest() {
  119. return gulp.src( 'dev/tests/**/*.js' )
  120. .pipe( mocha() )
  121. .pipe( tasks.coverage ? istanbul.writeReports() : buildUtils.noop() );
  122. },
  123. /**
  124. * Prepares files for coverage report.
  125. *
  126. * @returns {Stream}
  127. */
  128. prepareDevCoverage() {
  129. tasks.coverage = true;
  130. return gulp.src( 'dev/tasks/**/*.js' )
  131. .pipe( istanbul() )
  132. .pipe( istanbul.hookRequire() );
  133. },
  134. register() {
  135. gulp.task( 'test:node:pre-coverage', [ 'build:js:cjs' ], tasks.prepareNodeCoverage );
  136. gulp.task( 'test:node', tasks.testInNode );
  137. gulp.task( 'test:node:build', [ 'build:js:cjs' ] , tasks.testInNode );
  138. gulp.task( 'test:node:coverage', [ 'build:js:cjs', 'test:node:pre-coverage' ], tasks.testInNode );
  139. gulp.task( 'test:dev:pre-coverage', tasks.prepareDevCoverage );
  140. gulp.task( 'test:dev', tasks.devTest );
  141. gulp.task( 'test:dev:coverage', [ 'test:dev:pre-coverage' ], tasks.devTest );
  142. }
  143. };
  144. return tasks;
  145. };