category: framework-contributing
Before reading this article we recommend reading about the {@link framework/guides/contributing/development-environment Development environment}.
The CKEditor 5 testing environment uses a pretty popular setup with Karma, Webpack, babel-loader and Istanbul. We created a bunch of gulp tasks which glue all these pieces and special requirements for CKEditor together.
We are [considering dropping gulp and switching to npm scripts](https://github.com/ckeditor/ckeditor5/issues/473), so please do not be surprised that both methods are in use now.
Each CKEditor package has its own tests suite (see e.g. the engine's tests), however, the test runner is available in the ckeditor5 package, which is a central development environment. The actual code of the test runner is implemented in @ckeditor/ckeditor5-dev-tests package and can be easily reused outside ckeditor5.
In order to run the automated tests use the gulp test task.
It accepts the following arguments:
--watch (alias -w) – Whether to watch the files and execute tests whenever any file changes.--source-map (alias -s) – Whether to generate the source maps.--coverage (alias -c) – Whether to generate code coverage.--verbose (alias -v) – Allows switching on Webpack's logs.--files – Specify tests files to run. Accepts a package name or a glob. Read more about the rules for converting --files option to glob pattern.--browsers – Browsers which will be used to run the tests. Defaults to Chrome.Run all tests with code coverage check of the ckeditor5-core package:
gulp test -c --files=core
Run and watch the engine's view namespace tests and all the tests in ckeditor5-typing:
gulp test -cw --files=engine/view,typing
Run the bold*.js tests in the ckeditor5-basic-styles package:
gulp test -cw --files=basic-styles/bold*.js
In order to start a manual tests server use the gulp test:manual task.
It accepts --source-map (alias -s) option.
It starts a server available at http://localhost:8125.
A manual test consists of 3 files:
<name>.md file with the test description.<name>.js file with the JS part of the test (e.g. code initializing an editor).<name>.html file with the HTML part of the test. It doesn't need to be an entire HTML page (with the doctype, etc.), it can be just these HTML elements which you want to define.All 3 files are combined together and create a single manual test.
Example Markdown file:
## Create a new link
1. Select a fragment of regular text.
2. Click the toolbar "Link" button.
3. Check if the balloon panel attached to the selection appeared.
4. Fill in the "Link URL" input in the panel.
5. Click the "Save" button.
6. Check if the selected text is converted into a link.
Example HTML file:
<head>
<style>
/*
Some additional styles which this test needs.
And yes – the test builder will merge this tag with head defined in a template.
*/
</style>
</head>
<div id="editor">...</div>
Example JS file:
/* globals console, window, document */
import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classic.js';
import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials.js';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph.js';
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Essentials, Paragraph ]
} )
.then( editor => {
window.editor = editor;
} )
.catch( err => {
console.error( err.stack );
} );
Do not forget to add all dependencies of your manual test as `devDependencies` (in `package.json`).