IndexShardTest
extends UnitTest
in package
Used to test that the IndexShard class can properly add new documents and retrieve those documents by word. Checks that doc offsets can be updated, shards can be saved and reloaded
Tags
Table of Contents
- case_name = "TestCase"
- The suffix that all TestCase methods need to have to be called by run()
- $current_method : string
- Contains the value of the next test case to be run can be used by setUp
- $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
- addDocumentsGetPostingsSliceByIdTestCase() : mixed
- Check if can store documents into an index shard and retrieve them
- addDocumentsGetPostingsSliceReverseTestCase() : mixed
- Check if can iterate over posting slices in the reverse direction To do this we construct two identical shards. We go over 'shard' ascendingly, while we go over 'shard4' descendingly and compare
- addLinkGetPostingsSliceByIdTestCase() : mixed
- Check if can store link documents into an index shard and retrieve them
- appendIndexShardTestCase() : mixed
- Check that appending two index shards works correctly
- 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
- changeDocumentOffsetTestCase() : mixed
- Check that changing document offsets works
- documentKeyTestCase() : mixed
- Used to test the functions related to add auxiliary document keys the document key of a document in an IndexShard.
- run() : array<string|int, mixed>
- Execute each of the test cases of this unit test and return the results
- saveLoadTestCase() : mixed
- Check that save and load work
- setUp() : mixed
- Construct some index shard we can add documents to
- tearDown() : mixed
- Deletes any index shard files we may have created
Constants
case_name
The suffix that all TestCase methods need to have to be called by run()
public
mixed
case_name
= "TestCase"
Properties
$current_method
Contains the value of the next test case to be run can be used by setUp
public
string
$current_method
$test_case_results
Used to store the results for each test sub case
public
array<string|int, mixed>
$test_case_results
$test_objects
Used to hold objects to be used in tests
public
array<string|int, mixed>
$test_objects
Methods
__construct()
Constructor should be overridden to do any set up that occurs before and test cases
public
__construct() : mixed
Return values
mixed —addDocumentsGetPostingsSliceByIdTestCase()
Check if can store documents into an index shard and retrieve them
public
addDocumentsGetPostingsSliceByIdTestCase() : mixed
Return values
mixed —addDocumentsGetPostingsSliceReverseTestCase()
Check if can iterate over posting slices in the reverse direction To do this we construct two identical shards. We go over 'shard' ascendingly, while we go over 'shard4' descendingly and compare
public
addDocumentsGetPostingsSliceReverseTestCase() : mixed
Return values
mixed —addLinkGetPostingsSliceByIdTestCase()
Check if can store link documents into an index shard and retrieve them
public
addLinkGetPostingsSliceByIdTestCase() : mixed
Return values
mixed —appendIndexShardTestCase()
Check that appending two index shards works correctly
public
appendIndexShardTestCase() : mixed
Return values
mixed —assertEqual()
Checks that $x and $y are the same, the result of the test is added to $this->test_case_results
public
assertEqual(mixed $x, mixed $y[, string $description = "" ]) : mixed
Parameters
- $x : mixed
-
a first item to compare
- $y : mixed
-
a second item to compare
- $description : string = ""
-
information about this test subcase
Return values
mixed —assertFalse()
Checks that $x can coerced to false, the result of the test is added to $this->test_case_results
public
assertFalse(mixed $x[, string $description = "" ]) : mixed
Parameters
- $x : mixed
-
item to check
- $description : string = ""
-
information about this test subcase
Return values
mixed —assertNotEqual()
Checks that $x and $y are not the same, the result of the test is added to $this->test_case_results
public
assertNotEqual(mixed $x, mixed $y[, string $description = "" ]) : mixed
Parameters
- $x : mixed
-
a first item to compare
- $y : mixed
-
a second item to compare
- $description : string = ""
-
information about this test subcase
Return values
mixed —assertTrue()
Checks that $x can coerced to true, the result of the test is added to $this->test_case_results
public
assertTrue(mixed $x[, string $description = "" ]) : mixed
Parameters
- $x : mixed
-
item to check
- $description : string = ""
-
information about this test subcase
Return values
mixed —changeDocumentOffsetTestCase()
Check that changing document offsets works
public
changeDocumentOffsetTestCase() : mixed
Return values
mixed —documentKeyTestCase()
Used to test the functions related to add auxiliary document keys the document key of a document in an IndexShard.
public
documentKeyTestCase() : mixed
Return values
mixed —run()
Execute each of the test cases of this unit test and return the results
public
run([string $method = null ]) : array<string|int, mixed>
Parameters
- $method : string = null
-
if not null then the method to run, else run all methods
Return values
array<string|int, mixed> —test case results
saveLoadTestCase()
Check that save and load work
public
saveLoadTestCase() : mixed
Return values
mixed —setUp()
Construct some index shard we can add documents to
public
setUp() : mixed
Return values
mixed —tearDown()
Deletes any index shard files we may have created
public
tearDown() : mixed