Hvad er Cucumber Funktionsfil og trindefinition? (Eksempel)

Af: Thomas Hamilton Thomas Hamilton
Hours Opdateret

⚡ Smart opsummering

Cucumber Funktionsfiler beskriver adfærd i et letforståeligt Gherkin-sprog, mens trindefinitioner indeholder den kode, der kører hver linje. Cucumber Projektet har brug for begge dele, gemt i et fast mappelayout under en features-mappe.

  • 🔘 To filer: En funktionsfil angiver, hvad der skal ske; en trindefinitionsfil angiver, hvordan automatiseringen får det til at ske.
  • ☑️ Sylteagurk-nøgleord: Funktion, Scenarie, Givet, Hvornår og Så giver et scenarie dets struktur og dets læsbare form.
  • ✅ Ingen kolon på trin: Funktion og Scenarie skal bruge et kolon, men Given, When og Then må ikke, ellers ignoreres trinnet.
  • 🧪 Datasæt: Scenarieoversigt plus en eksempeltabel afspiller ét scenarie mod mange rækker input.
  • 🛠️ Delt opsætning: Baggrundsløft gentages. Givne trin ud af hvert scenarie i en funktion.
  • 📊 Matching: Cucumber ignorerer søgeordet ved matchning, så to trin deler muligvis aldrig den samme tekst.
Læs mere

Cucumber Funktionsfil og trindefinition forklaret med et eksempel

For hvert cucumber-projekt er der en enkelt mappe i roden af ​​projektet med navnet "features". Det er her, alle dine cucumber-features vil være placeret. I denne mappe finder du yderligere mapper, som er step_definition og support-mapperne.

Det layout er vigtigt, fordi Cucumber opdager dine filer efter konvention snarere end efter konfiguration. En feature-fil, der ligger uden for features-mappen, bliver simpelthen aldrig læst.

Hvad er "Funktionsfil"?

Funktionsfilen indeholder en beskrivelse på højt niveau af Testscenarie i et enkelt sprog. Det er kendt som SylteagurkGherkin er et tekstsprog i almindeligt engelsk.

Cucumber Funktionsfilen består af følgende komponenter —

  • Feature: En funktion vil beskrive det aktuelle testscript, som skal udføres.
  • Scenario: Scenario beskriver trinene og det forventede resultat for en bestemt testcase.
  • Scenarieoversigt: Samme scenarie kan udføres for flere sæt data ved hjælp af scenarieoversigt. Dataene leveres af en tabelstruktur adskilt af (II).
  • I betragtning af: Det specificerer konteksten for den tekst, der skal udføres. Ved at bruge datatabeller "Given", kan trin også parametreres.
  • Når"Hvornår" angiver den testhandling, der skal udføres.
  • DerefterDet forventede resultat af testen kan repræsenteres ved "Så".

Én fil indeholder én funktion. Scenarierne nedenunder er de konkrete eksempler, der illustrerer funktionen, og hvert scenarie følger den samme rytme: beskriv en startkontekst, beskriv en begivenhed, beskriv det forventede resultat.

Dernæst vil vi lære, hvordan man skriver Feature File i Cucumber med eksempel.

Eksempel på funktionsfil:

Det originale eksempel, der er offentliggjort med denne vejledning, er gengivet nedenfor præcis som skrevet.

Feature: Visit career guide page in career.guru99.com
Scenario: Visit career.guru99.com
Given: I am on career.guru99.com
When: I click on career guide menu
Then: I should see career guide page

⚠️ Rettelse: I eksemplet ovenfor placeres et kolon efter I betragtning af, Når og DerefterSylteagurk sætter et kolon efter Feature og Scenario kun. Et nøgleord step efterfulgt af et kolon parser ikke som et step, så Cucumber ignorerer lydløst linjen. Den rettede fil lyder som følger.

Feature: Visit career guide page in career.guru99.com

  Scenario: Visit career.guru99.com
    Given I am on career.guru99.com
    When I click on career guide menu
    Then I should see career guide page

Indrykning er ikke påkrævet af parseren, men to mellemrum pr. niveau er den konventionelle stil og gør en lang funktion langt nemmere at scanne. Animationen nedenfor viser en funktionsfil, der køres, og hvert trin bliver grønt, når det passerer.

Animation af en Cucumber funktionsfil kører med hvert Gherkin-trin rapporteret efter tur

Hvad er "trindefinition"?

Trindefinition kortlægger testcase-trinene i feature-filerne (introduceret af Given/When/Then) til kode. Det, der udfører trinene på Application Under Test og kontrollerer resultaterne mod forventede resultater. For at en trindefinition kan udføres, skal den matche den givne komponent i en funktion. Trindefinition er defineret i ruby-filer under "features/step_definitions/*_steps.rb".

Matchet laves alene ud fra trinnets tekst. Cucumber tager ikke nøgleordet i betragtning, når den søger efter en definition, hvilket er grunden til, at to trin i den samme suite aldrig indeholder identisk tekst, selvom det ene er en Given og det andet en Then.

Eksempel på trindefinition: Her vil vi bruge ovenfor Cucumber Eksempel på funktionsfil med søgning på career.guru99.com. Vi bruger funktioner som "Når, Så, Givet" som vist nedenfor. Cucumber Eksempler på Feature File.

Step 1:

Given (/^ I am on career.guru99.com$/) do

Browser.goto "http://career.guru99.com" -This will visit career.guru99 on browser

end

Step 2:
When (/^ click on career guide menu$/) do

Browser.text (:name, " career guide" ).click – This will click "career guide menu"

end

Step 3:

Then (/^ I should see career guide page$/) do

Browser.goto "http://career.guru99.com/category/career-guide/" - It will visit "career guide page"

end

⚠️ En bemærkning om sprog: Definitionerne ovenfor er Ruby, hvilket er hvor Cucumber startet, og det er derfor mappen er navngivet step_definitions og filerne ender på _steps.rbDen samme funktionsfil driver trindefinitioner skrevet i Java, Javamanuskript, Python eller C# uden en eneste ændring af Gherkin'en. I Cucumber-JVM flytter det regulære udtryk sig ind i en annotation på en metode:

@Given("I am on career.guru99.com")
public void i_am_on_the_career_page() {
    driver.get("http://career.guru99.com");
}

Uanset hvilket sprog du vælger, er trindefinitionen det eneste sted, implementeringsdetaljer hører hjemme.ping selektorer og HTTP-kald ud af feature-filen er det, der lader en ikke-programmør læse scenariet. første Cucumber script Gennemgangen bygger denne parring fra start til slut.

RELATEREDE ARTIKLER

Scenarieoversigt og eksempler i en funktionsfil

At kopiere et scenarie tre gange for at ændre én værdi er den mest almindelige måde, hvorpå en funktionsfil bliver ulæselig. Scenarieoversigt erstatter kopierne med en skabelon, og en Eksempler Tabellen leverer værdierne.

Parametre er skrevet i vinkelparenteser og skal matche en kolonneoverskrift i tabellen nedenunder. Cucumber erstatter værdierne, før den søger efter en matchende trindefinition, så selve definitionerne ikke kræver nogen særlig håndtering.

Scenario Outline: Search the career guide
  Given I am on career.guru99.com
  When I search for "<keyword>"
  Then I should see the <section> section

  Examples:
    | keyword   | section       |
    | interview | Interview Tips|
    | resume    | Resume Guide  |

Det er værd at huske på et par punkter, når du bruger dispositioner:

  • Dispositionen kører én gang pr. datarække. Den første række er headeren og udføres aldrig.
  • En scenarieoversigt skal efterfølges af mindst ét ​​eksempelafsnit, ellers kører der intet.
  • Tabelrørene behøver ikke at flugte, men justering af dem holder filen læsbar.
  • Hold tabellen lille. En tabel med tredive rækker er normalt et tegn på, at dataene hører hjemme i en datadrevet test i stedet.

Baggrund, Og, Men og de andre sylteagurk-nøgleord

Ud over de seks komponenter, der er nævnt tidligere, har Gherkin en håndfuld nøgleord, der holder længere funktionsfiler læsbare.

  • Baggrund — en blok af givne trin, der kører før hvert scenarie i funktionen. Det fjerner gentagelsen af ​​at skrive den samme forudsætning øverst i hvert scenarie.
  • og og Men — erstatninger for en gentaget Givet, Hvornår eller Så. De læser bedre og opfører sig identisk; Cucumber matcher trinteksten på begge måder.
  • Herske — en valgfri gruppeping, tilføjet i Gherkin 6, som samler scenarierne, der illustrerer én forretningsregel.
  • Dokumentstrenge — en tekstblok afgrænset af tre dobbelte anførselstegn, der sendes til trindefinitionen som et enkelt argument, når én linje ikke er nok.
  • Datatabeller — rørafgrænsede rækker knyttet til et enkelt trin, der bruges til at overføre en liste over værdier til det pågældende trin.
  • Tags — etiketter, der starter med et at-tegn, placeret over en funktion eller et scenarie, så en delmængde kan vælges under kørsel.
  • Kommentarer — en linje, der starter med en hash. Kommentarer er kun tilladt i starten af ​​en linje, og Gherkin har ingen blokkommentar.

Samlet set ser en funktionsfil med delt opsætning sådan ud:

Feature: Career guide navigation

  Background:
    Given I am on career.guru99.com

  Scenario: Open the career guide menu
    Given I am signed in
    And my profile is complete
    When I click on career guide menu
    Then I should see career guide page
    But I should not see the admin panel

Almindelige fejl i funktionsfiler og hvordan man retter dem

bro Cucumber Problemer rapporteret af begyndere er ikke fejl i rammeværket. De er små overtrædelser af Gherkin-reglerne, der fejler stille og roligt.

Mistake Hvad sker Fix
Kolon efter Givet, Hvornår eller Så Linjen genkendes ikke som et trin og springes over Brug kun et kolon efter Feature og Scenario
To trin med identisk tekst Cucumber behandler dem som dubletter, fordi søgeordet ignoreres Omformuler ét trin, så de to læses forskelligt
Funktionsfil uden for funktionsmappen Filen bliver aldrig fundet, og der køres ingen test Hold alle .feature filen under funktionsmappen
Femten trin i ét scenarie Scenariet holder op med at fungere som dokumentation Sigt efter tre til fem trin og indprent detaljer i trindefinitionen
Udfører derefter en assert på en databaserække Testen består, mens den brugersynlige adfærd er afbrudt Hævd på observerbart output såsom siden eller svaret
Scenarieoversigt uden eksempeltabel Skabelonen udføres aldrig Tilføj et afsnit med eksempler direkte under dispositionen

Det er langt billigere at rette disse, før suiten vokser, end at rette dem bagefter, fordi hvert scenarie, der skrives i mellemtiden, kopierer den samme form. Når funktionsfilerne fungerer korrekt, er næste trin at tilslutte projektet – se Cucumber installation gennemgang og den bredere automatiseringstest serien.

Ofte Stillede Spørgsmål

Nej. En .feature-fil kan deklarere præcis én funktion, selvom den kan indeholde så mange scenarier, som du ønsker. Hvis du har brug for en anden funktion, skal du oprette en anden fil – det er den begrænsning, der holder mappen navigerbar, efterhånden som en suite vokser.

Det gør det ikke. Gherkin er lokaliseret til mere end halvfjerds talte sprog. Tilføjelse af en sprogoverskrift på den første linje i filen ændrer nøgleordene, så et team kan skrive scenarier på det samme sprog, som deres domæneeksperter rent faktisk taler.

Den indeholder alt, der ikke er en trindefinition: miljøopsætning, browserkonfiguration, hooks, der kører før eller efter et scenarie, og delt hjælpekode. Keeping den separate forhindrer trindefinitionsfiler i at blive til en dumping jord.

Cucumber rapporterer trinnet som udefineret i stedet for mislykket og udskriver et foreslået kodestykke, som du kan indsætte i en trindefinitionsfil. Scenariet markeres som ikke bestået, så et udefineret trin tæller aldrig stille og roligt som en succes.

Et tag placeret over en funktion eller et scenarie lader brugeren vælge et delmængde på udførelsestidspunktet, uafhængigt af mappestrukturen. Teams tagger typisk et smoke-sæt, et slow-sæt og et work-in-progress-sæt og kører derefter kun det, som en given pipeline-fase har brug for.

Store sprogmodeller udarbejder Gherkin ud fra et acceptkriterium godt og genererer de matchende definitionsskeletter endnu hurtigere. RevSe outputtet for duplikeret trintekst og for scenarier, der lækker implementeringsdetaljer, hvilket er hvor genereret Gherkin normalt går galt.

Meget. Givet en åben funktionsfil udleder Copilot det regulære udtryk og metodesignaturen for et udefineret trin og udfylder brødteksten fra den omgivende kode. Betragt det som et første udkast; de foreslåede assertions kræver stadig en menneskelig kontrol.

Ja, og det er pointen med designet. Definitioner findes i en delt mappe og matches af tekst, ikke af fil, så et logintrin, der er skrevet én gang, genbruges af alle funktioner, der har brug for det. Genbrug er grunden til, at duplikeret trintekst er forbudt.

Opsummer dette indlæg med: