Yioop_V9.5_Source_Code_Documentation

PriorityQueueTest extends UnitTest
in package

Used to test the PriorityQueue class that is used to figure out which URL to crawl next

Tags
author

Chris Pollett

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
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
maxQueueTestCase()  : mixed
Insert five items into a priority queue. Checks that the resulting heap array matches the expected array calculated by hand. Weights of some elements of the queue are adjusted and the resulting heap array checked again. The results of polling the queue and normalizing the queue are tested
minQueueTestCase()  : mixed
Inserts five elements inserted into a minimum priority queue. The resulting heap array is compared to expected. Then repeated polling is done to make sure the objects come out in the correct order.
run()  : array<string|int, mixed>
Execute each of the test cases of this unit test and return the results
setUp()  : mixed
We setup two queue one that always returns the max element, one that always returns the min element
tearDown()  : mixed
Since our queues are persistent structures, we delete files that might be associated with them when we tear down

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

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

maxQueueTestCase()

Insert five items into a priority queue. Checks that the resulting heap array matches the expected array calculated by hand. Weights of some elements of the queue are adjusted and the resulting heap array checked again. The results of polling the queue and normalizing the queue are tested

public maxQueueTestCase() : mixed
Return values
mixed

minQueueTestCase()

Inserts five elements inserted into a minimum priority queue. The resulting heap array is compared to expected. Then repeated polling is done to make sure the objects come out in the correct order.

public minQueueTestCase() : 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

setUp()

We setup two queue one that always returns the max element, one that always returns the min element

public setUp() : mixed
Return values
mixed

tearDown()

Since our queues are persistent structures, we delete files that might be associated with them when we tear down

public tearDown() : mixed
Return values
mixed

        

Search results