helge
/
fediverse-features
1
4
Fork 2
Code Issues 5 Pull Requests Packages Projects Releases Wiki Activity
Gherkin Features for BDD in the fediverse
27 Commits
1 Branch
0 Tags
398 KiB
Gherkin 100%
 
Go to file
Helge d50d32536c Add feature for parsing actors ... 2023-11-30 12:27:07 +01:00
fedi Add feature for parsing actors ... 2023-11-30 12:27:07 +01:00
feps Update fep-8b32.feature 2023-11-27 19:31:41 +01:00
ietf Add host_meta test 2023-10-03 10:37:35 +02:00
w3c Update to new algorithm names 2023-09-01 19:37:31 +02:00
README.md add implementations section 2023-08-08 10:20:34 +02:00

README.md

fediverse-features

This repository is home of feature files in Gherkin for the Fediverse. Contributions are welcome.

Gherkin is the language for defining test cases. It has natural language syntax and is designed to provide simple documentation. In order to illustrate Gherkin and general we will use Gherkin to describe the purpose of this repository.

Feature: The fediverse-features repository
    A repository containing Gherking features for the Fediverse. The repository is available at
    https://codeberg.org/helge/fediverse-features
    Features can contain both things documented in the provided resources, and extra material.

Every feature file starts with the keyword Feature: a title and a possible description block. These explain the content of the feature file. When documenting behavior specified in a document, it should be linked. Furthermore, it should be specfied which behavior is covered by the specification document and which is not.

Scenario: Finding a feature for a task
    Given a developer Alyssa working on the Fediverse
    When Alyssa is implementing http signatures
    Then Alyssa finds the corresponding feature "fedi/http_signatures.feature"
    And Alyssa can test her implementation against the feature
    And Alyssa can add her implementation to the corresponding list in this repository

The form of a Scenario is given by the Given-When-Then structure. Given defines the environment. When describes the task. Then asserts the results. At this point, it should be noted that the last point is not part of this repository yet, but is on the roadmap. One should note that a feature file can contain multiple Scenarios.

The current structure is that the folder feps contains test related to FEP. The folder fedi contains more general tests.

Reading material

Implementations