Backport to branch(3.15) : Add JDBC database permission test #2910
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @feeblefakie, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request is an automated backport that introduces comprehensive integration tests for JDBC database permissions. The changes establish a dedicated test suite to verify proper access control and user management functionalities within the JDBC storage layer, ensuring that different database users have the correct permissions for various operations.
Highlights
- New JDBC Permission Test Suite: I've introduced a new, dedicated integration test suite specifically for JDBC database permission tests. This suite includes both general permission tests and admin permission tests.
- Gradle Configuration Updates: The
core/build.gradlefile has been updated to define a newsourceSetand a corresponding GradleTesttask (integrationTestJdbcPermission) to run these new JDBC permission tests independently. The relevant test files are now excluded from the generalintegrationTesttask and included in this new specialized task. - JDBC Permission Test Utilities: A new utility class,
JdbcPermissionTestUtils, has been added. This class abstracts the RDBMS-specific SQL commands required to create, drop, and grant necessary permissions to database users for testing purposes across MySQL, Oracle, PostgreSQL, and SQL Server. - Normal User Configuration Support: The
JdbcEnvclass has been enhanced to support configuring database connections for a 'normal user' (non-admin) by introducing new properties (scalardb.jdbc.normal_username,scalardb.jdbc.normal_password) and agetPropertiesForNormalUsermethod. This is crucial for testing permission boundaries.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds integration tests for JDBC database permissions. The changes are well-structured and follow existing patterns in the codebase, including updates to the Gradle build file and the addition of new test classes.
My main feedback is on the new JdbcPermissionTestUtils.java file. I've identified a potential portability issue with how SQL statements are executed for SQL Server and have provided suggestions to improve robustness by executing each statement individually. This will ensure the tests are reliable across different JDBC driver implementations.
| return String.format( | ||
| "CREATE LOGIN %s WITH PASSWORD = '%s', DEFAULT_DATABASE = master , CHECK_POLICY = OFF, CHECK_EXPIRATION = OFF; CREATE USER %s FOR LOGIN %s", | ||
| userName, password, userName, userName); |
There was a problem hiding this comment.
The SQL for creating a user in SQL Server consists of two separate statements. Combining them with a semicolon is not guaranteed to be portable across all JDBC drivers, as Statement.execute() is generally expected to run a single SQL statement. This method should be updated to return an array of statements to be executed individually.
private String getCreateUserSql(String userName, String password) {
if (JdbcTestUtils.isMysql(rdbEngine)) {
return String.format("CREATE USER '%s'@'%%' IDENTIFIED BY '%s'", userName, password);
} else if (JdbcTestUtils.isOracle(rdbEngine)) {
return String.format("CREATE USER %s IDENTIFIED BY %s", userName, password);
} else if (JdbcTestUtils.isPostgresql(rdbEngine)) {
return String.format("CREATE USER %s WITH PASSWORD '%s'", userName, password);
} else if (JdbcTestUtils.isSqlite(rdbEngine)) {
throw new UnsupportedOperationException("SQLite does not support user management");
} else if (JdbcTestUtils.isSqlServer(rdbEngine)) {
return String.format(
"CREATE LOGIN %s WITH PASSWORD = '%s', DEFAULT_DATABASE = master , CHECK_POLICY = OFF, CHECK_EXPIRATION = OFF; CREATE USER %s FOR LOGIN %s",
userName, password, userName, userName);
} else {
throw new UnsupportedOperationException("Creating users is not supported for " + rdbEngine);
}| } else if (JdbcTestUtils.isSqlServer(rdbEngine)) { | ||
| return String.format("DROP USER %s; DROP LOGIN %s", userName, userName); | ||
| } else { |
There was a problem hiding this comment.
The SQL for dropping a user in SQL Server consists of two separate statements. Combining them with a semicolon is not guaranteed to be portable across all JDBC drivers, as Statement.execute() is generally expected to run a single SQL statement. This method should be updated to return an array of statements to be executed individually.
private String getDropUserSql(String userName) {
if (JdbcTestUtils.isMysql(rdbEngine)) {
return String.format("DROP USER '%s'@'%%'", userName);
} else if (JdbcTestUtils.isOracle(rdbEngine)) {
return String.format("DROP USER %s", userName);
} else if (JdbcTestUtils.isPostgresql(rdbEngine)) {
return String.format("DROP USER %s", userName);
} else if (JdbcTestUtils.isSqlite(rdbEngine)) {
throw new UnsupportedOperationException("SQLite does not support user management");
} else if (JdbcTestUtils.isSqlServer(rdbEngine)) {
return String.format("DROP USER %s; DROP LOGIN %s", userName, userName);
} else {
throw new UnsupportedOperationException("Dropping users is not supported for " + rdbEngine);
}
2 participants
This is an automated backport of the following:
Please merge this PR after all checks have passed.