Bash/Debugging: Unterschied zwischen den Versionen

Aus Foxwiki
Versionsgeschichte interaktiv durchsuchen
← Zum vorherigen Versionsunterschied
VisuellWikitext
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
== Debugging für das gesamte Skript ==
== Debugging für das gesamte Skript ==
Wenn die Dinge nicht nach Plan laufen, müssen Sie herausfinden, was genau die Ursache für das Scheitern des Skripts ist.  Die Bash bietet umfangreiche Debugging-Funktionen.  Die gebräuchlichste ist, die Subshell mit der Option <code>-x</code> zu starten, wodurch das gesamte Skript im Debug-Modus ausgeführt wird.  Die Spuren der einzelnen Befehle und ihrer Argumente werden auf der Standardausgabe ausgegeben, nachdem die Befehle expandiert wurden, aber bevor sie ausgeführt werden.
Wenn die Dinge nicht nach Plan laufen, müssen Sie herausfinden, was genau die Ursache für das Scheitern des Skripts ist
* Die Bash bietet umfangreiche Debugging-Funktionen
* Die gebräuchlichste ist, die Subshell mit der Option <code>-x</code> zu starten, wodurch das gesamte Skript im Debug-Modus ausgeführt wird
* Die Spuren der einzelnen Befehle und ihrer Argumente werden auf der Standardausgabe ausgegeben, nachdem die Befehle expandiert wurden, aber bevor sie ausgeführt werden


Dies ist das <code>kommentierte-script1.sh</code> Skript, das im Debug-Modus ausgeführt wird.  Beachten Sie auch hier, dass die hinzugefügten Kommentare in der Ausgabe des Skripts nicht sichtbar sind.
Dies ist das <code>kommentierte-script1.sh</code> Skript, das im Debug-Modus ausgeführt wird
* Beachten Sie auch hier, dass die hinzugefügten Kommentare in der Ausgabe des Skripts nicht sichtbar sind
{| class="wikitable"
{| class="wikitable"
|
|
|}
|}
Es gibt jetzt einen vollwertigen Debugger für die Bash, der bei SourceForge verfügbar ist.  Diese Debugging-Funktionen sind in den meisten modernen Versionen der Bash ab 3.x verfügbar.
Es gibt jetzt einen vollwertigen Debugger für die Bash, der bei SourceForge verfügbar ist
* Diese Debugging-Funktionen sind in den meisten modernen Versionen der Bash ab 3.x verfügbar


== Debugging für Teile des Skripts ==
== Debugging für Teile des Skripts ==
Mit dem '''set''' der Bash können Sie die Teile des Skripts, von denen Sie sicher sind, dass sie fehlerfrei sind, im normalen Modus ausführen und nur für problematische Bereiche Debugging-Informationen anzeigen.  Angenommen, wir sind uns nicht sicher, was der '''w'''-Befehl im Beispiel <code>kommentiertes-skript1.sh</code> bewirken wird, dann könnten wir ihn wie folgt in das Skript einschließen:
Mit dem '''set''' der Bash können Sie die Teile des Skripts, von denen Sie sicher sind, dass sie fehlerfrei sind, im normalen Modus ausführen und nur für problematische Bereiche Debugging-Informationen anzeigen
* Angenommen, wir sind uns nicht sicher, was der '''w'''-Befehl im Beispiel <code>kommentiertes-skript1.sh</code> bewirken wird, dann könnten wir ihn wie folgt in das Skript einschließen:
{| class="wikitable"
{| class="wikitable"
|
|
Zeile 17: Zeile 23:
|
|
|}
|}
Sie können den Debugging-Modus innerhalb desselben Skripts beliebig oft ein- und ausschalten.
Sie können den Debugging-Modus innerhalb desselben Skripts beliebig oft ein- und ausschalten


Die folgende Tabelle gibt einen Überblick über weitere nützliche Bash-Optionen:
Die folgende Tabelle gibt einen Überblick über weitere nützliche Bash-Optionen:
Zeile 29: Zeile 35:
|set -f
|set -f
|set -o noglob
|set -o noglob
|Deaktiviert die Generierung von Dateinamen mit Metazeichen (Globbing).
|Deaktiviert die Generierung von Dateinamen mit Metazeichen (Globbing)
|-
|-
|set -v
|set -v
|set -o verbose
|set -o verbose
|Druckt Shell-Eingabezeilen aus, wenn sie gelesen werden.
|Druckt Shell-Eingabezeilen aus, wenn sie gelesen werden
|-
|-
|set -x
|set -x
|set -o xtrace
|set -o xtrace
|Druckt Befehlsspuren vor der Ausführung des Befehls.
|Druckt Befehlsspuren vor der Ausführung des Befehls
|}
|}
Der Bindestrich wird verwendet, um eine Shell-Option zu aktivieren und ein Plus, um sie zu deaktivieren.  Lassen Sie sich davon nicht verwirren!
Der Bindestrich wird verwendet, um eine Shell-Option zu aktivieren und ein Plus, um sie zu deaktivieren
* Lassen Sie sich davon nicht verwirren!


Im folgenden Beispiel werden diese Optionen in der Befehlszeile demonstriert:
Im folgenden Beispiel werden diese Optionen in der Befehlszeile demonstriert:
Zeile 45: Zeile 52:
|
|
|}
|}
Alternativ können diese Modi auch im Skript selbst angegeben werden, indem die gewünschten Optionen in der ersten Zeile der Shell-Deklaration hinzugefügt werden.  Optionen können kombiniert werden, wie es bei UNIX-Befehlen üblich ist:
Alternativ können diese Modi auch im Skript selbst angegeben werden, indem die gewünschten Optionen in der ersten Zeile der Shell-Deklaration hinzugefügt werden
* Optionen können kombiniert werden, wie es bei UNIX-Befehlen üblich ist:


'''#!/bin/bash <code>-xv</code>'''
'''#!/bin/bash <code>-xv</code>'''


Wenn Sie den fehlerhaften Teil Ihres Skripts gefunden haben, können Sie '''echo'''-Anweisungen vor jedem Befehl einfügen, bei dem Sie unsicher sind, so dass Sie genau sehen, wo und warum etwas nicht funktioniert.  Im Beispielskript <code>commented-script1.sh</code> könnte man das so machen, wobei man immer noch davon ausgeht, dass die Anzeige der Benutzer Probleme macht:
Wenn Sie den fehlerhaften Teil Ihres Skripts gefunden haben, können Sie '''echo'''-Anweisungen vor jedem Befehl einfügen, bei dem Sie unsicher sind, so dass Sie genau sehen, wo und warum etwas nicht funktioniert
* Im Beispielskript <code>commented-script1.sh</code> könnte man das so machen, wobei man immer noch davon ausgeht, dass die Anzeige der Benutzer Probleme macht:
{| class="wikitable"
{| class="wikitable"
|
|
Zeile 57: Zeile 66:
|
|
|}
|}
 
[[Kategorie:Bash/Scripting]]
= TMP =
== Debugging on the entire script ==
When things don't go according to plan, you need to determine what exactly causes the script to fail.  Bash provides extensive debugging features.  The most common is to start up the subshell with the <code>-x</code> option, which will run the entire script in debug mode.  Traces of each command plus its arguments are printed to standard output after the commands have been expanded but before they are executed.
 
This is the <code>commented-script1.sh</code> script ran in debug mode.  Note again that the added comments are not visible in the output of the script.
{| class="wikitable"
|
|}
There is now a full-fledged debugger for Bash, available at SourceForge.  These debugging features are available in most modern versions of Bash, starting from 3.x.
 
== Debugging on part(s) of the script ==
Using the '''set''' Bash built-in you can run in normal mode those portions of the script of which you are sure they are without fault, and display debugging information only for troublesome zones.  Say we are not sure what the '''w''' command will do in the example <code>commented-script1.sh</code>, then we could enclose it in the script like this:
{| class="wikitable"
|
|}
Output then looks like this:
{| class="wikitable"
|
|}
You can switch debugging mode on and off as many times as you want within the same script.
 
The table below gives an overview of other useful Bash options:
 
'''Table 2-1. Overview of set debugging options'''
{| class="wikitable"
!Short notation
!Long notation
!Result
|-
|set -f
|set -o noglob
|Disable file name generation using metacharacters (globbing).
|-
|set -v
|set -o verbose
|Prints shell input lines as they are read.
|-
|set -x
|set -o xtrace
|Print command traces before executing command.
|}
The dash is used to activate a shell option and a plus to deactivate it.  Don't let this confuse you!
 
In the example below, we demonstrate these options on the command line:
{| class="wikitable"
|
|}
Alternatively, these modes can be specified in the script itself, by adding the desired options to the first line shell declaration.  Options can be combined, as is usually the case with UNIX commands:
 
'''#!/bin/bash <code>-xv</code>'''
 
Once you found the buggy part of your script, you can add '''echo''' statements before each command of which you are unsure, so that you will see exactly where and why things don't work.  In the example <code>commented-script1.sh</code> script, it could be done like this, still assuming that the displaying of users gives us problems:
{| class="wikitable"
|
|}
In more advanced scripts, the '''echo''' can be inserted to display the content of variables at different stages in the script, so that flaws can be detected:
{| class="wikitable"
|
|}

Aktuelle Version vom 1. März 2024, 20:51 Uhr

Debugging für das gesamte Skript

Wenn die Dinge nicht nach Plan laufen, müssen Sie herausfinden, was genau die Ursache für das Scheitern des Skripts ist

  • Die Bash bietet umfangreiche Debugging-Funktionen
  • Die gebräuchlichste ist, die Subshell mit der Option -x zu starten, wodurch das gesamte Skript im Debug-Modus ausgeführt wird
  • Die Spuren der einzelnen Befehle und ihrer Argumente werden auf der Standardausgabe ausgegeben, nachdem die Befehle expandiert wurden, aber bevor sie ausgeführt werden

Dies ist das kommentierte-script1.sh Skript, das im Debug-Modus ausgeführt wird

  • Beachten Sie auch hier, dass die hinzugefügten Kommentare in der Ausgabe des Skripts nicht sichtbar sind

Es gibt jetzt einen vollwertigen Debugger für die Bash, der bei SourceForge verfügbar ist

  • Diese Debugging-Funktionen sind in den meisten modernen Versionen der Bash ab 3.x verfügbar

Debugging für Teile des Skripts

Mit dem set der Bash können Sie die Teile des Skripts, von denen Sie sicher sind, dass sie fehlerfrei sind, im normalen Modus ausführen und nur für problematische Bereiche Debugging-Informationen anzeigen

  • Angenommen, wir sind uns nicht sicher, was der w-Befehl im Beispiel kommentiertes-skript1.sh bewirken wird, dann könnten wir ihn wie folgt in das Skript einschließen:

Die Ausgabe sieht dann wie folgt aus:

Sie können den Debugging-Modus innerhalb desselben Skripts beliebig oft ein- und ausschalten

Die folgende Tabelle gibt einen Überblick über weitere nützliche Bash-Optionen:

Tabelle 2-1. Übersicht der eingestellten Debugging-Optionen

Kurze Schreibweise Lange Schreibweise Ergebnis
set -f set -o noglob Deaktiviert die Generierung von Dateinamen mit Metazeichen (Globbing)
set -v set -o verbose Druckt Shell-Eingabezeilen aus, wenn sie gelesen werden
set -x set -o xtrace Druckt Befehlsspuren vor der Ausführung des Befehls

Der Bindestrich wird verwendet, um eine Shell-Option zu aktivieren und ein Plus, um sie zu deaktivieren

  • Lassen Sie sich davon nicht verwirren!

Im folgenden Beispiel werden diese Optionen in der Befehlszeile demonstriert:

Alternativ können diese Modi auch im Skript selbst angegeben werden, indem die gewünschten Optionen in der ersten Zeile der Shell-Deklaration hinzugefügt werden

  • Optionen können kombiniert werden, wie es bei UNIX-Befehlen üblich ist:

#!/bin/bash -xv

Wenn Sie den fehlerhaften Teil Ihres Skripts gefunden haben, können Sie echo-Anweisungen vor jedem Befehl einfügen, bei dem Sie unsicher sind, so dass Sie genau sehen, wo und warum etwas nicht funktioniert

  • Im Beispielskript commented-script1.sh könnte man das so machen, wobei man immer noch davon ausgeht, dass die Anzeige der Benutzer Probleme macht:

In fortgeschritteneren Skripten kann das echo eingefügt werden, um den Inhalt von Variablen in verschiedenen Phasen des Skripts anzuzeigen, so dass Fehler aufgedeckt werden können:

Abgerufen von „https://wiki.foxtom.de/index.php?title=Bash/Debugging&oldid=96231“