1
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2022-11-09 12:25:43 -05:00
twbs--bootstrap/js/tests
Gleb Mazovetskiy c7d8e7a077 Accept elements as the tooltip / popover content
When a DOM node is passed to an HTML tooltip, the `title` node is only
moved if it is not already in the tooltip. Otherwise, `empty()` is used
instead of `detach()` before appending the `title` to avoid memory
leaks. If a DOM node is passed to a plain text tooltip, its text is
copied via jQuery `.text()`.

Replaces `.detach()` with `.empty()`, as `.detach()` is almost never
useful but instead leaks memory. The difference between `empty` and
`detach` is that the latter keeps all the attached jQuery events/data.
However, since we do not return the previous children, the user would
have to keep these themselves, thus they can `detach()` if necessary.

This is a port of https://github.com/twbs/bootstrap/pull/14552 to v4.
2015-08-31 01:06:13 +01:00
..
unit Accept elements as the tooltip / popover content 2015-08-31 01:06:13 +01:00
vendor Update QUnit to v1.18.0. 2015-08-27 08:15:19 +03:00
visual Docs: Update all dropdowns to new HTML structure 2015-08-21 00:18:55 +02:00
index.html Merge branch 'master' into v4m 2015-08-04 22:29:45 -07:00
README.md [Fixes #15951] Document JS test suite basics 2015-03-06 23:27:00 -08:00

How does Bootstrap's test suite work?

Bootstrap uses QUnit, a powerful, easy-to-use JavaScript unit test framework. Each plugin has a file dedicated to its tests in unit/<plugin-name>.js.

  • unit/ contains the unit test files for each Bootstrap plugin.
  • vendor/ contains third-party testing-related code (QUnit and jQuery).
  • visual/ contains "visual" tests which are run interactively in real browsers and require manual verification by humans.

To run the unit test suite via PhantomJS, run grunt test-js.

To run the unit test suite via a real web browser, open index.html in the browser.

How do I add a new unit test?

  1. Locate and open the file dedicated to the plugin which you need to add tests to (unit/<plugin-name>.js).
  2. Review the QUnit API Documentation and use the existing tests as references for how to structure your new tests.
  3. Write the necessary unit test(s) for the new or revised functionality.
  4. Run grunt test-js to see the results of your newly-added test(s).

Note: Your new unit tests should fail before your changes are applied to the plugin, and should pass after your changes are applied to the plugin.

What should a unit test look like?

  • Each test should have a unique name clearly stating what unit is being tested.
  • Each test should test only one unit per test, although one test can include several assertions. Create multiple tests for multiple units of functionality.
  • Each test should begin with assert.expect to ensure that the expected assertions are run.
  • Each test should follow the project's JavaScript Code Guidelines

Example tests

// Synchronous test
QUnit.test('should describe the unit being tested', function (assert) {
  assert.expect(1)
  var templateHTML = '<div class="alert alert-danger fade in">'
      + '<a class="close" href="#" data-dismiss="alert">×</a>'
      + '<p><strong>Template necessary for the test.</p>'
      + '</div>'
  var $alert = $(templateHTML).appendTo('#qunit-fixture').bootstrapAlert()

  $alert.find('.close').click()

  // Make assertion
  assert.strictEqual($alert.hasClass('in'), false, 'remove .in class on .close click')
})

// Asynchronous test
QUnit.test('should describe the unit being tested', function (assert) {
  assert.expect(1)
  var done = assert.async()

  $('<div title="tooltip title"></div>')
    .appendTo('#qunit-fixture')
    .on('shown.bs.tooltip', function () {
      assert.ok(true, '"shown" event was fired after calling "show"')
      done()
    })
    .bootstrapTooltip('show')
})