From 5e424f8d1c006f0d9689a40ec62cd43bf514e95d Mon Sep 17 00:00:00 2001 From: nicu-da Date: Wed, 29 Sep 2021 19:43:17 -0700 Subject: [PATCH] Command dedup conformance suites readme (#11051) * Add readme which explains the differences between different command deduplication suites CHANGELOG_BEGIN CHANGELOG_END * Update readme --- ledger/ledger-api-test-tool/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 ledger/ledger-api-test-tool/README.md diff --git a/ledger/ledger-api-test-tool/README.md b/ledger/ledger-api-test-tool/README.md new file mode 100644 index 000000000000..a9fe3ca9a3e6 --- /dev/null +++ b/ledger/ledger-api-test-tool/README.md @@ -0,0 +1,15 @@ +### Command deduplication test suites + +As different ledgers have different support for command deduplication, we provide multiple test suites which try to be as comprehensive as possible for all the various ledgers + +* default - is it a default test suite which does not need to be included explicitly +* append-only - Requires the schema to be append-only because we use the submission id set in the completion, which is + present only for append-only schemas +* configuration-required - If it requires specific settings to be set for the ledger configuration + +| Name | Default | Append only | Configuration required | Details | +| --- | --- | --- | --- | --- | +|CommandDeduplicationIT|Yes|No| No |Tests participant deduplication| +|KVCommandDeduplicationIT| No | No | minSkew set to 1 second. maxDeduplicationDuration has to be < 5s | Extends the test cases from `CommandDeduplicationIT` with committer side test cases. Requires the time model update because KV committer deduplication is based on maxDeduplicationDuration + minSkew| +|AppendOnlyKVCommandDeduplicationIT|No|Yes|Same as KVCommandDeduplicationIT | Same as `KVCommandDeduplicationIT` but it requires an append-only schema so that we have access to the submission id| +|AppendOnlyCommandDeduplicationParallelIT | No |Yes| No | Requires append only schema so that we have access to the submission id. | \ No newline at end of file