tasks.js 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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.
  17. *
  18. * To run tests under node:
  19. *
  20. * gulp test:node
  21. *
  22. * To run build before testing:
  23. *
  24. * gulp test:node:build
  25. *
  26. * To run testing with code coverage:
  27. *
  28. * gulp test:node:coverage
  29. */
  30. module.exports = () => {
  31. const ignoreRegexp = /\/\* ?bender-tags:.*\bbrowser-only\b.*\*\//;
  32. // Inject globals before running tests.
  33. global.should = chai.should;
  34. global.expect = chai.expect;
  35. global.assert = chai.assert;
  36. global.sinon = sinon;
  37. const tasks = {
  38. /**
  39. * Is set to `true` when code coverage report will be displayed.
  40. *
  41. * @type {Boolean}
  42. */
  43. coverage: false,
  44. /**
  45. * Prepares files for coverage report.
  46. *
  47. * @returns {Stream}
  48. */
  49. prepareCoverage() {
  50. const src = benderConfig.coverage.paths.map( ( item ) => {
  51. return item.replace( 'build/amd/', 'build/cjs/' );
  52. } );
  53. tasks.coverage = true;
  54. return gulp.src( src )
  55. .pipe( istanbul() )
  56. .pipe( istanbul.hookRequire() );
  57. },
  58. /**
  59. * Runs tests in Node.js environment.
  60. *
  61. * @returns {Stream}
  62. */
  63. testInNode() {
  64. const minVersion = '6.0.0';
  65. if ( semver.lt( process.version, minVersion ) ) {
  66. throw new gutil.PluginError( {
  67. plugin: 'test-node',
  68. message: `Wrong Node.js version. Please use Node.js in version v${ minVersion } or higher.`
  69. } );
  70. }
  71. const benderSrc = benderConfig.tests.all.paths.map( ( item ) => {
  72. return item.replace( 'build/amd/', 'build/cjs/' ) + '/*.js' ;
  73. } );
  74. const src = [
  75. ...benderSrc,
  76. '!build/cjs/tests/{ui,ui-*}/**/*.js',
  77. '!build/cjs/tests/theme-*/**/*.js',
  78. '!build/cjs/tests/creator-*/**/*.js'
  79. ];
  80. return gulp.src( src )
  81. .pipe( tasks.skipManual() )
  82. .pipe( tasks.skipIgnored() )
  83. .pipe( mocha( { reporter: 'progress' } ) )
  84. .pipe( tasks.coverage ? istanbul.writeReports() : buildUtils.noop() );
  85. },
  86. /**
  87. * Removes manual test files from source stream. It checks if the markdown file with the same name exists.
  88. *
  89. * @returns {Stream}
  90. */
  91. skipManual() {
  92. return filter( ( file ) => {
  93. return !devTools.isFile( file.path.slice( 0, -3 ) + '.md' );
  94. } );
  95. },
  96. /**
  97. * Skips test files that are marked to be ignored when testing outside browser.
  98. * To ignore file, add `browser-only` to bender-tags comment in test file.
  99. *
  100. * @returns {Stream}
  101. */
  102. skipIgnored() {
  103. return filterBy( file => !file.contents.toString().match( ignoreRegexp ) );
  104. }
  105. };
  106. gulp.task( 'test:node:pre-coverage', [ 'build:js:cjs' ], tasks.prepareCoverage );
  107. gulp.task( 'test:node', tasks.testInNode );
  108. gulp.task( 'test:node:build', [ 'build:js:cjs' ] , tasks.testInNode );
  109. gulp.task( 'test:node:coverage', [ 'build:js:cjs', 'test:node:pre-coverage' ], tasks.testInNode );
  110. return tasks;
  111. };