tdd.js 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. /**
  2. * Module dependencies.
  3. */
  4. var Suite = require('../suite');
  5. var Test = require('../test');
  6. var escapeRe = require('escape-string-regexp');
  7. /**
  8. * TDD-style interface:
  9. *
  10. * suite('Array', function() {
  11. * suite('#indexOf()', function() {
  12. * suiteSetup(function() {
  13. *
  14. * });
  15. *
  16. * test('should return -1 when not present', function() {
  17. *
  18. * });
  19. *
  20. * test('should return the index when present', function() {
  21. *
  22. * });
  23. *
  24. * suiteTeardown(function() {
  25. *
  26. * });
  27. * });
  28. * });
  29. *
  30. * @param {Suite} suite Root suite.
  31. */
  32. module.exports = function(suite) {
  33. var suites = [suite];
  34. suite.on('pre-require', function(context, file, mocha) {
  35. var common = require('./common')(suites, context);
  36. context.setup = common.beforeEach;
  37. context.teardown = common.afterEach;
  38. context.suiteSetup = common.before;
  39. context.suiteTeardown = common.after;
  40. context.run = mocha.options.delay && common.runWithSuite(suite);
  41. /**
  42. * Describe a "suite" with the given `title` and callback `fn` containing
  43. * nested suites and/or tests.
  44. */
  45. context.suite = function(title, fn) {
  46. var suite = Suite.create(suites[0], title);
  47. suite.file = file;
  48. suites.unshift(suite);
  49. fn.call(suite);
  50. suites.shift();
  51. return suite;
  52. };
  53. /**
  54. * Pending suite.
  55. */
  56. context.suite.skip = function(title, fn) {
  57. var suite = Suite.create(suites[0], title);
  58. suite.pending = true;
  59. suites.unshift(suite);
  60. fn.call(suite);
  61. suites.shift();
  62. };
  63. /**
  64. * Exclusive test-case.
  65. */
  66. context.suite.only = function(title, fn) {
  67. var suite = context.suite(title, fn);
  68. mocha.grep(suite.fullTitle());
  69. };
  70. /**
  71. * Describe a specification or test-case with the given `title` and
  72. * callback `fn` acting as a thunk.
  73. */
  74. context.test = function(title, fn) {
  75. var suite = suites[0];
  76. if (suite.isPending()) {
  77. fn = null;
  78. }
  79. var test = new Test(title, fn);
  80. test.file = file;
  81. suite.addTest(test);
  82. return test;
  83. };
  84. /**
  85. * Exclusive test-case.
  86. */
  87. context.test.only = function(title, fn) {
  88. var test = context.test(title, fn);
  89. var reString = '^' + escapeRe(test.fullTitle()) + '$';
  90. mocha.grep(new RegExp(reString));
  91. };
  92. context.test.skip = common.test.skip;
  93. context.test.retries = common.test.retries;
  94. });
  95. };