Unittest actions

[thekid]

Scope of Change

Unittest actions will be introduced to be able to create reusable beforeClass / afterClass / setUp / tearDown handling.

Rationale

Repeated code inside the beforeClass / afterClass / setUp / tearDown methods, like

• PHP Extension prerequisites checking
• Platform prerequisites checking
• Server bootup for integration tests
• PHP version prerequisites tests

Functionality

Usage

For all tests of a given class:

#[@action(new \unittest\VerifyExtensionAvailability('gd'))]
abstract class AbstractImageWriterTest extends TestCase {
  // ...
}

For only a single test:

class PathTest extends TestCase {

  #[@test, @action(new \unittest\IsPlatForm('Windows'))]
  public function leading_backslash_yields_current_drive() {
    // ...
  }
}

Example implementation

The test action itself:

class VerifyExtensionAvailability extends Object implements TestAction {
  protected $extension;

  public function  __construct($extension) {
    $this->extension= $extension;
  }

  public function beforeTest(TestCase $t) {
    if (!Runtime::getInstance()->extensionAvailable($this->extension)) {
      throw new PrerequisitesNotMetError('Extension "'.$this->extension.'" not available');
    }
  }

  public function afterTest(TestCase $t) {
    // Empty
  }
}

Security considerations

Speed impact

Dependencies

Related documents

http://nunit.org/index.php?p=actionAttributes&r=2.6.2
https://github.com/junit-team/junit/wiki/4.12-release-notes#pull-request-552-stopwatch-rule

[thekid]

Announcement http://news.planet-xp.net/article/544/2013/06/29/RFC-0272

[thekid]

It's kind of weird getting used to @unittest.PlatForm('Windows') ... so far, all our annotations have been lower-case. In the above pull request, I've used a derivation as seen in @expect:

class PathTest extends TestCase {

  #[@test, @action(class= 'unittest.action.IsPlatform', args= array('WIN'))]
  public function leading_backslash_yields_current_drive() {
    // ...
  }
}

Unfortunately, it's much longer...

[thekid]

Instead of this action annotation with key/value pairs:

[@test, @action(class= 'unittest.action.IsPlatform', args= array('WIN'))]

...we could now - since xp-framework/xp-framework#328 - also use:

[@test, @action(new IsPlatform('WIN'))]

...and use unittest\action\IsPlatform statements at the top.

Will rewrite the RFC accordingly 🕐

[thekid]

• Rewrote RFC 🕔
• Updated implementation - thekid/xp-framework@399303561ec2fe17f3455dac151bd0b2af0510c0 🕗
• Updated pull request Unittest actions xp-framework#318 accordingly 🕙
• Performed Last QA 🕚
• Checked Travis 🕛

[thekid]

✅ Set status to accepted.

[thekid]

Merged successfully.

[thekid]

Added possibility for multiple actions by supplying an array to @action for both classes and methods in xp-framework/xp-framework@203cf24:

#[@action([
#  new \unittest\action\ExtensionAvailable('mssql'),
#  new \unittest\action\IsPlatform('WIN')
#])]
class MsSqlWindowsDriverTest extends TestCase {
 // ...
}