Address code review comments

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
opensearch-project · Jan 17, 2024 · 359e5c6 · 359e5c6
1 parent 2bef064
commit 359e5c6
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/...rc/main/java/org/opensearch/test/ParameterizedDynamicSettingsOpenSearchIntegTestCase.java b/...rc/main/java/org/opensearch/test/ParameterizedDynamicSettingsOpenSearchIntegTestCase.java
@@ -17,6 +17,12 @@
  * Base class for running the tests with parameterization using dynamic settings: the cluster will be created once before the test suite and the
  * settings will be applied dynamically, please notice that not all settings could be changed dynamically (consider using {@link ParameterizedStaticSettingsOpenSearchIntegTestCase}
  * instead).
+ * <p>
+ * Here is the simple illustration on of the execution flow per parameters combination:
+ * <ul>
+ *   <li><b>suite scope</b>: create cluster -&gt; for each test method { apply settings -&gt; run test method -&gt; unapply settings } -&gt; shutdown cluster</li>
+ *   <li><b>test scope</b>: for each test method { create cluster -&gt;  apply settings -&gt; run test method -&gt; unapply settings -&gt; shutdown cluster }</li>
+ * </ul>
  */
 public abstract class ParameterizedDynamicSettingsOpenSearchIntegTestCase extends ParameterizedOpenSearchIntegTestCase {
     public ParameterizedDynamicSettingsOpenSearchIntegTestCase(Settings dynamicSettings) {

diff --git a/...src/main/java/org/opensearch/test/ParameterizedStaticSettingsOpenSearchIntegTestCase.java b/...src/main/java/org/opensearch/test/ParameterizedStaticSettingsOpenSearchIntegTestCase.java
@@ -13,9 +13,15 @@
 import java.util.Objects;
 
 /**
- * Base class for running the tests with parameterization wit static settings: the cluster will be pre-created with the settings at startup, the method
+ * Base class for running the tests with parameterization with static settings: the cluster will be pre-created with the settings at startup, the method
  * {@link #hasSameParametersAs(ParameterizedOpenSearchIntegTestCase)} is being used by the test scaffolding to detect when the test suite is instantiated with
  * the new parameters and the test cluster has to be recreated.
+ * <p>
+ * Here is the simple illustration on of the execution flow per parameters combination:
+ * <ul>
+ *   <li><b>suite scope</b>: create cluster -&gt; for each test method { run test method } -&gt; shutdown cluster</li>
+ *   <li><b>test scope</b>: for each test method { create cluster -&gt; run test method -&gt; shutdown cluster }</li>
+ * </ul>
  */
 public abstract class ParameterizedStaticSettingsOpenSearchIntegTestCase extends ParameterizedOpenSearchIntegTestCase {
     public ParameterizedStaticSettingsOpenSearchIntegTestCase(Settings nodeSettings) {