Mercurial Repository: p/roundup/code: test/test

comparison test/test_indexer.py @ 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	a23eaa3013e6
children	c6b2534a58a9

comparison

equal deleted inserted replaced

-:6010c20dc104
+:9ff091537f43
 self.dex.add_text(('test', '2', 'foo'), 'blah blah the world')
 self.assertSeqEqual(self.dex.find(['world']), [('test', '1', 'foo'),
 ('test', '2', 'foo')])
 self.assertSeqEqual(self.dex.find(['blah']), [('test', '2', 'foo')])
 self.assertSeqEqual(self.dex.find(['blah', 'hello']), [])
+self.assertSeqEqual(self.dex.find([]), [])
 def test_change(self):
 self.dex.add_text(('test', '1', 'foo'), 'a the hello world')
 self.dex.add_text(('test', '2', 'foo'), 'blah blah the world')
 self.assertSeqEqual(self.dex.find(['world']), [('test', '1', 'foo'),
 self.assertSeqEqual(self.dex.find([ u'Spr\xfcnge']),
 [('test', '1', 'a'), ('test', '2', 'a')])
 self.assertSeqEqual(self.dex.find([u'\u0440\u0443\u0441\u0441\u043a\u0438\u0439']),
 [('test', '2', 'a')])
+def testNullChar(self):
+"""Test with null char in string. Postgres FTS will not index
+it will just ignore string for now.
+"""
+string="\x00\x01fred\x255"
+self.dex.add_text(('test', '1', 'a'), string)
+self.assertSeqEqual(self.dex.find(string), [])
 def tearDown(self):
 shutil.rmtree('test-index')
 if hasattr(self, 'db'):
 self.db.close()
 from roundup.backends.indexer_xapian import Indexer
 self.dex = Indexer(db)
 def tearDown(self):
 IndexerTest.tearDown(self)
-class Get_IndexerAutoSelectTest(anydbmOpener, unittest.TestCase):
+class Get_IndexerTest(anydbmOpener, unittest.TestCase):
 def setUp(self):
 # remove previous test, ignore errors
 if os.path.exists(config.DATABASE):
 shutil.rmtree(config.DATABASE)
 self.db.close()
 if os.path.exists(config.DATABASE):
 shutil.rmtree(config.DATABASE)
 @skip_xapian
-def test_xapian_select(self):
+def test_xapian_autoselect(self):
 indexer = get_indexer(self.db.config, self.db)
 self.assertIn('roundup.backends.indexer_xapian.Indexer', str(indexer))
 @skip_whoosh
-def test_whoosh_select(self):
+def test_whoosh_autoselect(self):
 import mock, sys
 with mock.patch.dict('sys.modules',
 {'roundup.backends.indexer_xapian': None}):
 indexer = get_indexer(self.db.config, self.db)
 self.assertIn('roundup.backends.indexer_whoosh.Indexer', str(indexer))
-def test_native_select(self):
+def test_native_autoselect(self):
 import mock, sys
 with mock.patch.dict('sys.modules',
 {'roundup.backends.indexer_xapian': None,
 'roundup.backends.indexer_whoosh': None}):
 indexer = get_indexer(self.db.config, self.db)
 self.assertIn('roundup.backends.indexer_dbm.Indexer', str(indexer))
+def test_invalid_indexer(self):
+"""There is code at the end of indexer_common::get_indexer() to
+raise an AssertionError if the indexer name is invalid.
+This should never be triggered. If it is, it means that
+the code in configure.py that validates indexer names
+allows a name through that get_indexer can't handle.
+Simulate that failure and make sure that the
+AssertionError is raised.
+"""
+with self.assertRaises(ValueError) as cm:
+self.db.config['INDEXER'] = 'no_such_indexer'
+# mangle things so we can test AssertionError at end
+# get_indexer()
+from roundup.configuration import IndexerOption
+IndexerOption.allowed.append("unrecognized_indexer")
+self.db.config['INDEXER'] = "unrecognized_indexer"
+with self.assertRaises(AssertionError) as cm:
+indexer = get_indexer(self.db.config, self.db)
+# unmangle state
+IndexerOption.allowed.pop()
+self.assertNotIn("unrecognized_indexer", IndexerOption.allowed)
+self.db.config['INDEXER'] = ""
+def test_unsupported_by_db(self):
+"""This requires that the db associated with the test
+is not sqlite or postgres. anydbm works fine to trigger
+the error.
+"""
+self.db.config['INDEXER'] = 'native-fts'
+with self.assertRaises(AssertionError) as cm:
+get_indexer(self.db.config, self.db)
+self.assertIn("native-fts", cm.exception.args[0])
+self.db.config['INDEXER'] = ''
 class RDBMSIndexerTest(object):
 def setUp(self):
 # remove previous test, ignore errors
 if os.path.exists(config.DATABASE):
 self.assertIn('search configuration "foo" does', ctx.exception.args[0])
 self.db.rollback()
 self.db.config["INDEXER_LANGUAGE"] = "english"
+def testNullChar(self):
+"""Test with null char in string. Postgres FTS throws a ValueError
+on indexing which we ignore. This could happen when
+indexing a binary file with a bad mime type. On find, it
+throws a ProgrammingError that we remap to
+IndexerQueryError and pass up. If a null gets to that
+level on search somebody entered it (not sure how you
+could actually do that) but we want a crash in that case
+as the person is probably up to "no good" (R) (TM).
+"""
+import psycopg2
+string="\x00\x01fred\x255"
+self.dex.add_text(('test', '1', 'a'), string)
+with self.assertRaises(IndexerQueryError) as ctx:
+self.assertSeqEqual(self.dex.find(string), [])
+self.assertIn("null", ctx.exception.args[0])
 @skip_mysql
 class mysqlIndexerTest(mysqlOpener, RDBMSIndexerTest, IndexerTest):
 def setUp(self):
 mysqlOpener.setUp(self)
 RDBMSIndexerTest.setUp(self)
 self.dex.find(['hello world + ^the'])
 error = 'Query error: syntax error near "^"'
 self.assertEqual(str(ctx.exception), error)
+def testNullChar(self):
+"""Test with null char in string. FTS will throw
+an error on null.
+"""
+import psycopg2
+string="\x00\x01fred\x255"
+self.dex.add_text(('test', '1', 'a'), string)
+with self.assertRaises(IndexerQueryError) as cm:
+self.assertSeqEqual(self.dex.find(string), [])
 # vim: set filetype=python ts=4 sw=4 et si

Mercurial > p > roundup > code

comparison test/test_indexer.py @ 6915:9ff091537f43