Pokročilé testy při autokonfiguraci

Než se vrhneme na psaní vlastních testů tak se ještě podíváme na tři vestavěné testy, které se do minulého dílu nevešly. Nejsou to všechny vestavěné testy které SCons obsahuje ale já jsem je v seriálu nezmínil. Vynechám testy které už jsou pro pokročilé SCons uživatele protože nemám v úmyslu probírat zde SCons tak do hloubky. Po prostudování toho seriálu by jste se měli stát dostatečně zruční ve SCons, abyjste ho mohli bezproblémů začít používat ve svých projektech.

Všechny tři testy si jsou dost podobné. SCons jimi předhodíme program jako řetězec a necháme ho zpracovat. Jednotlivé testy se liší pouze v tom jak daleko v jeho zpracování dojdem. Nejjednoduším případem je test TryCompile. Ten přeloží námi zadaný text v jazyku, který určuje koncovka souboru. Test na úspěšnou kompilaci se obvykle používá při psaní vlastních testů, ale dá se také použít pokud chceme otestovat něco složitějšího. Dobrý trik je používat direktivu C preprocesoru #error na kterou když překladač narazí tak přeruší překlad s chybou. Druhý parametr funkce TryCompile je koncovka souboru, kterou musíme uvést včetně tečky.

Zde si všimněte použití r""" syntaxe pro snadné víceřádkové řetězce v Pythonu. Je to nejjednoduší způsob jak zadat testovací C program do SConscruct.

fbsd8:/tmp> cat SConstruct
env = Environment()
conf = Configure(env)

print conf.TryCompile(r"""
#include <stdlib.h>
#ifdef NULL
#else
#error "NULL not defined"
#endif
""",'.C')

env=conf.Finish()
fbsd8:/tmp> scons -Q
1
scons: `.' is up to date.

Dalším stupněm je funkce TryLink. Ta program nejen přeloží, jako to dělá TryCompile, ale i slinkuje oproti knihovnám které jsou nadefinované v proměnné prostředí LIBS. Nepoužívá se to moc často, protože CheckLib případně jeho zlepšená varianta CheckLibWithHeader obvykle úplně dostačuje.

TryLink funkce je vhodná na ověření funkčnosti prostředí kompilátoru a používá se zejména při tvorbě uzavřeného softwaru, kde neděláme autodetekci jednotlivých komponent zda jsou k dispozici, protože víme dopředu jaké komponenty máme nainstalované a jen si před začátkem buildu zjistíme zda jsou funkční a zda máme všechno nastavené správně. Testovací program pak obsahuje odkazy na funkce z námi používaných knihoven - z každé stačí jedna. Jelikož se testovací program bude jen kompilovat a nikoliv spouštět není potřeba dbát na správnou posloupnost volání funkcí.

Pokud používáte překladač Clang tak si při psaní testovacích programů dejte pozor na jeho optimalizaci volání funkcí případně IPO. Ve zkratce jde o to, že pokud volaná funkce nemá deklarován postranní efekt a vrací hodnotu s kterou se dál nepracuje tak Clang volání této funkce vyoptimalizuje - volání se neprovede a funkce se ani nepřilinkuje. V tomto případě pak nezjistíme nic, protože test bude vždy úspěšný.

V tomto příkladu nejprve pomocí CheckLib najdeme knihovnu OpenSSL a pak zkusíme přeložit testovací program.

fbsd8:/tmp> cat SConstruct
env = Environment()
conf = Configure(env)

conf.CheckLib('ssl','SSL_connect')

print conf.TryLink(r"""
#include <openssl/ssl.h>

int main(int argc, char* argv[]) {
        SSL_library_init();
}

""",'.C')

env=conf.Finish()
fbsd8:/tmp> scons
scons: Reading SConscript files ...
Checking for SSL_connect() in C library ssl... (cached) yes
1
scons: done reading SConscript files.
scons: Building targets ...
scons: `.' is up to date.
scons: done building targets.

Poslední z dnešní sady testovacích funkcí je TryRun. Ta je zajímavá a velmi užitečná. Tuto funkci ale nemůžeme použít pokud provádíme cross-kompilaci, protože testovaný program bude spuštěn na hostitelské, nikoliv cílové, platformě. Po zavolání této funkce dojde k přeložení, slinkování a spuštění programu. Pokud program skončí s návratovým kódem 0, tedy úspěšně, bude SCons frameworku předán jeho standardní výstup.

fbsd8:/tmp> cat SConstruct
env = Environment()
conf = Configure(env)

conf.CheckLib('ssl','SSL_connect')

print "Odpoved na otazku zivota, vesmiru a vubec je",conf.TryRun(r"""
#include <stdio.h>
#include <openssl/ssl.h>

int main(int argc, char* argv[]) {
        printf("%d",42*SSL_library_init());
		return 0;
}

""",'.C')[1]

env=conf.Finish()
fbsd8:/tmp> scons
scons: Reading SConscript files ...
Checking for SSL_connect() in C library ssl... (cached) yes
Odpoved na otazku zivota, vesmiru a vubec je 42
scons: done reading SConscript files.
scons: Building targets ...
scons: `.' is up to date.
scons: done building targets.

Vlastní testy

Naprogramovat si vlastní testy je v SCons velmi jednoduché. Stačí jen naprogramovat Python funkci, která bude zavolána s konfiguračním kontextem jako argumentem a pak SCons poučit o tom, že máme k dispozici nový test.

Pro programování vlastního testu můžeme použít dosavadní testy z kterých se nám obvykle hodí dnes probírané funkce z rodiny Try... Kromě toho máme k dispozici celý Python včetně rosáhlé standardní knihovny a pokud to stále nestačí můžeme si do Pythonu nainstalovat dodatečné knihovny za cenu menší přenositelnosti námi napsaných testů.

V testu je dobré používat funkce Message a Result, které uživatelsky příjemně vytisknou průběh a výsledek testu. Nulová hodnota předaná funkci Result značí neúspěch, jednička úspěšné zakončení testu. Stejnou hodnutu musíme z funkce vrátit pomocí return. Pokud budeme potřebovat přistupovat k prostředí, které pomocí testu nastavujeme, tak ho najdeme v položce konfiguračního kontextu s názvem env.

Jazyk Python má jednoprůchodový parser a tak je potřeba test definovat předtím než ho předáme funkci Configure. Podívejte se na jednoduchý příklad. Všimněte si že se jméno testu nemusí shodovat se jménem funkce.

env = Environment()

def jepondeli(conf):
   import time
   conf.Message("Testuji zda je dnes pondeli... ")
   dnes=time.localtime(time.time())
   if dnes[5] == 0:
      rc=1
   else:
      rc=0
   conf.Result(rc)
   return rc

conf = Configure(env, custom_tests={'jePondeli':jepondeli})
if conf.jePondeli():
   env.Append(CPPFLAGS = "-DPONDELI")

env=conf.Finish()