MiniTest v našem projektu v Ruby on Rails

25.9.2012 16:47 | Přečteno: 935× | Projekty | poslední úprava: 26.9.2012 12:20

Představím vám, jak  děláme unit testy v našem projektu v Ruby on Rails (Rails). Předpokládám, že víte, co je gem a fixtures;) Svůj rozporuplný názor na jazyk Ruby si nechám na závěr.

Motivace
Nedávno jsme začali dělat s kamarádem Petrem na našem dalším magickém projektu - Hlídačky.cz. Jedná se o veselý komunitní portál, kde si rodiče mohou najít někoho na hlídání dětí - hlídačku. Zatím máme jen informační stránku a nabíráme hlídačky. Portál spustíme do měsíce.

Oba už máme nějakou delší praxi v RoR, ale testy jsme moc nepoužívali. Přesto jsme si uvědomili, že u tohoto projektu je hlavním pilířem bezpečnost uživatelů a plynulý chod. Navíc jsme došli do fáze, kdy už člověk nestíhá sledovat, co dělal ten druhý nebo se nepamatuje celý kód.
A tady nám hodně pomohly testy. V drtivé většině případů nám odchytily chyby ještě dříve než jsme na ně sami narazili. Např. změna metody u modelu měla za následek 500 error u několika stránek (funkcionální testy).

MiniTest
Od Ruby verze 1.9 se sice používá Test::Unit, ale pod kapotou už fičí Minitest::Unit. Přesto stále můžete používat

require 'test/unit'

aniž byste něco museli přepisovat.

Pro integraci do Rails:

gem install minitest-rails

rails generate mini_test:install # vygeneruje minitest_helper.rb v adresáři test

A už můžeme psát test. Jako příklad jsem si vybral test modelu Sitter. Hlídačkám říkáme sitterky:)
Zábava začíná se syntaxí MiniTestu (MiniTest::Spec), který se liší od Test::Unit. Syntax MiniTestu je nicméně volitelná a stále se mohou používat asserty.

Test::Unit

assert_equal 10, Array.new(10).size

MiniTest::Unit MiniTest::Spec

Array.new(10).size.must_equal 10

Věřím, že tento příklad zaujmul mnohé honiče nad syntaxí nebo lidi co viděli Cucumber:)

Vytvoříme první tes v test/unit/sitter_test.rb

require 'minitest_helper'

 

class SitterTest < MiniTest::Rails::ActiveSupport::TestCase

  test "friends_that_used_sitter" do

    parent = parents :parent_sandra # nacteme rodice z fixtures

    sitter = sitters :sitter_will # nacteme hlidacku

    sitter.friends_they_used_her(parent).must_equal [parents(:parent_petr)]

    parent = parents :parent_sandra

    sitter = sitters :sitter_rick

    sitter.friends_they_used_her(parent).must_be_empty

  end

end

Na prvním řádku se nastavuje testovací prostředí včetně fixtures. Potom si vytvořime test modelu Sitter pomocí třídy MiniTest::Rails::ActiveSupport::TestCase. Zatím obsahuje jen jednu metodu. Ta testuje metodu friends_they_used_her modelu Sitter. V tomto konkrétním příkladě se zeptáme hlídačky Willa, jakým kamarádům rodiče Sandry, hlídala děti. Ano, naše hlídačka má trochu divné jméno Will. Will hlídal pouze Petrovi, který je kamarád Sandry. Proto testujeme, zda-li je tomu tak.

V druhém případě se ptáme Hlídačky Ricka, jestli hlídal děti nějakému kamarádovi Sandry. On nehlídal nikomu. Na témeř posledním řádku se ujištujeme, že pole kamarádů je prázdné.

Pro spuštění všech unit testů:

rake test:units

Osobně mi přišel výstup málo veselý a silně doporučuju odkomentovat jeden řádek v test/minitest_helper.rb

require "minitest/pride"

Vůbec bych nevěřil, že tak málo barviček může vnést do mého života tolik radosti.

Tohle byl pouze jeden z příkladů. Testů tam máme samozřejmě více:) Lehkým nedostatkem je, že testovací data máme ve fixtures. Může se stát, že do fixtures přidáme dalšího rodiče, který bude kamarád se Sandrou. Touto nevinnou úpravou už se nám ale pokazí testy.

Bohužel vytvářet všechna data za běhu testu v metodě setup mi přijde zase redundantní, protože rodiče potřebujeme nakonfigurovat i ve funkcionálních testech.

Co používáte vy na unit testy v Rails?

Poznámka na konec:

Osobně bych šel do staticky typovaného jazyka s odvozováním typů, abychom se vyhli těm nejtriviálnějším chybám. Potom co jsem přečetl knihu Metaprogramming Ruby, často mívám deprese z DuckTypingu a strach z toho, co mi za objekt přijde jako paramater metody. Bude to mít metodu, co potřebuju? Bude ji mít i po spuštění tohoto příkazu? Má smysl žít ve světě, který je postaven na konvencích?

Na druhou stranu Ruby má gem skoro na všechno a ušetří moře času, syntax s underscores je nádherná a přehledná, každý problém už řešil někdo přede mnou (google). Komunita je taky velká a veselá.

PS: hledáme veselé mamky z Brna, které bychom chtěli pozvat na kafe a ukázat jim to. Potřebujeme si s někým popovídat, abychom vědeli, co tam máme změnit, vylepšit atd. Kdybyste o někom věděli, dejte mu odkaz na Hlídačky.cz.

       

Komentáře

[Radek Miček]

Osobně bych šel do staticky typovaného jazyka s odvozováním typů, abychom se vyhli těm nejtriviálnějším chybám.

Statický typový systém může odhalit docela dost chyb – cituji z popisu jazyka Ur/Web, který je určen pro tvorbu spolehlivých webových aplikací:

The signature of the standard library is such that well-typed Ur/Web programs "don't go wrong" in a very broad sense. Not only do they not crash during particular page generations, but they also may not:

• Suffer from any kinds of code-injection attacks
• Return invalid HTML
• Contain dead intra-application links
• Have mismatches between HTML forms and the fields expected by their handlers
• Include client-side code that makes incorrect assumptions about the "AJAX"-style services that the remote web server provides
• Attempt invalid SQL queries
• Use improper marshaling or unmarshaling in communication with SQL databases or between browsers and web servers

[dejvik]

Ač to vypadá zajímavě, je to teprve na začátku. Jen dva díly tutoriálu, reference manuál nejde. Osobně bych potřeboval knihovnu pro napojení na Facebook, něco jako ORM atd. To univerzum knihoven je příliš malé.

[Radek Miček]

Mně referenční manuál funguje. Několik článků o jazyku Ur/Web napsal tento rok E. Z. Yang ve svém blogu.

Jazyk Ur/Web jsem uvedl hlavně jako příklad toho, co je možné udělat. Více knihoven je k dispozici pro jazyk Haskell a framework Yesod nebo pro jazyk OCaml a framework Ocsigen. Nicméně Ur/Web má silnější typový systém s IMO velmi atraktivním pojetím záznamů.

[phax7]

Ten HelloWorld ocsigenu nevypadá z nejpřívětivějších:) Ale to je taky tím že už jsem spoustu let zvyklý na jiné jazyky...

http://ocsigen.org/howto/helloworld

[Radek Miček]

Může to být i kratší:

open Lwt
open Eliom_content.Html5.D
open Eliom_service
open Eliom_parameter
open Eliom_registration.Html5

let main_service =
  register_service ~path:["hello"] ~get_params:unit
    (fun () () -> return (html (head (title (pcdata "Hello World of Ocsigen")) [])
                               (body [h1 [pcdata "Hello World!"]])))

[lmb]

Hello world v Happstacku (Haksell)

import Happstack.Server

main = simpleHTTP nullConf $ ok "Hello, World!"

[lmb]

s/Haksell/Haskell/

[nyan]

Statický typový systém může odhalit docela dost chyb

Nebo taky nemusi. Pokazde kdyz udelate

void x(void *p) {
  ...
  some_struct* t = (some_struct*)p;
  ...
}

...jde type checking do pr...kenny vohrady.

[pavlix]

Suffer from any kinds of code-injection attacks

To by se ten jazyk musel ale používat na všechno a řetězce v něm být pouhé texty, ne kód jako například SQL příkazy nebo javascript a kvůli některým vlastnostem by to v podstatě nemělo být ani HTML.

To už by mi přišlo jako docela hezký framework. Nicméně s těmito vlastnostmi přichází neflexibilita. Tudíž je ten jazyk prakticky bez šance získat výrazný podíl na webových aplikacích a je vhodný jen pro určitou škálu projektů.

[Radek Miček]

To by se ten jazyk musel ale používat na všechno a řetězce v něm být pouhé texty

Ano, on se používá na všechno – generuje se z něj C kód pro server, SQL pro databázi, HTML a JavaScript pro klienta.

[pavlix]

Pak tedy viz druhý odstavec.

[stanger]

Jako nekolikanasobne certifikovany Javista jeste starym dobrym Sunem si myslim, ze ta deprese brzo prejde (sam jsem si ten prechod na Ruby a Rails prozil). Jinak doporocuju v Rails drzet pokryti co nejbliz 100% prave z podobnych obav (u Javy jsem par % dole toleroval).

Pro testovani pouzivam kombinaci Cucumber a FactoryGirl. Ajax testuju Watirem.

[retroslava]

Array.new(10).size.must_equal 10 není MiniTest::Unit ale MiniTest::Spec. assert právě naopak je součást MiniTest::Unit. To musí vypadat ta aplikace teda, když netušíte ani takovýhle základní fakt. Snad se v tom kolega vyzná líp.

[phpGuru]

u technickeho clanku povazuji takove osobni invektivy v diskuzi za kontraproduktivni.

Prosim vysvetlete problematiku a upozornete klidne na nejake chyby, ale to jestli nejaky kolega nejakeho autora je takovy nebo makovy nevede opravdu k nicemu. Ja kdyz uz si dam tu praci a ctu nejakou diskuzi, tak se chci neco dozvedet a ne se prodirat mnozstvim narcistickych komentaru.

Nekomentuji casto, ale tohle me opravdu nadzvedlo. Chapu , ze kdyz jsou zde blogy s nejakou politickou tematikou, tak ze se vede polemicka a afektovana diskuze, ale v takovehle atmosfere aby se nejaky autor bal neco referovat o sve praci.

Dekuji.

[retroslava]

To já si jen vylévám dušičku. Zaráží mě když se někdo odváží publikovat jak něco udělal, když o tom asi nemá moc tušení. Potom si ten článek někdo přečte a nebere z něho moudra, která jsou naprosté blbosti. S takovýma lidma se potom běžně setkávám v práci a snaží se mě přesvědčit že já jsem ten neznalý.

MiniTest::Spec je standardní součást minitestu. Je to jen oslazená syntaxe normálního MiniTest::Unit a uvnitř se stejně používá klasický assert. Normálně dál převažují klasícké testy přes asserty. Je to takovej kompromis mezi syntaxí RSpecu a MiniTestu. Zajímavější než tohle lepení zbytečností na hlavní objekt je fakt, že se tyhle styly můžou kombinovat. Hlavně to, že můžeme používat describe a it pro "okomentování testů" a uvnitř použít klasický assert. Tahle možnost se mi líbí pro integrační testy a hojně jí využívám.

Jinak jako důkaz se můžete podívat na testy Rails. Ačkoliv jsou všechny přepsány do MiniTestu, používají klasický assert (schválně).

Lepší?

[dejvik]

Máte pravdu. Tušil jsem, že tam budu mít chyby; bylo to psáno v rychlosti:)  "must_equal" je v
MiniTest::Spec a ne v MiniTest::Unit. Opravím to.