EpubProcessorTest
extends UnitTest
in package
implements
CrawlConstants
UnitTest for the EpubProcessor class. An EpubProcessor is used to process a .epub (ebook publishing standard) file and extract summary from it. This class tests the processing of an .epub file format by EpubProcessor.
Tags
Interfaces, Classes, Traits and Enums
- CrawlConstants
- Shared constants and enums used by components that are involved in the crawling process
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
- run() : array<string|int, mixed>
- Execute each of the test cases of this unit test and return the results
- setUp() : mixed
- Creates a new EpubProcessor object so that we can process an .epub format file.
- tearDown() : mixed
- Delete any files associated with our test on EpubProcessor
- testEpubDescriptionTestCase() : mixed
- Test case to check whether the description of the document is not empty.
- testEpubLangTestCase() : mixed
- Test case to check whether the language of the document is retrieved correctly.
- testEpubTitleTestCase() : mixed
- Test case to check whether the title of the epub document is retrieved correctly.
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 —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()
Creates a new EpubProcessor object so that we can process an .epub format file.
public
setUp() : mixed
Return values
mixed —tearDown()
Delete any files associated with our test on EpubProcessor
public
tearDown() : mixed
Return values
mixed —testEpubDescriptionTestCase()
Test case to check whether the description of the document is not empty.
public
testEpubDescriptionTestCase() : mixed
Return values
mixed —testEpubLangTestCase()
Test case to check whether the language of the document is retrieved correctly.
public
testEpubLangTestCase() : mixed
Return values
mixed —testEpubTitleTestCase()
Test case to check whether the title of the epub document is retrieved correctly.
public
testEpubTitleTestCase() : mixed