Skip to content

Regression tests for external data sources #7989

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

Merged
labkey-tchad merged 3 commits into from
Aug 29, 2026
Merged

Regression tests for external data sources #7989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eeb25c2
Update TableSelectorTestCase to test oracle data source
labkey-tchad Aug 26, 2026
282eaf2
Add 'TestWhen' annotation to allow testing external data sources
labkey-tchad Aug 26, 2026
1ba13dd
Add SQL Server coverage and move external data source test case
labkey-tchad Aug 28, 2026
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
2 changes: 1 addition & 1 deletion api/src/org/labkey/api/ApiModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ public void registerServlets(ServletContext servletCtx)
TabLoader.TabLoaderTestCase.class,
Table.DataIteratorTestCase.class,
Table.TestCase.class,
TableSelectorTestCase.class,
TableSelectorTestCase.CoreTableSelectorTest.class,
TempTableInClauseGenerator.TestCase.class,
URLHelper.TestCase.class,
UserManager.TestCase.class,
Expand Down
6 changes: 4 additions & 2 deletions api/src/org/labkey/api/data/DbScope.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2145,6 +2145,7 @@ public static DbScope getDbScope(String dsName)
/**
* Some DbScopes shouldn't be exercised by junit tests (e.g., an external data source connected to LabKey Server via
* the PostgreSQL wire protocol)
* Tests that use this should be annotated with '@TestWhen(TestWhen.When.DB_SCOPE)'
*
* @return A collection of DbScopes that are suitable for testing
*/
Expand Down Expand Up @@ -2960,7 +2961,7 @@ public void afterLoadTable(SchemaTableInfo ti)
}

// Test dialects that are in-use; only for tests that require connecting to the database.
@TestWhen(TestWhen.When.BVT)
@TestWhen(TestWhen.When.DBSCOPE)
public static class DialectTestCase extends Assert
{
@Test
Expand Down Expand Up @@ -3011,6 +3012,7 @@ private void testDateDiff(DbScope scope, SqlDialect dialect, String date1, Strin
}
}

@TestWhen(TestWhen.When.DBSCOPE)
public static class GroupConcatTestCase extends Assert
{
@Test
Expand Down Expand Up @@ -3056,7 +3058,7 @@ private void testGroupConcat(DbScope scope, SqlDialect dialect, boolean distinct
}
}


@TestWhen(TestWhen.When.DBSCOPE)
public static class TransactionTestCase extends Assert
{
@Test
Expand Down
275 changes: 74 additions & 201 deletions api/src/org/labkey/api/data/TableSelectorTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import org.labkey.api.module.ModuleContext;
import org.labkey.api.query.FieldKey;
import org.labkey.api.security.User;
import org.labkey.api.test.TestWhen;
import org.labkey.api.util.ExceptionUtil;
import org.labkey.api.util.PageFlowUtil;
import org.labkey.api.util.TestContext;
Expand All @@ -40,229 +41,116 @@
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Stream;

public class TableSelectorTestCase extends AbstractSelectorTestCase<TableSelector>
public abstract class TableSelectorTestCase extends AbstractSelectorTestCase<TableSelector>
{
private static final Logger LOG = LogHelper.getLogger(TableSelectorTestCase.class, "Test progress");

@Test
public void testTableSelector() throws SQLException
@TestWhen(TestWhen.When.DBSCOPE)
public static class CoreTableSelectorTest extends TableSelectorTestCase
{

// Call below can be used to test that Oracle dialect behaves as expected, following our maxRows, offset, and other
// rules. Uncomment this line and the corresponding bean class below.
// testTableSelector(DbSchema.get("oracle.granite", DbSchemaType.Bare).getTable("account"), Account.class);

// Test MySQL or MariaDB database, if present
List<DbScope> mySqlScopes = DbScope.getDbScopesToTest().stream()
.filter(scope -> Set.of("MySQL", "MariaDB").contains(scope.getSqlDialect().getProductName()))
.toList();

for (DbScope mySqlScope: mySqlScopes)
{
DbSchema sakila = mySqlScope.getSchema("sakila", DbSchemaType.Bare);
if (sakila.existsInDatabase())
{
testTableSelector(sakila.getTable("Country"), Country.class);
}
else
{
DbSchema sys = mySqlScope.getSchema("sys", DbSchemaType.Bare);
if (sys.existsInDatabase())
{
testTableSelector(sys.getTable("sys_config"), Config.class);
}
}
}
testTableSelector(CoreSchema.getInstance().getTableInfoActiveUsers(), User.class);
testTableSelector(CoreSchema.getInstance().getTableInfoModules(), ModuleContext.class);
}

@SuppressWarnings("unused")
public static class Country
{
private int _country_id;
private String _country;
private Date _last_update;

public int getCountry_id()
{
return _country_id;
}

public void setCountry_id(int country_id)
{
_country_id = country_id;
}

public String getCountry()
@Test
public void testTableSelector() throws SQLException
{
return _country;
testTableSelector(CoreSchema.getInstance().getTableInfoActiveUsers(), User.class);
testTableSelector(CoreSchema.getInstance().getTableInfoModules(), ModuleContext.class);
}

public void setCountry(String country)
@Test
public void testGetObject()
{
_country = country;
}
TableSelector userSelector = new TableSelector(CoreSchema.getInstance().getTableInfoActiveUsers());

public Date getLast_update()
{
return _last_update;
}
User user = TestContext.get().getUser();
User selectedUser = userSelector.getObject(user.getUserId(), User.class);
assertEquals(user, selectedUser);

public void setLast_update(Date last_update)
{
_last_update = last_update;
}
// TableSelector to test a couple exception scenarios
TableSelector moduleSelector = new TableSelector(CoreSchema.getInstance().getTableInfoModules());
moduleSelector.setLogLevel(Level.OFF); // Suppress auto-logging since we're intentionally causing SQLExceptions

@Override
public boolean equals(Object o)
{
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Country country = (Country) o;
return _country_id == country._country_id && Objects.equals(_country, country._country) && Objects.equals(_last_update, country._last_update);
}
// Make sure that getObject() throws if more than one row is selected
try
{
moduleSelector.getObject(ModuleContext.class);
fail("getObject() should have thrown when returning multiple objects");
}
catch (UncategorizedSQLException e)
{
String message = e.getMessage();
// Verify that the exception message does not contain SQL (we don't want to display SQL to users...
assertFalse("Exception message " + message + " seems to contain SQL", message.contains("SELECT"));
// ...and that the exception is decorated, so the SQL does end up in mothership
String decoration = ExceptionUtil.getExceptionDecoration(e, ExceptionUtil.ExceptionInfo.DialectSQL);
assertNotNull("Exception was not decorated", decoration);
}

@Override
public int hashCode()
{
return Objects.hash(_country_id, _country, _last_update);
}
}
// Make sure that getObject() throws if pk == null, #20057

record Config(String Variable, String Value, Date Set_Time, String Set_By){}
// For now, null returns null to get DataReportsTest running again
ModuleContext ctx = moduleSelector.getObject(null, ModuleContext.class);
assertNull("getObject(null) should return null", ctx);

// public static class Account
// {
// private int _account_id;
// private String _account_number;
// private String _account_desc;
//
// public int getAccount_id()
// {
// return _account_id;
// }
//
// public void setAccount_id(int account_id)
// {
// _account_id = account_id;
// }
//
// public String getAccount_number()
// {
// return _account_number;
// }
//
// public void setAccount_number(String account_number)
// {
// _account_number = account_number;
// }
//
// public String getAccount_desc()
// {
// return _account_desc;
// }
//
// public void setAccount_desc(String account_desc)
// {
// _account_desc = account_desc;
// }
//
// @Override
// public boolean equals(Object o)
// try
// {
// if (this == o) return true;
// if (o == null || getClass() != o.getClass()) return false;
// Account account = (Account) o;
// return _account_id == account._account_id && Objects.equals(_account_number, account._account_number) && Objects.equals(_account_desc, account._account_desc);
// moduleSelector.getObject(null, ModuleContext.class);
// fail("getObject() should have thrown with null pk");
// }
//
// @Override
// public int hashCode()
// catch (IllegalStateException e)
// {
// return Objects.hash(_account_id, _account_number, _account_desc);
// assertEquals("PK on getObject() must not be null", e.getMessage());
// }
// }
}

@Test
public void testGetObject()
{
TableSelector userSelector = new TableSelector(CoreSchema.getInstance().getTableInfoActiveUsers());
@Test
public void testColumnLists() throws SQLException
{
TableInfo ti = CoreSchema.getInstance().getTableInfoActiveUsers();

User user = TestContext.get().getUser();
User selectedUser = userSelector.getObject(user.getUserId(), User.class);
assertEquals(user, selectedUser);
testColumnList(new TableSelector(ti, new HashSet<>(Arrays.asList("Email", "UserId", "DisplayName", "Created", "Active"))), false);
testColumnList(new TableSelector(ti, new HashSet<>(ti.getColumns("Email,UserId,DisplayName,Created,Active")), null, null), false);

// TableSelector to test a couple exception scenarios
TableSelector moduleSelector = new TableSelector(CoreSchema.getInstance().getTableInfoModules());
moduleSelector.setLogLevel(Level.OFF); // Suppress auto-logging since we're intentionally causing SQLExceptions
testColumnList(new TableSelector(ti, PageFlowUtil.set("Email", "UserId", "DisplayName", "Created", "Active")), true);
testColumnList(new TableSelector(ti, new LinkedHashSet<>(Arrays.asList("Email", "UserId", "DisplayName", "Created", "Active"))), true);
testColumnList(new TableSelector(ti, new CsvSet("Email, UserId, DisplayName, Created, Active")), true);
testColumnList(new TableSelector(ti, PageFlowUtil.set(ti.getColumn("Email"), ti.getColumn("UserId"), ti.getColumn("DisplayName"), ti.getColumn("Created"), ti.getColumn("Active")), null, null), true);
testColumnList(new TableSelector(ti, ti.getColumns("Email,UserId,DisplayName,Created,Active"), null, null), true);

// Make sure that getObject() throws if more than one row is selected
try
{
moduleSelector.getObject(ModuleContext.class);
fail("getObject() should have thrown when returning multiple objects");
}
catch (UncategorizedSQLException e)
{
String message = e.getMessage();
// Verify that the exception message does not contain SQL (we don't want to display SQL to users...
assertFalse("Exception message " + message + " seems to contain SQL", message.contains("SELECT"));
// ...and that the exception is decorated, so the SQL does end up in mothership
String decoration = ExceptionUtil.getExceptionDecoration(e, ExceptionUtil.ExceptionInfo.DialectSQL);
assertNotNull("Exception was not decorated", decoration);
// Singleton column collections should always be considered "stable"
testColumnList(new TableSelector(ti, PageFlowUtil.set("Email")), true);
testColumnList(new TableSelector(ti, new CsvSet("Email")), true);
testColumnList(new TableSelector(ti, Collections.singleton("Email")), true);
testColumnList(new TableSelector(ti, ti.getColumns("Email"), null, null), true);
testColumnList(new TableSelector(ti, Collections.singleton(ti.getColumn("Email")), null, null), true);
}

// Make sure that getObject() throws if pk == null, #20057
@Test
public void testInClause()
{
TableInfo table = CoreSchema.getInstance().getTableInfoContainers();
long rowCount = new TableSelector(table).getRowCount();

// For now, null returns null to get DataReportsTest running again
ModuleContext ctx = moduleSelector.getObject(null, ModuleContext.class);
assertNull("getObject(null) should return null", ctx);
Container root = ContainerManager.getRoot();
FilterClause rootClause = new InClause(FieldKey.fromParts("RowId"), Set.of(root.getRowId()));
assertEquals(1, new TableSelector(table, new SimpleFilter(rootClause), null).getRowCount());
assertEquals(rowCount - 1, new TableSelector(table, new SimpleFilter(new NotClause(rootClause)), null).getRowCount());

// try
// {
// moduleSelector.getObject(null, ModuleContext.class);
// fail("getObject() should have thrown with null pk");
// }
// catch (IllegalStateException e)
// {
// assertEquals("PK on getObject() must not be null", e.getMessage());
// }
}
FilterClause emptyClause = new InClause(FieldKey.fromParts("RowId"), Set.of());
assertEquals(0, new TableSelector(table, new SimpleFilter(emptyClause), null).getRowCount());
assertEquals(rowCount, new TableSelector(table, new SimpleFilter(new NotClause(emptyClause)), null).getRowCount());
}

@Test
public void testColumnLists() throws SQLException
{
TableInfo ti = CoreSchema.getInstance().getTableInfoActiveUsers();

testColumnList(new TableSelector(ti, new HashSet<>(Arrays.asList("Email", "UserId", "DisplayName", "Created", "Active"))), false);
testColumnList(new TableSelector(ti, new HashSet<>(ti.getColumns("Email,UserId,DisplayName,Created,Active")), null, null), false);

testColumnList(new TableSelector(ti, PageFlowUtil.set("Email", "UserId", "DisplayName", "Created", "Active")), true);
testColumnList(new TableSelector(ti, new LinkedHashSet<>(Arrays.asList("Email", "UserId", "DisplayName", "Created", "Active"))), true);
testColumnList(new TableSelector(ti, new CsvSet("Email, UserId, DisplayName, Created, Active")), true);
testColumnList(new TableSelector(ti, PageFlowUtil.set(ti.getColumn("Email"), ti.getColumn("UserId"), ti.getColumn("DisplayName"), ti.getColumn("Created"), ti.getColumn("Active")), null, null), true);
testColumnList(new TableSelector(ti, ti.getColumns("Email,UserId,DisplayName,Created,Active"), null, null), true);

// Singleton column collections should always be considered "stable"
testColumnList(new TableSelector(ti, PageFlowUtil.set("Email")), true);
testColumnList(new TableSelector(ti, new CsvSet("Email")), true);
testColumnList(new TableSelector(ti, Collections.singleton("Email")), true);
testColumnList(new TableSelector(ti, ti.getColumns("Email"), null, null), true);
testColumnList(new TableSelector(ti, Collections.singleton(ti.getColumn("Email")), null, null), true);
}

private void testColumnList(TableSelector selector, boolean stable) throws SQLException
protected void testColumnList(TableSelector selector, boolean stable) throws SQLException
{
// The following methods should succeed with both stable and unstable ordered column lists

Expand Down Expand Up @@ -446,7 +334,7 @@ private void testColumnList(TableSelector selector, boolean stable) throws SQLEx
}
}

private <K> void testTableSelector(TableInfo table, Class<K> clazz) throws SQLException
protected <K> void testTableSelector(TableInfo table, Class<K> clazz) throws SQLException
{
DbSchema schema = table.getSchema();
LOG.info("Testing {}.{}.{}", schema.getScope().getDisplayName(), schema.getName(), table.getName());
Expand Down Expand Up @@ -550,19 +438,4 @@ private <K> void test(TableSelector selector, Class<K> clazz, int offset, int ro
verifyResultSets(selector, rowCount, expectedComplete);
}

@Test
public void testInClause()
{
TableInfo table = CoreSchema.getInstance().getTableInfoContainers();
long rowCount = new TableSelector(table).getRowCount();

Container root = ContainerManager.getRoot();
FilterClause rootClause = new InClause(FieldKey.fromParts("RowId"), Set.of(root.getRowId()));
assertEquals(1, new TableSelector(table, new SimpleFilter(rootClause), null).getRowCount());
assertEquals(rowCount - 1, new TableSelector(table, new SimpleFilter(new NotClause(rootClause)), null).getRowCount());

FilterClause emptyClause = new InClause(FieldKey.fromParts("RowId"), Set.of());
assertEquals(0, new TableSelector(table, new SimpleFilter(emptyClause), null).getRowCount());
assertEquals(rowCount, new TableSelector(table, new SimpleFilter(new NotClause(emptyClause)), null).getRowCount());
}
}
2 changes: 2 additions & 0 deletions api/src/org/labkey/api/data/dialect/SqlDialect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
import org.labkey.api.module.ModuleContext;
import org.labkey.api.module.ModuleLoader;
import org.labkey.api.query.FieldKey;
import org.labkey.api.test.TestWhen;
import org.labkey.api.util.ExceptionUtil;
import org.labkey.api.util.HtmlString;
import org.labkey.api.util.MemTracker;
Expand Down Expand Up @@ -2414,6 +2415,7 @@ public SQLFragment array_element_like(SQLFragment a, String... values)
// TESTS
//

@TestWhen(TestWhen.When.DBSCOPE)
public static class DialectTestCase
{
DbScope s;
Expand Down
Loading