Show TOC

Creating a QUnit Test PageLocate this document in the navigation structure


As a prerequisite for creating a test, you need to have created a SAPUI5 application (such as myapp). Once you have done this, continue with the steps described below.

Creating a Test Page
Create a QUnit test page myqunittest.qunit.html in the folder test-resources/.
Note The file name XYZ.qunit.html is a recommendation to clearly indicate that this is a QUnit test. Technically, the .qunit name extension is not required.
You can use the file template shown below. This code snippet shows a basic QUnit test template which is used for SAPUI5 control tests.
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <base href="../../../../../../">
    <!--[if lte IE 9]><script>
         (function() {
                var baseTag = document.getElementsByTagName('base')[0];
                baseTag.href = baseTag.href;
    <script id="sap-ui-bootstrap" 
    <link rel="stylesheet" href="resources/sap/ui/thirdparty/qunit.css" type="text/css" media="screen" />
    <script type="text/javascript" src="resources/sap/ui/thirdparty/qunit.js"></script>
    <script type="text/javascript" src="resources/sap/ui/qunit/qunit-junit.js"></script>
    <script type="text/javascript" src="resources/sap/ui/qunit/QUnitUtils.js"></script>

    <script language="javascript">
    /* Create and structure your QUnit tests here
    Documentation can be found at
     QUnit.module("Module A"); 
     QUnit.test("1. a basic test example", 2, function (assert) {
       assert.ok(true, "this test is fine"); 
       var value = "hello1"; 
       assert.equal(value, "hello1", "We expect value to be 'hello1'"); 
    <div id="qunit"></div>
    <!-- [TODO: add additional html content here] -->

You can see above that a QUnit test page includes the SAPUI5 bootstrap (sap-ui-core.js), the QUnit related files (qunit.css and qunit.js) as well as the SAPUI5 utilities (QUnitUtils.js). The HTML body contains the tags needed by QUnit to report the test results. You can find the QUnit test template here: ../src/sap.ui.core/test/sap/ui/core/qunit/template.qunit.html.

Writing Test Functions

Write your test code (like in the following example) into the template introduced in the previous section:

    /* Create e.g. a SAPUI5 control which you need for your tests
       Alternatively you can do this also in the beforeEach method of a module */
    var oButton = new sap.ui.commons.Button("myButton", {text: "Click me"});

    /* The QUnit processing starts automatically when the page is
       loaded. If you want to delay the start because of some
       additional preparation work you can use the following utility
       function: */

    /* The module call can be used to categorize your test functions.
       In addition it is possible to define actions which are processed
       during beforeEach and afterEach. */
    QUnit.module("Module A");
    /* Example for a non-asynchronous test function:
       The first parameter is the name of the test,
       the second (optional) parameter is the number of expected assertions in the test,
       the third parameter is the test function to call when the tests runs. */
    QUnit.test("Test 1", 3, function(assert) { 
        assert.ok( true, "this test is fine" );
        var value = "hello1";
        assert.equal( value, "hello1", "We expect value to be 'hello1'" ); 

        /* You can also do some actions between the assertions,
           like triggering a keydown event with Enter key on the
           Dom element with ID 'myButton' using the utilities.
           Note: The utility function simulates a keyboard event
                 using 'jQuery.trigger'. This is not a 'real'
                 event which comes from the browser and there might
                 be differences you must be aware of: When the
                 user presses the Enter key on a button several
                 events are fired by the browser like keydown, keyup,
                 click, .... The function below ONLY simulates a
                 keydown! */
        sap.ui.test.qunit.triggerKeydown("myButton", "ENTER");

        assert.ok( true, "another test after the action" );

    /* Modules have a second, optional "lifecycle" parameter. The life cycle object can 
       have two methods - beforeEach and afterEach. Both methods are called for each test
       of the module. It is best practice to use those life cycle methods to have standelone
       tests that do not have dependencies on other tests. */
   QUnit.module("Module B", {
      beforeEach: function(){
       // Code needed for the tests of this module
       // = new Bar();

      afterEach: function(){
       // Cleanup here
       // = null;

    /* Example for an asynchronous test function: */

   QUnit.test("Test 2", 3, function(assert) {
       var done = assert.async(); 
    /* Instead of using the second parameter in the test definition you can define the number expected assertions in the function body. This is handy, when you write tests with different outcome. */
       // assert.expect(3);

    /* First you start with tests in the normal flow */
       assert.ok(true, "this test is fine");
       setTimeout(function() {
        assert.ok(true, "this test is executed asynchronously"); 

    /* Do the asynchrounos tests and give QUnit the sign to go on with the next test function via 'done' when the processing of the current one is completed */
    }, 1000); 

   /* Do the things which needs a test delay, e.g. press a button which starts a backend call */
    sap.ui.test.qunit.triggerKeydown("myButton", "ENTER");
    assert.ok(true, "this test is not executed asynchronously");

For the test example shown above, the following additional line was added to the body of the test template:

<div id="myContent"></div>