Add comments

Signed-off-by: Tomoyuki Morita <[email protected]> (cherry picked from commit 2c849f7)
opensearch-project · May 18, 2024 · 18b2b9c · 18b2b9c
1 parent 4b63df9
commit 18b2b9c
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 21 deletions.
diff --git a/spark/src/main/java/org/opensearch/sql/spark/execution/statestore/CopyBuilder.java b/spark/src/main/java/org/opensearch/sql/spark/execution/statestore/CopyBuilder.java
@@ -5,6 +5,7 @@
 
 package org.opensearch.sql.spark.execution.statestore;
 
+/** Interface for copying StateModel object. Refer {@link StateStore} */
 public interface CopyBuilder<T> {
   T of(T copy, long seqNo, long primaryTerm);
 }
diff --git a/spark/src/main/java/org/opensearch/sql/spark/execution/xcontent/XContentSerializer.java b/spark/src/main/java/org/opensearch/sql/spark/execution/xcontent/XContentSerializer.java
@@ -11,7 +11,7 @@
 import org.opensearch.core.xcontent.XContentParser;
 import org.opensearch.sql.spark.execution.statestore.StateModel;
 
-/** Interface for XContentSerializer */
+/** Interface for XContentSerializer, which serialize/deserialize XContent */
 public interface XContentSerializer<T extends StateModel> {
 
   /**

diff --git a/...g/opensearch/sql/spark/execution/xcontent/FlintIndexStateModelXContentSerializerTest.java b/...g/opensearch/sql/spark/execution/xcontent/FlintIndexStateModelXContentSerializerTest.java
@@ -55,7 +55,6 @@ void toXContentShouldSerializeFlintIndexStateModel() throws Exception {
 
   @Test
   void fromXContentShouldDeserializeFlintIndexStateModel() throws Exception {
-    // Given
     String json =
         "{\"version\":\"1.0\",\"type\":\"flintindexstate\",\"state\":\"active\",\"applicationId\":\"app1\",\"jobId\":\"job1\",\"latestId\":\"latest1\",\"dataSourceName\":\"datasource1\",\"lastUpdateTime\":1623456789,\"error\":\"\"}";
     XContentParser parser =

diff --git a/...ava/org/opensearch/sql/spark/execution/xcontent/IndexDMLResultXContentSerializerTest.java b/...ava/org/opensearch/sql/spark/execution/xcontent/IndexDMLResultXContentSerializerTest.java
@@ -38,15 +38,12 @@ void toXContentShouldSerializeIndexDMLResult() throws IOException {
 
   @Test
   void toXContentShouldHandleErrorInIndexDMLResult() throws IOException {
-    // Given
     IndexDMLResult dmlResult =
         new IndexDMLResult("query1", "FAILURE", "An error occurred", "datasource1", 1000L, 2000L);
 
-    // When
     XContentBuilder xContentBuilder = serializer.toXContent(dmlResult, ToXContent.EMPTY_PARAMS);
-    String json = xContentBuilder.toString();
 
-    // Then
+    String json = xContentBuilder.toString();
     assertTrue(json.contains("\"queryId\":\"query1\""));
     assertTrue(json.contains("\"status\":\"FAILURE\""));
     assertTrue(json.contains("\"error\":\"An error occurred\""));
@@ -59,7 +56,6 @@ void toXContentShouldHandleErrorInIndexDMLResult() throws IOException {
 
   @Test
   void fromXContentShouldThrowUnsupportedOperationException() {
-    // When/Then
     assertThrows(UnsupportedOperationException.class, () -> serializer.fromXContent(null, 0L, 0L));
   }
 }
diff --git a/.../java/org/opensearch/sql/spark/execution/xcontent/SessionModelXContentSerializerTest.java b/.../java/org/opensearch/sql/spark/execution/xcontent/SessionModelXContentSerializerTest.java
@@ -27,7 +27,6 @@ class SessionModelXContentSerializerTest {
 
   @Test
   void toXContentShouldSerializeSessionModel() throws Exception {
-    // Given
     SessionModel sessionModel =
         SessionModel.builder()
             .version("1.0")
@@ -41,11 +40,9 @@ void toXContentShouldSerializeSessionModel() throws Exception {
             .error(null)
             .build();
 
-    // When
     XContentBuilder xContentBuilder = serializer.toXContent(sessionModel, ToXContent.EMPTY_PARAMS);
-    String json = xContentBuilder.toString();
 
-    // Then
+    String json = xContentBuilder.toString();
     assertEquals(true, json.contains("\"version\":\"1.0\""));
     assertEquals(true, json.contains("\"type\":\"session\""));
     assertEquals(true, json.contains("\"sessionType\":\"interactive\""));
@@ -58,7 +55,6 @@ void toXContentShouldSerializeSessionModel() throws Exception {
 
   @Test
   void fromXContentShouldDeserializeSessionModel() throws Exception {
-    // Given
     String json =
         "{\n"
             + "  \"version\": \"1.0\",\n"
@@ -78,10 +74,8 @@ void fromXContentShouldDeserializeSessionModel() throws Exception {
             .createParser(NamedXContentRegistry.EMPTY, LoggingDeprecationHandler.INSTANCE, json);
     parser.nextToken();
 
-    // When
     SessionModel sessionModel = serializer.fromXContent(parser, 1L, 1L);
 
-    // Then
     assertEquals("1.0", sessionModel.getVersion());
     assertEquals(SessionType.INTERACTIVE, sessionModel.getSessionType());
     assertEquals("session1", sessionModel.getSessionId().getSessionId());

diff --git a/...ava/org/opensearch/sql/spark/execution/xcontent/StatementModelXContentSerializerTest.java b/...ava/org/opensearch/sql/spark/execution/xcontent/StatementModelXContentSerializerTest.java
@@ -31,9 +31,7 @@ class StatementModelXContentSerializerTest {
 
   @Test
   void toXContentShouldSerializeStatementModel() throws Exception {
-
     serializer = new StatementModelXContentSerializer();
-    // Given
     StatementModel statementModel =
         StatementModel.builder()
             .version("1.0")
@@ -50,11 +48,10 @@ void toXContentShouldSerializeStatementModel() throws Exception {
             .error(null)
             .build();
 
-    // When
     XContentBuilder xContentBuilder =
         serializer.toXContent(statementModel, ToXContent.EMPTY_PARAMS);
-    String json = xContentBuilder.toString();
 
+    String json = xContentBuilder.toString();
     assertEquals(true, json.contains("\"version\":\"1.0\""));
     assertEquals(true, json.contains("\"state\":\"running\""));
     assertEquals(true, json.contains("\"statementId\":\"statement1\""));
@@ -63,7 +60,6 @@ void toXContentShouldSerializeStatementModel() throws Exception {
   @Test
   void fromXContentShouldDeserializeStatementModel() throws Exception {
     StatementModelXContentSerializer serializer = new StatementModelXContentSerializer();
-    // Given
     String json =
         "{\"version\":\"1.0\",\"type\":\"statement\",\"state\":\"running\",\"statementId\":\"statement1\",\"sessionId\":\"session1\",\"applicationId\":\"app1\",\"jobId\":\"job1\",\"lang\":\"SQL\",\"dataSourceName\":\"datasource1\",\"query\":\"SELECT"
             + " * FROM table\",\"queryId\":\"query1\",\"submitTime\":1623456789,\"error\":\"\"}";
@@ -84,7 +80,6 @@ void fromXContentShouldDeserializeStatementModel() throws Exception {
   @Test
   void fromXContentShouldDeserializeStatementModelThrowException() throws Exception {
     StatementModelXContentSerializer serializer = new StatementModelXContentSerializer();
-    // Given
     String json =
         "{\"version\":\"1.0\",\"type\":\"statement_state\",\"state\":\"running\",\"statementId\":\"statement1\",\"sessionId\":\"session1\",\"applicationId\":\"app1\",\"jobId\":\"job1\",\"lang\":\"SQL\",\"dataSourceName\":\"datasource1\",\"query\":\"SELECT"
             + " * FROM table\",\"queryId\":\"query1\",\"submitTime\":1623456789,\"error\":null}";
@@ -107,7 +102,6 @@ void fromXContentThrowsExceptionWhenParsingInvalidContent() {
   @Test
   void fromXContentShouldThrowExceptionForUnexpectedField() throws Exception {
     StatementModelXContentSerializer serializer = new StatementModelXContentSerializer();
-
     String jsonWithUnexpectedField =
         "{\"version\":\"1.0\",\"type\":\"statement\",\"state\":\"running\",\"statementId\":\"statement1\",\"sessionId\":\"session1\",\"applicationId\":\"app1\",\"jobId\":\"job1\",\"lang\":\"SQL\",\"dataSourceName\":\"datasource1\",\"query\":\"SELECT"
             + " * FROM"