Creating a Test Case

From FirebugWiki

(Difference between revisions)
Jump to: navigation, search
(Changed JS template and added JS template for several test cases)
(Enhanced description of how to create test cases)
Line 1: Line 1:
 +
== General info ==
We can only work on issues, that we can reproduce. Therefore it is very important to have simple test cases for the bug you're seeing or the feature you are missing in Firebug.
We can only work on issues, that we can reproduce. Therefore it is very important to have simple test cases for the bug you're seeing or the feature you are missing in Firebug.
-
To help you with creating test cases we have created some HTML and JavaScript templates, which are listed below.
 
-
[http://fbug.googlecode.com/svn/tests/content/templates/net/issueXXXX.js JavaScript template for automated tests] - Template for automated tests used in [[FBTest]]
+
'''A test case MUST include precise step by step instructions how to reproduce it and a description of what you expect to see.'''
 +
 
 +
If you provide a test case file, you should also provide the following additional information:
 +
 
 +
* The issue number
 +
* The issue summary
 +
* Observed results (in case of bugs)
 +
* Contact information (so we can get back to you in case of questions)
== Manual tests ==
== Manual tests ==
-
In order to create a simple manual test case you can use one of the templates below:
+
=== How to create ===
-
# [http://fbug.googlecode.com/svn/tests/content/templates/default/issueXXXX.html Default HTML template] - Common template used for normal purposes
+
To create a manual test case you can either provide a publicly accessible URL or create a specific a test case file.
-
# [http://fbug.googlecode.com/svn/tests/content/templates/default/issueXXXXSeveralCases.html Enhanced HTML template] - Template including two cases and some example elements
+
 
 +
'''Please note again, that it is essential to give clear steps to reproduce your issue.'''
 +
 
 +
Additional material like videos or offering RDP access to your computer might help in some cases, but the abovementioned info is preferred, since others should also be able to reproduce the problem by their own.
 +
 
 +
=== Test cases for enhancements ===
 +
Also for test cases we want you to create a simple test case, so we are able to implement a feature/make a change as you imagine it.
 +
 
 +
So how can you provide a test case for something, that doesn't exist yet?
 +
Pretty simple: Like for bug descriptions you can create step by step instructions of how you imagine the changes.
 +
 
 +
==== Example ====
 +
You want a new option inside the [[Net Panel]], that allows you to copy the file name of a request.
 +
 
 +
<source lang="text">
 +
1. Open Firebug on this page
 +
2. Enable and switch to the Net panel
 +
3. Reload the page via F5
 +
4. Right-click the request for "Creating_a_Test_Case"
 +
  => The context menu for the request appears.
 +
5. Click the menu item "Copy file name" inside the context menu (not existing yet)
 +
 
 +
=> The file name "Creating_a_Test_Case" should be copied to the clipboard
 +
</source>
 +
 
 +
=== Templates ===
 +
To help you with creating test cases we provide some templates. You can use one of the templates below:
 +
* [http://fbug.googlecode.com/svn/tests/content/templates/default/issueXXXX.html Default HTML template] - Common template used for normal purposes
 +
* [http://fbug.googlecode.com/svn/tests/content/templates/default/issueXXXXSeveralCases.html Enhanced HTML template] - Template including two cases and some example elements
To adjust these templates please follow the steps below:
To adjust these templates please follow the steps below:
Line 20: Line 55:
# Remove all template comments
# Remove all template comments
-
There are already some examples, which you can use as reference:
+
=== Examples ===
-
* [https://getfirebug.com/tests/content/branches/1.8/css/537/issue537.html Issue 537]
+
There are already some examples, which can be used as reference:
-
* [https://getfirebug.com/tests/content/branches/1.8/css/1338/issue1338.html Issue 1338]
+
 
-
* [https://getfirebug.com/tests/content/branches/1.8/css/3652/issue3652.html Issue 3652]
+
* [https://getfirebug.com/tests/console/4504/issue4504.html Issue 4504] (Console panel related)
-
* [https://getfirebug.com/tests/content/branches/1.8/css/4180/issue4180.html Issue 4180]
+
* [https://getfirebug.com/tests/html/issue1318.html Issue 1318] (HTML panel related)
-
* [https://getfirebug.com/tests/content/branches/1.8/commandLine/4218/issue4218.html Issue 4218]
+
* [https://getfirebug.com/tests/css/4543/issue4543.html Issue 4543] (CSS panel related)
-
* [https://getfirebug.com/tests/content/branches/1.8/css/4543/issue4543.html Issue 4543]
+
* [https://getfirebug.com/tests/script/4248/issue4248.html Issue 4248] (Script panel related)
 +
* [https://getfirebug.com/tests/net/issue3071.html Issue 3071] (Net panel related)
== Automated tests ==
== Automated tests ==
-
For creation of an automated test, which will be part of the [[FBTest]] suite you need at least two parts. An HTML file and a JavaScript file, which executes the test.
+
For the creation of an automated test, which will be part of the [[FBTest]] suite you need at least two parts. An HTML file and a JavaScript file, which executes the test.
-
To create the HTML page for the automated test case please follow the steps for the [[#Manual tests|manual tests]].
+
 
 +
=== How to create ===
 +
To create the HTML page for the automated test case please follow the steps for the [[#Manual tests|manual tests]]. The only thing you do '''not''' need are observed results.
 +
 
 +
The automated (JavaScript based) test case should include the exact same steps as when manually executing the test case, i. e. instead of calling an internal Firebug function directly you should call the UI functions, that will call the internal function. So for example instead of calling the <code>editNewAttribute()</code> method for a specific node inside the [[HTML Panel]] you should programmatically open the context menu at it and choose the option "New Attribute...". [[FBTest]] already provides several [[Firebug Automated Test API|APIs]], which encapsulates such logic, like in this case the function <code>FBTest.executeContextMenuCommand()</code>.
 +
 
 +
=== Templates ===
 +
Two templates are available for automated tests:
 +
 
 +
* [http://fbug.googlecode.com/svn/tests/content/templates/net/issueXXXX.js Template for single tests] - JavaScript template for single automated tests covering an issue
 +
* [http://fbug.googlecode.com/svn/tests/content/templates/default/issueXXXXSeveralCases.js Template test suites] - JavaScript template for several automated tests covering an issue
-
The JavaScript test can be created using the [http://fbug.googlecode.com/svn/tests/content/templates/default/issueXXXX.js JavaScript template for automated tests]. Or if you want to combine several test cases in one test file, you can use the [http://fbug.googlecode.com/svn/tests/content/templates/default/issueXXXXSeveralCases.js JavaScript template for several automated tests].
 
You will have to adjust this template using the [[Firebug Automated Test API|automated test API]].
You will have to adjust this template using the [[Firebug Automated Test API|automated test API]].
 +
=== Examples ===
There are also some [[Firebug Automated Test Examples|examples]] for how to create automated tests.
There are also some [[Firebug Automated Test Examples|examples]] for how to create automated tests.
 +
 +
Also see some live examples:
 +
 +
* [https://getfirebug.com/tests/content/branches/1.9/css/537/issue537.html Issue 537]
 +
* [https://getfirebug.com/tests/content/branches/1.9/css/1338/issue1338.html Issue 1338]
 +
* [https://getfirebug.com/tests/content/branches/1.9/css/3652/issue3652.html Issue 3652]
 +
* [https://getfirebug.com/tests/content/branches/1.9/css/4180/issue4180.html Issue 4180]
 +
* [https://getfirebug.com/tests/content/branches/1.9/commandLine/4218/issue4218.html Issue 4218]
 +
* [https://getfirebug.com/tests/content/branches/1.9/css/4543/issue4543.html Issue 4543]

Revision as of 10:41, 11 October 2011

Contents

General info

We can only work on issues, that we can reproduce. Therefore it is very important to have simple test cases for the bug you're seeing or the feature you are missing in Firebug.

A test case MUST include precise step by step instructions how to reproduce it and a description of what you expect to see.

If you provide a test case file, you should also provide the following additional information:

  • The issue number
  • The issue summary
  • Observed results (in case of bugs)
  • Contact information (so we can get back to you in case of questions)

Manual tests

How to create

To create a manual test case you can either provide a publicly accessible URL or create a specific a test case file.

Please note again, that it is essential to give clear steps to reproduce your issue.

Additional material like videos or offering RDP access to your computer might help in some cases, but the abovementioned info is preferred, since others should also be able to reproduce the problem by their own.

Test cases for enhancements

Also for test cases we want you to create a simple test case, so we are able to implement a feature/make a change as you imagine it.

So how can you provide a test case for something, that doesn't exist yet? Pretty simple: Like for bug descriptions you can create step by step instructions of how you imagine the changes.

Example

You want a new option inside the Net Panel, that allows you to copy the file name of a request.

1. Open Firebug on this page
2. Enable and switch to the Net panel
3. Reload the page via F5
4. Right-click the request for "Creating_a_Test_Case"
   => The context menu for the request appears.
5. Click the menu item "Copy file name" inside the context menu (not existing yet)
 
=> The file name "Creating_a_Test_Case" should be copied to the clipboard

Templates

To help you with creating test cases we provide some templates. You can use one of the templates below:

To adjust these templates please follow the steps below:

  1. Replace "xxxx" by number of your issue
  2. Replace "Issue summary" by title of your issue
  3. Put inspectable elements, form fields etc. into the "content" section
  4. Add the exact steps to reproduce your issue under "Steps to reproduce"
  5. Describe the currently seen result under "Observed result"
  6. Describe what you would expect to see under "Expected result"
  7. Add your contact information
  8. Remove all template comments

Examples

There are already some examples, which can be used as reference:

Automated tests

For the creation of an automated test, which will be part of the FBTest suite you need at least two parts. An HTML file and a JavaScript file, which executes the test.

How to create

To create the HTML page for the automated test case please follow the steps for the manual tests. The only thing you do not need are observed results.

The automated (JavaScript based) test case should include the exact same steps as when manually executing the test case, i. e. instead of calling an internal Firebug function directly you should call the UI functions, that will call the internal function. So for example instead of calling the editNewAttribute() method for a specific node inside the HTML Panel you should programmatically open the context menu at it and choose the option "New Attribute...". FBTest already provides several APIs, which encapsulates such logic, like in this case the function FBTest.executeContextMenuCommand().

Templates

Two templates are available for automated tests:

You will have to adjust this template using the automated test API.

Examples

There are also some examples for how to create automated tests.

Also see some live examples:

Personal tools