31. Struktura testů pro Combiscript

Ilustrační obrázek k článku: Struktura testů pro Combiscript
Křížové testy v Combiscriptu ověřují shodu PHP a JS, slouží jako dokumentace a ukazují hranice kompatibility. Jak je správně strukturovat?

Proč potřebujeme jiné testy

Než začneme psát testovací skript, měli bychom si ujasnit, co od něj očekáváme.

Potřebujeme porovnat výsledky pro dva jazyky, takže nepůjde o unit testy v klasickém slova smyslu (a už vůbec ne o integrační). Tyto testy mají ještě jinou roli: ukazují, co lze použít - a co ne. Budou tedy sloužit nejen k testování, ale i jako jakýsi manuál. A protože porovnávají výsledky v PHP a JS, říkám jim křížové testy.

Jak bude stránka vypadat

Moje představa je stránka rozdělená na sekce (podle testovaných knihoven). V každé sekci bude tabulka se sloupci:

Taková struktura umožňuje rychle identifikovat odchylky i pochopit, proč vznikly

Datová struktura testů

Pro takové zobrazení potřebujeme jednotnou datovou strukturu. Testy budou rozdělené podle knihoven - každá knihovna bude mít své pole, v němž budou jednotlivé funkce, a u každé funkce seznam testů.

Takže například v sekci nm_Util bude asociativní pole, kde budou názvy jednotlivých testů. S tím ovšem přichází trochu problém, asociativní pole v PHP zakládáme pomocí [] v JS pomocí {}. Vypadá to, že zde budeme muset použít combisriptový komentářový přepínač, kód rozvětvit a například pro testy knihovny nm_util vznikne něco takového:

  1. <!-- --><?php
  2. "use strict";
  4. 0&&0<!--$_;/*
  5. $Tests['nm_Util'] = {};
  6. /*/
  7. $Tests['nm_Util'] = [];
  8. //*/
  10. $Tests['nm_Util']['nm_IsNumber'] = [Test1, Test2, Test3, ...];
  11. $Tests['nm_Util']['nm_Abs'] = [Test1, Test2, Test3, ...];
  12. ....

Kde v prvním řádku vidíme pro JS zakomentované přepnutí do PHP, abychom test mohli vkládat jak do JS tak do PHP scriptu. V druhém řádku vidíme use strict - nastavení strict modu pro JS,které se v PHP nijak neprojeví. Pak následuje deklarace asociativního pole pro každý jazyk. A pak v každém klíči tohoto pole jednotlivé testy.

Asi by se taková hlavička testovacího souboru přežít dala, ale moc hezké to není. Samozřejmě lze využít toho, že díky tomu, že PHP má jen jeden druh polí tak jej deklarovat nemusíme, a můžeme napsat jen:

  1. <!-- --><?php
  2. "use strict";
  4. 0&&0<!--$_;/*
  5. $Tests['nm_Util'] = {};
  6. //*/
  8. $Tests['nm_Util']['nm_IsNumber'] = [Test1, Test2, Test3, ...];
  9. $Tests['nm_Util']['nm_Abs'] = [Test1, Test2, Test3, ...];
  10. ....
PHP si s $Tests['nm_Util']['nm_IsNumber'] = .... poradí i když klíč nm_Util nebude předem definován. Ale nešlo by to zjednodušit ještě více? Kupodivu šlo. Klidně se můžeme combiscriptového přepínače zbavit a napsat i jen:
  1. <!-- --><?php
  2. "use strict";
  4. $Tests['nm_Util'] = [];
  6. $Tests['nm_Util']['nm_IsNumber'] = [Test1, Test2, Test3, ...];
  7. $Tests['nm_Util']['nm_Abs'] = [Test1, Test2, Test3, ...];
  8. ....

Teď se většina JS programátorů zděsí a začne protestovat. Tohle v JS nebude fungovat, pole [] přece v JS slouží k zápisu numerického pole a k zápisu asociativního pole slouží objekt {}. Ale to není úplná pravda. Každé pole je v JS i objektem a zdědilo od něj vlastnosti objektu, což jsou i stringové klíče. Rozdíl mezi polem [] je v PHP a v JS mnohem menší než se traduje a do obou lze zapisovat stringové klíče. A my tohoto budeme v našem kódu masivně využívat.

Pole [] lze v PHP i JS využít k ukládání stringových klíčů

String nebo funkce

Další rozhodnutí je, zda test zapisovat jako řetězec, nebo přímo jako anonymní funkci zapsanou v CombiScriptu. Zápis jako string bude potřebovat spouštění přes eval, u anonymní funkce je v PHP trochu problém s získáním zdrojového kódu funkce, který bychom museli vyparsovat ze zdrojového kódu. Nakonec se rozhoduji pro anonymní funkce. Součástí Combiscriptu budou např. i "reflection function" a ty by přes eval byly netestovatelné.

Výstupní funkce

Zbývá rozhodnout, jakou funkci použijeme pro výstup. Definuji, že budeme používat funkci Out. Tato funkce bude definována v PHP i v JS a vypíše výsledek testu do příslušného políčka tabulky.

Co všechno potřebujeme u testu za data

Každý test je tedy malý samostatný blok znalostí – a jeho struktura musí nést vše potřebné. Bude mít tři součásti

Podle těchto pravidel můžeme napsat testy pro několik našich prvních funkcí:

  1. <!-- --><?php
  2. "use strict";
  4. $Tests['nm_Util'] = [];
  6. $Tests['nm_Util']['nm_IsNumber'] = [
  7. [1, function()
  8. {
  9. Out(nm_IsNumber(5));
  10. }, 'Ověřuje, že kladné celé číslo je číslo'],
  12. [1, function()
  13. {
  14. Out(nm_IsNumber(-5));
  15. }, 'Ověřuje, že záporné celé číslo je číslo'],
  17. [1, function()
  18. {
  19. Out(nm_IsNumber(0));
  20. }, 'Ověřuje, že nula je číslo'],
  22. [1, function()
  23. {
  24. Out(nm_IsNumber(2.5));
  25. }, 'Ověřuje, že kladné desetinné číslo je číslo'],
  27. [1, function()
  28. {
  29. Out(nm_IsNumber(-2.5));
  30. }, 'Ověřuje, že záporné desetinné číslo je číslo'],
  32. [1, function()
  33. {
  34. Out(nm_IsNumber(.5));
  35. }, 'Ověřuje, že desetinné číslo s vynechanou úvodní nulou je číslo'],
  37. [1, function()
  38. {
  39. Out(nm_IsNumber(-.5));
  40. }, 'Ověřuje, že záporné desetinné číslo s vynechanou úvodní nulou je číslo'],
  42. [1, function()
  43. {
  44. Out(nm_IsNumber(3.21E4));
  45. }, 'Ověřuje, že číslo v exponenciálním tvaru je číslo'],
  47. [1, function()
  48. {
  49. Out(nm_IsNumber(-3.21E4));
  50. }, 'Ověřuje, že záporné číslo v exponenciálním tvaru je číslo'],
  52. [1, function()
  53. {
  54. Out(nm_IsNumber(3.21E-4));
  55. }, 'Ověřuje, že číslo s negativním exponentem je číslo'],
  57. [1, function()
  58. {
  59. Out(nm_IsNumber(-3.21E-4));
  60. }, 'Ověřuje, že záporné číslo s negativním exponentem je číslo'],
  62. [1, function()
  63. {
  64. Out(nm_IsNumber(-3.21e-4));
  65. }, 'Ověřuje, že se akceptuje malé "e" v exponenciálním tvaru'],
  67. [1, function()
  68. {
  69. Out(nm_IsNumber("123"));
  70. }, 'Ověřuje, že string obsahující číslo není číslo'],
  72. [1, function()
  73. {
  74. Out(nm_IsNumber([1]));
  75. }, 'Ověřuje, že pole není číslo']
  76. ];
  80. $Tests['nm_Util']['nm_IsAsInt'] = [
  81. [1, function()
  82. {
  83. Out(nm_IsAsInt(5));
  84. }, 'Ověřuje, že kladné celé číslo je celé číslo'],
  86. [1, function()
  87. {
  88. Out(nm_IsAsInt(-5));
  89. }, 'Ověřuje, že záporné celé číslo je celé číslo'],
  91. [1, function()
  92. {
  93. Out(nm_IsAsInt(5.0));
  94. }, 'Ověřuje, že celočíselný float je celé číslo'],
  96. [1, function()
  97. {
  98. Out(nm_IsAsInt(-5.0));
  99. }, 'Ověřuje, že záporný celočíselný float je celé číslo'],
  101. [1, function()
  102. {
  103. Out(nm_IsAsInt(0));
  104. }, 'Ověřuje, že nula je celé číslo'],
  106. [1, function()
  107. {
  108. Out(nm_IsAsInt(-0));
  109. }, 'Ověřuje, že minus nula je celé číslo'],
  111. [1, function()
  112. {
  113. Out(nm_IsAsInt(2.5));
  114. }, 'Ověřuje, že kladné desetinné číslo není celé číslo'],
  116. [1, function()
  117. {
  118. Out(nm_IsAsInt(-2.5));
  119. }, 'Ověřuje, že záporné desetinné číslo není celé číslo'],
  121. [1, function()
  122. {
  123. Out(nm_IsAsInt("123"));
  124. }, 'Ověřuje, že string obsahující číslo není celé číslo'],
  126. [1, function()
  127. {
  128. Out(nm_IsAsInt(9007199254740991.5));
  129. }, 'Ověřuje, že velké číslo s desetinnou částí se stále jeví jako integer (rozložení na číselné ose je už tak hrubé)'],
  131. [1, function()
  132. {
  133. Out(nm_IsAsInt(4.9999999999999995));
  134. }, 'Toto ještě není 5'],
  136. [1, function()
  137. {
  138. Out(nm_IsAsInt(4.9999999999999996));
  139. }, 'Toto už je 5']
  140. ];
  144. $Tests['nm_Util']['nm_Abs'] = [
  145. [1, function()
  146. {
  147. Out(nm_Abs(2.5));
  148. }, 'Ověřuje, že absolutní hodnota kladného čísla je to samé číslo'],
  150. [1, function()
  151. {
  152. Out(nm_Abs(-2.5));
  153. }, 'Ověřuje, že absolutní hodnota záporného čísla změní znaménko na kladné'],
  155. [1, function()
  156. {
  157. Out(nm_Abs(0));
  158. }, 'Ověřuje, že absolutní hodnota nuly je nula'],
  160. [1, function()
  161. {
  162. Out(nm_Abs("123"));
  163. }, 'Ověřuje, že pro nečíselný parametr se vyhodí chyba'],
  164. ];
  168. $Tests['nm_Util']['nm_Sign'] = [
  169. [1, function()
  170. {
  171. Out(nm_Sign(2.5));
  172. }, 'Ověřuje, že signum kladného čísla je +1'],
  174. [1, function()
  175. {
  176. Out(nm_Sign(-2.5));
  177. }, 'Ověřuje, že signum záporného čísla je -1'],
  179. [1, function()
  180. {
  181. Out(nm_Sign(0));
  182. }, 'Ověřuje, že signum nuly je 0'],
  184. [1, function()
  185. {
  186. Out(nm_Sign(-0));
  187. }, 'Ověřuje, že signum záporné nuly je také 0'],
  189. [1, function()
  190. {
  191. Out(nm_Sign("0"));
  192. }, 'Ověřuje, že pro nečíselný parametr se vyhodí chyba'],
  193. ];

Tyto křížové testy nejsou jen technickým nástrojem - jsou mapou kompatibility mezi PHP a JavaScriptem. Každý test dokumentuje chování, odhaluje odchylky a posiluje důvěru v polyglotní kód.

V příštích dílech si ukážeme, jak tyto testy automaticky spustit, porovnat výsledky a vygenerovat přehlednou HTML tabulku - a to jejich dvojnásobným spuštěním na serveru a v prohlížeči.

Předchozí