A Karma plugin. Adapter for OpenUI5/SAPUI5 Framework

Downloads in past


0.2.36 years ago9 years agoMinified + gzip package size for karma-openui5 in KB


NPM Version
Adapter for OpenUI5/SAPUI5 UI framework. This adapter loads OpenUI5/SAPUI5 from the specified location and makes it available for the tests to run in karma afterwards.


The easiest way is to add karma-openui5 as a devDependency in your package.json.
  "devDependencies": {
    "karma-openui5": "~0.2"

Information on how to install karma can be found here.


The following code shows the available configuration options.
For the client OpenUI5 configuration you can create an object using any of the options described in the documentation.
To automatically load test modules (via sap.ui.require), the tests config can be set to an array of module names. When using this config, the relevant files must not be included via the files config of Karma.
This is very similar to how RequireJS works with Karma, but without the need for a custom test-main.js file.
For the mockserver config you can pass an object like you would do it for the `sap.ui.core.util.MockServer.config` function. The rootUri and the metadataURL are required properties if you use the mock server. You can also pass mockdata settings like you would do it for the `simulate` function of the MockServer. The MockServer needs to be enabled explicitly by settings the `useMockServer` option.
// karma.conf.js
module.exports = function(config) {
    frameworks: ['openui5'],

    openui5: {
      path: 'http://path/to/sap-ui-core.js',
      useMockServer: false

    client: {
      openui5: {
        config: {
          theme: 'sap_belize'
        tests: [
        mockserver: {
          config: {
            autoRespond: true
          rootUri: '/my/service/',
          metadataURL: '/base/test/mock.xml',
          mockdataSettings: {


Application constrains

QUnit dependency

Do no require QUnit resources from within the tests. Karma loads its own versions of them in order hook in its reporting at the right places.
Therefore rather load those resources in the non-karma specific test runner HTML pages. Like this: ````html
<script src="../../resources/sap/ui/thirdparty/qunit.js"></script>
<script src="../../resources/sap/ui/qunit/qunit-css.js"></script>

OPA5: Component containers instead of iFrames

Only relevant when using Istanbul to create test coverage
has problems collecting code coverage results from within iFrames. To gather code coverage from OPA5 tests you need to execute them inside of component containers instead of iFrames. This will also speed up the execution time of your OPA5 tests.
Notice: With component containers you will loose the isolation of your single tests. Also, your applications index.html won't be executed anymore (as only the applications Component.js will be needed).
In your tests, replace iStartMyAppInAFrame() withiStartMyUIComponent() and iTeardownMyAppFrame() with iTeardownMyUIComponent().
For more information see the API reference of sap.ui.test.Opa5


(c) Copyright 2017 SAP SE or an SAP affiliate company
Licensed under the Apache License, Version 2.0 - see LICENSE.