[CM-1579]: Implemented test case to check synchronous implementation of the Experiment.logText() methods via ApiExperiment.

Author: yaricom

comet-java-client/src/test/java/ml/comet/experiment/impl/ApiExperimentTest.java

@@ -2,24 +2,40 @@
 
 import ml.comet.experiment.ApiExperiment;
 import ml.comet.experiment.OnlineExperiment;
+import ml.comet.experiment.asset.LoggedExperimentAsset;
+import ml.comet.experiment.context.ExperimentContext;
 import ml.comet.experiment.exception.CometGeneralException;
+import ml.comet.experiment.impl.asset.LoggedExperimentAssetImpl;
+import org.apache.commons.lang3.StringUtils;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 import static ml.comet.experiment.impl.ExperimentTestFactory.API_KEY;
 import static ml.comet.experiment.impl.ExperimentTestFactory.PROJECT_NAME;
 import static ml.comet.experiment.impl.ExperimentTestFactory.WORKSPACE_NAME;
+import static ml.comet.experiment.impl.ExperimentTestFactory.createApiExperiment;
 import static ml.comet.experiment.impl.ExperimentTestFactory.createOnlineExperiment;
+import static ml.comet.experiment.impl.asset.AssetType.TEXT_SAMPLE;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /**
  * The integration tests to test {@link ApiExperiment} implementation by sending/retrieving data from the backend.
  */
 @DisplayName("ApiExperimentTest INTEGRATION")
 @Tag("integration")
 public class ApiExperimentTest {
+    static Map<String, Object> SOME_METADATA = new HashMap<String, Object>() {{
+        put("someString", "string");
+        put("someInt", 10);
+    }};
+    static String SOME_TEXT = "this is some text to be used";
 
     @Test
     public void testApiExperimentInitializedWithInvalidValues() {
@@ -44,4 +60,46 @@ public void testApiExperimentInitialized() throws Exception {
             assertEquals(PROJECT_NAME, apiExperiment.getProjectName());
         }
     }
+
+    @Test
+    public void testLogTextFull() throws Exception {
+        try (ApiExperiment apiExperiment = createApiExperiment()) {
+            ExperimentContext ctx = ExperimentContext.builder()
+                    .withStep(100)
+                    .withContext("train")
+                    .build();
+
+            apiExperiment.logText(SOME_TEXT, ctx, SOME_METADATA);
+
+            // check that TEXT asset was saved as expected
+            List<LoggedExperimentAsset> assets = apiExperiment.getAssetList(TEXT_SAMPLE.type());
+            assertEquals(1, assets.size(), "wrong number of assets returned");
+            LoggedExperimentAsset asset = assets.get(0);
+            assertEquals(TEXT_SAMPLE.type(), asset.getType(), "wrong asset type");
+            ExperimentContext assetContext = ((LoggedExperimentAssetImpl) asset).getContext();
+            assertEquals(ctx.getStep(), assetContext.getStep(), "wrong asset's context step");
+            assertEquals(ctx.getContext(), assetContext.getContext(), "wrong asset's context ID");
+            assertEquals(SOME_METADATA, asset.getMetadata(), "wrong metadata:");
+            assertEquals(SOME_TEXT.length(), asset.getSize().orElse(0L), "wrong asset size");
+        }
+    }
+
+    @Test
+    public void testLogTextShort() throws Exception {
+        try (ApiExperiment apiExperiment = createApiExperiment()) {
+            apiExperiment.logText(SOME_TEXT);
+
+            // check that TEXT asset was saved as expected
+            List<LoggedExperimentAsset> assets = apiExperiment.getAssetList(TEXT_SAMPLE.type());
+            assertEquals(1, assets.size(), "wrong number of assets returned");
+
+            LoggedExperimentAsset asset = assets.get(0);
+            assertEquals(TEXT_SAMPLE.type(), asset.getType(), "wrong asset type");
+            assertEquals(SOME_TEXT.length(), asset.getSize().orElse(0L), "wrong asset size");
+            assertEquals(0, asset.getMetadata().size(), "no metadata expected");
+            ExperimentContext assetContext = ((LoggedExperimentAssetImpl) asset).getContext();
+            assertEquals(0, assetContext.getStep(), "no context step expected");
+            assertTrue(StringUtils.isBlank(assetContext.getContext()), "no context ID expected");
+        }
+    }
 }

comet-java-client/src/test/java/ml/comet/experiment/impl/ExperimentTestFactory.java

@@ -1,5 +1,7 @@
 package ml.comet.experiment.impl;
 
+import ml.comet.experiment.ApiExperiment;
+import ml.comet.experiment.ExperimentBuilder;
 import ml.comet.experiment.OnlineExperiment;
 
 import static ml.comet.experiment.impl.config.CometConfig.COMET_API_KEY;
@@ -21,10 +23,18 @@ public class ExperimentTestFactory {
     }
 
     static OnlineExperiment createOnlineExperiment() {
-        return OnlineExperimentImpl.builder()
-                .withApiKey(API_KEY)
+        return ExperimentBuilder.OnlineExperiment()
                 .withWorkspace(WORKSPACE_NAME)
                 .withProjectName(PROJECT_NAME)
+                .withApiKey(API_KEY)
+                .build();
+    }
+
+    static ApiExperiment createApiExperiment() {
+        return ExperimentBuilder.ApiExperiment()
+                .withProjectName(PROJECT_NAME)
+                .withWorkspace(WORKSPACE_NAME)
+                .withApiKey(API_KEY)
                 .build();
     }
 }