Zend_Test-PHPUnit-Db-Quickstart.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.test.phpunit.db.quickstart">
  5. <title>Quickstart</title>
  6. <sect3 id="zend.test.phpunit.db.quickstart.testcase">
  7. <title>Einen Datenbank TestCase erstellen</title>
  8. <para>
  9. Wir schreiben jetzt einige Datenbank Tests für das Bug Datenbank Beispiel in der
  10. Dokumentation von <classname>Zend_Db_Table</classname>. Zuerst beginnen wir zu
  11. Testen ob ein neuer Bug der eingefügt wird, in der Datenbank auch wirklich korrekt
  12. abgespeichert wird. Zuerst müssen wir eine Test-Klasse erstellen die
  13. <classname>Zend_Test_PHPUnit_DatabaseTestCase</classname> erweitert. Diese Klasse
  14. erweitert die Datenbank Erweiterung von PHPUnit, welche Ihrerseits den standardmäßigen
  15. Basis <classname>PHPUnit_Framework_TestCase</classname> erweitert. Ein Datenbank
  16. Testcase enthält zwei abstrakte Methoden die implementiert werden müssen, eine für die
  17. Datenbank Verbindung und eine für das initiale Datenset das als Seed oder Fixum
  18. verwendet werden soll.
  19. </para>
  20. <note>
  21. <para>
  22. Man sollte mit der PHPUnit Datenbank Erweiterung vertraut sein um diesem
  23. Quickstart einfach folgen zu können. Auch wenn diese Konzepte in dieser
  24. Dokumentation beschrieben werden, kann es hilfreich sein zuerst die Dokumentation
  25. von PHPUnit zu lesen.
  26. </para>
  27. </note>
  28. <programlisting language="php"><![CDATA[
  29. class BugsTest extends Zend_Test_PHPUnit_DatabaseTestCase
  30. {
  31. private $_connectionMock;
  32. /**
  33. * Returns the test database connection.
  34. *
  35. * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
  36. */
  37. protected function getConnection()
  38. {
  39. if($this->_connectionMock == null) {
  40. $connection = Zend_Db::factory(...);
  41. $this->_connectionMock = $this->createZendDbConnection(
  42. $connection, 'zfunittests'
  43. );
  44. Zend_Db_Table_Abstract::setDefaultAdapter($connection);
  45. }
  46. return $this->_connectionMock;
  47. }
  48. /**
  49. * @return PHPUnit_Extensions_Database_DataSet_IDataSet
  50. */
  51. protected function getDataSet()
  52. {
  53. return $this->createFlatXmlDataSet(
  54. dirname(__FILE__) . '/_files/bugsSeed.xml'
  55. );
  56. }
  57. }
  58. ]]></programlisting>
  59. <para>
  60. Hier erstellen wir die Datenbankverbindung und setzt einige Daten in die Datenbank.
  61. Einige wichtige Details über diesen Code sollten notiert werden:
  62. </para>
  63. <itemizedlist>
  64. <listitem>
  65. <para>
  66. Man kann ein <classname>Zend_Db_Adapter_Abstract</classname> nicht direkt von
  67. der <methodname>getConnection()</methodname> Methode erhalten, aber einen
  68. PHPUnit spezifischen Wrapper welcher mit der Methode
  69. <methodname>createZendDbConnection()</methodname> erstellt wird.
  70. </para>
  71. </listitem>
  72. <listitem>
  73. <para>
  74. Das Datenbank Schema (Tabellen und Datenbank) wird nicht bei jedem Testlauf
  75. wieder erstellt. Die Datenbank und die Tabellen müssen manuell erstellt werden
  76. bevor die Tests aufgeführt werden.
  77. </para>
  78. </listitem>
  79. <listitem>
  80. <para>
  81. Datenbank Tests schneiden standardmäßig die Daten während
  82. <methodname>setUp()</methodname> ab und fügen anschließend die Seed Daten ein,
  83. welche von der Methode <methodname>getDataSet()</methodname> zurückgegeben
  84. werden.
  85. </para>
  86. </listitem>
  87. <listitem>
  88. <para>
  89. DataSets müssen das Interface
  90. <classname>PHPUnit_Extensions_Database_DataSet_IDataSet</classname>
  91. implementieren. Es gibt eine Vielzahl an Typen von <acronym>XML</acronym> und
  92. YAML Konfigurationsdateien die in PHPUnit enthalten sind, welche es erlauben zu
  93. spezifizieren wie Tabellen und Datensätze auszusehen haben und man sollte in die
  94. Dokumentation von PHPUnit schauen um die aktuellsten Informationen über die
  95. Spezifikation diese Datensets zu erhalten.
  96. </para>
  97. </listitem>
  98. </itemizedlist>
  99. </sect3>
  100. <sect3 id="zend.test.phpunit.db.quickstart.dataset">
  101. <title>Einen Seed Datensatz spezifizieren</title>
  102. <para>
  103. Im vorhergehenden Setup für den Datenbank Testcase haben wir eine Seed Datei für das
  104. Datenbank Fixum spezifiziert. Jetzt erstellen wir diese Datei im spezifizierten
  105. Flat <acronym>XML</acronym> Format:
  106. </para>
  107. <programlisting language="xml"><![CDATA[
  108. <?xml version="1.0" encoding="UTF-8" ?>
  109. <dataset>
  110. <zfbugs bug_id="1" bug_description="system needs electricity to run"
  111. bug_status="NEW" created_on="2007-04-01 00:00:00"
  112. updated_on="2007-04-01 00:00:00" reported_by="goofy"
  113. assigned_to="mmouse" verified_by="dduck" />
  114. <zfbugs bug_id="2" bug_description="Implement Do What I Mean function"
  115. bug_status="VERIFIED" created_on="2007-04-02 00:00:00"
  116. updated_on="2007-04-02 00:00:00" reported_by="goofy"
  117. assigned_to="mmouse" verified_by="dduck" />
  118. <zfbugs bug_id="3" bug_description="Where are my keys?" bug_status="FIXED"
  119. created_on="2007-04-03 00:00:00" updated_on="2007-04-03 00:00:00"
  120. reported_by="dduck" assigned_to="mmouse" verified_by="dduck" />
  121. <zfbugs bug_id="4" bug_description="Bug no product" bug_status="INCOMPLETE"
  122. created_on="2007-04-04 00:00:00" updated_on="2007-04-04 00:00:00"
  123. reported_by="mmouse" assigned_to="goofy" verified_by="dduck" />
  124. </dataset>
  125. ]]></programlisting>
  126. <para>
  127. Wir arbeiten mit diesen vier Einträgen, der Datenbank Tabelle "zfbugs", im nächsten
  128. Beispiel. Das benötigte MySQL Schema für dieses Beispiel ist:
  129. </para>
  130. <programlisting language="sql"><![CDATA[
  131. CREATE TABLE IF NOT EXISTS `zfbugs` (
  132. `bug_id` int(11) NOT NULL auto_increment,
  133. `bug_description` varchar(100) default NULL,
  134. `bug_status` varchar(20) default NULL,
  135. `created_on` datetime default NULL,
  136. `updated_on` datetime default NULL,
  137. `reported_by` varchar(100) default NULL,
  138. `assigned_to` varchar(100) default NULL,
  139. `verified_by` varchar(100) default NULL,
  140. PRIMARY KEY (`bug_id`)
  141. ) ENGINE=InnoDB AUTO_INCREMENT=1 ;
  142. ]]></programlisting>
  143. </sect3>
  144. <sect3 id="zend.test.phpunit.db.quickstart.initial-tests">
  145. <title>Einige initiale Datenbank Tests</title>
  146. <para>
  147. Jetzt, da wie die zwei benötigten Abstrakten Methoden von
  148. <classname>Zend_Test_PHPUnit_DatabaseTestCase</classname> implementiert, und den
  149. Datenbank Inhalt des Seeds spezifiziert haben, der für jeden neuen Test wieder erzeugt
  150. wird, können wir dazu übergehen unsere erste Annahme zu treffen. Das wird ein Test um
  151. einen neuen Fehler einzufügen.
  152. </para>
  153. <programlisting language="php"><![CDATA[
  154. class BugsTest extends Zend_Test_PHPUnit_DatabaseTestCase
  155. {
  156. public function testBugInsertedIntoDatabase()
  157. {
  158. $bugsTable = new Bugs();
  159. $data = array(
  160. 'created_on' => '2007-03-22 00:00:00',
  161. 'updated_on' => '2007-03-22 00:00:00',
  162. 'bug_description' => 'Something wrong',
  163. 'bug_status' => 'NEW',
  164. 'reported_by' => 'garfield',
  165. 'verified_by' => 'garfield',
  166. 'assigned_to' => 'mmouse',
  167. );
  168. $bugsTable->insert($data);
  169. $ds = new Zend_Test_PHPUnit_Db_DataSet_QueryDataSet(
  170. $this->getConnection()
  171. );
  172. $ds->addTable('zfbugs', 'SELECT * FROM zfbugs');
  173. $this->assertDataSetsEqual(
  174. $this->createFlatXmlDataSet(dirname(__FILE__)
  175. . "/_files/bugsInsertIntoAssertion.xml"),
  176. $ds
  177. );
  178. }
  179. }
  180. ]]></programlisting>
  181. <para>
  182. Jetzt sieht ab <methodname>$bugsTable->insert($data);</methodname> alles wie gewohnt
  183. aus. Die Zeilen danach enthalten den Assertion Methodennamen. Wir wollen prüfen ob, nach
  184. dem Einfügen des neuen Fehlers, die Datenbank richtig mit den angegebenen Daten
  185. aktualisiert wurde. Hierfür erstellen wir eine Instanz von
  186. <classname>Zend_Test_PHPUnit_Db_DataSet_QueryDataSet</classname> und geben Ihr eine
  187. Datenbank Verbindung an. Dann sagen wir diesem Datenbank das er eine Tabelle "zfbugs"
  188. enthält welche durch ein <acronym>SQL</acronym> Statement angegeben wird. Der aktuelle
  189. Status der Datenbank wird mit dem erwarteten Datenbank Status vergleichen der in der
  190. anderen <acronym>XML</acronym> Datei "bugsInsertIntoAssertions.xml" enthalten ist.
  191. Diese <acronym>XML</acronym> Datei ist eine leichte Abwandlung von der oben angegeben,
  192. und enthält eine weitere Zeile mit den erwarteten Daten:
  193. </para>
  194. <programlisting language="xml"><![CDATA[
  195. <?xml version="1.0" encoding="UTF-8" ?>
  196. <dataset>
  197. <!-- previous 4 rows -->
  198. <zfbugs bug_id="5" bug_description="Something wrong" bug_status="NEW"
  199. created_on="2007-03-22 00:00:00" updated_on="2007-03-22 00:00:00"
  200. reported_by="garfield" assigned_to="mmouse" verified_by="garfield" />
  201. </dataset>
  202. ]]></programlisting>
  203. <para>
  204. Es gibt andere Wege um anzunehmen das der aktuelle Datenbank Status mit dem erwarteten
  205. Status gleich ist. Die Tabelle "Bugs" im Beispiel weiss bereits eine Menge über Ihren
  206. internen Status, warum dass also nicht zu unserem Vorteil nutzen? Das nächste Beispiel
  207. nimmt an dass das Löschen von der Datenbank möglich ist:
  208. </para>
  209. <programlisting language="php"><![CDATA[
  210. class BugsTest extends Zend_Test_PHPUnit_DatabaseTestCase
  211. {
  212. public function testBugDelete()
  213. {
  214. $bugsTable = new Bugs();
  215. $bugsTable->delete(
  216. $bugsTable->getAdapter()->quoteInto("bug_id = ?", 4)
  217. );
  218. $ds = new Zend_Test_PHPUnit_Db_DataSet_DbTableDataSet();
  219. $ds->addTable($bugsTable);
  220. $this->assertDataSetsEqual(
  221. $this->createFlatXmlDataSet(dirname(__FILE__)
  222. . "/_files/bugsDeleteAssertion.xml"),
  223. $ds
  224. );
  225. }
  226. }
  227. ]]></programlisting>
  228. <para>
  229. Wir haben hier ein Datenset
  230. <classname>Zend_Test_PHPUnit_Db_DataSet_DbTableDataSet</classname> erstellt, welches
  231. irgendweine Instanz von <classname>Zend_Db_Table_Abstract</classname> nimmt, und diese
  232. im Datenset mit Ihrem Tabellennamen hinzufügt, in diesem Beispiel "zfbugs". Man könnte
  233. mehrere Tabellen hinzufügen, indem die Methode <methodname>addTable()</methodname>
  234. verwendet wird, wenn man auf erwartete Datenbank Stati in mehr als einer Tabelle prüfen
  235. will.
  236. </para>
  237. <para>
  238. Hier haben wir nur eine Tabelle und prüfen auf den erwarteten Datenbank Status in
  239. "bugsDeleteAssertion.xml", welcher der originale Seed Datensatz ohne die Zeile mit der
  240. Id 4 ist.
  241. </para>
  242. <para>
  243. Da wir im vorhergehenden Beispiel nur geprüft haben ob die zwei spezifischen Tabellen
  244. (nicht Datensätze) identisch sind, sollten wir uns auch anschauen wie man annehmen kann
  245. dass zwei Tabellen identisch sind. Hierfür fügen wir einen weiteren Test in unseren
  246. TestCase hinzu, der das Verhalten beim Aktualisieren eines Datensets prüft.
  247. </para>
  248. <programlisting language="php"><![CDATA[
  249. class BugsTest extends Zend_Test_PHPUnit_DatabaseTestCase
  250. {
  251. public function testBugUpdate()
  252. {
  253. $bugsTable = new Bugs();
  254. $data = array(
  255. 'updated_on' => '2007-05-23',
  256. 'bug_status' => 'FIXED'
  257. );
  258. $where = $bugsTable->getAdapter()->quoteInto('bug_id = ?', 1);
  259. $bugsTable->update($data, $where);
  260. $rowset = $bugsTable->fetchAll();
  261. $ds = new Zend_Test_PHPUnit_Db_DataSet_DbRowset($rowset);
  262. $assertion = $this->createFlatXmlDataSet(
  263. dirname(__FILE__) . '/_files/bugsUpdateAssertion.xml'
  264. );
  265. $expectedRowsets = $assertion->getTable('zfbugs');
  266. $this->assertTablesEqual(
  267. $expectedRowsets, $ds
  268. );
  269. }
  270. }
  271. ]]></programlisting>
  272. <para>
  273. Hier haben wir den aktuellen Datenbank Status aus der Instanz eines
  274. <classname>Zend_Db_Table_Rowset_Abstract</classname>, in Verbindung mit der
  275. Instanz von <methodname>Zend_Test_PHPUnit_Db_DataSet_DbRowset($rowset)</methodname>
  276. erstellt, welche eine interne Daten-Repräsentation des Datensatzes erstellt. Das kann
  277. wiederum gegenüber anderen Daten-Tabellen verglichen werden indem die Annahme
  278. <methodname>$this->assertTablesEqual()</methodname> verwendet wird.
  279. </para>
  280. </sect3>
  281. </sect2>