Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use GherkinDocument class

Best Cucumber Common Library code snippet using GherkinDocument

GherkinDocument.php

Source:GherkinDocument.php

...6namespace Cucumber\Messages;7use JsonSerializable;8use Cucumber\Messages\DecodingException\SchemaViolationException;9/**10 * Represents the GherkinDocument message in Cucumber's message protocol11 * @see https://github.com/cucumber/common/tree/main/messages#readme12 *13 * The [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) of a Gherkin document.14 * Cucumber implementations should *not* depend on `GherkinDocument` or any of its15 * children for execution - use [Pickle](#io.cucumber.messages.Pickle) instead.16 *17 * The only consumers of `GherkinDocument` should only be formatters that produce18 * "rich" output, resembling the original Gherkin document. */19final class GherkinDocument implements JsonSerializable20{21    use JsonEncodingTrait;22    /**23     * Construct the GherkinDocument with all properties24     *25     * @param list<Comment> $comments26     */27    public function __construct(28        /**29         * The [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)30         * of the source, typically a file path relative to the root directory31         */32        public readonly ?string $uri = null,33        public readonly ?Feature $feature = null,34        /**35         * All the comments in the Gherkin document36         */37        public readonly array $comments = [],...

EnvelopeTest.php

Source:EnvelopeTest.php

1<?php2use Cucumber\Messages\Envelope;3use Cucumber\Messages\Feature;4use Cucumber\Messages\GherkinDocument;5use Cucumber\Messages\Location;6use PHPUnit\Framework\TestCase;7class EnvelopeTest extends TestCase8{9    public function testItCanBeConstructedWithDefaultProperties(): void10    {11        $envelope = new Envelope();12        self::assertNull($envelope->gherkinDocument);13    }14    public function testItCanBeConstructedWithASubsetOfProperties(): void15    {16        $envelope = new Envelope(17            gherkinDocument: new GherkinDocument(18                feature: new Feature(19                    location: new Location(20                        line: 2121                    )22                )23            )24        );25        self::assertSame(26            21,27            $envelope->gherkinDocument?->feature?->location?->line28        );29    }30}...

GherkinDocument

Using AI Code Generation

1require_once 'vendor/autoload.php';2use Behat\Gherkin\Node\PyStringNode;3use Behat\Gherkin\Node\TableNode;4use Behat\Gherkin\Gherkin;5use Behat\Gherkin\Node\FeatureNode;6use Behat\Gherkin\Node\ScenarioNode;7use Behat\Gherkin\Node\StepNode;8use Behat\Gherkin\Node\BackgroundNode;9use Behat\Gherkin\Node\OutlineNode;10use Behat\Gherkin\Node\ExamplesNode;11use Behat\Gherkin\Node\ExampleTableNode;12use Behat\Gherkin\Node\ExampleNode;13use Behat\Gherkin\Node\PyStringNode;14use Behat\Gherkin\Node\TableNode;15$parser = new Gherkin();16$feature = $parser->parse(file_get_contents('test.feature'));

GherkinDocument

Using AI Code Generation

1require_once 'vendor/autoload.php';2use Behat\Gherkin\Loader\GherkinFileLoader;3use Behat\Gherkin\Node\FeatureNode;4use Behat\Gherkin\Node\ScenarioNode;5use Behat\Gherkin\Node\StepNode;6use Behat\Gherkin\Node\TableNode;7use Behat\Gherkin\Node\PyStringNode;8use Behat\Gherkin\Node\BackgroundNode;9$loader = new GherkinFileLoader();10$feature = $loader->load('features/1.feature');11echo $feature->getTitle();12echo $feature->getDescription();13$scenarios = $feature->getScenarios();14foreach ($scenarios as $scenario) {15    echo $scenario->getTitle();16    echo $scenario->getDescription();17    $steps = $scenario->getSteps();18    foreach ($steps as $step) {19        echo $step->getType();20        echo $step->getText();21        $table = $step->getTable();22        if ($table) {23            $rows = $table->getRows();24            foreach ($rows as $row) {25                foreach ($row as $column) {26                    echo $column;27                }28            }29        }30        $string = $step->getPyString();31        if ($string) {32            echo $string->getRaw();33        }34    }35}36$background = $feature->getBackground();37if ($background) {38    echo $background->getTitle();39    echo $background->getDescription();40    $steps = $background->getSteps();41    foreach ($steps as $step) {42        echo $step->getType();43        echo $step->getText();44        $table = $step->getTable();45        if ($table) {46            $rows = $table->getRows();47            foreach ($rows as $row) {48                foreach ($row as $column) {49                    echo $column;50                }51            }52        }53        $string = $step->getPyString();54        if ($string) {55            echo $string->getRaw();56        }57    }58}59$loader = new GherkinFileLoader();60$feature = $loader->load('features/1.feature');61echo $feature->getFeatureNode()->getFile();

GherkinDocument

Using AI Code Generation

1use Cucumber\Gherkin\GherkinDocument;2use Cucumber\Gherkin\Parser;3$parser = new Parser();4$document = $parser->parse(file_get_contents('sample.feature'));5$feature = new GherkinDocument($document);6echo $feature->getTitle();7echo $feature->getDescription();8$scenarios = $feature->getScenarios();9foreach ($scenarios as $scenario) {10    echo $scenario->getTitle();11    echo $scenario->getDescription();12}13$steps = $scenario->getSteps();14foreach ($steps as $step) {15    echo $step->getKeyword();16    echo $step->getText();17}18$tags = $scenario->getTags();19foreach ($tags as $tag) {20    echo $tag;21}22$examples = $scenario->getExamples();23foreach ($examples as $example) {24    echo $example->getTitle();25    echo $example->getDescription();26    echo $example->getKeyword();27    $headers = $example->getHeader();28    foreach ($headers as $header) {29        echo $header;30    }31    $rows = $example->getRows();32    foreach ($rows as $row) {33        foreach ($row as $cell) {34            echo $cell;35        }36    }37}38$background = $feature->getBackground();39$steps = $background->getSteps();40foreach ($steps as $step) {41    echo $step->getKeyword();42    echo $step->getText();43}44$comments = $feature->getComments();45foreach ($comments as $comment) {46    echo $comment;47}48$tags = $feature->getTags();49foreach ($tags as $tag) {50    echo $tag;51}52$rules = $feature->getRules();53foreach ($rules as $rule) {54    echo $rule->getTitle();

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.