annotate doc/glossary.txt @ 6915:9ff091537f43

postgresql native-fts; more indexer tests 1) Make postgresql native-fts actually work. 2) Add simple stopword filtering to sqlite native-fts indexer. 3) Add more tests for indexer_common get_indexer Details: 1) roundup/backends/indexer_postgresql_fts.py: ignore ValueError raised if we try to index a string with a null character in it. This could happen due to an incorrect text/ mime type on a file that has nulls in it. Replace ValueError raised by postgresql with customized IndexerQueryError if a search string has a null in it. roundup/backends/rdbms_common.py: Make postgresql native-fts work. When specified it was using using whatever was returned from get_indexer(). However loading the native-fts indexer backend failed because there was no connection to the postgresql database when this call was made. Simple solution, move the call after the open_connection call in Database::__init__(). However the open_connection call creates the schema for the database if it is not there. The schema builds tables for indexer=native type indexing. As part of the build it looks at the indexer to see the min/max size of the indexed tokens. No indexer define, we get a crash. So it's a a chicken/egg issue. I solved it by setting the indexer to the Indexer from indexer_common which has the min/max token size info. I also added a no-op save_indexer to this Indexer class. I claim save_indexer() isn't needed as a commit() on the db does all the saving required. Then after open_connection is called, I call get_indexer to retrieve the correct indexer and indexer_postgresql_fts woks since the conn connection property is defined. roundup/backends/indexer_common.py: add save_index() method for indexer. It does nothing but is needed in rdbms backends during schema initialization. 2) roundup/backends/indexer_sqlite_fts.py: when this indexer is used, the indexer test in DBTest on the word "the" fail. This is due to missing stopword filtering. Implement basic stopword filtering for bare stopwords (like 'the') to make the test pass. Note: this indexer is not currently automatically run by the CI suite, it was found during manual testing. However there is a FIXME to extract the indexer tests from DBTest and run it using this backend. roundup/configuration.py, roundup/doc/admin_guide.txt: update doc on stopword use for sqlite native-fts. test/db_test_base.py: DBTest::testStringBinary creates a file with nulls in it. It was breaking postgresql with native-fts indexer. Changed test to assign mime type application/octet-stream that prevents it from being processed by any text search indexer. add test to exclude indexer searching in specific props. This code path was untested before. test/test_indexer.py: add test to call find with no words. Untested code path. add test to index and find a string with a null \x00 byte. it was tested inadvertently by testStringBinary but this makes it explicit and moves it to indexer testing. (one version each for: generic, postgresql and mysql) Renamed Get_IndexerAutoSelectTest to Get_IndexerTest and renamed autoselect tests to include autoselect. Added tests for an invalid indexer and using native-fts with anydbm (unsupported combo) to make sure the code does something useful if the validation in configuration.py is broken. test/test_liveserver.py: add test to load an issue add test using text search (fts) to find the issue add tests to find issue using postgresql native-fts test/test_postgresql.py, test/test_sqlite.py: added explanation on how to setup integration test using native-fts. added code to clean up test environment if native-fts test is run.
author John Rouillard <rouilj@ieee.org>
date Mon, 05 Sep 2022 16:25:20 -0400
parents 9ca128103a3a
children 648d5916c248
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6270
diff changeset
1 .. meta::
6774
e7b4ad2c57ac landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
2 :description:
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6270
diff changeset
3 Definitions of terms used in the Roundup Issue Tracker
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6270
diff changeset
4 documentation.
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6270
diff changeset
5
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 ================
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 Roundup Glossary
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 ================
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 class
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
12 a definition of the properties and behaviour of a set of items
6238
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
13 classname
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
14 the name of a class. It must start with a letter, end with a letter
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
15 or "_", and only have alphanumerics and "_" in the middle.
1571
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
16 db (or hyperdb)
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
17 a collection of items
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 designator
6270
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
19 a combined class + itemid reference to any item in the
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
20 hyperdb. E.g. issue26. Note that form values can include
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
21 something that looks like a designator composed of a classname, a
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
22 dash '-', and a number. E.g. file-1. These
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
23 are used to create new instances of a class via the web interface.
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
24 itemid
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
25 a numeric reference to a particular item of one class
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
26 item
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 a collection of data that forms one entry in the hyperdb.
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 property
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
29 one element of data that makes up an item. In Roundup, the set
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
30 of item properties may be changed as needed - even after the
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
31 tracker has been initialised and used in production.
796
5324a28060ab *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 783
diff changeset
32 schema
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
33 the definition of all the classes that make up an tracker
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
34 tracker
1571
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
35 the schema and hyperdb that forms one issue tracker
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
36 tracker home
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
37 the physical location on disk of a tracker
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 -----------------
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 Back to `Table of Contents`_
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43
6905
9ca128103a3a fix broken links to doc table of contents
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
44 .. _`Table of Contents`: ../docs.html
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45

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