Testplan Plugins

Description/Features

These plugins allow the user to write and maintain testplans within Confluence.
There are two macros:

1. testplan
2. testplansummary

The first plugin is the Testplan Plugin.

Any good Quality Assurance organization needs to write and maintain testplans as part of their daily tasks. I was finding that the tasklist Macro was inadequate, since it only held two states, and most testplans need three (pass, fail and not run). Additionally, I found it helpful to have testplans actually link to the bug numbers if a step fails. Rather than editing the source of the page and maintaining a table of steps and status, we needed something that was easier to maintain.

What I've done is, using the tasklist as reference, implemented a sort of super tasklist. Similar to the tasklist, you put each step of the testplan on seperate lines, and the macro will render a testplan. Each step will have a state, a description of the step, and 3 links to mark that step as passed, failed, or not run (reset). Clicking that link will flag the step appropriately. Furthermore, if you flag a step as failed, the testplan will prompt you for a comma-seperated list of Jira Numbers, and will construct links to the Jiras for you. Finally, a list of all Jira in this plan is given to the JiraIssues Macro, which will call the multi-issue key searcher to display a table of the currently tracked Jiras. The features to link to Jira are optional, and can be turned off using Macro Parameters.

The second plugin is the Testplan Summary Plugin

This plugin takes advantage of the Metadata Plugin to store status in the page metadata. You can then use the macros in that plugin to collate information on your testplans. As of Version 1.1, a supporting JAR containing the Metadata plugin is included, taking advantage of the ability in Confluence 2.2 to load supporting files from with the plugin jar. No further downloads are necessary.

Usage

testplan macro

This Macro allows you to write an easily maintained testplan. Each step should be placed on its own line. If you want to add a header to give a subsection of a testplan, use the ^ character at the front of the line. If you want to add a comment that isn't part of the plan, add // to the front.

For example:

{testplan:My Testplan}
^Header
//Comment
Step 1
Step 2
Step 3
Step 4
{testplan}

will render as:

Clicking the Pass/Fail/Reset link will take the appropriate action. If you click the fail link, you are prompted for a comma seperated list of bug numbers (or a single number). For example, if I click Pass for Step 1, fail for Step 2 and enter in 1, and fail step 2, entering 4,5 I get the following:

Clicking Reset All will only reset those steps that passed; I found it easier to preserve the failure Jira links when I rerun the tests; I can always click reset on an individual step to clear the status.

The full list of options available to the testplan macro are:

Optional User Macros

To take full advantage of the features of the testplan Macro, you should define the following Macros:

Macro	Description	Sample
pass	Denotes a step has passed. If none is defined, is used	<img align="absmiddle" src="/images/icons/emoticons/check.gif" alt="Pass" title="Pass"/>
notrun	Denotes a step has not run. If none is defined, is used	<img align="absmiddle" src="/images/icons/emoticons/warning.gif" alt="Not Run" title="Not Run"/>
jiraurl	Required for includeJiraLinks and useFailMacro options. Base URL for your Jira System. Is overridden by the option jiraUrl on the testplan itself.	http://bugs:8080
jirakey	Required for includeJiraLinks and useFailMacro options. Used to define a systemwide Jira Project key, useful if you only have one project. Is overriden by the jiraKey option on the testplan macro. Leaving both this and the testplan option null allows the user to enter multiple projects in one testplan. This option replaces jiraissueskey.	JRA
jiraissuesurl	Required for includeJiraLinks option. Specifies the base URL to use for the jiraissues link. Note that you MUST have the Multi-Issue Key Searcher Custom Field installed in your Jira system. Also note that you need to know the ID of the field (Go to the Custom Fields section of the Admin console in Jira and hover your mouse over the options for the Field to see the ID). Is overriden by the testplan option jiraIssuesUrl	http://bugs:8080/secure/IssueNavigator.jspa?decorator=none&view=rss&reset=true&mode=show&customfield_10054=

This macro is simpler:

The following options can be set on the testplansummary macro:

In addition, the following User Macros can be optionally defined:

If you dont's define the options, the emoticons , and are used.

Now, when you place the the page as such:

{testplansummary}

You'll get something like this:

3/14/06 1:08 PM by Brian Sensale

Flag Testplan as Pass Fail Not Run In Progress

Clicking the links will both flag the testplan, and set metadata for the user, status and date so the metadata query plugins can access the data.

An example metadata-report that uses the content-by-label query feature gives the following summary of testing status:

Examples

Create a testplan named My Testplan with the default values:

{testplan:My Testplan}
^Header
//Comment
Step 1
Step 2
Step 3
Step 4
{testplan}

Create a testplan named My Other Testplan, but don't create the Jiraissues link:

{testplan:My Other Testplan|includeJiraLinks=false}
^Header
//Comment
Step 1
Step 2
Step 3
Step 4
{testplan}

Create a testplan named Yet Another Testplan, don't use the fail macro:

{testplan:My Testplan|useFailMacro=no}
^Header
//Comment
Step 1
Step 2
Step 3
Step 4
{testplan}

Create a testplan named Still Another Testplan and suppress the header for the Jira Issues section:

{testplan:My Testplan|headerLevel=0}
^Header
//Comment
Step 1
Step 2
Step 3
Step 4
{testplan}

Create a testplan, restricting access to the qa group:

{testplan:My Testplan|restrictTo=qa}
^Header
//Comment
Step 1
Step 2
Step 3
Step 4
{testplan}

Create a testplan that uses a specific Jira project:

{testplan:My Testplan|jiraKey=CON}
^Header
//Comment
Step 1
Step 2
Step 3
Step 4
{testplan}

What we've done to make everything easier is to define a Global Template of type QA Testplan. When the user writes a new testplan, they choose this template for their page, and are prompted for the name of the testplan. They are then automatically given this Wiki Markup:

{testplansummary}
{testplan:Name Entered By User}
{testplan}

Version History

Screenshots

Screenshots
		Error Loading plugin on 2.3.2