Simpletest Eclipse Plugin

Compatibility

Installation

Update Existing Installation

1. Select "Help" > "Software Updates" > "Manage Configuration" from the menu
2. Drill down to find the Simpletest plugin and select it
3. In the right hand pane click the link for "Scan for Updates"
4. IF no updates are found, navigate to Window > Preferences > Install/Update > Valid Updates in the Eclipse preferences and select 'Compatible', not 'equivalent'. Then repeat the steps above.
5. Select the feature versions that you wish to upgrade, and click "Next".
6. Review the license agreements for the upgraded features. If the terms of all these licenses are acceptable, check "I accept the terms in the license agreements." Do not proceed to download the features if the license terms are not acceptable.
7. Click "Install" to allow the downloading and installing to proceed.
8. Once all the features and plug-ins have been downloaded successfully and their files installed into the product on the local computer, a new configuration that incorporates these features and plug-ins will be formulated. Click Yes when asked to exit and restart the Workbench for the changes to take effect.

Uninstall

Note: this will only work if the plugin was installed via the Feature Update method. If installed via alternate methods, then the plugin can be uninstalled by deleting the directories which were previously added.

1. Select "Help" > "Software Updates" > "Manage Configuration"
2. Drill down to find the Simpletest plugin
3. Right-click on the Simpletest plugin and select the option "Disable"
4. when prompted, restart Eclipse
5. After Eclipse has restarted, select "Help" > "Software Updates" > "Manage Configuration" from the menu bar
6. Select the option from the toolbar "Show Disabled Features"
7. Drill down to find the Simpletest plugin
8. Right-click on the Simpletest plugin and select the option "Uninstall"
9. When prompted, restart Eclipse

Usage

The following details some sample usages of the plugin.

1. Create a new test project (a holding place for related files)
   1. Select "File" > "New" > "Project.." from the menu
   2. Expand the folder "General" and select "Project"
   3. Click the "Next" button
   4. On the next tab enter a project name: "Test"
   5. Use the default Project Contents
   6. Click the "Finish" button
2. Create a Single Passing Test
   1. In the Package Explorer View right-click on the "Test" project and select "New" > "File".
   2. For the filename enter: test1.php and click "Finish"
   3. Double-click on the test1.php entry in the Package Explorer which should open a new view to edit the file.
   4. Enter the following for the contents of the file:

      <?php
      class test1 extends UnitTestCase {
        function test_pass(){
          $x = 1;
          $y = 2;
          $total = $x + $y;
          $this->assertEqual(3,$total, "This should pass");
        }
      }
      ?>
      

   5. Select "File" > "Save" from the menu.
   6. Right click on the test1.php entry and select "Run" > "Run Simpletest".
   7. The "Result View" should populate with information about the test run and the Simpletest console should fill with some information as well.
3. Single Test class multiple tests
   1. In the Package Explorer View right-click on the "Test" project and select "New" > "File".
   2. For the filename enter: test2.php and click "Finish".
   3. Double-click on the test2.php entry in the Package Explorer which should open a new view to edit the file.
   4. Enter the following for the contents of the file:

      <?php
      class test2 extends UnitTestCase {          
        function test_pass(){
          $x = 1;
          $y = 2;
          $total = $x + $y;
          $this->assertEqual(3,$total, "This should pass");
        }
        function test_fail(){
          $x = 1;
          $y = 2;
          $total = $x + $y;
          $this->assertEqual(4,$total,"This should fail");
        }
      }
      ?>
      

   5. Select "File" > "save" from the menu bar.
   6. Right click on the test2.php entry and select "Run" > "Run Simpletest".
   7. The Result View should populate with information about the test run and the Simpletest console should fill with some information as well
4. Group Tests (test multiple files at once)
   1. In the Package Explorer View right-click on the "Test" project and select "New" > "File"
   2. For the filename enter: grouptest.php and click "Finish".
   3. Double-click on the grouptest.php entry in the Package Explorer which should open a new view to edit the file.
   4. Enter the following for the contents of the file:

      <?php
      class myGroupTest extends GroupTest {
        function myGroupTest() {
          parent::GroupTest('');
          $this->addTestFile(dirname(__FILE__).'/test1.php');
          $this->addTestFile(dirname(__FILE__).'/test2.php');
        }
      }
      ?>
      

   5. Select "File" > "save" from the menu
   6. Right click on the grouptest.php entry and select "Run" > "Run Simpletest"
   7. The Result View should populate with information about the test run and the Simpletest console should fill with some information as well

Known Issues

• Make sure that if a constructor is used in the test case that the last line of the constructor calls the parent constructor (e.g. parent::UnitTestCase)
• Do not put any assertions into the test class constructor
• If you get an error indicating that a class could not load; then restart Eclipse. Once Eclipse restarts, open the Result View manually by selecting "Window"->"Show View"->"Other..." Then select the SimpleTest Category and select "Result View" and click "OK".

Future Features

These are features that should eventually make it into this plugin

• Allow different "include" file on each runner (override the "master" include)
• Handle fatal errors better