Users Guide"

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

m (Installation)
m (Installation)
Line 5: Line 5:
 
== Installation  ==
 
== Installation  ==
  
Below we'll take the CKEditor project as an example to illustrate the install process:
+
'''Note''': Below we'll take the CKEditor project as an example to illustrate the install process.
  
 +
 +
First of all, checking out these three component: the staging project, it's test suites and CKTester eventually.
 
#Checkout CKEditor's testing branch from SVN ( We name the working copy path as CKEDITOR_TEST_ROOT below ). <br>  
 
#Checkout CKEditor's testing branch from SVN ( We name the working copy path as CKEDITOR_TEST_ROOT below ). <br>  
 
#Checkout CKEditor trunk( or any other version are subjected to test ) from [http://svn.fckeditor.net/CKEditor/trunk/ SVN] into a folder ( e.g. ckeditor ) under CKEDITOR_TEST_ROOT ( We name the working copy path as CKEDITOR_ROOT below ).<br>  
 
#Checkout CKEditor trunk( or any other version are subjected to test ) from [http://svn.fckeditor.net/CKEditor/trunk/ SVN] into a folder ( e.g. ckeditor ) under CKEDITOR_TEST_ROOT ( We name the working copy path as CKEDITOR_ROOT below ).<br>  
#Checkout CKTester from [http://svn.fckeditor.net/CKTester SVN]&nbsp;into a folder( e.g. cktester ) under CKEDITOR_TEST_ROOT( We name the working copy path as CKTESTER_ROOT below ). <br>
+
#Checkout CKTester from [http://svn.fckeditor.net/CKTester SVN]&nbsp;into a folder( e.g. cktester ) under CKEDITOR_TEST_ROOT( We name the working copy path as CKTESTER_ROOT below ).
#Open the file {CKTESTER_ROOT}/variables.js.tpl with modification to the following variables:<br>
+
 
 +
Open the file {CKTESTER_ROOT}/variables.js.tpl with modification to the following variables:<br>
 
<pre> // Absolute path point to the root path of CKEditor project.
 
<pre> // Absolute path point to the root path of CKEditor project.
 
'CKEDITOR_ROOT'&nbsp;: '/ckeditor',
 
'CKEDITOR_ROOT'&nbsp;: '/ckeditor',
Line 17: Line 20:
 
       'CKEDITOR_TEST_BRANCH_ROOT'&nbsp;: '/'
 
       'CKEDITOR_TEST_BRANCH_ROOT'&nbsp;: '/'
 
</pre>
 
</pre>
#At last, run the script {CKTESTER_ROOT}/_dev/gen-profile.bat(.sh) ( you'll need install [http://ant.apache.org/ Apache Ant] ) which helps you to generate the testing profile automatically by scanning the resources within {CKEDITOR_TEST_ROOT}.<br><br>After that, you'll get a file created at {CKTESTER_ROOT}/template.js which looks basically like:
+
 
 +
At last, run the script {CKTESTER_ROOT}/_dev/gen-profile.bat(.sh) ( you'll need install [http://ant.apache.org/ Apache Ant] ) which helps you to generate the testing profile automatically by scanning the resources within {CKEDITOR_TEST_ROOT}. After that, you'll get a file created at {CKTESTER_ROOT}/template.js which looks basically like:
 
<pre> CKTESTER.fort.getProfile = function ()
 
<pre> CKTESTER.fort.getProfile = function ()
 
{
 
{
Line 33: Line 37:
  
 
</pre>
 
</pre>
#It's done, now point your web browser at {CKEDITOR_TEST_ROOT}/index.html, a few pilot links there to kick start you testing.<br>
+
It's done, now point your web browser at {CKEDITOR_TEST_ROOT}/index.html, a few pilot links there to kick start you testing.<br>
  
 
<br>
 
<br>

Revision as of 09:42, 24 September 2009

Overview

CKTester is our internal testing hub, created to provide seamless and integrated testing experience to our developers, been capable of managing and interfacing tests from various projects which may potentially rely on different testing frameworks/runners. Been designed with convenient authoring and ease of viewing the test cases in mind, it could be running independently in all situation from a browser : locally, on a web server or via secure connections.

Installation

Note: Below we'll take the CKEditor project as an example to illustrate the install process.


First of all, checking out these three component: the staging project, it's test suites and CKTester eventually.

  1. Checkout CKEditor's testing branch from SVN ( We name the working copy path as CKEDITOR_TEST_ROOT below ).
  2. Checkout CKEditor trunk( or any other version are subjected to test ) from SVN into a folder ( e.g. ckeditor ) under CKEDITOR_TEST_ROOT ( We name the working copy path as CKEDITOR_ROOT below ).
  3. Checkout CKTester from SVN into a folder( e.g. cktester ) under CKEDITOR_TEST_ROOT( We name the working copy path as CKTESTER_ROOT below ).

Open the file {CKTESTER_ROOT}/variables.js.tpl with modification to the following variables:

	// Absolute path point to the root path of CKEditor project.
	'CKEDITOR_ROOT' : '/ckeditor',

        // Point to the root path of CKEditor test branch.( You don't need to alter it if your web server's serving root from CKEDITOR_TEST_ROOT.
       'CKEDITOR_TEST_BRANCH_ROOT' : '/'

At last, run the script {CKTESTER_ROOT}/_dev/gen-profile.bat(.sh) ( you'll need install Apache Ant ) which helps you to generate the testing profile automatically by scanning the resources within {CKEDITOR_TEST_ROOT}. After that, you'll get a file created at {CKTESTER_ROOT}/template.js which looks basically like:

	CKTESTER.fort.getProfile = function ()
	{
		return {
			cells :
			[
			// Generated cell paths...
			],
			cellResolvers :
			[
			// Some Default cell resolvers. 
			]
		};
	};

It's done, now point your web browser at {CKEDITOR_TEST_ROOT}/index.html, a few pilot links there to kick start you testing.


Common Tasks

History

CKTester is evolved from previous project FCKTest.