Unit Testing Bash-Skripte

Question

Wir haben ein System, das einige Bash-Skripte neben Java-Code läuft. Da wir versuchen, alles zu testen, was möglicherweise brechen könnte, und diese Bash-Skripte könnten brechen, wollen wir sie testen.

Das Problem ist, es ist schwierig, Bash-Skripte zu testen.

Gibt es einen Weg oder eine Best Practice, um Bash-Skripte zu testen? Oder sollten wir aufhören, Bash-Skripte zu verwenden, und nach alternativen Lösungen suchen, die testbar sind?

Answer 1

ich aus einer Diskussionsgruppe die folgende Antwort erhielt:

ist es möglich, importieren (enthalten, was auch immer) eine Prozedur (Funktion, wie auch immer es heißt) von einer externen Datei. Das ist der Schlüssel zu einem Testskript zu schreiben: Sie brechen Ihr Skript in unabhängige Verfahren , die dann sowohl in importiert werden können Ihre laufenden Skript und Ihre Tests Skript, und dann haben Sie Ihre laufenden Skript so einfach wie möglich .

Diese Methode ähnelt der Abhängigkeitsinjektion für Skripts und klingt vernünftig. Das Vermeiden von Bash-Skripten und das Verwenden von mehr testbaren und weniger obskuren Sprachen ist vorzuziehen.

Answer 2

Es gibt tatsächlich eine unit testing framework for shell scripts. Ich habe es nicht selbst benutzt, aber es könnte einen Besuch wert sein.

ähnliche Fragen gestellt wurden vor:

• Unit Testing for Shell Scripts
• Test Anything Protocol in Shell Scripts

Answer 3

Ich finde es schwer zu rechtfertigen bash für größere Skripte zu verwenden, wenn Python so große Vorteile:

• Try/Except ermöglicht das Schreiben robusterer Skripts mit der Möglichkeit, Änderungen im Falle eines Fehlers rückgängig zu machen.
• Sie müssen keine obskure Syntax wie 'if [ x"$foo" = x"$bar"]; then ...' verwenden, die fehleranfällig ist.
• Einfache Analyse von Optionen und Argumenten mit dem Modul getopt (und es gibt ein noch einfacheres Modul zum Parsen von Argumenten, aber der Name entkommt mir).
• In Python können Sie mit Listen/Dicts und Objekten statt mit einfachen Strings und Arrays arbeiten.
• Zugang zu den richtigen Sprach-Tools wie Regex, Datenbanken (sicher, Sie könnten alles in den mysql Befehl in bash pipen, aber es ist nicht die schönste Art, Code zu schreiben).
• Keine Notwendigkeit, über die Verwendung der richtigen Form von $* oder "$*" oder "$@" oder $1 oder "$1", Leerzeichen in Dateinamen zu befürchten ist kein Problem, etc, etc, etc.

Jetzt habe ich nur bash verwenden für die einfachsten Skripte.

Answer 4

Warum sagen Sie, dass es "hart" ist, Bash-Skripte zu testen?

Was mit Test-Wrapper falsch ist wie:

#!/bin/bash 
set -e 
errors=0 
results=$($script_under_test $args<<ENDTSTDATA 
# inputs 
# go 
# here 
# 
ENDTSTDATA 
) 
[ "$?" -ne 0 ] || { 
    echo "Test returned error code $?" 2>&1 
    let errors+=1 
    } 

echo "$results" | grep -q $expected1 || { 
     echo "Test Failed. Expected $expected1" 
     let errors+=1 
} 
# and so on, et cetera, ad infinitum, ad nauseum 
[ "$errors" -gt 0 ] && { 
     echo "There were $errors errors found" 
     exit 1 
} 

Answer 5

TAP -konforme Bash Test: Bash Automated Testing System

bats-core

Answer 6

Epoxy ist ein Bash Test-Framework ich hauptsächlich zum Testen andere Software entworfen, aber ich benutze es bash-Module als auch zu testen, einschließlich itself und Carton.

Hauptvorteile sind relativ geringer Codierungsaufwand, unbegrenzte Assertion-Verschachtelung und flexible Auswahl der zu überprüfenden Assertionen.

Ich machte eine presentation im Vergleich zu BeakerLib - ein Framework von einigen bei Red Hat verwendet.

Answer 7

Ich mag shell2junit, ein Dienstprogramm, um JUnit-ähnliche Ausgabe von Bash-Skript-Tests zu generieren. Dies ist nützlich, da der erstellte Bericht dann von Systemen für die kontinuierliche Integration gelesen werden kann, z. B. den JUnit-Plug-Ins für Jenkins und Bamboo.

Während Shell2junit nicht die umfassende Bash-Scripting-Framework wie shunit2 bietet, ermöglicht es Ihnen eine schöne Berichterstattung über die Testergebnisse.

Answer 8

Sie vielleicht einen Blick auf bash_unit nehmen wollen:

https://github.com/pgrange/bash_unit

Answer 9

bashtest Versuchen. Es ist eine einfache Möglichkeit, Ihre Skripte zu testen. Zum Beispiel haben Sie do-some-work.sh, die einige Konfigurationsdateien ändern. Fügen Sie beispielsweise der Konfigurationsdatei /etc/my.cfg die neue Zeile PASSWORD = 'XXXXX' hinzu.

Sie schreiben Bash-Befehle Zeile für Zeile und überprüfen dann die Ausgabe.

Install:

pip3 install bashtest 

Tests erstellen ist ein einfach zu schreiben bash Befehle.

Datei test-do-some-work.bashtest:

# run the script 
$ ./do-some-work.sh > /dev/null 

# testing that the line "PASSWORD = 'XXXXX'" is in the file /etc/my.cfg 
$ grep -Fxq "PASSWORD = 'XXXXX'" /etc/my.cfg && echo "YES" 
YES 

Run Tests:

bashtest *.bashtest 

Sie some examples here und here

Answer 10

finden Vielleicht können diese verwendet werden, oder mitverursacht

https://thorsteinssonh.github.io/bash_test_tools/

Beabsichtigt, Ergebnisse in TAP-Protokoll zu schreiben, die ich für CI und gut für diejenigen, die Shell-Umgebungen wollen, gut vorstellen. Ich kann mir vorstellen, dass einige Dinge in Shell-Umgebungen laufen, daher sollten einige argumentieren, dass sie in ihrer Shell-Umgebung getestet werden sollten.

Answer 11

Geben Sie einen Versuch assert.sh

source "./assert.sh" 

local expected actual 
expected="Hello" 
actual="World!" 
assert_eq "$expected" "$actual" "not equivalent!" 
# => x Hello == World :: not equivalent! 

Hoffe, es hilft!