Yioop_V9.5_Source_Code_Documentation

IndexDocumentBundleTest extends UnitTest

in package

• Application

Used to test that the IndexDocumentBundle class can properly add and retrieve documents. Check its prepareMethod correctly deduplicates documents before inverted index creation. Tests inverted index creation and adding terms to IndexDocumentBundle's BPlusTree. Check look up of documents according to term.

Table of Contents

case_name  = "TestCase"

The suffix that all TestCase methods need to have to be called by run()

TEST_DIR  = __DIR__ . '/test_files/index_document_test'

Prefix of folders for index document test

$current_method  : string

Contains the value of the next test case to be run can be used by setUp

$index_archive  : IndexDocumentBundle

Holds the IndexDocumentBundle used for test purposes

$test_case_results  : array<string|int, mixed>

Used to store the results for each test sub case

$test_objects  : array<string|int, mixed>

Used to hold objects to be used in tests

__construct()  : mixed

Constructor should be overridden to do any set up that occurs before and test cases

addGetPagesTestCase()  : mixed

Tests that after adding pages to an IndexArchiveBundle, the page, and its summary can be retrieved.

addPartitionPostingsDictionaryTestCase()  : mixed

Tests the complete process of going for documents, dedup, building an inverted index and adding the result to the IndexDocumentBundle's inverted index. To this after the above is done perform lookup's of terms known to be in the indexed documents and check the properties of the returned posting lists.

assertEqual()  : mixed

Checks that $x and $y are the same, the result of the test is added to $this->test_case_results

assertFalse()  : mixed

Checks that $x can coerced to false, the result of the test is added to $this->test_case_results

assertNotEqual()  : mixed

Checks that $x and $y are not the same, the result of the test is added to $this->test_case_results

assertTrue()  : mixed

Checks that $x can coerced to true, the result of the test is added to $this->test_case_results

buildInvertedIndexPartitionTestCase()  : mixed

Tests the process of added documents to the IndexDocumentBundle, then building an inverted index from this. To check after the above is done perform lookup's of terms known to have posting list and then checking the properties of the returned posting lists.

prepareIndexTestCase()  : mixed

Tests the prepareIndexMap method which is used to deduplicate pages before an inverted index of a partition is made. Tests adding pages pages with the same doc_id to make sure will get grouped together Grouping also affect how documents are scored so tests this as well.

run()  : array<string|int, mixed>

Execute each of the test cases of this unit test and return the results

saveDescriptionTestCase()  : mixed

Checks if the constructor of the IndexDocumentBundle correctly save the constructor info such as the bundle description

setUp()  : mixed

Sets up an array to keep track of what linear hash tables we've made so that we can delete them when done a test.

tearDown()  : mixed

Deletes all the Linear Hash tables in $this->table_dirs

docidFromInt()  : string

Computes a 24 byte docId by padding an int to the left with 0's

docidFromIntKeys()  : string

docids are typically made from three 8byte strings. This function takes three ints and left pads each with '0' (\x30) and concatenates then to make a 24 byte docid. As docids use their 8 byte to say whether the id is for a document (replace with 'd') or a link (replace with 'l') this function uses the value of the $is_doc flag to determine which value overwrite the 8th byte with.