SK-1802 Fix inconsistencies in SDK v2

skyflow-vivek · skyflow-vivek · commit ea8ae4ca82d2 · 2024-12-05T21:05:42.000+05:30
- Fix inconsistency between vault and connection client
- Added unit tests for vault and connection clients
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -23,7 +23,7 @@ jobs:
           json: ${{ secrets.TEST_CREDENTIALS_FILE_STRING }}
 
       - name: Build & Run tests with Maven
-        run: mvn -B package -DTEST_VAULT_ID=${{ secrets.TEST_VAULT_ID }} -DTEST_VAULT_URL=${{ secrets.TEST_VAULT_URL }} -DTEST_SKYFLOW_ID=${{ secrets.TEST_SKYFLOW_ID }} -DTEST_TOKEN=${{ secrets.TEST_TOKEN }} -DTEST_CREDENTIALS=${{ secrets.TEST_CREDENTIALS_FILE_STRING }} -DTEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} -f pom.xml
+        run: mvn -B package -DTEST_VAULT_ID=${{ secrets.TEST_VAULT_ID }} -DTEST_VAULT_URL=${{ secrets.TEST_VAULT_URL }} -DTEST_SKYFLOW_ID=${{ secrets.TEST_SKYFLOW_ID }} -DTEST_TOKEN=${{ secrets.TEST_TOKEN }} -DTEST_CREDENTIALS=${{ secrets.TEST_CREDENTIALS_FILE_STRING }} -DTEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} -DTEST_HUNDRED_TOKEN=${{ secrets.TEST_HUNDRED_TOKEN }} -f pom.xml
 
       - name: Codecov
         uses: codecov/codecov-action@v2.1.0
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -37,6 +37,7 @@ jobs:
           touch .env
           echo SKYFLOW_CREDENTIALS=${{ secrets.SKYFLOW_CREDENTIALS }} >> .env
           echo TEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} >> .env
+          echo TEST_HUNDRED_TOKEN=${{ secrets.TEST_HUNDRED_TOKEN }} >> .env
 
       - name: Build & Run tests with Maven
         run: mvn -B package -DTEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} -DTEST_DATA_CREDENTIALS_FILE=${{ secrets.TEST_DATA_CREDENTIALS_FILE }} -f pom.xml
diff --git a/.github/workflows/shared-build-and-deploy.yml b/.github/workflows/shared-build-and-deploy.yml
@@ -89,6 +89,7 @@ jobs:
           touch .env
           echo SKYFLOW_CREDENTIALS=${{ secrets.SKYFLOW_CREDENTIALS }} >> .env
           echo TEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} >> .env
+          echo TEST_HUNDRED_TOKEN=${{ secrets.TEST_HUNDRED_TOKEN }} >> .env
 
       - name: Create credentials json
         id: create-json
diff --git a/src/main/java/com/skyflow/ConnectionClient.java b/src/main/java/com/skyflow/ConnectionClient.java
@@ -12,6 +12,7 @@
 import com.skyflow.utils.logger.LogUtil;
 import com.skyflow.utils.validations.Validations;
 import io.github.cdimascio.dotenv.Dotenv;
+import io.github.cdimascio.dotenv.DotenvException;
 
 public class ConnectionClient {
     private final ConnectionConfig connectionConfig;
@@ -30,21 +31,19 @@ protected ConnectionConfig getConnectionConfig() {
         return connectionConfig;
     }
 
-    protected void setCommonCredentials(Credentials commonCredentials) {
+    protected void setCommonCredentials(Credentials commonCredentials) throws SkyflowException {
         this.commonCredentials = commonCredentials;
         prioritiseCredentials();
     }
 
-    protected void updateConnectionConfig(ConnectionConfig connectionConfig) {
+    protected void updateConnectionConfig(ConnectionConfig connectionConfig) throws SkyflowException {
         prioritiseCredentials();
     }
 
     protected void setBearerToken() throws SkyflowException {
-        prioritiseCredentials();
         Validations.validateCredentials(this.finalCredentials);
         if (this.finalCredentials.getApiKey() != null) {
             setApiKey();
-            return;
         } else if (Token.isExpired(token)) {
             LogUtil.printInfoLog(InfoLogs.BEARER_TOKEN_EXPIRED.getLog());
             token = Utils.generateBearerToken(this.finalCredentials);
@@ -61,7 +60,7 @@ private void setApiKey() {
         }
     }
 
-    private void prioritiseCredentials() {
+    private void prioritiseCredentials() throws SkyflowException {
         try {
             if (this.connectionConfig.getCredentials() != null) {
                 this.finalCredentials = this.connectionConfig.getCredentials();
@@ -78,6 +77,11 @@ private void prioritiseCredentials() {
                     this.finalCredentials.setCredentialsString(sysCredentials);
                 }
             }
+            token = null;
+            apiKey = null;
+        } catch (DotenvException e) {
+            throw new SkyflowException(ErrorCode.INVALID_INPUT.getCode(),
+                    ErrorMessage.EmptyCredentials.getMessage());
         } catch (Exception e) {
             throw new RuntimeException(e);
         }
diff --git a/src/main/java/com/skyflow/VaultClient.java b/src/main/java/com/skyflow/VaultClient.java
@@ -169,7 +169,6 @@ protected V1TokenizePayload getTokenizePayload(TokenizeRequest request) {
     }
 
     protected void setBearerToken() throws SkyflowException {
-        prioritiseCredentials();
         Validations.validateCredentials(this.finalCredentials);
         if (this.finalCredentials.getApiKey() != null) {
             setApiKey();
diff --git a/src/test/java/com/skyflow/ConnectionClientTests.java b/src/test/java/com/skyflow/ConnectionClientTests.java
@@ -0,0 +1,95 @@
+package com.skyflow;
+
+import com.skyflow.config.ConnectionConfig;
+import com.skyflow.config.Credentials;
+import io.github.cdimascio.dotenv.Dotenv;
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class ConnectionClientTests {
+    private static final String INVALID_EXCEPTION_THROWN = "Should not have thrown any exception";
+    private static final String EXCEPTION_NOT_THROWN = "Should have thrown an exception";
+    private static ConnectionClient connectionClient;
+    private static String connectionID = null;
+    private static String connectionURL = null;
+    private static String apiKey = null;
+    private static ConnectionConfig connectionConfig;
+
+    @BeforeClass
+    public static void setup() {
+        connectionID = "connection123";
+        connectionURL = "https://test.connection.url";
+        apiKey = "sky-ab123-abcd1234cdef1234abcd4321cdef4321";
+
+        Credentials credentials = new Credentials();
+        credentials.setApiKey(apiKey);
+
+        connectionConfig = new ConnectionConfig();
+        connectionConfig.setConnectionId(connectionID);
+        connectionConfig.setConnectionUrl(connectionURL);
+        connectionClient = new ConnectionClient(connectionConfig, credentials);
+    }
+
+    @Test
+    public void getConnectionConfig() {
+        try {
+            ConnectionConfig config = connectionClient.getConnectionConfig();
+            Assert.assertEquals(connectionID, config.getConnectionId());
+            Assert.assertEquals(connectionURL, config.getConnectionUrl());
+        } catch (Exception e) {
+            Assert.fail(INVALID_EXCEPTION_THROWN);
+        }
+    }
+
+    @Test
+    public void testSetBearerToken() {
+        try {
+            Dotenv dotenv = Dotenv.load();
+            String bearerToken = dotenv.get("TEST_HUNDRED_TOKEN");
+            Credentials credentials = new Credentials();
+            credentials.setToken(bearerToken);
+            connectionConfig.setCredentials(credentials);
+            connectionClient.updateConnectionConfig(connectionConfig);
+
+            // regular scenario
+            connectionClient.setBearerToken();
+
+            // re-use scenario
+            connectionClient.setBearerToken();
+        } catch (Exception e) {
+            Assert.fail(INVALID_EXCEPTION_THROWN);
+        }
+    }
+
+    @Test
+    public void testSetBearerTokenWithApiKey() {
+        try {
+            Credentials credentials = new Credentials();
+            credentials.setApiKey(apiKey);
+            connectionConfig.setCredentials(null);
+            connectionClient.updateConnectionConfig(connectionConfig);
+            connectionClient.setCommonCredentials(credentials);
+
+            // regular scenario
+            connectionClient.setBearerToken();
+
+            // re-use scenario
+            connectionClient.setBearerToken();
+        } catch (Exception e) {
+            Assert.fail(INVALID_EXCEPTION_THROWN);
+        }
+    }
+
+    @Test
+    public void testSetBearerTokenWithEnvCredentials() {
+        try {
+            connectionConfig.setCredentials(null);
+            connectionClient.updateConnectionConfig(connectionConfig);
+            connectionClient.setCommonCredentials(null);
+            Assert.assertNull(connectionClient.getConnectionConfig().getCredentials());
+        } catch (Exception e) {
+            Assert.fail(INVALID_EXCEPTION_THROWN);
+        }
+    }
+}
diff --git a/src/test/java/com/skyflow/VaultClientTests.java b/src/test/java/com/skyflow/VaultClientTests.java

Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,6 @@ protected V1TokenizePayload getTokenizePayload(TokenizeRequest request) {`
`169`	`169`	`}`
`170`	`170`
`171`	`171`	`protected void setBearerToken() throws SkyflowException {`
`172`		`- prioritiseCredentials();`
`173`	`172`	`Validations.validateCredentials(this.finalCredentials);`
`174`	`173`	`if (this.finalCredentials.getApiKey() != null) {`
`175`	`174`	`setApiKey();`