Testing your Code Using PHPUnit

To create a PHPUnit Test Case:

1. In the PHP Explorer, right-click your project, and select New | PHP File.
   The New PHP File dialog is displayed.
2. Call your new file 'calculator', and click Finish.
3. Copy and paste the following code into the new file:

<?php
class Calculator {
public function add($a,
$b) {
return $a + $b;
}
 
public function multiply($a,
$b) {
return $a * $b;
}
 
public function divide($a,
$b) {
if($b == null) {
throw new Exception("Division
by zero");
}
return $a / $b;
}
 
public function subtract($a,
$b) {
return $a - $b;
}
}
?>

4. Save the file.
5. In the PHP Explorer, right-click the file and select New | PHPUnit Test Case.
   The New PHPUnit Test Case dialog is displayed.

6. To select the element to be tested, click Browse next to the Tested Element field.
   The Element selection dialog is displayed.

7. Begin typing 'calculator'.
   The Calculator class is displayed in the list of matching items.
8. Double-click the Calculator class, and in the New PHPUnit Test Case dialog, click Finish.
   A 'CalculatorTest.php' file is added to your project which contains tests for your original 'calculator' file. All functions (add, multiply, divide and subtract) in the original 'Calculator' file will have a corresponding test function in the 'CalculatorTest' file.

Note:

Test functions will have been created, but parameters need to be entered to ensure the test runs effectively. For more on this, see Running your Unit Test Case, below.

To configure and run your test case:

1. In the 'CalculatorTest' file, expand the test_add public function.

2. Note that a function has been created but no parameters have been inserted. You will have to manually enter the relevant parameters to be tested and the predicted results.

3. Delete the following code representing the default test which will return a "test not implemented" result if the test case is run (lines 47-50):

// TODO Auto-generated CalculatorTest->test_add()
$this->markTestIncomplete("add test not implemented");
$this->Calculator->add(/*parameters */);

4. Replace the above code with the following:

$this->assertEquals($this->Calculator->add(1, 
		 2), 3);

The numbers 1 and 2 indicate that when the test case is run, the parameters 1 and 2 will be entered into the 'add' function in your Calculator file (i.e. the test will try to add 1 + 2). The last number (3) indicates that the expected result is 3. If the result is something other than 3, the test will report a failure for this function.

6. Save the file.

7. To run the unit test, click the arrow next to the Run button on the Tool-bar, and select Run As | PHPUnit Test .
   -OR-
   From the Menu-bar, select Run | Run As | PHPUnit Test .

8. To debug the PHPUnit Test Case, click the arrow next to the debug button on the toolbar, and select Debug As | PHPUnit Test .
   -OR-
   From the Main Menu, select Run | Debug As | PHPUnit Test .
   The unit test will be run and a PHP Unit view will open.
   As the test is run, the parameters you have configured will be entered into the relevant functions in the Calculator file to test whether the correct result is outputted according to the expected results you specified.

9. Four tests will be displayed - one for each calculator function  - which should have passed successfully, as indicated by the green tick icon . The other three functions (divide, multiply and subtract), will have passed but will have a note indicating that they have not been implemented.This is because you have not yet specified the testing parameters.

10. Repeat steps 1-6 above for the remaining functions, entering suitable parameters in the format:

$this->assertEquals($this->Calculator->subtract/divide/multiply(x, 
		 y),z);

Select each required operation (subtract, divide or multiply), and enter variables where x and y are the two parameters which will be entered into the calculator, and z is the expected result.

11. Run the Unit Test again by clicking the Run Last Test button in the PHPUnit view, and make sure all the tests passed successfully.

To analyze and correct errors in your code:

1. To simulate a failed result, change the parameters under the add function so that the expected result is wrong. For example:

$this->assertEquals($this->Calculator->add(1, 
		 2),4);

2. Save the file.

3. Run the Unit Test again by clicking the Run Last Test button in the PHPUnit view.

4. The display in the PHPUnit view will now display that test_add has failed, indicated by the blue X icon .

5. To only view the failures, click the Show failures only button on the view's toolbar.

6. Select a failed result to view it in the Trace failure view. Click the Filter Stack Trace icon to filter the results and view the relevant functions.

7. Double-click the failed result to go to the relevant section in the code.

8. Correct the code, save the file and run the test again by clicking the Run Last Test button in the PHPUnit view.  

The tests should be successful. If they are not, repeat steps 6-8.

To create a PHPUnit Test Suite:

1. Create another Unit Test Case for your 'Calculator' project:

1. In the PHP Explorer, right-click your project, and select New | PHP File.
   The New PHP File dialog is displayed.
2. Call your new file 'newtest', and click Finish.

3. Copy and paste this sample code into the new file.
4. Save the file.
5. In the PHP Explorer, right-click the file, and select New | PHPUnit Test Case.
   The New PHPUnit Test Case dialog is displayed.
6. To select the element to be tested, click Browse next to the Tested Element field.
   The Element selection dialog is displayed.
7. Begin typing 'Calculator', and double-click the 'CalculatorTest2' element.
8. In the New PHPUnit Test Case dialog, click Finish.
   The 'CalculatorTest2Test.php' file is added to your project.

2. Save the project.

3. In the PHP Explorer View, right-click your project, and select New | PHPUnit Test Suite.
   The New PHPUnit Test Suite dialog is displayed.

4. Click Add.
   The Element selection dialog is displayed.

5. Add the 'CalculatorTest' and 'CalculatorTest2' elements.

6. Click Finish.
   A new 'CalculatorSuite' file is created, integrating both tests into one file.

7. Run the Calculator Suite by clicking the arrow next to the Run button on the toolbar, and selecting Run As | PHPUnit Test .
   -OR-
   From the Menu-bar, select Run | Run As | PHPUnit Test .
   Both tests are run, with the results of both displayed in a tree in the PHPUnit view at the bottom of the screen.

To generate a report on your Unit Test results:

1. In the PHPUnit view, click the arrow next to the Generate Report icon .

2. Select Generate with 'plain.xsl'.
   A report will be automatically generated and opened in a browser window.
   

For more information on the different types of reports, see PHPUnit Testing.