Russole commented on code in PR #22445:
URL: https://github.com/apache/kafka/pull/22445#discussion_r3350514721


##########
storage/src/test/java/org/apache/kafka/tiered/storage/README.md:
##########
@@ -1,11 +1,11 @@
 # The Test Flow
 
-Step 1: For every test, setup is done via TieredStorageTestHarness which 
extends IntegrationTestHarness and sets up a cluster with TS enabled on it.
+Step 1: Each test is a standalone class. It declares a `clusterConfig()` 
method that returns a `ClusterConfig` with tiered storage enabled (via 
`TieredStorageTestUtils.createServerPropsForRemoteStorage`), and test methods 
annotated with `@ClusterTemplate("clusterConfig")` that receive a 
`ClusterInstance` provided by the test framework.

Review Comment:
   nit: The current wording says `clusterConfig()` returns a `ClusterConfig`, 
but the tiered storage tests generally return `List<ClusterConfig>` from their 
`@ClusterTemplate` methods. Could we make this slightly more precise, e.g. 
“returns one or more `ClusterConfig` instances, typically as 
`List<ClusterConfig>`”?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to