Kurkkukieli: syntaksi, muoto ja esimerkit

Mikä on Gherkin Language?

etikkakurkku on liiketoiminnan kannalta luettava kieli, joka auttaa kuvaamaan liiketoiminnan käyttäytymistä menemättä toteutuksen yksityiskohtiin. Se on toimialakohtainen kieli testien määrittelemiseen Cucumber muodossa. Se kuvaa käyttötapauksia selkokielellä ja antaa käyttäjien poistaa loogisia yksityiskohtia käyttäytymistesteistä.

Gherkinin teksti toimii dokumentaationa ja automatisoitujen testien runkona. Gherkin-muoto perustuu TreeTop Grammariin, joka on olemassa yli 37 kielellä, joten voit kirjoittaa Gherkiniä yli 37 puhutulla kielellä. Skriptillä on kaksi päätarkoitusta: se dokumentoi käyttäjäskenaarioita ja tarjoaa perustan automatisoitujen BDD-testien kirjoittamiselle.

Miksi Gherkin?

Ilman yhteistä, selkeää muotoa liiketoiminta- ja tekniset tiimit kuvaavat vaatimukset eri tavoin, mikä aiheuttaa väärinkäsityksiä. Gherkin antaa kaikille yhden, jäsennellyn sanaston, joka on kuin tavallista englantia, mutta liittyy suoraan suoritettaviin testeihin.

Gherkinin syntaksi

Gherkin on riviorientoitunut kieli, aivan kuten YAML ja PythonJokaista riviä kutsutaan vaiheeksi (step), ja se alkaa avainsanalla. Sisennyksiin käytetään sarkainmerkkejä tai välilyöntejä. Kommentin voi lisätä mihin tahansa, mutta sen on alettava #-merkillä. Tulkki lukee jokaisen rivin poistettuaan Gherkin-avainsanat, kuten Given, When ja Then.

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

Gherkin-dokumentilla on .feature-tiedostotunniste, ja se on yksinkertaisesti testitiedosto kuvaavalla tiedostotunnisteella. Cucumber lukee Gherkin-dokumentin ja suorittaa testin varmistaakseen, että ohjelmisto toimii Gherkin-syntaksin kuvaamalla tavalla.

Tärkeitä termejä, joita käytetään suolakurkussa

Pääavainsanat ovat Ominaisuus, Tausta, Skenaario, Koska, Milloin, Sitten, Ja, Mutta ja Skenaarion pääpiirteet. Cucumber ei ole tiukkoja nimeämissääntöjä, mutta selkeä nimeämiskäytäntö auttaa.

Ominaisuus

Tiedoston tiedostopäätteen tulisi olla .feature, ja jokaisen ominaisuustiedoston tulisi kuvata vain yksi ominaisuus. Avainsana Feature alkaa merkeillä Ominaisuus: jota seuraa välilyönti ja ominaisuuden nimi.

skenaario

Jokaisella ominaisuustiedostolla voi olla useita skenaarioita, ja jokainen skenaario alkaa Skenaario: ja sen jälkeen skenaarion nimi.

Tausta

Background-avainsana lisää kontekstia skenaarioon. Se voi sisältää vaiheita, jotka kaikki skenaariot jakavat; ero on siinä, että nämä vaiheet suoritetaan ennen jokaista skenaariota.

Tietty

Annettu avainsana asettaa järjestelmän tunnettuun tilaan ennen kuin käyttäjä aloittaa vuorovaikutuksen sen kanssa. Se määrittelee ennakkoedellytyksen eli kontekstin:

Given I am on "/."

Kun

When-avainsana määrittää käyttäjän suorittaman toiminnon:

When I perform "Sign In."

Sitten

Then-avainsana määrittää When-vaiheen toiminnon jälkeen havaitun tuloksen. Sinun tulisi tarkistaa vain havaittavat muutokset:

Then I should see "Welcome Tom."

Ja Mutta

Sinulla voi olla useita Given-, When- tai Then-vaiheita. And- ja But-avainsanat lisäävät luettavuuden parantamiseksi lisävaiheita:

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

Koska When, Then, And ja But ovat kaikki testiaskeleita. Tulkki ei aiheuta virhettä, jos vaihdat ne, mutta skenaario ei lue järkevästi, joten käytä kutakin avainsanaa sen aiottuun tarkoitukseen.

Kurkku-esimerkkejä

Esimerkki 1: Kirjautumistoiminto sosiaalisen median sivustolle.

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 analysoi jokaisen ominaisuustiedostoon kirjoitetun vaiheen, ja ominaisuustiedoston vaiheiden on vastattava vaiheen määritystiedoston vaiheita.

Esimerkki 2: Käyttäjän todennusskenaario taustan kanssa.

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

Gherkin käytön parhaat käytännöt

• Jokaisen skenaarion tulisi toteutua erikseen ja itsenäisesti.
• Jokaisen ominaisuuden tulisi olla suoritettavissa itsenäisesti.
• Vaiheiden tiedot tulisi näyttää erikseen.
• Yhdistä skenaariosi vaatimuksiisi ja track mitkä skenaariot kuuluvat kuhunkin vaatimukseen.
• Luo modulaarisia, helposti ymmärrettäviä vaiheita ja yhdistä yleisiä skenaarioita.
• Kuvaile, mitä järjestelmä tekee, älä miten se sen tekee.

Gherkinin edut

• Gherkin on tarpeeksi yksinkertainen, jotta ei-ohjelmoijatkaan ymmärtäisivät sen.
• Ohjelmoijat voivat käyttää sitä vankkana pohjana testiensä aloittamiseen.
• Se helpottaa käyttäjätarinoiden omaksumista ja vastaa liiketoiminnan vaatimuksiin.
• Sekä yritysjohtajat että kehittäjät voivat lukea samaa käsikirjoitusta.
• Gherkin-testitapaukset linkittävät hyväksymistestit suoraan automatisoituihin testeihin.
• Kirjoitustyyli helpottaa koodin uudelleenkäyttöä eri testeissä.

Gherkinin haitat

• Se vaatii vahvaa liiketoimintaosaamista ja yhteistyötä.
• Se ei välttämättä toimi hyvin kaikissa tilanteissa.
• Huonosti kirjoitetut testit voivat lisätä testien ylläpitokustannuksia.

UKK