Gherkin-Sprache: Syntax, Format und Beispiele

Was ist Gurkensprache?

Gurke ist eine für Geschäftsleute verständliche Sprache, die Ihnen hilft, Geschäftsverhalten zu beschreiben, ohne auf Implementierungsdetails einzugehen. Es handelt sich um eine domänenspezifische Sprache zur Definition von Tests in Cucumber Es verwendet ein einfaches Format, um Anwendungsfälle zu beschreiben, und ermöglicht es Benutzern, Logikdetails aus Verhaltenstests zu entfernen.

Der Text in Gherkin dient als Dokumentation und als Gerüst für Ihre automatisierten Tests. Das Gherkin-Format basiert auf der TreeTop-Grammatik, die in über 37 Sprachen existiert. Daher können Sie Gherkin in über 37 gesprochenen Sprachen schreiben. Das Skript erfüllt zwei Hauptzwecke: Es dokumentiert Benutzerszenarien und bildet die Grundlage für das Schreiben automatisierter BDD-Tests.

Warum Gurke?

Ohne ein gemeinsames, leicht verständliches Format beschreiben Fach- und IT-Teams Anforderungen unterschiedlich, was zu Missverständnissen führt. Gherkin bietet allen Beteiligten ein einheitliches, strukturiertes Vokabular, das sich wie normales Englisch liest und dennoch direkt auf ausführbare Tests abgebildet werden kann.

Gurkensyntax

Gherkin ist eine zeilenorientierte Sprache, genau wie YAML und PythonJede Zeile wird als Schritt bezeichnet und beginnt mit einem Schlüsselwort. Tabulatoren oder Leerzeichen dienen zur Einrückung. Kommentare können an beliebiger Stelle eingefügt werden, müssen aber mit einem #-Zeichen beginnen. Der Interpreter liest jede Zeile, nachdem er Gherkin-Schlüsselwörter wie „Given“, „When“ und „Then“ entfernt hat.

Feature: Title of the Scenario
  Given [Preconditions or Initial Context]
  When [Event or Trigger]
  Then [Expected output]

Ein Gherkin-Dokument hat die Dateiendung .feature und ist einfach eine Testdatei mit einer beschreibenden Dateiendung. Cucumber liest das Gherkin-Dokument und führt einen Test aus, um zu überprüfen, ob sich die Software so verhält, wie es die Gherkin-Syntax beschreibt.

Wichtige Begriffe, die in der Gewürzgurke verwendet werden

Die wichtigsten Schlüsselwörter sind: Merkmal, Hintergrund, Szenario, Gegeben, Wenn, Dann, Und, Aber und Szenario-Gliederung. Cucumber Es gibt keine strengen Namensregeln, aber eine klare Namenskonvention ist hilfreich.

Funktion

Die Datei sollte die Erweiterung .feature haben, und jede Feature-Datei sollte nur ein Feature beschreiben. Das Schlüsselwort Feature beginnt mit Feature: gefolgt von einem Leerzeichen und dem Feature-Namen.

Szenario

Jede Feature-Datei kann mehrere Szenarien enthalten, und jedes Szenario beginnt mit Szenario: gefolgt vom Szenarionamen.

Hintergrund

Das Schlüsselwort „Hintergrund“ fügt dem Szenario Kontext hinzu. Es kann Schritte enthalten, die in jedem Szenario gemeinsam sind; der Unterschied besteht darin, dass diese Schritte vor jedem Szenario ausgeführt werden.

Gegeben

Das Schlüsselwort „Given“ versetzt das System in einen definierten Zustand, bevor der Benutzer mit ihm interagiert. Es definiert die Vorbedingung oder den Kontext:

Given I am on "/."

Wenn die Funktion

Das Schlüsselwort „When“ definiert die vom Benutzer ausgeführte Aktion:

When I perform "Sign In."

Dann

Das Schlüsselwort „Then“ definiert das Ergebnis, das nach der Aktion im Schritt „When“ beobachtet wird. Sie sollten nur erkennbare Änderungen überprüfen:

Then I should see "Welcome Tom."

Und Aber

Es können mehrere „Gegeben“-, „Wenn“- oder „Dann“-Schritte vorhanden sein. Die Schlüsselwörter „Und“ und „Aber“ fügen zur besseren Lesbarkeit zusätzliche Schritte hinzu:

And I enter "EmailAddress" with "tomjohn@gmail.com."
But I should see "Welcome Tom."

Given, When, Then, And und But sind allesamt Testschritte. Der Interpreter gibt keinen Fehler aus, wenn man sie vertauscht, aber das Szenario ist dann nicht mehr verständlich. Verwenden Sie daher jedes Schlüsselwort für seinen vorgesehenen Zweck.

Beispiele für Gurken

Beispiel 1: Eine Anmeldefunktion für ein soziales Netzwerk.

Feature: Login functionality of a social networking site
  Given I am a registered user
  When I enter my username
  And I enter my password
  Then I should be redirected to the home page

Gherkin analysiert jeden im Feature-File beschriebenen Schritt, und die Schritte im Feature-File müssen mit denen in der Schrittdefinitionsdatei übereinstimmen.

Beispiel 2: Ein Benutzerauthentifizierungsszenario mit Hintergrund.

Feature: User Authentication

Background:
  Given the user is already registered on the website

Scenario: Successful login
  Given the user is on the login page
  When the user inputs the correct email address
  And the user inputs the correct password
  And the user clicks the Login button
  Then the user should be authenticated
  And the user should be redirected to their dashboard

bewährte Methoden zur Verwendung von Gewürzgurken

• Jedes Szenario sollte separat und unabhängig ausgeführt werden.
• Jede Funktion sollte für sich ausführbar sein.
• Die einzelnen Schritte sollten separat angezeigt werden.
• Verbinden Sie Ihre Szenarien mit Ihren Anforderungen und track welche Szenarien zu welcher Anforderung gehören.
• Erstellen Sie modulare, leicht verständliche Schritte und kombinieren Sie gängige Szenarien.
• Beschreiben Sie, was das System tut, nicht wie es es tut.

Vorteile von Gurke

• Gherkin ist so einfach, dass auch Nicht-Programmierer es verstehen können.
• Programmierer können es als solide Grundlage für ihre Tests nutzen.
• Dadurch werden User Stories leichter verständlich und die Geschäftsanforderungen werden gezielt angegangen.
• Sowohl Führungskräfte als auch Entwickler können dasselbe Skript lesen.
• Gherkin-Testfälle verknüpfen Akzeptanztests direkt mit automatisierten Tests.
• Der Schreibstil erleichtert die Wiederverwendung von Code in verschiedenen Tests.

Nachteile von Gurke

• Es erfordert ein hohes Maß an geschäftlichem Engagement und Zusammenarbeit.
• Es funktioniert möglicherweise nicht in jedem Szenario gut.
• Schlecht formulierte Tests können die Kosten für die Testwartung erhöhen.

Häufig gestellte Fragen