Changes between Version 5 and Version 6 of TestManagerForTracPluginApi

Sep 23, 2010, 3:05:21 PM (8 years ago)
Roberto Longobardi



  • TestManagerForTracPluginApi

    v5 v6  
    1 [[PageOutline(2-5,Contents,pullout)]]
     1Test Manager for Trac Plugin - Public API
     2The TestManagerForTracPlugin plugin can be used programmatically to create, edit Test Catalogs, Test Cases and Test Plans, and to set the test execution verdicts of Test Cases in a plan.
    3 = Test Manager plugin for Trac =
     4In the following, because of the spam filter not allowing more than a few URLs in a page, I have replaced:
    5 == Description ==
    7 A Trac plugin to create Test Cases, organize them in Catalogs, generate Test Plans and track their execution status and outcome.
    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.
    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.
    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.
    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.
    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.
    29 The '''programmatic''' and the '''RESTful API''' are documented in details in this page TestManagerForTracPluginApi.
    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).
    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.
    38 Next to each catalog (or sub-catalog) a number in brackets shows the number of test cases it contains.
    40 Notice at the top of the page breadcrumbs to easily navigate up in the catalogs tree.
    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).
    45 Just save the new page ("Submit Changes") and you'll have your new (sub-)catalog in place.
    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.
    55 They are implemented again as wiki pages, with a naming convention that allows the plugin code to recognize them and treat them appropriately.
    57 Again, notice the breadcrumbs at the top, useful to go back to the enclosing catalog or any catalog up the hierarchy.
    59 [[BR]]
    60 [[BR]]
    61 [[Image(screen3.JPG)]]
    62 [[BR]]
    63 [[BR]]
    64 == Moving Test Cases from one catalog to another ==
    66 It is also possible to move a Test Case into a different catalog, with an experience similar to cut&paste.
    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.
    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).
    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.
    74 [[BR]]
    75 [[BR]]
    76 [[Image(screen6.JPG)]]
    77 [[BR]]
    78 [[BR]]
    79 == Test Plans ==
    80 '''Since: 1.1.0'''
    82 A Test Plan represents a plan for a particular execution of all the Test Cases in a Test Catalog (or sub-catalog).
    84 Think for example at the build verification test following a nightly build, or, for traditional projects, Technical Test and eventually Client Test.
    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.
    89 [[BR]]
    90 [[BR]]
    91 [[Image(screen9.JPG)]]
    92 [[BR]]
    93 [[BR]]
    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".
    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.
    99 [[BR]]
    100 [[BR]]
    101 [[Image(screen7.JPG)]]
    102 [[BR]]
    103 [[BR]]
    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.
    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).
    110 The change is immediately reflected in the Test Plan.
    112 [[BR]]
    113 [[BR]]
    114 [[Image(screen8.JPG)]]
    115 [[BR]]
    116 [[BR]]
    118 When viewing a Test Case, you can open a new Ticket by means of the "Open Ticket on this Test Case" button.
    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.
    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:
    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
    128 For example, to get the test case number, you template will have something like:
    130   bleah bleah
    131   Test Case: %(testCaseNumber)s
    132   bleah bleah
    135 == Custom fields ==
    136 '''Since: 1.2.0'''
     15== Working with Test Catalogs and Test Cases ==
    138 Custom fields can be added to the four test objects and to the workflow state object, by declaring them in the trac.ini file.
    139 See the README.txt file for how to recreate this example.
    140 The following screenshot shows a custom "platform" field added to the Test Case object, and how it is presented to the User for editing.
     17You can create test catalogs and cases programmatically by means of the following http requests.
    142 [[BR]]
    143 [[BR]]
    144 [[Image(screen11.png)]]
    145 [[BR]]
    146 [[BR]]
    147 [[BR]]
    149 == Customizable Workflow ==
    150 '''Since: 1.2.0'''
     20=== Create a root test catalog ===
    152 The following figure shows a sample workflow added to Test Cases with custom sample operations.
    153 No built-in operation is currently implemented but the sample one shown here, named 'sample_operation', which logs a debug message with the text input by the User.
    155 Every object which has a workflow defined is created in a "new" state, so every transition should consider this as the first state in the state machine.
     22Get the following URL:
     26this will assign a unique ID (the number 0 in the URL below) to the new catalog, create the corresponding Wiki page and redirect to it. You may discard the response if you don't need to know the catalog ID (last number in the URL):
    158 sleep = new -> asleep
    159 sleep.permissions = TEST_MODIFY
    161 sing = new -> singing
    162 sing.permissions = TEST_MODIFY
    163 sing.operations = sample_operation
    165 calmdown = new -> calm
    166 calmdown.permissions = TEST_MODIFY
    167 calmdown.operations = sample_operation
    169 kill = asleep,calm -> dead
    170 kill.permissions = TICKET_MODIFY
    173 See the README.txt file for more details.
     32=== Create a sub-catalog ===
    175 [[BR]]
    176 [[BR]]
    177 [[Image(screen12.png)]]
    178 [[BR]]
    179 [[BR]]
    180 [[BR]]
     34Get the wollowing URL, where "path" is the name of the parent catalog.
    182 == Searching and filtering Test Cases in the tree view ==
    183 A type-ahead, browser-side filtering feature allows for easily locating Test Cases matching a particular naming convention in the title, and/or a particular execution status.
     37this will assign a unique ID (the number 1 in the URL below) to the new catalog, create the corresponding Wiki page and redirect to it. You may discard the response if you don't need to know the catalog ID (last number in the URL):
    185 This is available both in the context of a Test Catalog and in Test Plans.
    187 Multiple words (or parts of) separated by blanks are supported, in AND condition.
     43=== Create a Test Case ===
    189 In the case of a Test Plan, you can also add a test case status to filter by this criterion.
    190 The supported statuses are (even substrings of):
    191  * untested
    192  * successful
    193  * failed
     45Get the following URL, where "path" is the name of the parent (sub-)catalog.
    195 [[BR]]
    196 [[BR]]
    197 [[Image(screen4.JPG)]]
    198 [[BR]]
    199 [[BR]]
    200 [[BR]]
    202 == Test Management and Execution Statistics ==
    203 '''Since: 1.1.1'''
     51this will assign a unique ID (the number 0 in the URL below) to the new test case, create the corresponding Wiki page and redirect to it. You may discard the response if you don't need to know the test case ID (last number in the URL):
    205 Charting capabilities allow for tracking the evolution of the test suites and the corresponding test plans.
    207 To access the test management statistics, click on '''Test Stats''' in the Trac toolbar on the upper right corner of the page.
    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.
    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.
    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.
    215 '''Note:''' You will need internet connection to be able to display this charts, since it leverages Yahoo remote charting services.
    217 [[BR]]
    218 [[BR]]
    219 [[Image(screen10.png)]]
    220 [[BR]][[BR]]
    221 == Security ==
    223 The following new permissions are available to manage the Test Manager security:
    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
    232 [[BR]][[BR]]
    233 == Programmatic API ==
    235 The '''programmatic RESTful API''' is documented in details in this page TestManagerForTracPluginApi.
    238 [[BR]][[BR]]
    239 == Tutorial (as powerpoint presentation) ==
    240 '''TODO:''' These tutorials document release 1.0.3 and so need to be updated with the Test Plan and other recent features.
     58== Working with Test Plans and setting the status of a Test Case ==
    242  * attachment:"UserGuide_part_1.ppt"
    243  * attachment:"UserGuide_part_2.ppt"
    244  * attachment:"UserGuide_part_3.ppt"
     60You can also create a new Test Plan (e.g. for each nightly build) programmatically as follows.
    246 [[BR]][[BR]]
    247 == Project site ==
    248 Project site:
    250 The project is also on Pypi:
     63=== Create a Test Plan from a specific catalog ===
    252 [[BR]][[BR]]
    253 == Bugs/Feature Requests ==
     65Get the following URL, where "path" is the name of the (sub-)catalog to create the test plan against.
    255 If you have any issues, create a
    256 [ new ticket].
    258 Existing bugs and feature requests for TestManagerForTracPlugin are
    259 [report:9?COMPONENT=TestManagerForTracPlugin here].
     71this will assign a unique ID (the number 1 in the URL below) to the new test plan and redirect to displaying the Test Plan: You may discard the response if you don't need to know the plan ID (planid parameter in the URL):
    261 [[TicketQuery(component=TestManagerForTracPlugin,format=table,col=summary|status|severity|priority|milestone|type|owner|time|description)]]
    263 [[BR]][[BR]]
    264 == Download ==
     77The Test Plan will contain all of the test cases in the specified catalog, with a status of "Untested".
    266 Download the egg files, ready to be installed, from the project site [ here].
     79Note: As you can notice, you can always pass from a test catalog to one of its test plans by adding the "planid=<plan id>" parameter to the test catalog URL. The same also stands for test cases. You can pass to a test case in a particular plan by adding the planid parameter to its URL.
    268 [[BR]][[BR]]
    269 == Source ==
    271 You can download the source code from [ here].
    273 [[BR]][[BR]]
    274 == Example ==
     83=== Set a Test Case execution verdict, in the context of a Test Plan ===
    276 The plugin can be installed as usual, from the Trac administration panel, and requires a database upgrade.
     85Then, you can set the verdict for any test case in the plan, by means of the following.
    278 I had to drop support for Trac 0.11, couldn't afford to keep both releases compatibility with a complete rewrite to do.
    279 At the moment it has been tested only on Trac 0.12 with Python 2.6.
     87Get the following URL, where "id" is the Test Case ID and planid is the Test Plan ID:
    281 Follow the tutorial presentation that you can download from the project site to start.
    282 The tutorial needs to be updated to the new Test Plan feature.
    284 [[BR]][[BR]]
    285 == Recent Changes ==
     93The supported statuses are currently:
    287 [[ChangeLog(testmanagerfortracplugin, 3)]]
     95 * TO_BE_TESTED
     96 * SUCCESSFUL
     97 * FAILED
    289 [[BR]][[BR]]
    290 == Author/Contributors ==
    292 '''Author:''' [wiki:seccanj] [[BR]]
    293 '''Maintainer:''' [wiki:seccanj] [[BR]]
    294 '''Contributors:'''
     100== Change a [custom] property of any test object ==
     102Any property, either standard or custom, of any test object can be set programmatically through the RESTful API.
     104A 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).
     106The realms that identify the test objects are the following:
     108Test Catalog: testcatalog
     109Test Case: testcase
     110Test Case in the context of a plan (i.e. with a status): testcaseinplan
     111Test Plan: testplan
     112The realm must be provided to the property update service through the "realm" parameter.
     114The corresponding key properties, needed to identify any particular object, are:
     116Test Catalog: id
     117Test Case: id
     118Test Case in the context of a plan (i.e. with a status): id, planid
     119Test Plan: id
     120The key properties are provided to the property update service through the "key" parameter, in the form of a dictionary.
     122The 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.
     124For 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:
     130== Traceability between Test Cases and Tickets ==
     132You can open a Ticket and have a traceback to the (e.g. failed) Test Case as follows.
     135=== Open a Ticket on a Test Case ===
     137Whether 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:
     143this 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.