Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,25 @@ methods. Avoid depending on undocumented authentication plugins.
Use [OpenTelemetry integration](diagnostics/integrations.md) for explicit OTLP
export and [Metrics](diagnostics/metrics.md) for Prometheus scraping.

## TestClient review

The TestClient keeps command names only when their observable behavior can be
preserved over the supported gRPC APIs. Reads, writes, hard deletes,
subscriptions, scavenging, data verification, and load operations use the gRPC
client on `NodePort`. The generic `WRFL` alias remains available and runs the
same workload as `WRFLGRPC`.

The following commands are intentionally retired:

- `TWR`, because the public gRPC streams API does not expose the transaction
start, write, and commit lifecycle. A batch append is not an equivalent test.
- `WRFLTCP` and `WRFLCA`, because transport-specific aliases would hide which
protocol the workload exercises.
- `RT`, because its projection and node-failure scenarios require a dedicated
replacement rather than a different command behind the same name.
- `CHKTCP`, because it validates a retired frame protocol. Use `CHKGRPC` to
validate malformed gRPC-frame handling.

Legacy usage telemetry is separate from OTLP observability. See
[Usage telemetry](usage-telemetry.md) before running a node in an environment
that should not make outbound telemetry calls.
1 change: 1 addition & 0 deletions scripts/test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ misc_projects=(
EventStore.Common.Tests
EventStore.SourceGenerators.Tests
EventStore.SystemRuntime.Tests
EventStore.TestClient.Tests
)

declare -a requested_projects
Expand Down
1 change: 1 addition & 0 deletions src/Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<PackageVersion Include="DotNext.Unsafe" Version="5.26.2" />
<PackageVersion Include="EventStore.Client" Version="21.2.0" />
<PackageVersion Include="EventStore.Client.Grpc.Streams" Version="23.3.9" />
<PackageVersion Include="EventStore.Client.Grpc.Operations" Version="23.3.9" />
<!--Version 8 and beyond are free for open-source projects and non-commercial use, but commercial use requires a paid license-->
<PackageVersion Include="FluentAssertions" Version="6.12.2" />
<PackageVersion Include="AWSSDK.Core" Version="4.0.100.6" />
Expand Down
44 changes: 44 additions & 0 deletions src/EventStore.TestClient.Tests/CommandInventoryTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
using System;
using System.Linq;
using System.Threading;
using NUnit.Framework;

namespace EventStore.TestClient.Tests;

[TestFixture]
public class CommandInventoryTests
{
private static readonly string[] SupportedCommandKeywords =
[
"PING", "PINGFL", "PINGFLW", "RDALLGRPC", "WRFLGRPC",
"WR", "WRJ", "WRFL", "WRFLW",
"MWR", "MWRFLW", "DEL",
"RDALL", "RD", "RDFL", "WRLT",
"VERIFY", "SUBSCR", "SCAVENGE", "CHKGRPC", "SST"
];
private static readonly string[] RetiredCommandKeywords = ["TWR", "WRFLCA", "WRFLTCP", "RT", "CHKTCP"];

[Test]
public void test_client_preserves_supported_command_surface()
{
using var cancellation = new CancellationTokenSource();
var client = new Client(new ClientOptions(), cancellation);
var usages = client.GetCommandList()
.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);

Assert.Multiple(() =>
{
foreach (var keyword in SupportedCommandKeywords)
{
Assert.That(usages.Any(x => x == keyword || x.StartsWith($"{keyword} ", StringComparison.Ordinal)),
Is.True, $"Missing TestClient command '{keyword}'");
}

foreach (var keyword in RetiredCommandKeywords)
{
Assert.That(usages.Any(x => x == keyword || x.StartsWith($"{keyword} ", StringComparison.Ordinal)),
Is.False, $"TestClient command '{keyword}' advertises behavior that gRPC does not provide");
}
});
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<IsTestProject>true</IsTestProject>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="GitHubActionsTestLogger" />
<PackageReference Include="Microsoft.NET.Test.Sdk" />
<PackageReference Include="NUnit" />
<PackageReference Include="NUnit3TestAdapter" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\EventStore.TestClient\EventStore.TestClient.csproj" />
</ItemGroup>
<ItemGroup>
<None Include="..\EventStore.Common\Utils\version.properties">
<Link>version.properties</Link>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup>
</Project>
Loading
Loading