Sylteagurksprog: Syntaks, format og eksempler

Hvad er Gherkin Language?

Sylteagurk er et forretningslæsbart sprog, der hjælper dig med at beskrive forretningsadfærd uden at gå i detaljer med implementeringen. Det er et domænespecifikt sprog til at definere tests i Cucumber format. Den bruger et enkelt sprog til at beskrive brugsscenarier og lader brugerne fjerne logiske detaljer fra adfærdstests.

Teksten i Gherkin fungerer som dokumentation og som skelet for dine automatiserede tests. Gherkin-formatet er baseret på TreeTop Grammar, som findes på mere end 37 sprog, så du kan skrive Gherkin på over 37 talte sprog. Scriptet tjener to primære formål: det dokumenterer brugerscenarier, og det danner grundlag for at skrive automatiserede BDD-tests.

Hvorfor cornichon?

Uden et fælles, letforståeligt format beskriver forretnings- og tekniske teams krav forskelligt, hvilket skaber misforståelser. Gherkin giver alle et enkelt, struktureret ordforråd, der læses som almindeligt engelsk, men som er direkte knyttet til eksekverbare tests.

Agurkesyntaks

Gherkin er et linjeorienteret sprog, ligesom YAML og PythonHver linje kaldes et trin og starter med et nøgleord. Tabulatorer eller mellemrum bruges til indrykning. En kommentar kan tilføjes hvor som helst, men skal starte med et #-tegn. Fortolkeren læser hver linje efter at have fjernet Gherkin-nøgleord som f.eks. Givet, Når og Så.

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

Et Gherkin-dokument har filtypen .feature og er blot en testfil med en beskrivende filtypenavn. Cucumber læser Gherkin-dokumentet og udfører en test for at validere, at softwaren opfører sig som beskrevet i Gherkin-syntaksen.

Vigtige udtryk brugt i sylteagurk

De vigtigste nøgleord er Funktion, Baggrund, Scenarie, Givet, Hvornår, Så, Og, Men og Scenarieoversigt. Cucumber har ingen strenge navngivningsregler, men en klar navngivningskonvention hjælper.

Feature

Filen skal have filtypenavnet .feature, og hver feature-fil skal kun beskrive én feature. Nøgleordet Feature starter med Feature: efterfulgt af et mellemrum og funktionsnavnet.

Scenario

Hver funktionsfil kan have flere scenarier, og hvert scenarie starter med Scenario: efterfulgt af scenarienavnet.

Baggrund

Nøgleordet Background tilføjer kontekst til scenariet. Det kan indeholde trin, der deles af hvert scenarie; forskellen er, at disse trin kører før hvert scenarie.

I betragtning af

Nøgleordet Given sætter systemet i en kendt tilstand, før brugeren begynder at interagere med det. Det definerer forudsætningen eller konteksten:

Given I am on "/."

Når

Nøgleordet When definerer den handling, som brugeren udfører:

When I perform "Sign In."

Derefter

Nøgleordet Then definerer det observerede resultat efter handlingen i trinnet When. Du bør kun verificere mærkbare ændringer:

Then I should see "Welcome Tom."

Og & Men

Du kan have flere trin: Givet, Hvornår eller Så. Nøgleordene Og og Men tilføjer ekstra trin for at øge læsbarheden:

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

Givet, Når, Så, Og og Men er alle testtrin. Fortolkeren giver ikke en fejl, hvis du bytter om på dem, men scenariet vil ikke læses fornuftigt, så brug hvert nøgleord til dets tilsigtede formål.

Eksempler på cornichoner

Eksempel 1: En loginfunktion til et socialt netværk.

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 analyserer hvert trin, der er skrevet i funktionsfilen, og trinnene i funktionsfilen skal stemme overens med dem i trindefinitionsfilen.

Eksempel 2: Et brugergodkendelsesscenarie med en baggrund.

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

De bedste fremgangsmåder ved brug af sylteagurk

• Hvert scenarie skal udføres separat og uafhængigt.
• Hver funktion skal kunne eksekveres i sig selv.
• Trininformation skal vises uafhængigt.
• Forbind dine scenarier med dine krav og track hvilke scenarier der hører til hvert krav.
• Skab modulære, letforståelige trin, og kombiner almindelige scenarier.
• Beskriv hvad systemet gør, ikke hvordan det gør det.

Fordele ved cornichoner

• Gherkin er simpelt nok til, at ikke-programmører kan forstå det.
• Programmører kan bruge det som et solidt grundlag for at starte deres tests.
• Det gør brugerhistorier lettere at fordøje og målretter forretningskravene.
• Virksomhedsledere og udviklere kan begge læse det samme script.
• Gherkin-testcases forbinder accepttests direkte med automatiserede tests.
• Skrivestilen gør det nemmere at genbruge kode på tværs af tests.

Ulemper ved cornichon

• Det kræver et højt niveau af forretningsengagement og samarbejde.
• Det fungerer måske ikke godt i alle scenarier.
• Dårligt skrevne tests kan øge omkostningerne til testvedligeholdelse.

Ofte Stillede Spørgsmål