What is a good PHP design (pattern?) for my testing-application?

Question

I want to write a simple class (PHP5) that can 'run' an unknown amount of subclasses. These subclasses are best translated as 'checks'; they all will more or less do the same thing and give an answer (true / false). Think of it as system startup checks.

Over time new checks (subclasses) will be added to a directory and they should automatically be run when the main class is invoked. Others may write checks but they will have to follow the functions dictated by the main class.

What would be a clean yet simple way to build this? I found the Factory pattern and combined with interface it seems a good starting point. However I am not sure, and I would appreciate advice on this.

EDIT: the provided answers here all work, however the answer by Gordon gives additional possibilities of batches and stacking, something I did not think of at the time of asking, but am now rather happy about.

Answer 1

If you want to create a Batch-like functionality, use the Command Pattern.

Below is a very simple implementation of the pattern. The idea is to have a unified interface for all classes you want to invoke. Each class encapsulates one operation in the batch:

interface BatchCommand
{
    public function execute();
    public function undo();
}

One class implementing the interface will be the commander of all subclasses:

class BatchCommander implements BatchCommand
{
    protected $commands;

    public function add(BatchCommand $command)
    {
        $this->commands[] = $command;
    }
    public function execute()
    {
        foreach($this->commands as $command) {
            $command->execute();
        }
    }
    public function undo()
    {
        foreach($this->commands as $command) {
            $command->undo();
        }
    }
}

A simple Command could look like this:

class FileRename implements BatchCommand
{
    protected $src;
    protected $dest;

    public function __construct($src, $dest)
    {
        $this->$src;
        $this->dest;
    }

    public function execute()
    {
        rename($this->src, $this->dest);
    }

    public function undo()
    {
        rename($this->dest, $this->src);
    }
}

You could then use it like this:

$commander = new BatchCommander;
$commander->add(new FileRename('foo.txt', 'bar.txt'));
$commander->add(/* other commands */);
$commander->execute();

Because BatchCommander is a BatchCommand itself, you can easily stack batches belonging together into other Batches, thus creating a very flexible tree structure, e.g.

$batch1 = new BatchCommander;
$batch1->add(/* some command */);
$batch1->add(/* some other command */);

$batch2 = new BatchCommander;
$batch2->add(/* some command */);
$batch2->add(/* some other command */);

$main = new BatchCommander;
$main->add($batch1);
$main->add($batch2);
$main->execute();

In your Check/Test context, this means you could group conceptually belonging single tests into a test suite. And you can create test suites of test suites, by stacking one suite into another.

Of course, you could also give the BatchCommander a file path to check on instantiation and have it init all BatchCommands by running through the files in the file path. Or pass it a Factory instance to use for creating the Check commands.

You don't have to have execute and undo for method names. Name it check if you want. Leave out undo if you don't need it. The basic idea still stays the same though: one interface for all classes to be commanded, whatever that may look like. Feel free to adapt.

An alternative with a somewhat different UseCase is the Chain of Reponsibility pattern. Check it out to see if this would be of utility too.

Answer 2

I guess the issue here is how you find which classes you should instantiate and run, since you need to know the name of the class.

I suggest that you load each *.php file in the directory and use a simple naming convention. For instance, the name of the file (minus extension) is the name of the class. Then just:

 // foreach $file in glob("*.php"):
    $classname = basename($file, ".php");
    $instance = new $classname(); 
    $result = $instance->runCheck();

Where runCheck() is the actual method that each class must provide.

You did not say anything about running checks in any particular order, but that could be remedied by adding a nn_ prefix to each file and load them in order. For instance 05_CheckFoo.php.

Answer 3

Check class autoloading, so you don't have to take care of how many subclasses exist. PHP will take of everything: http://php.net/manual/en/language.oop5.autoload.php