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

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

EventTestBase.cs

Source:EventTestBase.cs

...13    public class EventTestBase14    {15        protected readonly IncrementingIdGenerator idGenerator = new IncrementingIdGenerator();16        17        protected void AssertEvents(string testFeatureFile, List<Envelope> actualGherkinDocumentEvent, List<Envelope> expectedGherkinDocumentEvent, TestFile testFile)18        {19            actualGherkinDocumentEvent.Should().BeEquivalentTo(expectedGherkinDocumentEvent,20               config => config21                   .AllowingInfiniteRecursion()22                   .IgnoringCyclicReferences()23                   .Excluding(ghe => ghe.Path.EndsWith("Uri"))24                   .Using<string>(ctx =>25                                    {26                                        var replacedSubject = NormalizeNewLines(ctx.Subject);27                                        var expectedSubject = NormalizeNewLines(ctx.Expectation);28                                        replacedSubject.Should().Be(expectedSubject);29                                    })30                   .WhenTypeIs<string>(),31               $"{testFeatureFile} is not generating the same content as {testFile.ExpectedFileFullPath}");32        }33        private string NormalizeNewLines(string value)34        {35            return value?.Replace("\r\n", "\n").Replace("\n", Environment.NewLine);36        }37        protected class TestFile38        {39            public string FullPath { get; set; }40            public string ExpectedFileFullPath { get; set; }41        }42        protected TestFile GetFullPathToTestFeatureFile(string testFeatureFile, string category, string filePostfix)43        {44            var fullPathToTestFeatureFile = Path.Combine(TestFileProvider.GetTestFileFolder(category), testFeatureFile);45            var featureFileFolder = Path.GetDirectoryName(fullPathToTestFeatureFile);46            Debug.Assert(featureFileFolder != null);47            var expectedAstFile = fullPathToTestFeatureFile + filePostfix;48            return new TestFile()49            {50                FullPath = fullPathToTestFeatureFile,51                ExpectedFileFullPath = expectedAstFile52            };53        }54        protected List<Envelope> ProcessGherkinEvents(string fullPathToTestFeatureFile, bool printSource, bool printAst, bool printPickles)55        {56            var raisedEvents = new List<Envelope>();57            var sourceProvider = new SourceProvider();58            var sources = sourceProvider.GetSources(new List<string> {fullPathToTestFeatureFile});59            var gherkinEventsProvider = new GherkinEventsProvider(printSource, printAst, printPickles, idGenerator);60            foreach (var source in sources)61            {62                foreach (var evt in gherkinEventsProvider.GetEvents(source))63                {64                    raisedEvents.Add(evt);65                }66            }67            return raisedEvents;68        }69        protected string GetExpectedContent(string expectedAstFile)70        {...

GherkinEventsProvider.cs

Source:GherkinEventsProvider.cs

...21            _pickleCompiler = new PickleCompiler(idGenerator);22            _printAst = printAst;23            _printPickles = printPickles;24        }25        public IEnumerable<Envelope> GetEvents(Source source)26        {27            var events = new List<Envelope>();28            try29            {30                var gherkinDocument = _parser.Parse(new StringReader(source.Data));31                if (_printSource)32                {33                    events.Add(new Envelope34                    {35                        Source = source36                    });37                }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);63                }64            }65            catch (ParserException e)66            {67                AddParseError(events, e, source.Uri);68            }69            return events;70        }71        private void AddParseError(List<Envelope> events, ParserException e, String uri)72        {73            events.Add(new Envelope74            {75                ParseError = new ParseError()76                {77                    Message = e.Message,78                    Source = new SourceReference()79                    {80                        Location = new Location(e.Location.Column, e.Location.Line),81                        Uri = uri82                    }83                }84            });85        }86    }87}...

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}...

SourceTests.cs

Source:SourceTests.cs

...11        public void TestSourceMessage(string testFeatureFile)12        {13            var testFile = GetFullPathToTestFeatureFile(testFeatureFile, "good", ".source.ndjson");14            var expectedAstContent = GetExpectedContent(testFile.ExpectedFileFullPath);15            var expectedGherkinDocumentEvent = NDJsonParser.Deserialize<Envelope>(expectedAstContent);16            var raisedEvents = ProcessGherkinEvents(testFile.FullPath, true, false, false);17            raisedEvents.Should().Match(list => list.All(e => e.Source != null));18            AssertEvents(testFeatureFile, raisedEvents, expectedGherkinDocumentEvent, testFile);19        }20    }21}...

PicklesTests.cs

Source:PicklesTests.cs

...11        public void TestPickleCompilation(string testFeatureFile)12        {13            var testFile = GetFullPathToTestFeatureFile(testFeatureFile, "good", ".pickles.ndjson");14            var expectedContent = GetExpectedContent(testFile.ExpectedFileFullPath);15            var expectedEvents = NDJsonParser.Deserialize<Envelope>(expectedContent);16            var raisedEvents = ProcessGherkinEvents(testFile.FullPath, false, false, true);17            raisedEvents.Should().Match(list => list.All(e => e.Pickle != null));18            AssertEvents(testFeatureFile, raisedEvents, expectedEvents, testFile);19        }20    }21}...

Envelope.cs

Source:Envelope.cs

2using System.Runtime.Serialization;34namespace Gherkin.CucumberMessages.Types5{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}
...

Envelope

Using AI Code Generation

1using Gherkin.CucumberMessages.Types;2using System;3using System.Collections.Generic;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7{8    {9        static void Main(string[] args)10        {11";12            var envelope = new Envelope();13            envelope.Source = new Source();14            envelope.Source.Data = source;15            envelope.Source.Media = new Media();16            envelope.Source.Media.Encoding = "UTF-8";17            envelope.Source.Media.ContentType = "text/x.cucumber.gherkin+plain";18            Console.WriteLine(envelope.Source.ToString());19            Console.ReadLine();20        }21    }22}

Envelope

Using AI Code Generation

1using Gherkin.CucumberMessages.Types;2{3    static void Main(string[] args)4    {5        var envelope = new Envelope();6        envelope.Source = new Source();7        envelope.Source.Uri = "test.feature";8Given I have a step";9        envelope.Source.Media = new Media();10        envelope.Source.Media.Encoding = "UTF-8";11        envelope.Source.Media.ContentType = "text/x.cucumber.gherkin+plain";12        Console.WriteLine(envelope);13    }14}15using Gherkin.CucumberMessages;16{17    static void Main(string[] args)18    {19        var envelope = new Envelope();20        envelope.Source = new Source();21        envelope.Source.Uri = "test.feature";22Given I have a step";23        envelope.Source.Media = new Media();24        envelope.Source.Media.Encoding = "UTF-8";25        envelope.Source.Media.ContentType = "text/x.cucumber.gherkin+plain";26        Console.WriteLine(envelope);27    }28}29using Gherkin;30{31    static void Main(string[] args)32    {33        var envelope = new Envelope();34        envelope.Source = new Source();35        envelope.Source.Uri = "test.feature";36Given I have a step";37        envelope.Source.Media = new Media();38        envelope.Source.Media.Encoding = "UTF-8";39        envelope.Source.Media.ContentType = "text/x.cucumber.gherkin+plain";40        Console.WriteLine(envelope);41    }42}

Envelope

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.IO;4using Gherkin.CucumberMessages.Types;5{6    {7        static void Main(string[] args)8        {9            string path = @"C:\Users\username\Downloads\cucumber-messages-11.0.0\cucumber-messages-11.0.0\cucumber-messages\testdata\gherkin\messages\envelope.ndjson";10            string[] lines = File.ReadAllLines(path);11            List<Envelope> envelopeList = new List<Envelope>();12            foreach (string line in lines)13            {14                Envelope envelope = Envelope.Parser.ParseJson(line);15                envelopeList.Add(envelope);16            }17            foreach (Envelope envelope in envelopeList)18            {19                Console.WriteLine(envelope.Source);20            }21        }22    }23}

Envelope

Using AI Code Generation

1var env = new Envelope();2env.Source = new Source();3env.Source.Uri = "path/to/file.feature";4env.Source.Data = "Feature: Hello World";5var json = env.ToJson();6var json = "{ \"source\": { \"uri\": \"path/to/file.feature\", \"data\": \"Feature: Hello World\" } }";7var env = Envelope.Parser.ParseJson(json);8var json = "{ \"source\": { \"uri\": \"path/to/file.feature\", \"data\": \"Feature: Hello World\" } }";9var env = Envelope.Parser.ParseJson(json);10var json = "{ \"source\": { \"uri\": \"path/to/file.feature\", \"data\": \"Feature: Hello World\" } }";11var env = Envelope.Parser.ParseJson(json);12var json = "{ \"source\": { \"uri\": \"path/to/file.feature\", \"data\": \"Feature: Hello World\" } }";13var env = Envelope.Parser.ParseJson(json);14var json = "{ \"source\": { \"uri\": \"path/to/file.feature\", \"data\": \"Feature: Hello World\" } }";15var env = Envelope.Parser.ParseJson(json);16var json = "{ \"source\": { \"uri\": \"path/to/file.feature\", \"data\": \"Feature: Hello World\" } }";17var env = Envelope.Parser.ParseJson(json

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.