KNOX-3440: Remove HSQLDB completely from Knox

Author: smolnar82

gateway-server/pom.xml

@@ -586,13 +586,6 @@
             <artifactId>gateway-shell</artifactId>
         </dependency>
 
-        <dependency>
-            <groupId>org.hsqldb</groupId>
-            <artifactId>hsqldb</artifactId>
-            <scope>provided</scope>
-            <classifier>jdk8</classifier>
-        </dependency>
-
         <dependency>
             <groupId>com.h2database</groupId>
             <artifactId>h2</artifactId>

gateway-server/src/main/java/org/apache/knox/gateway/database/DataSourceProvider.java

@@ -33,7 +33,6 @@ public static DataSource getDataSource(GatewayConfig gatewayConfig, AliasService
             case POSTGRESQL -> new PostgresDataSourceFactory();
             case MYSQL -> new MysqlDataSourceFactory();
             case MARIADB -> new MariaDBDataSourceFactory();
-            case HSQL -> new HsqlDataSourceFactory();
             case H2 -> new H2DataSourceFactory();
             case ORACLE -> new OracleDataSourceFactory();
         };

gateway-server/src/main/java/org/apache/knox/gateway/database/DatabaseType.java

@@ -48,16 +48,6 @@ public enum DatabaseType {
             AbstractDataSourceFactory.KNOXIDF_TRUSTED_OIDC_ISSUERS_TABLE_SQL,
             AbstractDataSourceFactory.KNOXIDF_DELEGATION_POLICY_TABLES_SQL
     ),
-    HSQL("hsql",
-            AbstractDataSourceFactory.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
-            AbstractDataSourceFactory.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
-            AbstractDataSourceFactory.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
-            AbstractDataSourceFactory.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME,
-            AbstractDataSourceFactory.KNOXIDF_FED_IDENTITY_TABLE_CREATE_SQL_FILE_NAME,
-            AbstractDataSourceFactory.KNOXIDF_FED_IDENTITY_ATTR_TABLE_CREATE_SQL_FILE_NAME,
-            AbstractDataSourceFactory.KNOXIDF_TRUSTED_OIDC_ISSUERS_TABLE_SQL,
-            AbstractDataSourceFactory.KNOXIDF_DELEGATION_POLICY_TABLES_SQL
-    ),
     H2("h2",
             AbstractDataSourceFactory.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
             AbstractDataSourceFactory.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,

gateway-server/src/main/java/org/apache/knox/gateway/database/HsqlDataSourceFactory.java

@@ -32,7 +32,7 @@ public class KnoxDatabase {
 
     // Matches the leading "CREATE TABLE [IF NOT EXISTS] <name>" of a DDL statement so the table name
     // can be handed to the existence check. Case-insensitive; tolerates the IF NOT EXISTS that the
-    // standard (PostgreSQL/MySQL/HSQL) scripts use but Derby and Oracle omit.
+    // standard (PostgreSQL/MySQL/H2) scripts use but Oracle omit.
     private static final Pattern CREATE_TABLE_PATTERN =
         Pattern.compile("(?i)^\\s*CREATE\\s+TABLE\\s+(?:IF\\s+NOT\\s+EXISTS\\s+)?([\\w.]+)");
 

gateway-server/src/main/java/org/apache/knox/gateway/database/KnoxDatabase.java

@@ -28,7 +28,7 @@
 import java.util.List;
 import java.util.Map;
 
-import org.hsqldb.jdbc.JDBCDataSource;
+import org.h2.jdbcx.JdbcDataSource;
 import org.junit.After;
 import org.junit.AfterClass;
 import org.junit.Before;
@@ -37,8 +37,8 @@
 
 /**
  * Exercises {@link KnoxDatabase#createTablesIfNotExist(String)} and its
- * {@link KnoxDatabase#parseCreateTableStatements(String)} helper directly against an in-memory HSQL
- * database, using the standard (PostgreSQL/HSQL) KnoxIDF delegation-policy DDL as a representative
+ * {@link KnoxDatabase#parseCreateTableStatements(String)} helper directly against an in-memory H2
+ * database, using the standard KnoxIDF delegation-policy DDL as a representative
  * multi-statement, foreign-key-ordered script.
  */
 public class KnoxDatabaseTest {
@@ -57,16 +57,16 @@ public class KnoxDatabaseTest {
       "DELEGATION_POLICY_RESOURCES",
       "DELEGATION_POLICY_RESOURCE_SCOPES");
 
-  private static JDBCDataSource dataSource;
+  private static JdbcDataSource dataSource;
   private KnoxDatabase db;
 
   @BeforeClass
   public static void setUpClass() {
-    dataSource = new JDBCDataSource();
-    dataSource.setDatabaseName("knox_database_test");
+    dataSource = new JdbcDataSource();
     dataSource.setUser(USER);
     dataSource.setPassword(PASSWORD);
-    dataSource.setUrl("jdbc:hsqldb:mem:knoxdatabasetest;sql.syntax_pgs=true"); // sql.syntax_pgs => use postgres syntax
+    // In-memory H2; DB_CLOSE_DELAY=-1 keeps the database alive across connection open/close for the class.
+    dataSource.setUrl("jdbc:h2:mem:knoxdatabasetest;DB_CLOSE_DELAY=-1");
   }
 
   @Before

gateway-server/src/test/java/org/apache/knox/gateway/database/KnoxDatabaseTest.java

@@ -18,6 +18,7 @@
 
 import org.apache.commons.io.IOUtils;
 import org.apache.knox.gateway.database.AbstractDataSourceFactory;
+import org.junit.After;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
 import org.junit.Test;
@@ -46,31 +47,36 @@ public class DelegationPolicySchemaTest {
   private static final String H2_DB = "delegationpolicies";
   // H2 is the OOTB embedded backend; DB_CLOSE_DELAY=-1 keeps the in-memory database alive for the class.
   private static final String H2_URL = "jdbc:h2:mem:" + H2_DB + ";DB_CLOSE_DELAY=-1";
-  private static final String HSQL_URL = "jdbc:hsqldb:mem:delegationschema;ifexists=false";
-  private static final String HSQL_USER = "SA";
-  private static final String HSQL_PASSWORD = "";
+
+  // Child-first so the foreign keys don't block the truncation between tests.
+  private static final String[] TABLES_CHILD_FIRST = {
+      "DELEGATION_POLICY_RESOURCE_SCOPES", "DELEGATION_POLICY_RESOURCES",
+      "DELEGATION_POLICY_GROUPS", "DELEGATION_POLICY_USERS", "DELEGATION_POLICIES"};
 
   private static Connection h2Conn;
-  private static Connection hsqlConn;
 
   @BeforeClass
   public static void setUp() throws Exception {
     h2Conn = DriverManager.getConnection(H2_URL);
-    hsqlConn = DriverManager.getConnection(HSQL_URL, HSQL_USER, HSQL_PASSWORD);
     // H2 (the OOTB embedded backend) uses the standard DDL script; IF NOT EXISTS makes it idempotent.
     runScript(h2Conn, loadSql(AbstractDataSourceFactory.KNOXIDF_DELEGATION_POLICY_TABLES_SQL));
-    // Run standard DDL on HSQLDB
-    runScript(hsqlConn, loadSql(AbstractDataSourceFactory.KNOXIDF_DELEGATION_POLICY_TABLES_SQL));
     // Verify Oracle DDL script is present on the classpath (execution requires an Oracle-backed test)
     loadSql(AbstractDataSourceFactory.ORACLE_KNOXIDF_DELEGATION_POLICY_TABLES_SQL);
   }
 
+  @After
+  public void clearTables() throws Exception {
+    // Reset mutable state so each test starts clean regardless of JUnit method order (notably the
+    // "empty after DDL" assertion in testAllFiveTablesQueryable).
+    try (Statement stmt = h2Conn.createStatement()) {
+      for (String table : TABLES_CHILD_FIRST) {
+        stmt.execute("DELETE FROM " + table);
+      }
+    }
+  }
+
   @AfterClass
   public static void tearDown() throws Exception {
-    try (Connection conn = DriverManager.getConnection(HSQL_URL, HSQL_USER, HSQL_PASSWORD);
-         Statement stmt = conn.createStatement()) {
-      stmt.execute("SHUTDOWN");
-    }
     if (h2Conn != null && !h2Conn.isClosed()) {
       try (Statement stmt = h2Conn.createStatement()) {
         stmt.execute("DROP ALL OBJECTS");
@@ -80,7 +86,7 @@ public static void tearDown() throws Exception {
   }
 
   @Test
-  public void testH2AllFiveTablesQueryable() throws Exception {
+  public void testAllFiveTablesQueryable() throws Exception {
     for (String table : new String[]{
         "DELEGATION_POLICIES", "DELEGATION_POLICY_USERS", "DELEGATION_POLICY_GROUPS",
         "DELEGATION_POLICY_RESOURCES", "DELEGATION_POLICY_RESOURCE_SCOPES"}) {
@@ -93,28 +99,15 @@ public void testH2AllFiveTablesQueryable() throws Exception {
   }
 
   @Test
-  public void testHsqlAllFiveTablesQueryable() throws Exception {
-    for (String table : new String[]{
-        "DELEGATION_POLICIES", "DELEGATION_POLICY_USERS", "DELEGATION_POLICY_GROUPS",
-        "DELEGATION_POLICY_RESOURCES", "DELEGATION_POLICY_RESOURCE_SCOPES"}) {
-      try (Statement stmt = hsqlConn.createStatement();
-           ResultSet rs = stmt.executeQuery("SELECT COUNT(*) FROM " + table)) {
-        assertTrue("Table must be queryable: " + table, rs.next());
-        assertEquals("Table must be empty after DDL: " + table, 0, rs.getInt(1));
-      }
-    }
-  }
-
-  @Test
-  public void testHsqlStandardSqlIdempotent() throws Exception {
+  public void testStandardSqlIdempotent() throws Exception {
     // Running the script twice must not throw due to IF NOT EXISTS
-    runScript(hsqlConn, loadSql(AbstractDataSourceFactory.KNOXIDF_DELEGATION_POLICY_TABLES_SQL));
+    runScript(h2Conn, loadSql(AbstractDataSourceFactory.KNOXIDF_DELEGATION_POLICY_TABLES_SQL));
   }
 
   @Test
   public void testDefaultValues() throws Exception {
     final String id = UUID.randomUUID().toString();
-    try (Statement stmt = hsqlConn.createStatement()) {
+    try (Statement stmt = h2Conn.createStatement()) {
       stmt.execute("INSERT INTO DELEGATION_POLICIES "
           + "(registration_id, actor_authority, actor_id, created_at, updated_at) "
           + "VALUES ('" + id + "', 'oidc', 'actor-id', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)");
@@ -131,21 +124,21 @@ public void testDefaultValues() throws Exception {
 
   @Test
   public void testNotNullViolationActorAuthority() throws Exception {
-    expectConstraintViolation(hsqlConn,
+    expectConstraintViolation(h2Conn,
         "INSERT INTO DELEGATION_POLICIES (registration_id, actor_authority, actor_id, created_at, updated_at) "
             + "VALUES ('" + UUID.randomUUID() + "', NULL, 'actor-id', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)");
   }
 
   @Test
   public void testNotNullViolationActorId() throws Exception {
-    expectConstraintViolation(hsqlConn,
+    expectConstraintViolation(h2Conn,
         "INSERT INTO DELEGATION_POLICIES (registration_id, actor_authority, actor_id, created_at, updated_at) "
             + "VALUES ('" + UUID.randomUUID() + "', 'oidc', NULL, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)");
   }
 
   @Test
   public void testNotNullViolationCreatedAt() throws Exception {
-    expectConstraintViolation(hsqlConn,
+    expectConstraintViolation(h2Conn,
         "INSERT INTO DELEGATION_POLICIES (registration_id, actor_authority, actor_id, created_at, updated_at) "
             + "VALUES ('" + UUID.randomUUID() + "', 'oidc', 'actor-id', NULL, CURRENT_TIMESTAMP)");
   }
@@ -154,36 +147,36 @@ public void testNotNullViolationCreatedAt() throws Exception {
   public void testUniqueConstraintOnActorAuthorityAndId() throws Exception {
     final String id1 = UUID.randomUUID().toString();
     final String id2 = UUID.randomUUID().toString();
-    try (Statement stmt = hsqlConn.createStatement()) {
+    try (Statement stmt = h2Conn.createStatement()) {
       stmt.execute("INSERT INTO DELEGATION_POLICIES (registration_id, actor_authority, actor_id, created_at, updated_at) "
           + "VALUES ('" + id1 + "', 'oidc', 'duplicateactor', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)");
-      expectConstraintViolation(hsqlConn,
+      expectConstraintViolation(h2Conn,
           "INSERT INTO DELEGATION_POLICIES (registration_id, actor_authority, actor_id, created_at, updated_at) "
               + "VALUES ('" + id2 + "', 'oidc', 'duplicateactor', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)");
     }
   }
 
   @Test
   public void testFkViolationUsers() throws Exception {
-    expectConstraintViolation(hsqlConn,
+    expectConstraintViolation(h2Conn,
         "INSERT INTO DELEGATION_POLICY_USERS (registration_id, username) VALUES ('" + UUID.randomUUID() + "', 'alice')");
   }
 
   @Test
   public void testFkViolationGroups() throws Exception {
-    expectConstraintViolation(hsqlConn,
+    expectConstraintViolation(h2Conn,
         "INSERT INTO DELEGATION_POLICY_GROUPS (registration_id, group_name) VALUES ('" + UUID.randomUUID() + "', 'admins')");
   }
 
   @Test
   public void testFkViolationResources() throws Exception {
-    expectConstraintViolation(hsqlConn,
+    expectConstraintViolation(h2Conn,
         "INSERT INTO DELEGATION_POLICY_RESOURCES (registration_id, resource_uri) VALUES ('" + UUID.randomUUID() + "', '/api/v1')");
   }
 
   @Test
   public void testFkViolationResourceScopes() throws Exception {
-    expectConstraintViolation(hsqlConn,
+    expectConstraintViolation(h2Conn,
         "INSERT INTO DELEGATION_POLICY_RESOURCE_SCOPES (registration_id, resource_uri, scope) "
             + "VALUES ('" + UUID.randomUUID() + "', '/api/v1', 'read')");
   }

gateway-server/src/test/java/org/apache/knox/gateway/services/knoxidf/delegation/DelegationPolicySchemaTest.java

@@ -44,27 +44,16 @@ public class TrustedOidcIssuersSchemaTest {
   private static final String H2_DB = "trustedissuers";
   // H2 is the OOTB embedded backend; DB_CLOSE_DELAY=-1 keeps the in-memory database alive for the class.
   private static final String H2_URL = "jdbc:h2:mem:" + H2_DB + ";DB_CLOSE_DELAY=-1";
-  private static final String HSQL_URL = "jdbc:hsqldb:mem:trustedissuersschema;ifexists=false";
-  private static final String HSQL_USER = "SA";
-  private static final String HSQL_PASSWORD = "";
 
   private static Connection h2Conn;
-  private static Connection hsqlConn;
 
   @BeforeClass
   public static void setUp() throws SQLException {
     h2Conn = DriverManager.getConnection(H2_URL);
-    hsqlConn = DriverManager.getConnection(HSQL_URL, HSQL_USER, HSQL_PASSWORD);
   }
 
   @AfterClass
   public static void tearDown() throws Exception {
-    // HSQLDB: follow JDBCTokenStateServiceTest pattern — new connection for SHUTDOWN
-    try (Connection conn = DriverManager.getConnection(HSQL_URL, HSQL_USER, HSQL_PASSWORD);
-         Statement stmt = conn.createStatement()) {
-      stmt.execute("SHUTDOWN");
-    }
-
     // H2: drop all objects to release the in-memory database, then close the shared connection.
     if (h2Conn != null && !h2Conn.isClosed()) {
       try (Statement stmt = h2Conn.createStatement()) {
@@ -96,7 +85,7 @@ public void testH2DdlCreatesTable() throws Exception {
   @Test
   public void testStandardSqlIdempotent() throws Exception {
     String sql = loadSql(AbstractDataSourceFactory.KNOXIDF_TRUSTED_OIDC_ISSUERS_TABLE_SQL);
-    try (Statement stmt = hsqlConn.createStatement()) {
+    try (Statement stmt = h2Conn.createStatement()) {
       stmt.execute(sql);
       // Second execution must succeed due to IF NOT EXISTS
       stmt.execute(sql);

gateway-server/src/test/java/org/apache/knox/gateway/services/knoxidf/trustedoidcissuer/TrustedOidcIssuersSchemaTest.java

@@ -65,16 +65,18 @@ public class JDBCTokenStateServiceTest {
 
   @ClassRule
   public static final TemporaryFolder testFolder = new TemporaryFolder();
-  public static final String CONNECTION_URL = "jdbc:hsqldb:mem:knox;ifexists=false";
-  public static final String DB_NAME = "knox";
+  public static final String CONNECTION_URL = "jdbc:h2:mem:knox;DB_CLOSE_DELAY=-1";
+  // H2DataSourceFactory builds the URL as "jdbc:h2:" + getDatabaseName(), so the database name
+  // carries the in-memory location and flags to produce the same URL the test opens directly above.
+  public static final String DB_NAME = "mem:knox;DB_CLOSE_DELAY=-1";
   private static JDBCTokenStateService jdbcTokenStateService;
   private static TokenMAC tokenMAC;
 
   @SuppressWarnings("PMD.JUnit4TestShouldUseBeforeAnnotation")
   @BeforeClass
   public static void setUp() throws Exception {
     final GatewayConfig gatewayConfig = EasyMock.createNiceMock(GatewayConfig.class);
-    EasyMock.expect(gatewayConfig.getDatabaseType()).andReturn(DatabaseType.HSQL.type()).anyTimes();
+    EasyMock.expect(gatewayConfig.getDatabaseType()).andReturn(DatabaseType.H2.type()).anyTimes();
     EasyMock.expect(gatewayConfig.getDatabaseConnectionUrl()).andReturn(CONNECTION_URL).anyTimes();
     EasyMock.expect(gatewayConfig.getDatabaseName()).andReturn(DB_NAME).anyTimes();
     final AliasService aliasService = EasyMock.createNiceMock(AliasService.class);

gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/JDBCTokenStateServiceTest.java

@@ -27,32 +27,31 @@
 import java.time.Instant;
 import java.util.List;
 
-import org.hsqldb.jdbc.JDBCDataSource;
+import org.h2.jdbcx.JdbcDataSource;
 import org.junit.After;
 import org.junit.AfterClass;
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;
 
 public class RemoteConfigDatabaseTest {
-  public static final String DB_NAME = "remote_config_test";
   public static final String USER = "sa";
   public static final String PASSWORD = "";
-  private static JDBCDataSource dataSource;
+  private static JdbcDataSource dataSource;
   private RemoteConfigDatabase db;
 
   @BeforeClass
   public static void setUpClass() throws Exception {
-    dataSource = new JDBCDataSource();
-    dataSource.setDatabaseName(DB_NAME);
+    dataSource = new JdbcDataSource();
     dataSource.setUser(USER);
     dataSource.setPassword(PASSWORD);
-    dataSource.setUrl("jdbc:hsqldb:mem:knox;sql.syntax_pgs=true"); // sql.syntax_pgs => use postgres syntax
+    // In-memory H2; DB_CLOSE_DELAY=-1 keeps the database alive across connection open/close for the class.
+    dataSource.setUrl("jdbc:h2:mem:knox;DB_CLOSE_DELAY=-1");
   }
 
   @Before
   public void setUp() throws Exception {
-    db = new RemoteConfigDatabase(dataSource, "hsql");
+    db = new RemoteConfigDatabase(dataSource, "h2");
   }
 
   @After