Tesztvezérelt fejlesztés: mi ez, és mi nem.

Programozás

A tesztvezérelt fejlesztés az utóbbi években népszerűvé vált. Sok programozó kipróbálta ezt a technikát, kudarcot vallott, és arra a következtetésre jutott, hogy a TDD nem éri meg a szükséges erőfeszítéseket.

Egyes programozók úgy gondolják, hogy elméletileg ez egy jó gyakorlat, de soha nincs elég idő a TDD valóban használatára. És mások azt gondolják, hogy ez alapvetően időpazarlás.

Ha így érez, azt hiszem, talán nem érti, mi is a TDD valójában. (OK, az előző mondat arra hívta fel a figyelmét). Van egy nagyon jó könyv a TDD-ről, a Test Driven Development: Például, Kent Beck, ha meg akarja nézni és többet szeretne megtudni.

Ebben a cikkben áttekintem a tesztalapú fejlesztés alapjait, foglalkozva a TDD technikával kapcsolatos általános tévhitekkel. Ez a cikk az első a számos cikk közül, amelyeket közzé fogok tenni, a tesztvezérelt fejlesztésről.

Miért érdemes használni a TDD-t?

Tanulmányok, dolgozatok és viták folynak arról, hogy mennyire hatékony a TDD. Annak ellenére, hogy feltétlenül hasznos néhány szám, nem hiszem, hogy megválaszolnák azt a kérdést, hogy miért is kellene először a TDD-t használni.

Mondja, hogy Ön webfejlesztő. Most fejeztél be egy kis funkciót. Elégnek tartja-e ezt a funkciót kipróbálni, csak manuális interakcióval a böngészővel? Nem hiszem, hogy elég csak a fejlesztők által manuálisan elvégzett tesztekre hagyatkozni. Sajnos ez azt jelenti, hogy a kód egy része nem elég jó.

De a fenti szempont a tesztelésre vonatkozik, nem pedig magára a TDD-re. Akkor miért TDD? A rövid válasz: "mert ez a legegyszerűbb módszer a jó minőségű kód és a jó teszt lefedettség elérésére".

A hosszabb válasz abból adódik, hogy mi is a TDD valójában ... Kezdjük a szabályokkal.

Játékszabályok

Bob bácsi három szabálysal írja le a TDD-t:

- Csak akkor írhat gyártási kódot, ha hibás egységtesztet kell elvégeznie. - Nem írhat többet egységnyi tesztből, mint amennyi a kudarchoz elegendő; és az összeállítási hibák kudarcok. - Nem írhat többet gyártási kódot, mint amennyi elegendő az egy meghibásodott egység teszt teljesítéséhez.

Tetszik egy rövidebb verzió is, amelyet itt találtam:

- Csak annyit írjon, hogy kudarcot valljon. - Csak annyi gyártási kódot írjon, hogy a hibás egység tesztje sikeres legyen.

Ezek a szabályok egyszerűek, de a TDD-hez közeledő emberek gyakran megsértenek egyet vagy többet. Kihívom önt: írhat-e egy kis projektet, szigorúan ezeket a szabályokat betartva? Kis projekt alatt valami valósat értek, nem csak egy példát, amelyhez 50 kódsor szükséges.

Ezek a szabályok meghatározzák a TDD mechanikáját, de biztosan nem minden, amit tudnod kell. Valójában a TDD használatának folyamatát gyakran vörös / zöld / refaktor ciklusként írják le. Lássuk, miről van szó.

Red Green Refactor ciklus

Vörös fázis

A piros fázisban tesztet kell írnia arról a viselkedésről, amelyet végrehajtani készül. Igen, viselkedést írtam . A teszt alapú fejlesztésben a „teszt” szó félrevezető. Először „Viselkedésvezérelt fejlődésnek” kellett volna neveznünk. Igen, tudom, egyesek azzal érvelnek, hogy a BDD eltér a TDD-től, de nem tudom, hogy egyetértek-e. Tehát az egyszerűsített meghatározásomban BDD = TDD.

Itt egy általános tévhit következik: „Először írok egy osztályt és egy metódust (de nincs megvalósítás), majd írok egy tesztet az osztály módszerének tesztelésére”. Valójában nem így működik.

Tegyünk egy lépést hátra. Miért követeli meg a TDD első szabálya, hogy tesztet kell írni, mielőtt bármilyen darab gyártási kódot megírna? TDD embermániások vagyunk?

Az RGR ciklus minden fázisa egy fázist jelent a kód életciklusában, és azt, hogy hogyan viszonyulhat hozzá.

A piros fázisban úgy viselkedsz, mintha egy igényes felhasználó lennél, aki a készülő kódot a lehető legegyszerűbb módon szeretné használni. Olyan tesztet kell írnia, amely egy kóddarabot használ, mintha már megvalósították volna. Felejtsd el a megvalósítást! Ha ebben a szakaszban azon gondolkodik, hogyan fogja írni a gyártási kódot, akkor rosszul teszi!

Ebben a szakaszban koncentrál egy tiszta felület megírására a jövőbeni felhasználók számára. Ebben a szakaszban tervezi meg, hogyan fogják használni a kódot az ügyfelek.

Ez az első szabály a legfontosabb, és ez a szabály különbözteti meg a TDD-t a rendszeres teszteléstől. Írsz egy tesztet, hogy aztán megírd a gyártási kódot. Nem írsz tesztet a kódod tesztelésére.

Nézzünk meg egy példát.

// LeapYear.spec.jsdescribe('Leap year calculator', () => { it('should consider 1996 as leap', () => { expect(LeapYear.isLeap(1996)).toBe(true); });});

A fenti kód egy példa arra, hogyan nézhet ki egy teszt a JavaScript-ben, a Jasmine tesztelési keretrendszer használatával. Nem kell ismernie Jázmint - elég megérteni, hogy it(...)ez egy teszt, és expect(...).toBe(...)egy módja annak, hogy a Jázmint ellenőrizze, hogy valami a vártnak felel-e meg.

A fenti tesztben ellenőriztem, hogy a függvény LeapYear.isLeap(...)visszatér- truee az 1996-os évre. Gondolhatja, hogy 1996 mágikus szám, és ezért rossz gyakorlat. Ez nem. A tesztkódban a mágikus számok jók, míg a gyártási kódban kerülni kell őket.

Ennek a tesztnek valóban van néhány következménye:

  • A szökőév kalkulátorának neve: LeapYear
  • isLeap(...)statikus módszere LeapYear
  • isLeap(...)egy számot (és nem egy tömböt vesz fel) argumentumként, és a truevagy false.

Ez egy teszt, de valójában sok következménye van! Szükségünk van-e olyan módszerre, amellyel meg tudjuk állapítani, hogy egy év szökőév-e, vagy olyan módszerre van szükségünk, amely visszaadja a szökőévek listáját a kezdő és a befejező dátum között? Jelentős az elemek neve? Ezeket a kérdéseket kell szem előtt tartania, amikor teszteket ír a vörös fázisban.

Ebben a szakaszban döntéseket kell hoznia a kód felhasználásának módjáról. Ezt arra alapozza, amire valóban szüksége van jelenleg, és nem arra, amire Ön szerint szükség lehet.

Itt jön egy másik hiba: ne írjon egy csomó olyan funkciót / osztályt, amelyre úgy gondolja, hogy szüksége lehet. Koncentráljon a megvalósított funkcióra és arra, amire valóban szükség van. Olyan dolgok megírása, amelyekhez a funkció nem szükséges, túlméretes.

Mi van az absztrakcióval? Ezt később látni fogjuk, a refaktor szakaszában.

Zöld fázis

This is usually the easiest phase, because in this phase you write (production) code. If you are a programmer, you do that all the time.

Here comes another big mistake: instead of writing enough code to pass the red test, you write all the algorithms. While doing this, you are probably thinking about what is the most performing implementation. No way!

In this phase, you need to act like a programmer who has one simple task: write a straightforward solution that makes the test pass (and makes the alarming red on the test report becomes a friendly green). In this phase, you are allowed to violate best practices and even duplicate code. Code duplication will be removed in the refactor phase.

But why do we have this rule? Why can’t I write all the code that is already in my mind? For two reasons:

  • A simple task is less prone to errors, and you want to minimize bugs.
  • You definitely don’t want to mix up code which is under testing with code that is not. You can write code that is not under testing (aka legacy), but the worst thing you can do is mixing up tested and untested code.

What about clean code? What about performance? What if writing code makes me discover a problem? What about doubts?

Performance is a long story, and is out of the scope of this article. Let’s just say that performance tuning in this phase is, most of the time, premature optimization.

The test driven development technique provides two others things: a to-do list and the refactor phase.

The refactor phase is used to clean up the code. The to-do list is used to write down the steps required to complete the feature you are implementing. It also contains doubts or problems you discover during the process. A possible to-do list for the leap year calculator could be:

Feature: Every year that is exactly divisible by four is a leap year, except for years that are exactly divisible by 100, but these centurial years are leap years if they are exactly divisible by 400.
- divisible by 4- but not by 100- years divisible by 400 are leap anyway
What about leap years in Julian calendar? And years before Julian calendar?

The to-do list is live: it changes while you are coding and, ideally, at the end of the feature implementation it will be blank.

Refactor phase

In the refactor phase, you are allowed to change the code, while keeping all tests green, so that it becomes better. What “better” means is up to you. But there is something mandatory: you have to remove code duplication. Kent Becks suggests in his book that removing code duplication is all you need to do.

In this phase you play the part of a picky programmer who wants to fix/refactor the code to bring it to a professional level. In the red phase, you’re showing off your skills to your users. But in the refactor phase, you’re showing off your skills to the programmers who will read your implementation.

Removing code duplication often results in abstraction. A typical example is when you move two pieces of similar code into a helper class that works for both the functions/classes where the code has been removed.

For example the following code:

class Hello { greet() { return new Promise((resolve) => { setTimeout(()=>resolve('Hello'), 100); }); }}class Random { toss() { return new Promise((resolve) => { setTimeout(()=>resolve(Math.random()), 200); }); }}new Hello().greet().then(result => console.log(result));new Random().toss().then(result => console.log(result));

could be refactored into:

class Hello { greet() { return PromiseHelper.timeout(100).then(() => 'hello'); }}class Random { toss() { return PromiseHelper.timeout(200).then(() => Math.random()); }}class PromiseHelper { static timeout(delay) { return new Promise(resolve => setTimeout(resolve, delay)); }}const logResult = result => console.log(result);new Hello().greet().then(logResult);new Random().toss().then(logResult);

As you can see, in order to remove thenew Promise and setTimeout code duplication, I created a PromiseHelper.timeout(delay) method, which serves both Hello and Random classes.

Just keep in mind that you cannot move to another test unless you’ve removed all the code duplication.

Final considerations

In this section I will try to answer to some common questions and misconceptions about Test Drive Development.

  • T.D.D. requires much more time than “normal” programming!

What actually requires a lot of time is learning/mastering TDD as well as understanding how to set up and use a testing environment. When you are familiar with the testing tools and the TDD technique, it actually doesn’t require more time. On the contrary, it helps keep a project as simple as possible and thus saves time.

  • How many test do I have to write?

The minimum amount that lets you write all the production code. The minimum amount, because every test slows down refactoring (when you change production code, you have to fix all the failing tests). On the other hand, refactoring is much simpler and safer on code under tests.

  • With Test Driven Development I don’t need to spend time on analysis and on designing the architecture.

This cannot be more false. If what you are going to implement is not well-designed, at a certain point you will think “Ouch! I didn’t consider…”. And this means that you will have to delete production and test code. It is true that TDD helps with the “Just enough, just in time” recommendation of agile techniques, but it is definitely not a substitution for the analysis/design phase.

  • Should test coverage be 100%?

No. As I said earlier, don’t mix up tested and untested code. But you can avoid using TDD on some parts of a project. For example I don’t test views (although a lot of frameworks make UI testing easy) because they are likely to change often. I also ensure that there is very a little logic inside views.

  • I am able to write code with very a few bugs, I don’t need testing.

You may able to to that, but is the same consideration valid for all your team members? They will eventually modify your code and break it. It would be nice if you wrote tests so that a bug can be spotted immediately and not in production.

  • TDD works well on examples, but in a real application a lot of the code is not testable.

I wrote a whole Tetris (as well as progressive web apps at work) using TDD. If you test first, code is clearly testable. It is more a matter of understanding how to mock dependencies and how to write simple but effective tests.

  • Tests should not be written by the developers who write the code, they should be written by others, possibly QA people.

If you are speaking about testing your application, yes it is a good idea to ask other people to test what your team did. If you are speaking about writing production code, then that’s the wrong approach.

What’s next?

This article was about the philosophy and common misconceptions of TDD. I am planning to write other articles on TDD where you will see a lot of code and fewer words. If you are interested on how to develop Tetris using TDD, stay tuned!