Add Dotnet Implementation #81

clrudolphi · 2025-07-08T22:57:43Z

🤔 What's changed?

Adding a dotnet implementation. This is more or less a direct port of the Java source.

⚡️ What's your motivation?

Will be using this to implement/enhance the conformation testing of the Reqnroll implementation of Messages.

🏷️ What kind of change is this?

🏦 Refactoring/debt/DX (improvement to code design, tooling, etc. without changing behaviour)

♻️ Anything particular you want feedback on?

I need a review of the QueryTest suite to ensure that I have all the tests included.

This needs integration into the CI pipeline.
This will need a nuget push as well.

📋 Checklist:

I agree to respect and uphold the Cucumber Community Code of Conduct
I've changed the behaviour of the code
- I have added/updated tests to cover my changes.
My change requires a change to the documentation.
- I have updated the documentation accordingly.
Users should know about my change
- I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

davidjgoss · 2025-07-09T05:31:35Z

dotnet/Query/QueryTest/Resources/attachments.feature.ndjson

Could we dynamically populate these files from the canonical ones in the testdata folder rather than commit them again here?

EDIT: yes, I've made that change to the .net solution.
Will need your help to change the build script to have the files copied into the .net folder structure as part of the java build process.

I don't quite understand. Why do the test data files have to be copied?

Java for example doesn't copy any file, it uses a a relative path "../testdata" to go up one directory and then down the testdata folder..

No problem. I've adjusted the path to look outside the root of the dotnet solution.

mpkorstanje

I need a review of the QueryTest suite to ensure that I have all the tests included.

If you use the data from the testdata folder, that should be guaranteed.

Will be using this to implement/enhance the conformation testing of the Reqnroll implementation of Messages.

I'm not sure if the query library is the right tool for that. It doesn't provide a systematic list of operations on messages yet. Rather it is driven by the needs of the various report generators that we're migrating to messages. So I'm afraid we might end up with rather disjoint libraries if it used by one implementation for conformance testing and for reporting in another.

The implementation looks good over all. A few remarks:

The access modifiers seem to be a bit to open. I'd like to keep the public API of these libraries small and well defined. This makes it easier to create new versions without breaking changes and if we do make breaking changes, communicate those through the version number.
There is a little bit of technical debt that I think would be good to clean up from Java first before we duplicate it to .Net.

dotnet/Query/Query/Query.cs

mpkorstanje · 2025-07-09T10:16:19Z

dotnet/Query/Query/Query.cs

+        return FindLineageBy(pickle);
+    }
+
+    public string FindNameOf(GherkinDocument element, NamingStrategy namingStrategy)


@davidjgoss since we made the lineage API public, I think we could get rid of all the FindNameOf methods.

Made #84 to show.

mpkorstanje · 2025-07-09T10:17:54Z

dotnet/Query/Query/Query.cs

+
+    public IList<TestStep> FindAllTestSteps() => _testStepById.Values.OrderBy(ts => ts.Id).ToList();
+
+    public IDictionary<Feature?, List<TestCaseStarted>> FindAllTestCaseStartedGroupedByFeature()


This too could be removed and pushed into client libraries.

mpkorstanje · 2025-07-09T10:22:55Z

dotnet/Query/Query/TimestampComparer.cs

+namespace Io.Cucumber.Query
+{
+    // Port of io.cucumber.query.TimestampComparator (Java)
+    public class TimestampComparer : IComparer<Timestamp>


Please pay attention to the access modifiers. This Java equivalent of this class is package-private (default, no access modifier). The .Net equivalent is internal I think.

I saw a few more of these, but I'm not 100% on .Net access controls.

Also, this class is one I'm intending to move into messages.

Modified the access modifiers where it makes sense to me. Let me know if you find any that remain concerning.
I left the Query.UpdateXXX methods as internal as some of them are used in the test project.

…er than embedded resources).

- Updated `Lineage` class to implement `IEquatable<Lineage>`, adding a specific `Equals` method and `GetHashCode`. - Simplified timestamp conversion in `Query` class using `ToDateTimeOffset()` extension method. - Changed `TimestampComparer` visibility from public to internal. - Added `TimestampExtensions` class for converting `Timestamp` to `DateTimeOffset`. - Minor fix in `QueryAcceptanceTest.cs` to default null names to empty strings.

clrudolphi · 2025-07-09T16:47:12Z

I'm not sure if the query library is the right tool for that.

My intent is to use it within our Messages conformance test suite, but to use it to confirm the integrity (internal consistency) of the generated messages. Things such as a TestStepStarted points to a valid TestCaseStarted, etc.

clrudolphi · 2025-07-09T16:48:07Z

@mpkorstanje @davidjgoss Let me know if there is anything else you'd like to see changed.
Otherwise, I'll wait for the other in-flight PRs to close and then I'll make the dotnet version match.

mpkorstanje · 2025-07-09T20:32:21Z

My intent is to use it within our Messages conformance test suite, but to use it to confirm the integrity (internal consistency) of the generated messages. Things such as a TestStepStarted points to a valid TestCaseStarted, etc.

That sounds reasonable.

mpkorstanje · 2025-07-09T20:35:53Z

Otherwise, I'll wait for the other in-flight PRs to close and then I'll make the dotnet version match.

Cheers! Appreciate the patience. This PR made me realize this library needed some cleanup. Otherwise we implemt composite operations multiple times.

mpkorstanje · 2025-07-09T21:49:59Z

@clrudolphi I noticed that the .Net implementation of the Gherkin parser isn't using messages yet. Gaspar said he'd tackle that somewhere in Autumn. While waiting for this PR, perhaps that is something you can work on.

clrudolphi · 2025-07-10T02:29:26Z

@clrudolphi I noticed that the .Net implementation of the Gherkin parser isn't using messages yet. Gaspar said he'd tackle that somewhere in Autumn. While waiting for this PR, perhaps that is something you can work on.

To clarify the ask, my understanding is that

the Astconverter and pickle compiler classes need to be changed to emit instances of Cucumber/Messages rather than the Gherkin.Cucumber.Messages.Types that are built in to the Gherkin project.
the Gherkin.Cucumber.Messages.Types classes should be deleted
the scanner and dotnet parser would NOT be changed
no changes required in the implementations for other platforms/languages
tests in the dotnet implementation would need to be updated to reflect the change in types

Please confirm this scope and correct anywhere I'm mistaken.

mpkorstanje · 2025-07-10T13:05:39Z

Yes to those points with the following remarks. Please do also communicate with Gaspar to ensure the timing is convenient.

the scanner and dotnet parser would NOT be changed

Not fundamentally. There might be changes related to changing Gherkin.Cucumber.Messages.Types to Cucumber/Messages.

tests in the dotnet implementation would need to be updated to reflect the change in types

Only the unit test, if any. Unless I'm mistaken the Gherkin .Net implementation is already using the repositories acceptance tests, so the acceptance tests would not have to be changed.

And this is all on the assumption that the Cucumber/Messages and Gherkin.Cucumber.Messages.Types both serialize to the same json. But that assumption is of course not validated and may not hold. In that case, there might be a change needed to messages.

dotnet/Query/Query/Query.cs

… lineage derived methods).

clrudolphi · 2025-07-18T14:08:44Z

Commit 828599e makes this match what is proposed in #84. Tests won't pass until #84 is merged (making the expected results files available).

clrudolphi added 4 commits July 8, 2025 09:26

Initial commit of project structure.

8104b9e

first class ported

8a7a7e9

Implementation plus tests

281e078

First cut at fully passing tests.

8360374

mpkorstanje self-assigned this Jul 9, 2025

davidjgoss reviewed Jul 9, 2025

View reviewed changes

mpkorstanje reviewed Jul 9, 2025

View reviewed changes

mpkorstanje mentioned this pull request Jul 9, 2025

Clean up Lineage dependent methods from Query #82

Open

clrudolphi added 2 commits July 9, 2025 08:44

Refactor such that testdata files are read from the file system (rath…

5aa6c09

…er than embedded resources).

clrudolphi mentioned this pull request Jul 11, 2025

Use cucumber/messages where possible cucumber/gherkin#425

Open

9 tasks

mpkorstanje reviewed Jul 15, 2025

View reviewed changes

dotnet/Query/Query/Query.cs Outdated Show resolved Hide resolved

mpkorstanje self-requested a review July 15, 2025 16:29

clrudolphi added 2 commits July 17, 2025 11:21

cleanup - per review comments

0c69735

Modified to conform to changes coming in Query cucumber#84 (Deprecate…

828599e

… lineage derived methods).


		public IList<TestStep> FindAllTestSteps() => _testStepById.Values.OrderBy(ts => ts.Id).ToList();

		public IDictionary<Feature?, List<TestCaseStarted>> FindAllTestCaseStartedGroupedByFeature()

Uh oh!

Add Dotnet Implementation #81

Are you sure you want to change the base?

Add Dotnet Implementation #81

Uh oh!

Conversation

clrudolphi commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤔 What's changed?

⚡️ What's your motivation?

🏷️ What kind of change is this?

♻️ Anything particular you want feedback on?

📋 Checklist:

Uh oh!

davidjgoss Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

clrudolphi Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

clrudolphi Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

mpkorstanje left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mpkorstanje Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

clrudolphi Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

clrudolphi commented Jul 9, 2025

Uh oh!

clrudolphi commented Jul 9, 2025

Uh oh!

mpkorstanje commented Jul 9, 2025

Uh oh!

mpkorstanje commented Jul 9, 2025

Uh oh!

mpkorstanje commented Jul 9, 2025

Uh oh!

clrudolphi commented Jul 10, 2025

Uh oh!

mpkorstanje commented Jul 10, 2025

Uh oh!

Uh oh!

clrudolphi commented Jul 18, 2025

Uh oh!

Uh oh!

clrudolphi commented Jul 8, 2025 •

edited

Loading

clrudolphi Jul 9, 2025 •

edited

Loading

mpkorstanje Jul 13, 2025 •

edited

Loading

mpkorstanje left a comment •

edited

Loading

mpkorstanje Jul 9, 2025 •

edited

Loading