| 7 | | A Trac plugin to create Test Cases, organize them in Catalogs, generate Test Plans and track their execution status and outcome. |
| 8 | | |
| 9 | | Differently from other test management plugins for Trac that use Tickets as test case holders, this one uses Wiki pages and an additional proprietary data model to store Test Cases. |
| 10 | | This allows you to not pollute your ticket lists with something that is not a ticket, and at the same time is powered by the Trac search engine and formatting syntax for Wiki pages. |
| 11 | | |
| 12 | | A set of plugins intercept requests for Wiki pages that are test cases and decorate the page with title, breadcrumbs, tree view, type-ahead search inside the catalogs, test case status semaphore and icons and buttons that allow you to create new test cases, sub-catalogs, copy and paste test cases around different catalogs and change a test case status. |
| 13 | | |
| 14 | | Multiple Test Plans can be associated to any Test Catalog, in order to keep track of the execution of the corresponding Test Cases in a particular testing context. |
| 15 | | |
| 16 | | All of the test objects, i.e. catalogs, test cases, test plans and test cases in a plan (i.e. with a status and a status change history), support: |
| 17 | | * '''Custom properties''', which can be declared in the trac.ini file and will be available to the User for change, stored in the database and available to change listeners. |
| 18 | | * Change history |
| 19 | | * Listener interface to be notified of object creatio, modification and deletion |
| 20 | | * '''Customizable Workflow''' state machine, declared in the trac.ini file, with the same syntax as for Ticket workflows (I may have reused some existing code here :-) |
| 21 | | * '''Customizable Workflow Operations''', via a plugin api so that any component can provide its custom operations to be performed upon any workflow action, as defined in the trac.ini file. |
| 22 | | * Workflow also supports a listener API for components interested in state transitions and actions performed |
| 23 | | * Workflow states also support custom properties, so to be able to convey additional context information on a workflow state and use it in listeners or directly from the database. |
| 24 | | |
| 25 | | The developed workflow engine is able to work on any Trac Resource, it is not confined to this plugin ones. You can then define a workflow on any Trac resource, including Wiki pages, declaratively in the trac.ini file. |
| 26 | | You will then add a handful of custom code (for example in an ITemplateStreamFilter) to add the markup that the workflow engine generates for you to your desired Trac web page. |
| 27 | | See the enhancement tickets documentation or the README.txt file contained in the egg (if you don't wish to browse the code) for further details. |
| 28 | | |
| 29 | | The '''programmatic''' and the '''RESTful API''' are documented in details in this page TestManagerForTracPluginApi. |
| 30 | | |
| 31 | | Here follows an overview of the plugin functionalities. For a full tutorial, refer to the powerpoint presentations attached below (the ones with shorter names work). |
| 32 | | |
| 33 | | [[BR]] |
| 34 | | [[BR]] |
| 35 | | == Test Catalogs == |
| 36 | | Test catalogs contain sub-catalogs or Test Cases. A Javascript tree view displays a catalog node and its sub-tree, including all of the test cases contained. |
| 37 | | |
| 38 | | Next to each catalog (or sub-catalog) a number in brackets shows the number of test cases it contains. |
| 39 | | |
| 40 | | Notice at the top of the page breadcrumbs to easily navigate up in the catalogs tree. |
| 41 | | |
| 42 | | You can add sub-catalogs or Test Cases simply by entering a name (blanks and case is supported) and click the appropriate button. A new wiki page is generated, with a naming convention allowing the plugin code to position it correctly in the catalogs tree, and opened for editing. |
| 43 | | Be careful that the first line will always be taken as the title of the catalog (the same stands for test cases, read below). |
| 44 | | |
| 45 | | Just save the new page ("Submit Changes") and you'll have your new (sub-)catalog in place. |
| 46 | | |
| 47 | | [[BR]] |
| 48 | | [[BR]] |
| 49 | | [[Image(screen2.JPG)]] |
| 50 | | [[BR]] |
| 51 | | [[BR]] |
| 52 | | == Test Cases == |
| 53 | | Test Cases are the smallest units of test execution. |
| 54 | | |
| 55 | | They are implemented again as wiki pages, with a naming convention that allows the plugin code to recognize them and treat them appropriately. |
| 56 | | |
| 57 | | Again, notice the breadcrumbs at the top, useful to go back to the enclosing catalog or any catalog up the hierarchy. |
| 58 | | |
| 59 | | [[BR]] |
| 60 | | [[BR]] |
| 61 | | [[Image(screen3.JPG)]] |
| 62 | | [[BR]] |
| 63 | | [[BR]] |
| 64 | | == Moving Test Cases from one catalog to another == |
| 65 | | |
| 66 | | It is also possible to move a Test Case into a different catalog, with an experience similar to cut&paste. |
| 67 | | |
| 68 | | You first open a test case and click on the "Move the Test Case into another catalog" button. This is similar to a "cut" operation. |
| 69 | | |
| 70 | | You then navigate and open the destination catalog and click on "Move the copied Test Case here" button (which only appears if a Test Case has been cut first). |
| 71 | | |
| 72 | | It is also possible to cancel the operation at any time by clicking the "Cancel" button in a Gmail-type of yellow message at the top of the page. |
| 73 | | |
| 74 | | [[BR]] |
| 75 | | [[BR]] |
| 76 | | [[Image(screen6.JPG)]] |
| 77 | | [[BR]] |
| 78 | | [[BR]] |
| 79 | | == Test Plans == |
| 80 | | '''Since: 1.1.0''' |
| 81 | | |
| 82 | | A Test Plan represents a plan for a particular execution of all the Test Cases in a Test Catalog (or sub-catalog). |
| 83 | | |
| 84 | | Think for example at the build verification test following a nightly build, or, for traditional projects, Technical Test and eventually Client Test. |
| 85 | | |
| 86 | | Thus a Test Plan is associated to one Test Catalog, or sub-catalog. You can have any number of Test Plans for one Test Catalog, anyway. |
| 87 | | The list of Test Plans you generated for a Test Catalog is displayd in a table at the bottom of the same catalog, as shown in the following figure. |
| 88 | | |
| 89 | | [[BR]] |
| 90 | | [[BR]] |
| 91 | | [[Image(screen9.JPG)]] |
| 92 | | [[BR]] |
| 93 | | [[BR]] |
| 94 | | |
| 95 | | To create a Test Plan for a catalog, open the desired Test Catalog (or sub-catalog), enter the name of the new Test Plan in the appropriate test box and click "Generate a new Test Plan". |
| 96 | | |
| 97 | | The new Test Plan will be opened for display, showing all of the Test Cases in the catalog, in the "Untested" status, as shown in the figure below. |
| 98 | | |
| 99 | | [[BR]] |
| 100 | | [[BR]] |
| 101 | | [[Image(screen7.JPG)]] |
| 102 | | [[BR]] |
| 103 | | [[BR]] |
| 104 | | |
| 105 | | To track the execution status of a Test Case in a particular Test Plan, open it by clicking on the Test Case name from the Test Plan tree. |
| 106 | | Then simply click on the corresponding light in the semaphore at the bottom of the page, as shown in the following figure. |
| 107 | | |
| 108 | | You don't need to save anything, the change is immediately recorded in the database by means of an Ajax call (this API will be documented asap, to allow for setting test case execution status from external applications). |
| 109 | | |
| 110 | | The change is immediately reflected in the Test Plan. |
| 111 | | |
| 112 | | [[BR]] |
| 113 | | [[BR]] |
| 114 | | [[Image(screen8.JPG)]] |
| 115 | | [[BR]] |
| 116 | | [[BR]] |
| 117 | | |
| 118 | | When viewing a Test Case, you can open a new Ticket by means of the "Open Ticket on this Test Case" button. |
| 119 | | |
| 120 | | The new ticket will contain a link back to the corresponding Test Case and, if you were viewing it in the context of a particular Test Plan, of the Test Plan as well. |
| 121 | | |
| 122 | | This plugin also supports the TracTicketTemplatePlugin to fill a ticket template with this information. In this case, you can use the following parameters in the template to receive the information: |
| 123 | | |
| 124 | | * testCaseNumber: The wiki page for the corresponding Test Case |
| 125 | | * planId: The ID of the Test Plan |
| 126 | | * planName: The name of the Test Plan |
| 127 | | |
| 128 | | For example, to get the test case number, you template will have something like: |
| 205 | | Charting capabilities allow for tracking the evolution of the test suites and the corresponding test plans. |
| 206 | | |
| 207 | | To access the test management statistics, click on '''Test Stats''' in the Trac toolbar on the upper right corner of the page. |
| 208 | | |
| 209 | | As shown in the next figure, a chart will be displayed with statistics about all the test cases in the system and a default period of time. |
| 210 | | |
| 211 | | By means of the filtering criteria at the bottom of the chart, you can select the desired period of time, the chart resolution (in terms of time between different samples) and the Test Plan for your chart. |
| 212 | | |
| 213 | | You can bookmark the URL named "Static URL" at the bottom of the page in order to go directly with the current selected filtering criteria. |
| 214 | | |
| 215 | | '''Note:''' You will need internet connection to be able to display this charts, since it leverages Yahoo remote charting services. |
| 216 | | |
| 217 | | [[BR]] |
| 218 | | [[BR]] |
| 219 | | [[Image(screen10.png)]] |
| 220 | | [[BR]][[BR]] |
| 221 | | == Security == |
| 222 | | |
| 223 | | The following new permissions are available to manage the Test Manager security: |
| 224 | | |
| 225 | | * TEST_VIEW - Ability to view test catalogs and test cases |
| 226 | | * TEST_MODIFY - Ability to create and edit test catalogs and test cases |
| 227 | | * TEST_EXECUTE - Ability to change the status of a test case in a test plan |
| 228 | | * TEST_DELETE - Ability to delete test cases |
| 229 | | * TEST_PLAN_ADMIN - Ability to generate and delete test plans |
| 230 | | * TEST_STATS_VIEW - Ability to view test management statistics |
| 231 | | |
| 232 | | [[BR]][[BR]] |
| 233 | | == Programmatic API == |
| 234 | | |
| 235 | | The '''programmatic RESTful API''' is documented in details in this page TestManagerForTracPluginApi. |
| | 53 | {{{ |
| | 54 | <yourserver/yourproject>/wiki/TC_TT0_TT1_TC0 |
| | 55 | }}} |
| 292 | | '''Author:''' [wiki:seccanj] [[BR]] |
| 293 | | '''Maintainer:''' [wiki:seccanj] [[BR]] |
| 294 | | '''Contributors:''' |
| | 100 | == Change a [custom] property of any test object == |
| | 101 | |
| | 102 | Any property, either standard or custom, of any test object can be set programmatically through the RESTful API. |
| | 103 | |
| | 104 | A test object is identified by its realm (i.e. type) and its key (i.e. in most cases the ID, for test cases in the context of a plan, also the plan ID is required). |
| | 105 | |
| | 106 | The realms that identify the test objects are the following: |
| | 107 | |
| | 108 | Test Catalog: testcatalog |
| | 109 | Test Case: testcase |
| | 110 | Test Case in the context of a plan (i.e. with a status): testcaseinplan |
| | 111 | Test Plan: testplan |
| | 112 | The realm must be provided to the property update service through the "realm" parameter. |
| | 113 | |
| | 114 | The corresponding key properties, needed to identify any particular object, are: |
| | 115 | |
| | 116 | Test Catalog: id |
| | 117 | Test Case: id |
| | 118 | Test Case in the context of a plan (i.e. with a status): id, planid |
| | 119 | Test Plan: id |
| | 120 | The key properties are provided to the property update service through the "key" parameter, in the form of a dictionary. |
| | 121 | |
| | 122 | The next things to pass to the service are the name of the property to modify and the new value. Guess what... you use the "name" and "value" parameters, respectively. |
| | 123 | |
| | 124 | For example, to change a Test Case - with ID 5 - custom property "platform" (which has been previously added to the test case type in the trac.ini file) to the new value "Windows", this is the URL to GET: |
| | 125 | |
| | 126 | {{{{ |
| | 127 | <yourserver/yourproject>/testpropertyupdate?realm=testcase&key={'id':'5'}&name=platform&value=Windows |
| | 128 | }}} |
| | 129 | |
| | 130 | == Traceability between Test Cases and Tickets == |
| | 131 | |
| | 132 | You can open a Ticket and have a traceback to the (e.g. failed) Test Case as follows. |
| | 133 | |
| | 134 | |
| | 135 | === Open a Ticket on a Test Case === |
| | 136 | |
| | 137 | Whether you deploy TracTicketTemplatePlugin or not, you can get the following URL, where testCaseNumber is the Test Case complete path, planid is the Test Plan ID and planName is its name: |
| | 138 | |
| | 139 | {{{ |
| | 140 | <yourserver/yourproject>/newticket?testCaseNumber=TC_TT0_TC0&planId=1&planName=Test%20Plan%20for%2020100818&description=Test%20Case:%20[wiki:TC_TT0_TC0],%20Test%20Plan:%20Test%20Plan%20for%2020100818%20(1) |
| | 141 | }}} |
| | 142 | |
| | 143 | this will redirect to a Ticket edit page, with the Test Case in Test Plan hyperlink in the description (as Wiki page references). You can simply post the form to create the Ticket. |
