source: peerreviewplugin/trunk/codereview/tracgenericclass/README.txt

Last change on this file was 15270, checked in by Cinc-th, 8 years ago
  • Generic classes for workflow support added. Taken from TestManagerForTracPlugin with minor changes.
  • Upgrade of database schema
  • Property svn:eol-style set to native
  • Property svn:keywords set to Revision Id
File size: 3.9 KB
Line 
1Check the tutorial on YouTube: http://www.youtube.com/watch?v=BIi3QMT0rT4
2
3Test Manager plugin for Trac
4
5Copyright (C) 2010-2015 Roberto Longobardi
6 
7This file is part of the Test Manager plugin for Trac.
8 
9This software is licensed as described in the file COPYING, which
10you should have received as part of this distribution. The terms
11are also available at:
12
13https://trac-hacks.org/wiki/TestManagerForTracPluginLicense
14
15Author: Roberto Longobardi <otrebor.dev@gmail.com>
16
17
18Project web page on TracHacks: http://trac-hacks.org/wiki/TestManagerForTracPlugin
19 
20Project web page on SourceForge.net: http://sourceforge.net/projects/testman4trac/
21 
22Project web page on Pypi: http://pypi.python.org/pypi/TestManager
23
24 
25A Trac plugin to create Test Cases, organize them in catalogs, generate test plans and track their execution status and outcome.
26
27This module provides a framework to help creating classes on Trac that:
28 * Are persisted on the DB
29 * Support change history
30 * Support extensibility through custom properties that the User can specify declaratively in the trac.ini file
31 * Support custom operations to be performed before and after the standard object lifecycle events.
32 * Listener interface for Components willing to be notified on any object lifecycle event (i.e. creation, modification, deletion).
33
34Database tables are also automatically created by the framework as declaratively stated by the client Components.
35 
36Also provides an intermediate class to build objects that wrap Wiki pages and have additional properties.
37
38
39More details:
40
41A generic object framework supporting programmatic and declarative definition of its standard fields, declarative definition of custom fields (in trac.ini) and keeping track of change history has been created, by generalizing the base Ticket code.
42
43The specific object "type" is specified during construction as the "realm" parameter.
44This name must also correspond to the database table storing the corresponding objects, and is used as the base name for the custom fields table and the change tracking table (see below).
45
46Features:
47    * Support for custom fields, specified in the trac.ini file
48      with the same syntax as for custom Ticket fields. Custom
49      fields are kept in a "<schema>_custom" table
50    * Keeping track of all changes to any field, into a separate
51      "<schema>_change" table
52    * A set of callbacks to allow for subclasses to control and
53      perform actions pre and post any operation pertaining the
54      object's lifecycle
55    * Registering listeners, via the ITestObjectChangeListener
56      interface, for object creation, modification and deletion.
57    * Searching objects by similarity, i.e. matching any set of
58      valorized fields (even non-key fields), applying the
59      "dynamic record" pattern.
60      See the method list_matching_objects.
61    * Integration with the Trac Search page.
62    * Integration with the Trac Resource API.
63    * Support for declarative specification of the database
64      backing a particular class. The tables are created
65      automatically.
66    * Fine-grained security access control to any operation on
67      any resource type or instance.
68
69================================================================================================= 
70Change History:
71
72(Refer to the tickets on trac-hacks for complete descriptions.)
73
74Release 1.1.5 (2012-10-14):
75  This release makes the plugins compatible with Trac 1.0.
76  o Fixed Ticket #10293 (Track-Hacks): New install impossible on Trac 1.0beta1
77
78Release 1.1.3 (2012-06-03):
79  o Fixed Ticket #9953 (Track-Hacks): Changing a testcase custom field value gives and error
80
81Release 1.0.7 (2011-08-28):
82  o Enhanced upgrade process
83
84Release 1.0.6 (2011-06-19):
85  o Fixed Ticket #8871 (Track-Hacks): No # allowed at custom fields
86
87Release 1.0.4 (2011-01-17):
88  o Added support for LIKE match in list_matching_objects.
89
90Release 1.0.0 (2010-10-01):
91  o First release publicly available apart from the core Test Manager plugin
92 
Note: See TracBrowser for help on using the repository browser.