CM-4552: Implemented support for getting ID of the existing experiment from the COMET_EXPERIMENT_KEY environment variable.

Author: yaricom

comet-java-client/src/main/java/ml/comet/experiment/exception/CometGeneralException.java

@@ -26,8 +26,9 @@ public CometGeneralException(String message) {
 
     /**
      * Constructs a new runtime exception with the specified detail message and
-     * cause.  <p>Note that the detail message associated with
-     * {@code cause} is <i>not</i> automatically incorporated in
+     * cause.
+     *
+     * <p>Note that the detail message associated with {@code cause} is <i>not</i> automatically incorporated in
      * this runtime exception's detail message.
      *
      * @param message the detail message (which is saved for later retrieval

comet-java-client/src/main/java/ml/comet/experiment/impl/ApiExperimentImpl.java

@@ -17,6 +17,7 @@
 
 import static ml.comet.experiment.impl.config.CometConfig.COMET_API_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_BASE_URL;
+import static ml.comet.experiment.impl.config.CometConfig.COMET_EXPERIMENT_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_MAX_AUTH_RETRIES;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_PROJECT_NAME;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_TIMEOUT_CLEANING_SECONDS;
@@ -173,6 +174,9 @@ public ApiExperiment build() {
             if (StringUtils.isBlank(this.workspace)) {
                 this.workspace = COMET_WORKSPACE_NAME.getOptionalString().orElse(null);
             }
+            if (StringUtils.isBlank(this.experimentKey)) {
+                this.experimentKey = COMET_EXPERIMENT_KEY.getOptionalString().orElse(null);
+            }
             ApiExperimentImpl experiment = new ApiExperimentImpl(
                     this.apiKey, this.experimentKey, this.logger,
                     COMET_BASE_URL.getString(),

comet-java-client/src/main/java/ml/comet/experiment/impl/OnlineExperimentBuilderImpl.java

@@ -11,6 +11,7 @@
 
 import static ml.comet.experiment.impl.config.CometConfig.COMET_API_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_BASE_URL;
+import static ml.comet.experiment.impl.config.CometConfig.COMET_EXPERIMENT_KEY;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_MAX_AUTH_RETRIES;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_PROJECT_NAME;
 import static ml.comet.experiment.impl.config.CometConfig.COMET_TIMEOUT_CLEANING_SECONDS;
@@ -111,6 +112,9 @@ public OnlineExperimentImpl build() {
         if (StringUtils.isBlank(this.baseUrl)) {
             this.baseUrl = COMET_BASE_URL.getString();
         }
+        if (StringUtils.isBlank(this.experimentKey)) {
+            this.experimentKey = COMET_EXPERIMENT_KEY.getOptionalString().orElse(null);
+        }
         if (this.maxAuthRetries == -1) {
             this.maxAuthRetries = COMET_MAX_AUTH_RETRIES.getInt();
         }

comet-java-client/src/main/java/ml/comet/experiment/impl/config/CometConfig.java

@@ -50,6 +50,11 @@ public final class CometConfig {
      */
     public static final ConfigItem COMET_PROJECT_NAME =
             new ConfigItem("project", "COMET_PROJECT_NAME", instance);
+    /**
+     * The key of the existing Comet experiment.
+     */
+    public static final ConfigItem COMET_EXPERIMENT_KEY =
+            new ConfigItem("experimentKey", "COMET_EXPERIMENT_KEY", instance);
     /**
      * The Comet workspace name.
      */

comet-java-client/src/test/java/ml/comet/experiment/impl/config/CometConfigTest.java

@@ -125,4 +125,18 @@ public void testClearOverrideConfig() {
         assertNotNull(timeout);
         assertEquals(timeout.getSeconds(), 3600);
     }
+
+    @Test
+    public void testReadAllConfigVariables() {
+        CometConfig.applyConfigOverride(fullCometConfig);
+        String defaultStringValue = "full";
+
+        assertEquals(defaultStringValue, CometConfig.COMET_API_KEY.getString());
+        assertEquals(defaultStringValue, CometConfig.COMET_PROJECT_NAME.getString());
+        assertEquals(defaultStringValue, CometConfig.COMET_EXPERIMENT_KEY.getString());
+        assertEquals(defaultStringValue, CometConfig.COMET_WORKSPACE_NAME.getString());
+        assertEquals("https://www.comet.ml", CometConfig.COMET_BASE_URL.getString());
+        assertEquals(5, CometConfig.COMET_MAX_AUTH_RETRIES.getInt());
+        assertEquals(60, CometConfig.COMET_TIMEOUT_CLEANING_SECONDS.getInt());
+    }
 }

comet-java-client/src/test/resources/full-comet-config.conf

@@ -4,5 +4,6 @@ comet {
     apiKey = "full"
     project = "full"
     workspace = "full"
+    experimentKey = "full"
     cleaningTimeoutSeconds = 60
 }