Testen¶

Installation von SimpleTest¶

Das in CakePHP 1.2 enthaltene Test-Framework ist aufgebaut auf dem SimpleTest-Test-Framework. SimpleTest ist in der Standard-CakePHP-Installation nicht enthalten, somit müssen wir das nun runterladen.

https://simpletest.sourceforge.net/.

deinen /cake/vendors/ oder in den /app/vendors/ Ordner, je nach euren Anforderungen. Du solltest also jetzt einen ../vendors/simpletest/ Ordner samt der dazugehörigen SimpleTest-Dateien haben!?

mindestens auf 1 setzt, bevor du mit irgendwelchen Test`s anfängst!

Starten der integrierten Test-Funktionen¶

CakePHP 1.2 kommt mit einem Bündel an Test-Fallbeispielen, involviert in die Core-CakePHP-Funktionen, daher. Auf diese Test`s kann zugegriffen werden indem man mit dem Browser https://deine.cake.adresse/dein_cake_ordner/test.php (je nachdem wie euer spezifisches Setup aussieht..), ansteuert.

anklickst… ;-D).

dauern, aber schlussendlich sollte etwas wie: „2/2 test casese complete: 49 passes, 0 fails and 0 exceptions.“ angezeigt werden.

Über „fixtures“¶

Wenn man Code testet der auf models und Daten basiert, dann kann man für eines davon *fixtures* nutzen, als einen Weg um temporäre Datensätze mit Beispieldaten zu laden und diese dann zum testen zu verwenden.

Der Vorteil beim verwenden von fixtures liegt darin, dass dein Test keine Chance hat geladene Anwendungsdaten zu zerstören. Zusätzlich kannst du damit Anfangen deine Code-Priorität, mit aktuell gefertigten Live-Inhalten für eine Anwendung, zu testen.

CakePHP versucht die Verbindung namens $test in deiner /app/config/database.php Einstellungs-Datei zu benutzen. Wenn diese Verbindung nicht brauchbar ist, dann wird die $default Datenbank-Verbindung genutzt und die Test-Tabellen werden in der dort definierten Datenbank erstellt.

In einem anderen Fall, wird „test_suite“ zu deinem eigenen Tabellen-Zusatz(falls vorhanden) hinzu gefügt um einer Kollision, mit einer vorhandenen Tabelle, vorzubeugen.

CakePHP bietet folgende Möglichkeiten wärend der Tour durch fixtures-basierte Test Fälle:

1. Erstellt Tabellen für alles was von den fixtures gebraucht wird

2. Füllt Tabellen mit Daten, wenn Daten in fixture angefordert werden

3. Startet Test Methoden

4. Entleert fixture-Tabellen

5. Löscht fixture-Tabellen aus der Datenbank

Erstellen von Vorrichtungen (fixtures)¶

Beim Erstellen von Vorrichtungen solltest du hauptsächlich 2 Dinge definieren: Wie wurde die Tabelle erstellt (welche Felder sind ein Teil der Tabelle) und welche Datensätze werden zu Beginn die Test-Tabelle belegen.

dann unsere Modell-Artikel testen.

deinem ../app/tests/fixtures/ Ordner, mit folgendem Inhalt:

<?php
 class ArticleTestFixture extends CakeTestFixture {
      var $name = 'ArticleTest';

      var $fields = array(
          'id' => array('type' => 'integer', 'key' => 'primary'),
          'title' => array('type' => 'string', 'length' => 255, 'null' => false),
          'body' => 'text',
          'published' => array('type' => 'integer', 'default' => '0', 'null' => false),
          'created' => 'datetime',
          'updated' => 'datetime'
      );
      var $records = array(
          array ('id' => 1, 'title' => 'First Article', 'body' => 'First Article Body', 'published' => '1', 'created' => '2007-03-18 10:39:23', 'updated' => '2007-03-18 10:41:31'),
          array ('id' => 2, 'title' => 'Second Article', 'body' => 'Second Article Body', 'published' => '1', 'created' => '2007-03-18 10:41:23', 'updated' => '2007-03-18 10:43:31'),
          array ('id' => 3, 'title' => 'Third Article', 'body' => 'Third Article Body', 'published' => '1', 'created' => '2007-03-18 10:43:23', 'updated' => '2007-03-18 10:45:31')
      );
 }
 ?>

Wir brauchen $fields um zu spezifizieren welche Felder Bestandteil der Tabelle sind und wie diese Felder definiert sind.

gleiche das in der Funktion generateColumnSchema(), aus der Cake-Datenbank-Engineklasse, definiert wird (zum Beispiel die Datei dbo_mysql.php).

aussagen:

type

CakePHP`s interner Daten-Typ. Momentan unterstützt: string (Speicherort für diverse Zeichenketten/-folgen), text (Speicherort für Texte), integer (Speicherort für Ganzzahlen), float (Speicherort für Fliesskommazahlen), datetime (Speicherort für Datum+Zeit), timestamp (Speicherort für Zeitmarken), time (Speicherort für Zeiten), date (Speicherort für Datumsangaben), und binary (Speicherort für Binärzahlen/zeichen)

key

auf primary setzen damit das Feld AUTO-ANWACHSEN lassen zu können und um einen Hauptschlüssel für die Tabelle zu erstellen.

length

setzen um dem Feld die spezielle länge zu geben die es haben sollte.

null

Setze den Wert auf „true“ („wahr“ => Zum Erlauben von NULLen) oder „false“ („unwahr“ => um NULLen zu verbieten)

default

Standart-Einheit des Feldes..

Zum Schluss könnten wir eine Reihe von Datensätzen setzen, welche publiziert werden nach dem die Test-Tabelle erstellt wurde. Das Format ist ziemlich ordentlich und braucht wenig weitere Erklärung. Versuch daran zu denken, dass jeder Datensatz im $records Ordner einen Schlüssel haben muss für jedes Feld das im $fields Ordner angegeben ist. Falls ein Feld für für einen speziellen Datensatz einen NULL-Wert braucht, dann deklariere den Wert des Schlüssel`s als NULL.

Importieren von Datensätzen und Tabellen-Daten¶

Deine Anwendung mag möglicherweise funktionierende Entwürfe beinhalten, mit echten

deine Entwürfe

Doppelanstrengung, wenn man die

Inhalten definieren sollte.

Tabellendefinition

Modellen oder

Anwendung

Muster-Inhalte

(app/tests/fixtures/article_test_fixture.php) wie folgt:

<?php
  class ArticleTestFixture extends CakeTestFixture {
         var $name = 'ArticleTest';
         var $import = 'Article';
  }
  ?>

aus der Tabelle,

verfügbar ist.

tun wenn

<?php
class ArticleTestFixture extends CakeTestFixture {
    var $name = 'ArticleTest';
    var $import = array('model' => 'Article', 'records' => true);
}
?>

Muster-Inhalte dazu

wird, indem

werden.

<?php
  class ArticleTestFixture extends CakeTestFixture {
         var $name = 'ArticleTest';
         var $import = array('table' => 'articles');
  }
?>

Tabelle

articles veranlassen, indem die CakePHP-Datenbankverbindung ‚default‘

musst du

<?php
  class ArticleTestFixture extends CakeTestFixture {
  var $name = 'ArticleTest';
  var $import = array('table' => 'articles', 'connection' => 'other');
  }
  ?>

da irgendwelche

attraktive Tabellen-

Tabelle. Um also

<?php
  class ArticleTestFixture extends CakeTestFixture {
         var $name = 'ArticleTest';
         var $import = array('table' => 'articles', 'records' => true);
  }
?>

exitierenden Muster oder

definiert, genau nach den Vorgaben aus der vorhergehenden Sektion. zum Beispiel:

<?php
  class ArticleTestFixture extends CakeTestFixture {
         var $name = 'ArticleTest';
         var $import = 'Article';

         var $records = array(
             array ('id' => 1, 'title' => 'First Article', 'body' => 'First Article Body', 'published' => '1', 'created' => '2007-03-18 10:39:23', 'updated' => '2007-03-18 10:41:31'),
             array ('id' => 2, 'title' => 'Second Article', 'body' => 'Second Article Body', 'published' => '1', 'created' => '2007-03-18 10:41:23', 'updated' => '2007-03-18 10:43:31'),
             array ('id' => 3, 'title' => 'Third Article', 'body' => 'Third Article Body', 'published' => '1', 'created' => '2007-03-18 10:43:23', 'updated' => '2007-03-18 10:45:31')
         );
  }
?>

CakeTestCase Callback Methods¶

If you want to sneak in some logic just before or after an individual CakeTestCase method, and/or before or after your entire CakeTestCase, the following callbacks are available:

start()

end()

startCase()

endCase()

before($method)

after($method)

startTest($method)

endTest($method)

Erstellen einer Versuchs-Anwendung (test case)¶

Lass uns darauf einigen dass wir unseren Muster-Artikel (article model) bereits unter ../app/models/article.php erstellt haben und dieser sollte in etwa wie folgt aussehen:

<?php
  class Article extends AppModel {
         var $name = 'Article';

         function published($fields = null) {
             $conditions = array(
                 $this->name . '.published' => 1
             );

             return $this->findAll($conditions, $fields);
         }

  }
?>

verwenden wird, allerdings durch Vorrichtungen für Versuche, lässt sich einiges an Funktionalität im Versuch testen.

Anwendungen (um Versuche isoliert zu lassen), somit müssen wir zum starten das vorhergehende Module verwenden (in diesem Fall ist das Anwendungsmodul ja schon fertig definiert), dann informiere die Versuchs-Umgebung darüber, dass wir das Modul testen wollen, indem wir herausfinden welche Datenbank-Konfiguration benutzt werden sollte!. Die CakePHP Test-Umgebung ermöglicht eine Datenbank-Konfiguration namen`s test_suite, diese wird gebraucht für alle Module, die auf Vorrichtungen angewiesen sind. Der Datensatz $useDbConfig zu dieser Konfigurationsdatei lässt CakePHP wissen das dieses Modul die test_suite DB-Verbindung benutzt.

wiederzuverwerten umd das ganze dazu benutzen das wir alle want to reuse all our existing modules we will create a test model that will extend from Article, set $useDbConfig and $name appropiately. Let’s now create a file named article.test.php in your app/tests/cases/models directory, with the following contents:

<?php
  App::import('Model','Article');

  class ArticleTest extends Article {
         var $name = 'ArticleTest';
         var $useDbConfig = 'test_suite';
  }

  class ArticleTestCase extends CakeTestCase {
         var $fixtures = array( 'app.article_test' );
  }
?>

Wie du erkennen solltest we’re not really adding any test methods yet, we have just defined our ArticleTest model (that inherits from Article), and created the ArticleTestCase. In variable $fixtures we define the set of fixtures that we’ll use.

Creating a test method¶

Let’s now add a method to test the function published() in the Article model. Edit the file app/tests/cases/models/article.test.php so it now looks like this:

<?php
  App::import('Model', 'Article');

  class ArticleTestCase extends CakeTestCase {
      var $fixtures = array( 'app.article' );

      function testPublished() {
          $this->Article =& ClassRegistry::init('Article');

          $result = $this->Article->published(array('id', 'title'));
          $expected = array(
              array('Article' => array( 'id' => 1, 'title' => 'First Article' )),
              array('Article' => array( 'id' => 2, 'title' => 'Second Article' )),
              array('Article' => array( 'id' => 3, 'title' => 'Third Article' ))
          );

          $this->assertEqual($result, $expected);
      }
  }
  ?>

by creating an instance of our fixture based Article model, and then run our published() method. In $expected we set what we expect should be the proper result (that we know since we have defined which records are initally populated to the article table.) We test that the result equals our expectation by using the assertEqual method. See the section Creating Tests for information on how to run the test.

Creating a test case¶

Say you have a typical articles controller, with its corresponding model, and it looks like this:

<?php
class ArticlesController extends AppController {
   var $name = 'Articles';
   var $helpers = array('Ajax', 'Form', 'Html');

   function index($short = null) {
     if (!empty($this->data)) {
       $this->Article->save($this->data);
     }
     if (!empty($short)) {
       $result = $this->Article->findAll(null, array('id',
          'title'));
     } else {
       $result = $this->Article->findAll();
     }

     if (isset($this->params['requested'])) {
       return $result;
     }

     $this->set('title', 'Articles');
     $this->set('articles', $result);
   }
}
?>

Create a file named articles_controller.test.php in your app/tests/cases/controllers directory and put the following inside:

<?php
class ArticlesControllerTest extends CakeTestCase {
   function startCase() {
     echo '<h1>Starting Test Case</h1>';
   }
   function endCase() {
     echo '<h1>Ending Test Case</h1>';
   }
   function startTest($method) {
     echo '<h3>Starting method ' . $method . '</h3>';
   }
   function endTest($method) {
     echo '<hr />';
   }
   function testIndex() {
     $result = $this->testAction('/articles/index');
     debug($result);
   }
   function testIndexShort() {
     $result = $this->testAction('/articles/index/short');
     debug($result);
   }
   function testIndexShortGetRenderedHtml() {
     $result = $this->testAction('/articles/index/short',
     array('return' => 'render'));
     debug(htmlentities($result));
   }
   function testIndexShortGetViewVars() {
     $result = $this->testAction('/articles/index/short',
     array('return' => 'vars'));
     debug($result);
   }
   function testIndexFixturized() {
     $result = $this->testAction('/articles/index/short',
     array('fixturize' => true));
     debug($result);
   }
   function testIndexPostFixturized() {
     $data = array('Article' => array('user_id' => 1, 'published'
          => 1, 'slug'=>'new-article', 'title' => 'New Article', 'body' => 'New Body'));
     $result = $this->testAction('/articles/index',
     array('fixturize' => true, 'data' => $data, 'method' => 'post'));
     debug($result);
   }
}
?>

The testAction method¶

The new thing here is the testAction method. The first argument of that method is the Cake url of the controller action to be tested, as in ‚/articles/index/short‘.

The second argument is an array of parameters, consisting of:

return

Set to what you want returned.

Valid values are:

• ‚vars‘ - You get the view vars available after executing action

• ‚view‘ - You get The rendered view, without the layout

• ‚contents‘ - You get the rendered view’s complete html, including the layout

• ‚result‘ - You get the returned value when action uses $this->params[‚requested‘].

The default is ‚result‘.

fixturize

Set to true if you want your models auto-fixturized (so your application tables get copied, along with their records, to test tables so if you change data it does not affect your real application.) If you set ‚fixturize‘ to an array of models, then only those models will be auto-fixturized while the other will remain with live tables. If you wish to use your fixture files with testAction() do not use fixturize, and instead just use fixtures as you normally would.

method

set to ‚post‘ or ‚get‘ if you want to pass data to the controller

data

the data to be passed. Set it to be an associative array consisting of fields => value. Take a look at function testIndexPostFixturized() in above test case to see how we emulate posting form data for a new article submission.

Pitfalls¶

If you use testAction to test a method in a controller that does a redirect, your test will terminate immediately, not yielding any results.

https://mark-story.com/posts/view/testing-cakephp-controllers-the-hard-way for a possible fix.

Creating Helper test, part I¶

First of all we will define the responsibilities of our CurrencyRendererHelper. Basically, it will have two methods just for demonstration purpose:

function usd($amount)

This function will receive the amount to render. It will take 2 decimal digits filling empty space with zeros and prefix ‚USD‘.

function euro($amount)

This function will do the same as usd() but prefix the output with ‚EUR‘. Just to make it a bit more complex, we will also wrap the result in span tags:

<span class="euro"></span>

Let’s create the tests first:

<?php

//Import the helper to be tested.
//If the tested helper were using some other helper, like Html,
//it should be impoorted in this line, and instantialized in startTest().
App::import('Helper', 'CurrencyRenderer');

class CurrencyRendererTest extends CakeTestCase {
    private $currencyRenderer = null;

    //Here we instantiate our helper, and all other helpers we need.
    public function startTest() {
        $this->currencyRenderer = new CurrencyRendererHelper();
    }

    //testing usd() function.
    public function testUsd() {
        $this->assertEqual('USD 5.30', $this->currencyRenderer->usd(5.30));
        //We should always have 2 decimal digits.
        $this->assertEqual('USD 1.00', $this->currencyRenderer->usd(1));
        $this->assertEqual('USD 2.05', $this->currencyRenderer->usd(2.05));
        //Testing the thousands separator
        $this->assertEqual('USD 12,000.70', $this->currencyRenderer->usd(12000.70));
    }
}

Here, we call usd() with different parameters and tell the test suite to check if the returned values are equal to what is expected.

Executing the test now will result in errors (because currencyRendererHelper doesn’t even exist yet) showing that we have 3 fails.

Once we know what our method should do, we can write the method itself:

<?php
class CurrencyRendererHelper extends AppHelper {
    public function usd($amount) {
        return 'USD ' . number_format($amount, 2, '.', ',');
    }
}

Here we set the decimal places to 2, decimal separator to dot, thousands separator to comma, and prefix the formatted number with ‚USD‘ string.

Save this in app/views/helpers/currency_renderer.php and execute the test. You should see a green bar and messaging indicating 4 passes.

Initializing the component¶

Since CakePHP discourages from importing models directly into components we need a controller to access the data in the model.

If the startup() function of the component looks like this:

public function startup(&$controller){
          $this->Transporter = $controller->Transporter;
 }

then we can just design a really simple fake class:

class FakeTransporterController {}

and assign values into it like this:

$this->TransporterComponentTest = new TransporterComponent();
$controller = new FakeTransporterController();
$controller->Transporter = new TransporterTest();
$this->TransporterComponentTest->startup(&$controller);

Creating a test method¶

Just create a class that extends CakeTestCase and start writing tests!

class TransporterTestCase extends CakeTestCase {
    var $fixtures = array('transporter');
    function testGetTransporter() {
          $this->TransporterComponentTest = new TransporterComponent();
          $controller = new FakeTransporterController();
          $controller->Transporter = new TransporterTest();
          $this->TransporterComponentTest->startup(&$controller);

          $result = $this->TransporterComponentTest->getTransporter("12345", "Sweden", "54321", "Sweden");
          $this->assertEqual($result, 1, "SP is best for 1xxxx-5xxxx");

          $result = $this->TransporterComponentTest->getTransporter("41234", "Sweden", "44321", "Sweden");
          $this->assertEqual($result, 2, "WSTS is best for 41xxx-44xxx");

          $result = $this->TransporterComponentTest->getTransporter("41001", "Sweden", "41870", "Sweden");
          $this->assertEqual($result, 3, "GL is best for 410xx-419xx");

          $result = $this->TransporterComponentTest->getTransporter("12345", "Sweden", "54321", "Norway");
          $this->assertEqual($result, 0, "Noone can service Norway");
   }
}

About CakeWebTestCase¶

CakeWebTestCase is a direct extension of the SimpleTest WebTestCase, without any extra functionality. All the functionality found in the SimpleTest documentation for Web testing is also available here. This also means that no functionality other than that of SimpleTest is available. This means that you cannot use fixtures, and all web test cases involving updating/saving to the database will permanently change your database values. Test results are often based on what values the database holds, so making sure the database contains the values you expect is part of the testing procedure.

Creating a test¶

In keeping with the other testing conventions, you should create your view tests in tests/cases/views. You can, of course, put those tests anywhere but following the conventions whenever possible is always a good idea. So let’s create the file tests/cases/views/complete_web.test.php

First, when you want to write web tests, you must remember to extend CakeWebTestCase instead of CakeTestCase:

class CompleteWebTestCase extends CakeWebTestCase

If you need to do some preparation before you start the test, create a constructor:

function CompleteWebTestCase(){
  //Do stuff here
}

When writing the actual test cases, the first thing you need to do is get some output to look at. This can be done by doing a get or post request, using get()or post() respectively. Both these methods take a full url as the first parameter. This can be dynamically fetched if we assume that the test script is located under http://your.domain/cake/folder/webroot/test.php by typing:

$this->baseurl = current(split("webroot", $_SERVER['PHP_SELF']));

You can then do gets and posts using Cake urls, like this:

$this->get($this->baseurl."/products/index/");
$this->post($this->baseurl."/customers/login", $data);

The second parameter to the post method, $data, is an associative array containing the post data in Cake format:

$data = array(
  "data[Customer][mail]" => "[email protected]",
  "data[Customer][password]" => "userpass");

When you have requested the page you can do all sorts of asserts on it, using standard SimpleTest web test methods.

Walking through a page¶

CakeWebTest also gives you an option to navigate through your page by clicking links or images, filling forms and clicking buttons. Please refer to the SimpleTest documentation for more information on that.

Customizing the test reporter¶

The standard test reporter is very minimalistic. If you want more shiny output to impress someone, fear not, it is actually very easy to extend. By creating a new reporter and making a request with a matching output GET parameter you can get test results with a custom reporter.

Reporters generate the visible output from the test suite. There are two built in reporters: Text and Html. By default all web requests use the Html reporter. You can create your own reporters by creating files in your app/libs. For example you could create the file app/libs/test_suite/reporters/my_reporter.php and in it create the following:

require_once CAKE_TEST_LIB . 'reporter' . DS . 'cake_base_reporter.php';

class MyReporter extends CakeBaseReporter {
    //methods go here.
}

Extending CakeBaseReporter or one of its subclasses is not required, but strongly suggested as you may get missing errors otherwise. CakeBaseReporter encapsulates a few common test suite features such as test case timing and code coverage report generation. You can use your custom reporter by setting the output query string parameter to the reporter name minus ‚reporter‘. For the example above you would set output=my to use your custom reporter.

Test Reporter methods¶

Reporters have a number of methods used to generate the various parts of a Test suite response.

paintDocumentStart()

Paints the start of the response from the test suite. Used to paint things like head elements in an html page.

paintTestMenu()

Paints a menu of available test cases.

testCaseList()

Retrieves and paints the list of tests cases.

groupCaseList()

Retrieves and paints the list of group tests.

paintHeader()

Prints before the test case/group test is started.

paintPass()

Prints everytime a test case has passed. Use $this->getTestList() to get an array of information pertaining to the test, and $message to get the test result. Remember to call parent::paintPass($message).

paintFail()

Prints everytime a test case has failed. Remember to call parent::paintFail($message).

paintSkip()

Prints everytime a test case has been skipped. Remember to call parent::paintSkip($message).

paintException()

Prints everytime there is an uncaught exception. Remember to call parent::paintException($message). Prints everytime an error is raised. Remember to call parent::paintError($message).

paintFooter()

Prints when the test case/group test is over, i.e. when all test cases has been executed.

paintDocumentEnd()

Paints the end of the response from the test suite. Used to paint things like footer elements in an html page.

Grouping tests¶

If you want several of your test to run at the same time, you can try creating a test group. Create a file in /app/tests/groups/ and name it something like your_test_group_name.group.php. In this file, extend TestSuite and import test as follows:

<?php
class TryGroupTest extends TestSuite {
  var $label = 'try';
  function tryGroupTest() {
    TestManager::addTestCasesFromDirectory($this, APP_TEST_CASES . DS . 'models');
  }
}
?>

The code above will group all test cases found in the /app/tests/cases/models/ folder. To add an individual file, use TestManager::addTestFile($this, filename).