feat: Toon SpecGenerator for building unit tests to verify against spec by ghost1face · Pull Request #6 · toon-format/toon-dotnet

ghost1face · 2025-11-17T18:01:05Z

Description

This PR creates tests to quickly validate if code is aligned with a specific spec version.

Created SpecGenerator tool to automatically generate xUnit tests from TOON spec fixtures
Added comprehensive test coverage for V2 spec including primitives, arrays, objects, delimiters, and whitespace handling
Implemented .specignore file to explicitly skip tests incompatible with .NET constraints
Added convenience scripts (specgen.sh and specgen.ps1) for easy test regeneration

Unit tests have been generated all pass except for:

Key Folding tests
Path Expansion tests
Several tests for decimal parsing and representation of them

Type of Change

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update
Refactoring (no functional changes)
Performance improvement
Test coverage improvement

Related Issues

Closes #

Changes Made

Adds test generator for generating tests according to the spec
Adds unit tests to cover V2 spec

SPEC Compliance

This PR implements/fixes spec compliance
Spec section(s) affected:
Spec version:

Testing

All existing tests pass
Added new tests for changes
Tested on .NET 8.0
Tested on .NET 9.0

Checklist

My code follows the project's coding standards
I have run dotnet format
I have added tests that prove my fix/feature works
New and existing tests pass locally
I have updated documentation (if needed)
My changes do not introduce new dependencies

Additional Context

- Implement StringUtils for string manipulation, including escaping and unescaping. - Create ValidationShared for key validation and safety checks. - Introduce ToonDecodeOptions and ToonEncodeOptions for customizable encoding/decoding settings. - Develop ToonDecoder for parsing TOON format strings into JsonNode objects. - Implement ToonEncoder for converting data structures into TOON format strings. - Add ToonFormatException for error handling during parsing and encoding. - Create unit tests for ToonDecoder and ToonEncoder to ensure functionality and data integrity. - Remove outdated UnitTest1.cs file.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

ghost1face · 2025-11-18T02:28:33Z

Now we have better visibility on which tests are not passing and can start to address them in upcoming PRs

src/ToonFormat/Constants.cs

Copilot

Pull Request Overview

This PR introduces a test generation tool that automatically creates unit tests from the TOON specification repository, enabling systematic validation of encoder and decoder implementations against the spec. The generated tests cover the V2 spec with noted exceptions for key folding, path expansion, and certain decimal parsing behaviors.

Key Changes

Created SpecGenerator tool to automatically generate xUnit tests from TOON spec fixtures
Added comprehensive test coverage for V2 spec including primitives, arrays, objects, delimiters, and whitespace handling
Implemented .specignore file to explicitly skip tests incompatible with .NET constraints
Added convenience scripts (specgen.sh and specgen.ps1) for easy test regeneration

Reviewed Changes

Copilot reviewed 44 out of 50 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/ToonFormat.SpecGenerator/*	New test generator tool that reads TOON spec fixtures and generates C# unit tests
tests/ToonFormat.Tests/Encode/*	Auto-generated encode tests validating TOON encoder output
tests/ToonFormat.Tests/Decode/*	Auto-generated decode tests validating TOON decoder behavior
.specignore	Configuration file listing tests to skip due to .NET language constraints
specgen.sh / specgen.ps1	Shell scripts for regenerating tests from spec
src/ToonFormat/Internal/Decode/*	Fixed Chinese comment translations to English

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/ToonFormat.SpecGenerator/SpecGeneratorOptions.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

johannschopplich

@ghost1face Thanks for the PR (and generally reviewing the other PRs!). I was only tagged due to changes to the Contributing file – LGTM.

ghost1face · 2025-11-18T12:51:51Z

@ghost1face Thanks for the PR (and generally reviewing the other PRs!). I was only tagged due to changes to the Contributing file – LGTM.

Looks like I'll be needing another maintainer to review myself here. If we can get this in, we can set a good foundation of tests to validate against

johannschopplich · 2025-11-18T12:56:06Z

I agree. Hopefully more members of the community besides @0xZunia are willing to contribute. Happy to add members to the team that you recommend.

0xZunia · 2025-11-18T13:15:11Z

Sorry I'm running out of time right now @ghost1face.
Might need to add a maintainer ASAP during my low activity period...

ghost1face · 2025-11-18T15:15:33Z

Sorry I'm running out of time right now @ghost1face. Might need to add a maintainer ASAP during my low activity period...

No problem, I understand we're all busy.

I've been moving a little slow only because I want to make sure this is community and not just my preference alone. We'll take things to the discussions for any other passionate maintainers

ghost1face · 2025-11-21T12:36:33Z

@239573049 this is our first order of business. Can you review here? Once we have this in place we have a test suite to validate against

239573049 · 2025-11-22T01:39:57Z

这是我们的首要任务。你能在这里复习一下吗？一旦我们有了这个测试套件，就可以进行验证

Could you please take a look at these checks and see why they are incorrect?

239573049 · 2025-11-22T02:42:37Z

Could you please check for me why I don't have the merge permission? @johannschopplich

ghost1face · 2025-11-22T04:05:18Z

这是我们的首要任务。你能在这里复习一下吗？一旦我们有了这个测试套件，就可以进行验证

These checks run a new generated suite of unit tests to validate full compliance to the V2 spec. The code-base isn't yet v2 compliant. Subsequent pull requests will be getting us closer.

As far as not having the merge permission, you'll have to approve first as a maintainer. Merging is blocked without a maintainer approval

239573049 · 2025-11-22T04:07:08Z

这是我们的首要任务。你能在这里复习一下吗？一旦我们有了这个测试套件，就可以进行验证

These checks run a new generated suite of unit tests to validate full compliance to the V2 spec. The code-base isn't yet v2 compliant. Subsequent pull requests will be getting us closer.

As far as not having the merge permission, you'll have to approve first as a maintainer. Merging is blocked without a maintainer approval

Sorry, it seems that I haven't found a place to approve this PR.

239573049

approve

johannschopplich · 2025-11-22T07:45:27Z

@239573049 You have to click on the Files changed tab and then the green "Review" button to leave your review:

239573049

Approve

239573049 and others added 12 commits November 6, 2025 16:12

Update src/ToonFormat/Constants.cs

0fce37f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/ToonFormat/Internal/Encode/Normalize.cs

9a1517c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

wip: Spec generator

ab4f735

feat: Spec generator utility for aligning tests with spec

a5aad2f

feat: Generated encoding tests based on spec

def253d

feaet: Enhance spec generator tool

c90c137

fix: Generate appropriate namespace for tests

cc7c954

chore: Cleanup

e4eafe0

fix: Update test coverage and fix errors in generated tests

f2962a4

chore: Git attributes

f542869

fix: Handle representing exponent notation appropriately

8505193

ghost1face added the enhancement New feature or request label Nov 17, 2025

Merge remote-tracking branch 'origin/main' into toon-revision-2

7269029

ghost1face changed the title ~~WIP: Toon revision 2~~ feat: Toon SpecGenerator for building unit tests to verify against spec Nov 18, 2025

chore: dotnet format outstanding items

aa35b75

ghost1face marked this pull request as ready for review November 18, 2025 02:24

ghost1face requested review from a team and johannschopplich as code owners November 18, 2025 02:24

ghost1face commented Nov 18, 2025

View reviewed changes

src/ToonFormat/Constants.cs Show resolved Hide resolved

ghost1face requested a review from Copilot November 18, 2025 02:34

Copilot AI reviewed Nov 18, 2025

View reviewed changes

tests/ToonFormat.SpecGenerator/SpecGeneratorOptions.cs Outdated Show resolved Hide resolved

Update tests/ToonFormat.SpecGenerator/SpecGeneratorOptions.cs

c2f27a1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

johannschopplich approved these changes Nov 18, 2025

View reviewed changes

ghost1face assigned 239573049 Nov 21, 2025

239573049 reviewed Nov 22, 2025

View reviewed changes

239573049 approved these changes Nov 22, 2025

View reviewed changes

239573049 merged commit fce9b0a into main Nov 22, 2025
0 of 6 checks passed

Conversation

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

Uh oh!

Description

Type of Change

Related Issues

Changes Made

SPEC Compliance

Testing

Checklist

Additional Context

Uh oh!

ghost1face commented Nov 18, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Uh oh!

johannschopplich left a comment

Choose a reason for hiding this comment

Uh oh!

ghost1face commented Nov 18, 2025

Uh oh!

johannschopplich commented Nov 18, 2025

Uh oh!

0xZunia commented Nov 18, 2025

Uh oh!

ghost1face commented Nov 18, 2025

Uh oh!

ghost1face commented Nov 21, 2025

Uh oh!

239573049 commented Nov 22, 2025

Uh oh!

239573049 commented Nov 22, 2025

Uh oh!

ghost1face commented Nov 22, 2025

Uh oh!

239573049 commented Nov 22, 2025

Uh oh!

239573049 left a comment

Choose a reason for hiding this comment

Uh oh!

johannschopplich commented Nov 22, 2025

Uh oh!

239573049 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ghost1face commented Nov 17, 2025 •

edited

Loading