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.

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

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

dotnet/Query/Query/TimestampComparer.cs

…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).

mpkorstanje · 2025-09-17T10:31:22Z

@charlierudolph I think we're at point now where we are relatively stable. More methods might be added, but the tests are setup such that we won't block each other when that happens.

clrudolphi · 2025-09-17T10:54:04Z

Ok. I'll take another look.

Tests passing.

mpkorstanje

LGTM. I'm going to leave this open until Monday as a reminder to release it.

clrudolphi · 2025-11-03T16:23:19Z

LGTM. I'm going to leave this open until Monday as a reminder to release it.

Could you hold off for a few days? I'd like to reconfirm package naming(re comments made by Gaspar wrt Tag-Expressions)?

mpkorstanje · 2025-11-03T19:46:00Z

Not a problem! Please re-request a review when done.

mpkorstanje · 2025-11-03T19:47:01Z

dotnet/Query/ILineageReducer.cs

@@ -0,0 +1,30 @@
+using Io.Cucumber.Messages.Types;
+
+namespace Io.Cucumber.Query


Await review from Gaspar on cucumber/tag-expressions#219

…s of Cucumber libraries. Enabled nullable.

mpkorstanje · 2025-11-25T12:50:27Z

@clrudolphi I saw you did 4fd7cd9, but didn't ask for a re-review where are we at right now?

clrudolphi · 2025-11-25T17:11:26Z

@clrudolphi I saw you did 4fd7cd9, but didn't ask for a re-review where are we at right now?

Sorry about that. This had fallen down the list of priorities.
I think this is ready for merge.

gasparnagy

I think this is good in general, but please change the namespace to Cucumber.Query and also make sure that file-scoped namespaces are used in all classes (so that it will be easier to maintain that long term).

gasparnagy · 2025-11-26T10:08:49Z

CONTRIBUTING.md

+| `List<T>`           | `ReadonlyArray<T>`      | `List<T>`               |
+| `Map<K, V>`         | `Map<K, V>`             | `Dictionary<K, V>`      |
+| `Map<K, V>`         | `Record<K, V>`          | `Dictionary<K, V>`      |
+| `List<Entry<T, V>>` | `ReadonlyArray<[T, V]>` | `List<Entry<T, V>>`     |


What does Entry mean here?

I took that as an example of a kvp. Perhaps the .NET example should be List<KeyValuePair<T, V>>?
@mpkorstanje, would you mind adding some context?

I see. Yes, I would mention KeyValuePair or a tuple. I would use KeyValuePair on external interfaces and tuple for internal ones. But I haven't seen in the code where any of these are used.

Note to self: Remove this one.

gasparnagy

Did a bit more detailed check and found some smallish things. Could you please check?

dotnet/QueryTest/Cucumber.QueryTest.csproj

… file.

gasparnagy

Two further comments

.github/workflows/test-dotnet.yml

dotnet/Cucumber.Query.sln

mpkorstanje · 2025-12-02T12:23:50Z

Note to self: Following #81 (comment) update polyglot-release to support .slnx files.

Saved solution as SLNX. Updated github workflows to use .net 10 only. (Added global.json to enable .net10 MTP testing)

.github/workflows/test-dotnet.yml

gasparnagy

LGTM

mpkorstanje · 2025-12-04T18:38:51Z

.github/workflows/release-nuget.yaml

+jobs:
+  publish-nuget:
+    name: Publish package to NuGet.org
+    # Failing on `ubuntu-24.04` (https://github.com/cucumber/gherkin/issues/349)


Note to self: Upgrade and remove comment.

mpkorstanje

Looks good.

Leaving this open as a reminder to merge and release it.

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

dotnet/Query/QueryTest/Resources/attachments.feature.ndjson Outdated Show resolved Hide resolved

mpkorstanje reviewed Jul 9, 2025

View reviewed changes

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

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

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

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

mpkorstanje mentioned this pull request Jul 9, 2025

Clean up Lineage dependent methods from Query #82

Closed

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

Merge branch 'main' into dotnet

cec1a90

clrudolphi added 4 commits September 17, 2025 14:12

Merge branch 'main' into dotnet

65c2338

Matching Java implementation; first commit.

d37f949

Tests passing.

Reducing access modifiers on Repository updateXXX methods.

327fed7

Update CHANGELOG.md

dca52dc

Update LICENSE

e7f6db1

mpkorstanje approved these changes Oct 31, 2025

View reviewed changes

mpkorstanje self-assigned this Oct 31, 2025

mpkorstanje requested changes Nov 3, 2025

View reviewed changes

Modified library name to be consistent with other .NET implementation…

4fd7cd9

…s of Cucumber libraries. Enabled nullable.

clrudolphi requested review from gasparnagy and mpkorstanje November 25, 2025 17:10

gasparnagy requested changes Nov 26, 2025

View reviewed changes

clrudolphi added 3 commits November 29, 2025 09:39

Merge branch 'main' into dotnet

cd39810

Changed name of principal namespace to Cucumber.Query.

6ff92ec

Made use of file-scoped namespace declarations (consistent).

a18fe36

clrudolphi requested a review from gasparnagy November 29, 2025 15:58

gasparnagy requested changes Dec 1, 2025

View reviewed changes

dotnet/QueryTest/Cucumber.QueryTest.csproj Outdated Show resolved Hide resolved

dotnet/QueryTest/Cucumber.QueryTest.csproj Outdated Show resolved Hide resolved

dotnet/QueryTest/Cucumber.QueryTest.csproj Outdated Show resolved Hide resolved

clrudolphi added 3 commits December 1, 2025 12:49

Eliminated duplications between test csproj file and build properties…

c2436c7

… file.

Upgraded test dependencies to MSTestv4 (and related nuget packages).

5835e96

Migrated to AwesomeAssertions (from FluentAssertions).

182cd5d

gasparnagy reviewed Dec 2, 2025

View reviewed changes

.github/workflows/test-dotnet.yml Outdated Show resolved Hide resolved

dotnet/Cucumber.Query.sln Outdated Show resolved Hide resolved

clrudolphi added 3 commits December 3, 2025 06:57

Updated test project to .net 10.x;

ed742f9

Saved solution as SLNX. Updated github workflows to use .net 10 only. (Added global.json to enable .net10 MTP testing)

Fix dotnet test command

5ab81e1

Delete Cucumber.Query.sln

035e48b

clrudolphi requested a review from gasparnagy December 3, 2025 19:29

mpkorstanje reviewed Dec 3, 2025

View reviewed changes

.github/workflows/test-dotnet.yml Show resolved Hide resolved

gasparnagy approved these changes Dec 4, 2025

View reviewed changes

mpkorstanje reviewed Dec 4, 2025

View reviewed changes

mpkorstanje approved these changes Dec 4, 2025

View reviewed changes

		@@ -0,0 +1,30 @@
		using Io.Cucumber.Messages.Types;

		namespace Io.Cucumber.Query

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!

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!

Uh oh!

Uh oh!

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!

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

Uh oh!

Uh oh!

clrudolphi commented Sep 17, 2025

Uh oh!

mpkorstanje left a comment

Choose a reason for hiding this comment

Uh oh!

clrudolphi commented Nov 3, 2025

Uh oh!

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

Uh oh!

Uh oh!

mpkorstanje Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

clrudolphi commented Nov 25, 2025

Uh oh!

gasparnagy left a comment

Choose a reason for hiding this comment

Uh oh!

gasparnagy Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

clrudolphi Nov 29, 2025

Choose a reason for hiding this comment

Uh oh!

gasparnagy Dec 1, 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 Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

gasparnagy left a comment

Choose a reason for hiding this comment

Uh oh!

clrudolphi commented Jul 8, 2025 •

edited

Loading

mpkorstanje left a comment •

edited

Loading

mpkorstanje commented Sep 17, 2025 •

edited

Loading

mpkorstanje commented Nov 3, 2025 •

edited

Loading

mpkorstanje commented Nov 25, 2025 •

edited

Loading

gasparnagy Dec 1, 2025 •

edited

Loading