view doc/implementation.txt @ 7906:470616e64414

issue2551334 - get test suite running under windows Fix test_cgi under windows. Few classes of errors: 1) comparing paths with a/b (unix) to a\b (windows). Use normpath to fix it. Also change regexps used for path matching to use either \ or / for directory separators. 2) database not being closed preventing deletion of test case directory. Windows doesn't allow deletion of open files. In some cases replaced calling client.inner_mail() with main() because main() makes sure to close the database. In other cases assigned self.db = client.db beacuse client reopens the database and closes the original self.db. Reassigning allows tearDown to close the last opened handle to a db. 3) commit the admin password to the database. If it's not commited calling the code sometimes comes up with a different admin password. Not sure why we don't see this on linux. 4) run commit() on database so that sqlite databases can be closed and deleted. Unit tests don't call the main entry points that have finally clauses to close the databases properly, so do it in the test. 5) split tests that try to resolve symbolic links in the template directory to a separate method. Under windows user needs special permissions to creae symbolic links, so I report the method is skipped if creating a link fails.
author John Rouillard <rouilj@ieee.org>
date Sat, 27 Apr 2024 23:19:51 -0400
parents 81a634b7226e
children
line wrap: on
line source

.. meta::
    :description:
        Additional implementation notes for the Roundup Issue Tracker.
        Supplement for docstrings in the Roundup package.

====================
Implementation notes
====================

[see also the roundup package docstring]

There have been some modifications to the spec. I've marked these in the
source with 'XXX' comments when I remember to.

In short:
 Class.find() - may match multiple properties, uses keyword args.

 Class.filter() - isn't in the spec and it's very useful to have at the
    Class level.

 CGI interface index view specifier layout part - lose the '+' from the
    sorting arguments (it's a reserved URL character ;). Just made no
    prefix mean ascending and '-' prefix descending.

 ItemClass - renamed to IssueClass to better match it only having one
    hypderdb class "issue". Allowing > 1 hyperdb class breaks the
    "superseder" multilink (since it can only link to one thing, and
    we'd want bugs to link to support and vice-versa).

 template - the call="link()" is handled by special-case mechanisms in
    my top-level CGI handler. In a nutshell, the handler looks for a
    method on itself called 'index%s' or 'item%s' where %s is a class.
    Most items pass on to the templating mechanism, but the file class
    _always_ does downloading. It'll probably stay this way too...

 template - call="link(property)" may be used to link "the current item"
    (from an index) - the link text is the property specified.

 template - added functions that I found very useful: List, History and
    Submit.

 template - items must specify the message lists, history, etc. Having
    them by default was sometimes not wanted.

 template - index view determines its default columns from the
    template's ``tal:condition="request/show/<property>"`` directives.

 template - menu() and field() look awfully similar now .... ;)

 roundup_admin.py - the command-line tool has a lot more commands at its
    disposal

-----------------

Back to `Table of Contents`_

.. _`Table of Contents`: ../docs.html


Roundup Issue Tracker: http://roundup-tracker.org/