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

How to use GherkinDocument class of Gherkin.CucumberMessages.Types package

Best Gherkin-dotnet code snippet using Gherkin.CucumberMessages.Types.GherkinDocument

AstMessagesConverter.cs

Source:AstMessagesConverter.cs

...11using Rule = Gherkin.CucumberMessages.Types.Rule;12using Step = Gherkin.CucumberMessages.Types.Step;13using DataTable = Gherkin.CucumberMessages.Types.DataTable;14using DocString = Gherkin.CucumberMessages.Types.DocString;15using GherkinDocument = Gherkin.CucumberMessages.Types.GherkinDocument;16using Scenario = Gherkin.CucumberMessages.Types.Scenario;17using TableCell = Gherkin.CucumberMessages.Types.TableCell;18using TableRow = Gherkin.CucumberMessages.Types.TableRow;19using Tag = Gherkin.CucumberMessages.Types.Tag;20namespace Gherkin.CucumberMessages21{22    public class AstMessagesConverter23    {24        private readonly IIdGenerator _idGenerator;25        public AstMessagesConverter(IIdGenerator idGenerator)26        {27            _idGenerator = idGenerator;28        }29        public GherkinDocument ConvertGherkinDocumentToEventArgs(Ast.GherkinDocument gherkinDocument, string sourceEventUri)30        {31            return new GherkinDocument()32            {33                Uri = sourceEventUri,34                Feature = ConvertFeature(gherkinDocument),35                Comments = ConvertComments(gherkinDocument)36            };37        }38        private IReadOnlyCollection<Comment> ConvertComments(Ast.GherkinDocument gherkinDocument)39        {40            return gherkinDocument.Comments.Select(c =>41                new Comment()42                {43                    Text = c.Text,44                    Location = ConvertLocation(c.Location)45                }).ToReadOnlyCollection();46        }47        private Feature ConvertFeature(Ast.GherkinDocument gherkinDocument)48        {49            var feature = gherkinDocument.Feature;50            if (feature == null)51            {52                return null;53            }54            var children = feature.Children.Select(ConvertToFeatureChild).ToReadOnlyCollection();55            var tags = feature.Tags.Select(ConvertTag).ToReadOnlyCollection();56            return new Feature()57            {58                Name = CucumberMessagesDefaults.UseDefault(feature.Name, CucumberMessagesDefaults.DefaultName),59                Description = CucumberMessagesDefaults.UseDefault(feature.Description, CucumberMessagesDefaults.DefaultDescription),60                Keyword = feature.Keyword,61                Language = feature.Language,...

PickleCompiler.cs

Source:PickleCompiler.cs

...11        public PickleCompiler(IIdGenerator idGenerator)12        {13            _idGenerator = idGenerator;14        }15        public List<Pickle> Compile(GherkinDocument gherkinDocument)16        {17            var pickles = new List<Pickle>();18            var feature = gherkinDocument.Feature;19            if (feature == null)20            {21                return pickles;22            }23            var language = feature.Language;24            var tags = feature.Tags;25            BuildFeature(pickles, language, tags, Enumerable.Empty<PickleStep>, feature.Children, gherkinDocument.Uri);26            return pickles;27        }28        protected virtual void BuildFeature(List<Pickle> pickles, string language, IEnumerable<Tag> tags,29            Func<IEnumerable<PickleStep>> backgroundStepsFactory, IEnumerable<FeatureChild> children,...

GherkinEventsProvider.cs

Source:GherkinEventsProvider.cs

...38                if (_printAst)39                {40                    events.Add(new Envelope41                    {42                        GherkinDocument =43                            _astMessagesConverter.ConvertGherkinDocumentToEventArgs(gherkinDocument, source.Uri)44                    });45                }46                if (_printPickles)47                {48                    var pickles = _pickleCompiler.Compile(_astMessagesConverter.ConvertGherkinDocumentToEventArgs(gherkinDocument, source.Uri));49                    foreach (Pickle pickle in pickles)50                    {51                        events.Add(new Envelope52                        {53                            Pickle = pickle54                        });55                    }56                }57            }58            catch (CompositeParserException e)59            {60                foreach (ParserException error in e.Errors)61                {62                    AddParseError(events, error, source.Uri);...

AstBuildingTests.cs

Source:AstBuildingTests.cs

...11        public void TestSuccessfulAstBuilding(string testFeatureFile)12        {13            var testFile = GetFullPathToTestFeatureFile(testFeatureFile, "good", ".ast.ndjson");14            var expectedAstContent = GetExpectedContent(testFile.ExpectedFileFullPath);15            var expectedGherkinDocumentEvent = NDJsonParser.Deserialize<Envelope>(expectedAstContent);16            var raisedEvents = ProcessGherkinEvents(testFile.FullPath, false, true, false);17            raisedEvents.Should().Match(list => list.All(e => e.GherkinDocument != null));18            AssertEvents(testFeatureFile, raisedEvents, expectedGherkinDocumentEvent, testFile);19        }20        [Theory, MemberData(nameof(TestFileProvider.GetInvalidTestFiles), MemberType = typeof(TestFileProvider))]21        public void TestFailedAstBuilding(string testFeatureFile)22        {23            var testFile = GetFullPathToTestFeatureFile(testFeatureFile, "bad", ".errors.ndjson");24            var expectedAstContent = GetExpectedContent(testFile.ExpectedFileFullPath);25            var expectedGherkinDocumentEvent = NDJsonParser.Deserialize<Envelope>(expectedAstContent);26            var raisedEvents = ProcessGherkinEvents(testFile.FullPath, false, true, false);27            raisedEvents.Should().Match(list => list.All(e => e.ParseError != null));28            AssertEvents(testFeatureFile, raisedEvents, expectedGherkinDocumentEvent, testFile);29        }30    }31}...

Envelope.cs

Source:Envelope.cs

...5{6    public class Envelope7    {8        [DataMember(Name = "gherkinDocument")]9        public GherkinDocument GherkinDocument { get; set; }1011        [DataMember(Name = "source")]12        public Source Source { get; set; }1314        [DataMember(Name = "pickle")]15        public Pickle Pickle { get; set; }1617        [DataMember(Name = "parseError")]18        public ParseError ParseError { get; set; }19    }20}
...

GherkinDocument.cs

Source:GherkinDocument.cs

1ï»¿using System.Collections.Generic;2using System.Runtime.Serialization;3namespace Gherkin.CucumberMessages.Types4{5    public class GherkinDocument6    {7        [DataMember(Name = "uri")]8        public string Uri { get; set; }9        [DataMember(Name = "feature")]10        public Feature Feature { get; set; }11        [DataMember(Name = "comments")]12        public IReadOnlyCollection<Comment> Comments { get; set; }13    }14}...

GherkinDocument

Using AI Code Generation

1{2    {3        static void Main(string[] args)4        {5            var gherkinDocument = new GherkinDocument();6            gherkinDocument.Feature = new Feature();7            gherkinDocument.Feature.Name = "Hello";8            gherkinDocument.Feature.Description = "World";9            gherkinDocument.Feature.Children.Add(new FeatureChild());10            gherkinDocument.Feature.Children[0].Background = new Background();11            gherkinDocument.Feature.Children[0].Background.Name = "Background";12            gherkinDocument.Feature.Children[0].Background.Description = "Description";13            gherkinDocument.Feature.Children[0].Background.Steps.Add(new Step());14            gherkinDocument.Feature.Children[0].Background.Steps[0].Keyword = "Given ";15            gherkinDocument.Feature.Children[0].Background.Steps[0].Text = "I am on the Google search page";16            gherkinDocument.Feature.Children[0].Background.Steps.Add(new Step());17            gherkinDocument.Feature.Children[0].Background.Steps[1].Keyword = "When ";18            gherkinDocument.Feature.Children[0].Background.Steps[1].Text = "I search for \"cheese\"";19            gherkinDocument.Feature.Children[0].Background.Steps.Add(new Step());20            gherkinDocument.Feature.Children[0].Background.Steps[2].Keyword = "Then ";21            gherkinDocument.Feature.Children[0].Background.Steps[2].Text = "the search result should contain \"cheese\"";22            Console.WriteLine(gherkinDocument.Feature.Children[0].Background.Steps[0].Text);23            Console.WriteLine(gherkinDocument.Feature.Children[0].Background.Steps[1].Text);24            Console.WriteLine(gherkinDocument.Feature.Children[0].Background.Steps[2].Text);25        }26    }27}

GherkinDocument

Using AI Code Generation

1{2    static void Main(string[] args)3    {4        GherkinDocument gherkinDocument = new GherkinDocument();5        string json = gherkinDocument.ToJson();6        Console.WriteLine(json);7    }8}9{10  "feature": {11    "location": {12    },13      {14        "scenario": {15          "location": {16          },17            {18              "location": {19              },20            }21        }22      }23  }24}25{26    static void Main(string[] args)27    {28        string json = @"{29  ""feature"": {30    ""location"": {31    },32      {33        ""scenario"": {34          ""location"": {35          },36            {37              ""location"": {38              },39            }40        }41      }42  }43}";44        GherkinDocument gherkinDocument = GherkinDocument.Parser.ParseJson(json);45        Console.WriteLine(gherkinDocument.Feature.Name);46    }47}

GherkinDocument

Using AI Code Generation

1using Gherkin.CucumberMessages.Types;2using System;3using System.IO;4{5    {6        static void Main(string[] args)7        {8            string path = @"C:\Users\user\source\repos\GherkinTest\GherkinTest\Features\1.feature";9            string featureFile = File.ReadAllText(path);10            GherkinDocument gherkinDocument = GherkinDocument.Parser.ParseFrom(featureFile);11            Feature feature = gherkinDocument.Feature;12            string featureName = feature.Name;13            string featureDescription = feature.Description;14            string featureKeyword = feature.Keyword;15            string featureLanguage = feature.Language;16            string featureTags = feature.Tags[0].Name;17            string featureChildren = feature.Children[0].Keyword;18            int featureLocationLine = feature.Location.Line;19            int featureLocationColumn = feature.Location.Column;20            string featureUri = feature.Uri;21            string featureComments = feature.Comments[0].Text;22            Console.WriteLine("Feature name: " + featureName);23            Console.WriteLine("Feature description: " + featureDescription);24            Console.WriteLine("Feature keyword: " + featureKeyword);25            Console.WriteLine("Feature language: " + featureLanguage);26            Console.WriteLine("Feature tags: " + featureTags);27            Console.WriteLine("Feature children: " + featureChildren);28            Console.WriteLine("Feature location line: " + featureLocationLine);29            Console.WriteLine("Feature location column: " + featureLocationColumn);30            Console.WriteLine("Feature uri: " + featureUri);31            Console.WriteLine("Feature comments

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.