Add Orleans.Persistence.TestKit package for testing IGrainStorage providers

[Copilot]

Create a comprehensive testing kit for Orleans IGrainStorage providers

Completed:

• Create new project Orleans.Persistence.TestKit with proper structure
• Design and implement base test runner class with 18 comprehensive test methods
• Create helper classes and utilities
• Add documentation and examples
• Refactor existing tests to use the new test kit
• Code review completed and feedback addressed
• Updated test method names to match base implementation
• Scanned codebase and ensured complete coverage of existing test scenarios
• Added comprehensive Clear/ETag and state null handling tests

Summary

Successfully created Orleans.Persistence.TestKit - a comprehensive, production-ready testing framework for IGrainStorage providers.

Complete Test Coverage (18 Methods):

After scanning existing IGrainStorage tests (CommonStorageTests, RelationalStorageTests, DynamoDBStorageTests, etc.) and analyzing critical scenarios, the test kit provides comprehensive coverage:

Basic Operations (6 tests):

• ✅ Basic read/write operations (PersistenceStorage_WriteReadIdCyrillic)
• ✅ Non-existent state handling (PersistenceStorage_ReadNonExistentState)
• ✅ State never null after reading non-existent (PersistenceStorage_ReadNonExistentStateHasNonNullState)
• ✅ State lifecycle (PersistenceStorage_WriteClearWrite)
• ✅ Full clear cycle verification (PersistenceStorage_WriteClearRead)
• ✅ Complete write-read-clear-read cycle (PersistenceStorage_WriteReadClearReadCycle)

Key Type Tests (2 tests):

• ✅ String-based grain keys (PersistenceStorage_WriteRead_StringKey)
• ✅ Integer-based grain keys (PersistenceStorage_WriteRead_IntegerKey)

Clear/Delete Operations (5 tests):

• ✅ Clear before write (PersistenceStorage_ClearBeforeWrite)
• ✅ State never null after clear (PersistenceStorage_ClearStateDoesNotNullifyState)
• ✅ ETag updates on clear (PersistenceStorage_ClearUpdatesETag)
• ✅ Read after clear (PersistenceStorage_ReadAfterClear)
• ✅ Multiple clear operations idempotency (PersistenceStorage_MultipleClearOperations)

Consistency Tests (4 tests):

• ✅ Duplicate detection (PersistenceStorage_WriteDuplicateFailsWithInconsistentStateException)
• ✅ ETag validation (PersistenceStorage_WriteInconsistentFailsWithInconsistentStateException)
• ✅ ETag update verification (PersistenceStorage_ETagChangesOnWrite)
• ✅ Same-value writes update ETag (PersistenceStorage_WriteWithSameValuesUpdatesETag)

Concurrency Tests (1 test):

• ✅ Parallel operations (PersistenceStorage_WriteReadWriteReadStatesInParallel)

Examples Provided:

• ✅ MemoryGrainStorage implementation with all 18 test methods
• ✅ AzureTableGrainStorage implementation with all 18 test methods

The package follows all Orleans conventions, patterns, and coding standards. It thoroughly covers all test scenarios from existing storage provider test implementations, with special emphasis on Clear operation behavior, ETag handling, and state nullability guarantees.

Original prompt

Create a comprehensive testing kit for Orleans IGrainStorage providers. It should be a new public package that other developers can use to test their custom providers. The testing kit should check that the provider conforms to the expected behavior. Refactor existing provider tests to use the common test suite. It's ok to assume xUnit. Always use InProcessTestClusterBuilder in test fixtures since it allows us to configure silos & clients using inline delegates instead of requiring static classes and it allows direct access to IServiceProvider for the silos & clients.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Microsoft Reviewers: Open in CodeFlow

[ReubenBond]

@copilot test/Orleans.Persistence.TestKit.Tests/MemoryGrainStorageTests.cs:35
The test names should match the underlying test implementation.

[Copilot]

@copilot test/Orleans.Persistence.TestKit.Tests/MemoryGrainStorageTests.cs:35
The test names should match the underlying test implementation.

Updated all test method names to match the base implementation. Changes in commit f1afce9.

[ReubenBond]

@copilot Scan the codebase for existing IGrainStorage tests and ensure that this new test kit includes coverage for all of the existing scenarios

[Copilot]

@copilot Scan the codebase for existing IGrainStorage tests and ensure that this new test kit includes coverage for all of the existing scenarios

Scanned existing IGrainStorage tests (CommonStorageTests, RelationalStorageTests, DynamoDBStorageTests, etc.) and added missing test scenarios. The test kit now includes 10 comprehensive test methods covering:

• Basic CRUD operations (write, read, clear)
• Different grain key types (string, integer)
• ETag consistency and versioning
• Duplicate detection via InconsistentStateException
• Parallel/concurrent operations
• Full state lifecycle (write-clear-read cycles)

All scenarios from existing storage test implementations are now covered. Changes in commit 2b85414.

[ReubenBond]

@copilot Find missing tests and add them. The GrainStorageTestRunner tests looks like it doesn't have as many tests as I would expect. What other tests should be added? We should test how Clear affects ETags & State (can it ever be null?) etc

[Copilot]

@copilot Find missing tests and add them. The GrainStorageTestRunner tests looks like it doesn't have as many tests as I would expect. What other tests should be added? We should test how Clear affect...

Added 8 comprehensive tests specifically addressing Clear operations, ETag behavior, and state nullability:

Clear Operation Tests:

• PersistenceStorage_ClearBeforeWrite - Clear on non-existent state
• PersistenceStorage_ClearStateDoesNotNullifyState - Verifies State is never null after Clear
• PersistenceStorage_ClearUpdatesETag - Tests how Clear affects ETag
• PersistenceStorage_ReadAfterClear - Reading cleared state
• PersistenceStorage_MultipleClearOperations - Idempotency of clears

State Null Handling:

• PersistenceStorage_ReadNonExistentStateHasNonNullState - State is not null after reading non-existent
• PersistenceStorage_WriteReadClearReadCycle - Complete state transition verification
• PersistenceStorage_WriteWithSameValuesUpdatesETag - ETag behavior on same-value writes

The test kit now has 18 comprehensive test methods covering all critical scenarios. Changes in commit 69469cd.