Skip to content

RANGER-5390:Enable and Improve Test Cases for KMS Module #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

RANGER-5390:Enable and Improve Test Cases for KMS Module #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 2 additions & 40 deletions kms/src/test/java/org/apache/hadoop/crypto/key/RangerKMSDBTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
package org.apache.hadoop.crypto.key;

import org.apache.hadoop.conf.Configuration;
import org.apache.ranger.kms.dao.DaoManager;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.junit.jupiter.MockitoExtension;
Expand All @@ -40,7 +40,6 @@
import static org.junit.jupiter.api.Assertions.assertTrue;

@ExtendWith(MockitoExtension.class)
@Disabled
public class RangerKMSDBTest {
private static final String PROPERTY_PREFIX = "ranger.ks.";
private static final String DB_DIALECT = "jpa.jdbc.dialect";
Expand Down Expand Up @@ -72,21 +71,17 @@ public class RangerKMSDBTest {
public void setUp() throws Exception {
conf = new Configuration();

// Set basic database properties required for RangerKMSDB constructor
conf.set(PROPERTY_PREFIX + DB_DIALECT, "org.eclipse.persistence.platform.database.H2Platform");
conf.set(PROPERTY_PREFIX + DB_DRIVER, "org.h2.Driver");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:h2:mem:testdb");
conf.set(PROPERTY_PREFIX + DB_USER, "test");
conf.set(PROPERTY_PREFIX + DB_PASSWORD, "test");

// Save original system properties
originalSystemProperties = new Properties();
originalSystemProperties.putAll(System.getProperties());

// Create temporary files for testing
createTempFiles();

// Get private method and field using reflection
updateDBSSLURLMethod = RangerKMSDB.class.getDeclaredMethod("updateDBSSLURL");
updateDBSSLURLMethod.setAccessible(true);

Expand All @@ -96,10 +91,8 @@ public void setUp() throws Exception {

@AfterEach
public void tearDown() {
// Restore original system properties
System.setProperties(originalSystemProperties);

// Clean up temporary files
cleanupTempFiles();

if (rangerKMSDB != null) {
Expand All @@ -112,30 +105,26 @@ public void testUpdateDBSSLURL_NullConfiguration() throws Exception {
Configuration nullConf = null;
rangerKMSDB = new RangerKMSDB(nullConf) {
@Override
public org.apache.ranger.kms.dao.DaoManager getDaoManager() {
public DaoManager getDaoManager() {
return null;
}
};

// Should not throw exception
assertDoesNotThrow(() -> updateDBSSLURLMethod.invoke(rangerKMSDB));
}

@Test
public void testUpdateDBSSLURL_NoSSLEnabledProperty() throws Exception {
// Don't set DB_SSL_ENABLED property
createRangerKMSDBWithoutSSL();

String originalUrl = conf.get(PROPERTY_PREFIX + DB_URL);
updateDBSSLURLMethod.invoke(rangerKMSDB);

// URL should remain unchanged
assertEquals(originalUrl, conf.get(PROPERTY_PREFIX + DB_URL));
}

@Test
public void testUpdateDBSSLURL_MySQLSSLEnabled_NoQueryParams() throws Exception {
// Setup MySQL configuration
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -157,7 +146,6 @@ public void testUpdateDBSSLURL_MySQLSSLEnabled_NoQueryParams() throws Exception

@Test
public void testUpdateDBSSLURL_MySQLSSLEnabled_WithQueryParams() throws Exception {
// Setup MySQL configuration with existing query parameters
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger?charset=utf8");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -166,13 +154,11 @@ public void testUpdateDBSSLURL_MySQLSSLEnabled_WithQueryParams() throws Exceptio
updateDBSSLURLMethod.invoke(rangerKMSDB);

String updatedUrl = conf.get(PROPERTY_PREFIX + DB_URL);
// Should not modify URL if it already has query parameters
assertEquals("jdbc:mysql://localhost:3306/ranger?charset=utf8", updatedUrl);
}

@Test
public void testUpdateDBSSLURL_MySQLSSLDisabled() throws Exception {
// Setup MySQL configuration with SSL disabled
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "false");
Expand All @@ -186,7 +172,6 @@ public void testUpdateDBSSLURL_MySQLSSLDisabled() throws Exception {

@Test
public void testUpdateDBSSLURL_PostgreSQLSSLEnabled_WithCertificateFile() throws Exception {
// Setup PostgreSQL configuration
conf.set(PROPERTY_PREFIX + DB_DIALECT, "postgresql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:postgresql://localhost:5432/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -203,7 +188,6 @@ public void testUpdateDBSSLURL_PostgreSQLSSLEnabled_WithCertificateFile() throws

@Test
public void testUpdateDBSSLURL_PostgreSQLSSLEnabled_WithVerification_NoCertFile() throws Exception {
// Setup PostgreSQL configuration
conf.set(PROPERTY_PREFIX + DB_DIALECT, "postgresql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:postgresql://localhost:5432/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -220,7 +204,6 @@ public void testUpdateDBSSLURL_PostgreSQLSSLEnabled_WithVerification_NoCertFile(

@Test
public void testUpdateDBSSLURL_PostgreSQLSSLEnabled_NoVerification() throws Exception {
// Setup PostgreSQL configuration
conf.set(PROPERTY_PREFIX + DB_DIALECT, "postgresql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:postgresql://localhost:5432/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -237,7 +220,6 @@ public void testUpdateDBSSLURL_PostgreSQLSSLEnabled_NoVerification() throws Exce

@Test
public void testUpdateDBSSLURL_PostgreSQLSSLDisabled() throws Exception {
// Setup PostgreSQL configuration with SSL disabled
conf.set(PROPERTY_PREFIX + DB_DIALECT, "postgresql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:postgresql://localhost:5432/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "false");
Expand All @@ -247,13 +229,11 @@ public void testUpdateDBSSLURL_PostgreSQLSSLDisabled() throws Exception {
updateDBSSLURLMethod.invoke(rangerKMSDB);

String updatedUrl = conf.get(PROPERTY_PREFIX + DB_URL);
// PostgreSQL URL should not be modified when SSL is disabled
assertEquals(originalUrl, updatedUrl);
}

@Test
public void testUpdateDBSSLURL_OracleDatabase() throws Exception {
// Setup Oracle configuration (should not modify URL)
conf.set(PROPERTY_PREFIX + DB_DIALECT, "oracle");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:oracle:thin:@localhost:1521:ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -263,13 +243,11 @@ public void testUpdateDBSSLURL_OracleDatabase() throws Exception {
updateDBSSLURLMethod.invoke(rangerKMSDB);

String updatedUrl = conf.get(PROPERTY_PREFIX + DB_URL);
// Oracle URL should not be modified
assertEquals(originalUrl, updatedUrl);
}

@Test
public void testUpdateDBSSLURL_KeystoreAndTruststoreSetup() throws Exception {
// Setup MySQL configuration with SSL verification and keystore/truststore
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -284,7 +262,6 @@ public void testUpdateDBSSLURL_KeystoreAndTruststoreSetup() throws Exception {
createRangerKMSDBWithoutSSL();
updateDBSSLURLMethod.invoke(rangerKMSDB);

// Verify system properties are set
assertEquals(tempKeystore.getAbsolutePath(), System.getProperty("javax.net.ssl.keyStore"));
assertEquals("keystore-password", System.getProperty("javax.net.ssl.keyStorePassword"));
assertEquals(tempTruststore.getAbsolutePath(), System.getProperty("javax.net.ssl.trustStore"));
Expand All @@ -293,7 +270,6 @@ public void testUpdateDBSSLURL_KeystoreAndTruststoreSetup() throws Exception {

@Test
public void testUpdateDBSSLURL_OneWaySSL() throws Exception {
// Setup MySQL configuration with 1-way SSL (should not set keystore)
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -307,15 +283,12 @@ public void testUpdateDBSSLURL_OneWaySSL() throws Exception {
createRangerKMSDBWithoutSSL();
updateDBSSLURLMethod.invoke(rangerKMSDB);

// Verify keystore is not set for 1-way SSL
assertNull(System.getProperty("javax.net.ssl.keyStore"));
// But truststore should still be set
assertEquals(tempTruststore.getAbsolutePath(), System.getProperty("javax.net.ssl.trustStore"));
}

@Test
public void testUpdateDBSSLURL_NonExistentKeystoreFile() throws Exception {
// Setup configuration with non-existent keystore file
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -327,13 +300,11 @@ public void testUpdateDBSSLURL_NonExistentKeystoreFile() throws Exception {
createRangerKMSDBWithoutSSL();
updateDBSSLURLMethod.invoke(rangerKMSDB);

// Should not set system property for non-existent file
assertNull(System.getProperty("javax.net.ssl.keyStore"));
}

@Test
public void testUpdateDBSSLURL_EmptyKeystoreProperty() throws Exception {
// Setup configuration with empty keystore property
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -344,13 +315,11 @@ public void testUpdateDBSSLURL_EmptyKeystoreProperty() throws Exception {
createRangerKMSDBWithoutSSL();
updateDBSSLURLMethod.invoke(rangerKMSDB);

// Should not set system property for empty keystore
assertNull(System.getProperty("javax.net.ssl.keyStore"));
}

@Test
public void testUpdateDBSSLURL_VariousBooleanValues() throws Exception {
// Test various boolean value formats
String[] trueValues = {"true", "TRUE", "True"};
String[] falseValues = {"false", "FALSE", "False", "", null, "invalid"};

Expand Down Expand Up @@ -392,7 +361,6 @@ public void testUpdateDBSSLURL_VariousBooleanValues() throws Exception {

@Test
public void testUpdateDBSSLURL_SQLServerDatabase() throws Exception {
// Test SQL Server (should not modify URL for SSL)
conf.set(PROPERTY_PREFIX + DB_DIALECT, "sqlserver");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:sqlserver://localhost:1433;database=ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -402,13 +370,11 @@ public void testUpdateDBSSLURL_SQLServerDatabase() throws Exception {
updateDBSSLURLMethod.invoke(rangerKMSDB);

String updatedUrl = conf.get(PROPERTY_PREFIX + DB_URL);
// SQL Server URL should not be modified
assertEquals(originalUrl, updatedUrl);
}

@Test
public void testUpdateDBSSLURL_PostgreSQLSSLRequired() throws Exception {
// Setup PostgreSQL configuration with SSL required
conf.set(PROPERTY_PREFIX + DB_DIALECT, "postgresql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:postgresql://localhost:5432/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -425,7 +391,6 @@ public void testUpdateDBSSLURL_PostgreSQLSSLRequired() throws Exception {

@Test
public void testUpdateDBSSLURL_ComplexScenario() throws Exception {
// Test complex scenario with multiple properties set
conf.set(PROPERTY_PREFIX + DB_DIALECT, "mysql");
conf.set(PROPERTY_PREFIX + DB_URL, "jdbc:mysql://localhost:3306/ranger");
conf.set(PROPERTY_PREFIX + DB_SSL_ENABLED, "true");
Expand All @@ -445,7 +410,6 @@ public void testUpdateDBSSLURL_ComplexScenario() throws Exception {
assertTrue(updatedUrl.contains("requireSSL=false"));
assertTrue(updatedUrl.contains("verifyServerCertificate=false"));

// System properties should not be set when verification is false
assertNull(System.getProperty("javax.net.ssl.keyStore"));
assertNull(System.getProperty("javax.net.ssl.trustStore"));
}
Expand All @@ -455,7 +419,6 @@ private void createTempFiles() throws IOException {
tempTruststore = File.createTempFile("test-truststore", ".jks");
tempCertificate = File.createTempFile("test-cert", ".pem");

// Write some dummy content to make files readable
Files.write(tempKeystore.toPath(), "dummy content".getBytes());
Files.write(tempTruststore.toPath(), "dummy content".getBytes());
Files.write(tempCertificate.toPath(), "dummy content".getBytes());
Expand All @@ -476,7 +439,6 @@ private void cleanupTempFiles() {
private void createRangerKMSDBWithoutSSL() {
try {
rangerKMSDB = new RangerKMSDB(conf) {
// Override to prevent actual DB connection
@Override
public org.apache.ranger.kms.dao.DaoManager getDaoManager() {
return null;
Expand Down
2 changes: 0 additions & 2 deletions kms/src/test/java/org/apache/hadoop/crypto/key/TestDBToKeySecure.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import org.apache.hadoop.conf.Configuration;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestMethodOrder;
Expand All @@ -36,7 +35,6 @@

@ExtendWith(MockitoExtension.class)
@TestMethodOrder(MethodOrderer.MethodName.class)
@Disabled
public class TestDBToKeySecure {
private static SecurityManager originalSecurityManager;

Expand Down
2 changes: 0 additions & 2 deletions kms/src/test/java/org/apache/hadoop/crypto/key/TestHSM2DBMKUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestMethodOrder;
Expand All @@ -35,7 +34,6 @@

@ExtendWith(MockitoExtension.class)
@TestMethodOrder(MethodOrderer.MethodName.class)
@Disabled
public class TestHSM2DBMKUtil {
private final PrintStream originalOut = System.out;
private final PrintStream originalErr = System.err;
Expand Down
Loading
Loading