Facet
EnglishInstallieren

STANDARDS · GHERKIN

Given, When, Then: Verhalten als Beispiele, die jeder lesen kann.

Gherkin ist das Textformat, mit dem Cucumber an konkreten Beispielen beschreibt, was Software tut. FACET beschreibt die Akzeptanzkriterien eines Records im selben Format.

Ein Schlüsselwort je Zeile sagt, wofür die Zeile steht.

Ein Szenario ist ein konkretes Beispiel für eine Regel. Wer nur die Schlüsselwörter liest, kennt schon seinen Aufbau: wo es beginnt, was geschieht, was danach gelten muss.

Ein Gherkin-Szenario, ein Schlüsselwort je Zeile
  1. Feature: Discount codesFeatureBenennt die Fähigkeit, die die Beispiele darunter beschreiben.
  2. Scenario: An expired code is rejectedScenarioEin konkretes Beispiel für eine Regel, mit einem Namen, den ein Mensch sagen würde.
  3. Given a code that expired yesterdayGivenDer Zustand, bevor etwas geschieht.
  4. When the customer applies the codeWhenDie eine Handlung, um die es im Beispiel geht.
  5. Then the total is unchangedThenEin Ergebnis, das jemand beobachten kann.
  6. And the customer sees that the code has expiredAndEin weiterer Schritt derselben Art wie der darüber, hier ein zweites Ergebnis.

Dasselbe Szenario in einem FACET-Record.

FACET behält die Sätze und legt sie dorthin, wo der Rest des Features liegt: neben seinen Zweck, seine Anker und die Tests, die es belegen.

GHERKINdiscount-codes.feature
Feature: Discount codes  # 1   Scenario: An expired code is rejected  # 2    Given a code that expired yesterday    When the customer applies the code    Then the total is unchanged    And the customer sees that the code has expired
RECORDdocs/facets/features/checkout/pricing/discount-codes.yaml
id: checkout/pricing/discount-codes  # 1contract:  scenarios:    - id: expired-code-rejected  # 2      statement: |  # 3        Given a code that expired yesterday        When the customer applies the code        Then the total is unchanged        And the customer sees that the code has expiredverification:  unit_tests:    - id: checkout::discount::test_expired_code_rejected      proves: [expired-code-rejected]  # 5
Wo jedes Gherkin-Element in einem FACET-Record steht
#GherkinFACET-RecordWas sich ändert
1Feature:id: checkout/pricing/discount-codesDer Record ist das Feature. Seine Id sagt, wo es im Produkt liegt.
2Scenario:contract.scenarios[].idEine stabile Id statt eines Titels, damit Tests und andere Records es benennen können.
3Given / When / Then / Andcontract.scenarios[].statementDie Schritte, unverändert. Jeder Schritt auf eigener Zeile; ein zweiter Schritt derselben Art beginnt mit And.
4Scenario Outline + Examplesstatement mit <Platzhaltern> + examplesBenannte Beispielblöcke, eine Regel je Block, und weiterhin ein Szenario, egal wie viele Zeilen es hat.
5Step Definitionsverification … proves: [scenario-id]Der Record benennt die Tests, die das Szenario belegen. Sie bleiben im Testrunner, den Sie schon nutzen.

Grenze

FACET nutzt die Form von Gherkin, keine .feature-Datei.

Das Szenario steht im Record. Unter verification benennt der Record die Tests, die es belegen, und facet test führt sie in den Runnern aus, die Sie schon nutzen. Ein Szenario ohne verknüpften Test ist eine Lint-Warnung.

Warum FACET Features so beschreibt.

Dokumentation, die Code beschreibt, läuft ihm davon. Ein Szenario beschreibt Verhalten: das, wonach Menschen fragen, und das, was Tests prüfen können.

  • Eine Sprache für Produkt, Entwicklung und Support

    Ein Szenario ist so geschrieben, dass Entwickler und Produktmanager es gleichermaßen lesen, und die Hilfeartikel, mit denen der Support arbeitet, lassen sich aus demselben Record erzeugen. Niemand braucht den Code, um zu sagen, ob der Satz stimmt.

  • Geformt wie ein Test

    Given ist der Zustand davor, When die Handlung, Then das Beobachtbare. Das ist die Form eines Tests, also kann jedes Szenario von einem beansprucht werden, und der Record sagt, von welchem.

  • Ein Szenario, ein Akzeptanzkriterium

    Ein Szenario je Regel oder Grenzfall. Zwei Folgen sind zwei Zeilen, denn ein Test kann nicht die Hälfte eines verbundenen Satzes belegen.

  • Auf das Feature ausgerichtet

    Szenarien stehen unter dem Feature, das sie beschreiben, nicht unter einer Datei oder einer Klasse. Ein Feature hat zwischen zwei und neun davon, mindestens eines ein Fehlerfall.

Quelle: FACETOriginalauszug aus der englischen Quelle.[…] a named, coherent capability of the product that can be reasoned about, changed, and owned independently. […]Auf GitHub öffnen FACET §2.1.1Originalauszug aus der englischen Quelle.[…] It has between two and nine observable scenarios, including at least one failure path. […]Auf GitHub öffnen, FACET §3.2Originalauszug aus der englischen Quelle.[…] The normative behavior of the feature — the rules that MUST hold. […]Auf GitHub öffnen, FACET §3.2.3Originalauszug aus der englischen Quelle.[…] MUST NOT flatten them into set notation or a list inside one Given/When/Then. […]Auf GitHub öffnen, FACET §3.4Originalauszug aus der englischen Quelle.[…] The tests and property checks that prove the contract holds. […]Auf GitHub öffnen und FACET §8.5Originalauszug aus der englischen Quelle.[…] The Knowledge facet exists precisely to feed this pipeline. […]Auf GitHub öffnen.

Die offizielle Referenz

Die Schlüsselwörter von Gherkin, seine Grammatik und seine Übersetzungen in viele Sprachen dokumentiert Cucumber.