Enhetstesta funktioner med Bats-core

I verkliga projekt ligger Era Bash-funktioner i biblioteksfiler, inte i själva testfilen. Bats tillhandahåller hjälpfunktionen load för att läsa in externa filer relativt till testfilens katalog.

• load '../lib/math.sh' läser in filen innan varje test körs.
• Efter inläsningen är alla funktioner som definieras i filen tillgängliga i Era testblock.
• Håll Era biblioteksfunktioner i en lib/-katalog och Era tester i en test/-katalog för en tydlig uppdelning.

Exempel på projektlayout och tillhörande test:

Kommandot run är kärnan i Bats-testning. I stället för att köra ett kommando direkt omsluter Ni det med run, vilket fångar dess slutstatus och utdata utan att testet omedelbart misslyckas.

• $status — innehåller slutstatusen för det senaste run-kommandot.
• $output — innehåller den sammanlagda standardutmatningen från det senaste run-kommandot.
• $lines — en array där varje element är en rad utdata (${lines[0]}, ${lines[1]} osv.).

Detta låter Er kontrollera både lyckade och misslyckade fall:

De inbyggda påståendena med [ ] fungerar, men ger bristfälliga felmeddelanden. Hjälpbiblioteket bats-assert tillhandahåller tydliga påståendefunktioner som visar exakt vad som gick fel.

• assert_success — kontrollerar att $status är 0.
• assert_failure — kontrollerar att $status inte är noll.
• assert_output — kontrollerar att $output är lika med den angivna strängen.
• assert_output --partial — kontrollerar att utdatan innehåller delsträngen.
• refute_output --partial — kontrollerar att utdatan INTE innehåller delsträngen.

Installera genom att klona bats-core/bats-assert till en test/helpers/-mapp och läs sedan in det:

Bats tillhandahåller två särskilda funktioner — setup och teardown — som körs automatiskt runt varje test. Använd dem för att förbereda och städa upp delat tillstånd, så att varje test startar i en känd miljö.

• setup() körs före varje enskilt @test-block.
• teardown() körs efter varje enskilt @test-block, även om testet misslyckas.
• Vanliga användningsområden är att skapa temporära kataloger, ange miljövariabler och ta bort temporära filer efter testet.

Ibland behöver Ni bara konfigurera resurskrävande resurser en gång per fil — inte före varje enskilt test. Bats tillhandahåller setup_file och teardown_file för detta.

• setup_file() körs en gång före alla tester i filen.
• teardown_file() körs en gång efter alla tester i filen.
• Använd BATS_FILE_TMPDIR (som är tillgänglig automatiskt) för att dela data mellan setup_file och Era tester — vanliga variabler bevaras inte mellan subshells.

Ett typiskt användningsfall är att starta en mockserver eller bygga en binär en gång och sedan avsluta den i slutet:

Ett mycket vanligt mönster är att testa Bash-funktioner som läser från eller skriver till filsystemet. Den centrala tekniken är att använda temporära kataloger (via mktemp -d i setup), så att tester aldrig rör riktiga filer och aldrig stör varandra.

• Arbeta alltid i $TEST_DIR (eller $BATS_TEST_TMPDIR — som är tillgänglig automatiskt i nyare versioner av Bats).
• Använd hjälpbiblioteket bats-file för tydliga filpåståenden som assert_file_exists och assert_file_contains.
• Hårdkoda aldrig sökvägar som /tmp/myfile — parallella testkörningar kommer att krocka.

Funktioner anropar ofta externa program som curl, aws eller git. I enhetstester vill Ni testa Er logik, inte det riktiga externa kommandot. Den enklaste tekniken för mocking i Bats är att definiera en shellfunktion med samma namn som kommandot i setup — den får företräde framför den riktiga binärfilen.

• Definiera en funktion som curl() { echo 'mocked response'; return 0; } i setup och exportera den.
• Använd export -f curl så att funktionen är synlig i subshells som skapas av run.
• Ni kan också skriva mocken till en temporär fil på PATH för mer komplexa scenarier.

Alla tester kan inte alltid köras — ibland krävs en riktig nätverksanslutning, ett visst verktyg eller ett specifikt operativsystem. Bats tillhandahåller skip för att villkorligt hoppa över ett test med ett informativt meddelande, i stället för att kommentera bort det eller få testsviten att gå sönder.

• Anropa skip "reason" var som helst i ett @test-block för att hoppa över testet.
• Överhoppade tester visas som S i utdatan och räknas inte som misslyckanden.
• Bats 1.5+ har stöd för taggar: märk tester med # bats test_tags=slow,network och filtrera med bats --filter-tags network test/.

Ett välorganiserat Bats-projekt följer en förutsägbar katalogstruktur, vilket gör det enkelt att introducera nya medarbetare och integrera projektet med CI-pipelines.

Rekommenderad struktur:

• lib/ — Bash-funktioner för produktion (en fil per ansvarsområde: math.sh, fileutils.sh).
• test/ — en .bats-fil per biblioteksfil (math.bats, fileutils.bats).
• test/helpers/ — bats-assert, bats-file och bats-support som Git-submoduler.
• Makefile — ett test-mål så att medarbetare bara behöver köra make test.

Kör hela testsviten med ett enda kommando:

I den här lektionen lärde Ni Er att strukturera och skriva enhetstester för enskilda Bash-funktioner med Bats-core. Här är de viktigaste punkterna:

• Testfilens struktur — använd shebang-raden #!/usr/bin/env bats och @test-block med beskrivande namn.
• load — läs in Era biblioteksfiler så att funktionerna är tillgängliga i testerna utan att Ni behöver kopiera och klistra in dem.
• run + $status + $output — den centrala trion; använd alltid run för att fånga resultat utan att testet omedelbart misslyckas.
• bats-assert — föredra assert_success, assert_failure och assert_output framför råa [ ] för läsbara felmeddelanden.
• setup / teardown — körs före/efter varje test; setup_file / teardown_file körs en gång per fil.
• Mocking — ersätt externa kommandon genom att skugga dem med shellfunktioner med samma namn, exporterade med export -f.
• skip — hoppa villkorligt över tester som är beroende av resurser som inte är tillgängliga.
• Projektlayout — håll lib/, test/ och test/helpers/ åtskilda för bättre underhåll och CI-integration.

Dessa mönster ger Era Bash-projekt samma disciplin i testningen som Ni skulle tillämpa på vilket modernt programvaruprojekt som helst.