SNOW-532834 Using default role when snowflake.role.name is not specif…

…ied (#507)
snowflakedb · Jul 14, 2023 · 5547ea4 · 5547ea4
1 parent 2af18ec
commit 5547ea4
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 15 deletions.
diff --git a/src/main/java/net/snowflake/ingest/streaming/example/SnowflakeStreamingIngestExample.java b/src/main/java/net/snowflake/ingest/streaming/example/SnowflakeStreamingIngestExample.java
@@ -26,7 +26,7 @@
 public class SnowflakeStreamingIngestExample {
   // Please follow the example in profile_streaming.json.example to see the required properties, or
   // if you have already set up profile.json with Snowpipe before, all you need is to add the "role"
-  // property.
+  // property. If the "role" is not specified, the default user role will be applied.
   private static String PROFILE_PATH = "profile.json";
   private static final ObjectMapper mapper = new ObjectMapper();
 

diff --git a/src/main/java/net/snowflake/ingest/utils/Utils.java b/src/main/java/net/snowflake/ingest/utils/Utils.java
@@ -153,7 +153,7 @@ public static Properties createProperties(Properties inputProp) {
     }
 
     if (!properties.containsKey(Constants.ROLE)) {
-      throw new SFException(ErrorCode.MISSING_CONFIG, "role");
+      logger.logInfo("Snowflake role is not provided, the default user role will be applied.");
     }
 
     /**

diff --git a/src/test/java/net/snowflake/ingest/TestUtils.java b/src/test/java/net/snowflake/ingest/TestUtils.java
@@ -223,7 +223,8 @@ public static String getSchema() throws Exception {
     return schema;
   }
 
-  public static Properties getProperties(Constants.BdecVersion bdecVersion) throws Exception {
+  public static Properties getProperties(Constants.BdecVersion bdecVersion, boolean useDefaultRole)
+      throws Exception {
     if (profile == null) {
       init();
     }
@@ -236,7 +237,9 @@ public static Properties getProperties(Constants.BdecVersion bdecVersion) throws
     props.put(SCHEMA, schema);
     props.put(WAREHOUSE, warehouse);
     props.put(PRIVATE_KEY, privateKeyPem);
-    props.put(ROLE, role);
+    if (!useDefaultRole) {
+      props.put(ROLE, role);
+    }
     props.put(ACCOUNT_URL, getAccountURL());
     props.put(BLOB_FORMAT_VERSION, bdecVersion.toByte());
     return props;

diff --git a/src/test/java/net/snowflake/ingest/streaming/internal/OAuthBasicTest.java b/src/test/java/net/snowflake/ingest/streaming/internal/OAuthBasicTest.java
@@ -23,7 +23,7 @@ public class OAuthBasicTest {
   /** Create client with invalid authorization type, this should fail. */
   @Test
   public void invalidAuthType() throws Exception {
-    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE);
+    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE, false);
     props.put(Constants.AUTHORIZATION_TYPE, "INVALID_AUTH_TYPE");
     SFException e =
         Assert.assertThrows(
@@ -38,7 +38,7 @@ public void invalidAuthType() throws Exception {
   /** Create client with missing config, this should fail. */
   @Test
   public void missingOAuthParam() throws Exception {
-    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE);
+    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE, false);
     props.put(Constants.AUTHORIZATION_TYPE, Constants.OAUTH);
 
     // Missing oauth_client_id
@@ -83,7 +83,7 @@ public void missingOAuthParam() throws Exception {
   /** Create client with mock credential, should fail when refreshing token */
   @Test(expected = SecurityException.class)
   public void testCreateOAuthClient() throws Exception {
-    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE);
+    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE, false);
     props.remove(Constants.PRIVATE_KEY);
     props.put(Constants.AUTHORIZATION_TYPE, Constants.OAUTH);
     props.put(Constants.OAUTH_CLIENT_ID, "MOCK_CLIENT_ID");

diff --git a/src/test/java/net/snowflake/ingest/streaming/internal/OpenManyChannelsIT.java b/src/test/java/net/snowflake/ingest/streaming/internal/OpenManyChannelsIT.java
@@ -51,7 +51,7 @@ public void setUp() throws Exception {
             String.format(
                 "create or replace table %s.%s.%s (col int)",
                 databaseName, SCHEMA_NAME, TABLE_NAME));
-    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE);
+    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE, false);
     if (props.getProperty(ROLE).equals("DEFAULT_ROLE")) {
       props.setProperty(ROLE, "ACCOUNTADMIN");
     }

diff --git a/src/test/java/net/snowflake/ingest/streaming/internal/StreamingIngestBigFilesIT.java b/src/test/java/net/snowflake/ingest/streaming/internal/StreamingIngestBigFilesIT.java
@@ -47,7 +47,7 @@ public void beforeAll() throws Exception {
         .createStatement()
         .execute(String.format("use warehouse %s", TestUtils.getWarehouse()));
 
-    prop = TestUtils.getProperties(Constants.BdecVersion.THREE);
+    prop = TestUtils.getProperties(Constants.BdecVersion.THREE, false);
     if (prop.getProperty(ROLE).equals("DEFAULT_ROLE")) {
       prop.setProperty(ROLE, "ACCOUNTADMIN");
     }

diff --git a/src/test/java/net/snowflake/ingest/streaming/internal/StreamingIngestIT.java b/src/test/java/net/snowflake/ingest/streaming/internal/StreamingIngestIT.java
@@ -3,7 +3,6 @@
 import static net.snowflake.ingest.utils.Constants.BLOB_NO_HEADER;
 import static net.snowflake.ingest.utils.Constants.COMPRESS_BLOB_TWICE;
 import static net.snowflake.ingest.utils.Constants.REGISTER_BLOB_ENDPOINT;
-import static net.snowflake.ingest.utils.Constants.ROLE;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
 
@@ -89,10 +88,9 @@ public void beforeAll() throws Exception {
         .createStatement()
         .execute(String.format("use warehouse %s", TestUtils.getWarehouse()));
 
-    prop = TestUtils.getProperties(Constants.BdecVersion.THREE);
-    if (prop.getProperty(ROLE).equals("DEFAULT_ROLE")) {
-      prop.setProperty(ROLE, "ACCOUNTADMIN");
-    }
+    // Test without role param
+    prop = TestUtils.getProperties(Constants.BdecVersion.THREE, true);
+
     client =
         (SnowflakeStreamingIngestClientInternal<?>)
             SnowflakeStreamingIngestClientFactory.builder("client1").setProperties(prop).build();

diff --git a/src/test/java/net/snowflake/ingest/streaming/internal/datatypes/AbstractDataTypeTest.java b/src/test/java/net/snowflake/ingest/streaming/internal/datatypes/AbstractDataTypeTest.java
@@ -66,7 +66,7 @@ public void before() throws Exception {
 
     conn.createStatement().execute(String.format("use warehouse %s;", TestUtils.getWarehouse()));
 
-    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE);
+    Properties props = TestUtils.getProperties(Constants.BdecVersion.THREE, false);
     if (props.getProperty(ROLE).equals("DEFAULT_ROLE")) {
       props.setProperty(ROLE, "ACCOUNTADMIN");
     }