FIDES-1887 - Add sslmode to MySQL DB integration#6048
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6048 +/- ##
==========================================
+ Coverage 86.88% 86.89% +0.01%
==========================================
Files 419 419
Lines 25968 25978 +10
Branches 2828 2828
==========================================
+ Hits 22561 22574 +13
+ Misses 2788 2785 -3
Partials 619 619 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…nto wades/add-sslmode Changelog merge conflict resolved
galvana
requested changes
Apr 16, 2025
Contributor
galvana
left a comment
galvana
left a comment
There was a problem hiding this comment.
Overall this looks good! Just recommending the use of an enum of sslmode and adding the missing tests we discussed offline
Comment on lines
+43
to
+48
| sslmode: Optional[str] = Field( | ||
| None, # TODO: support for verify-ca and verify-full | ||
| title="SSL Mode", | ||
| description="The SSL mode to use for the connection. Valid values are 'required', 'preferred', and 'disabled'.", | ||
| pattern=r"required|preferred|disabled", | ||
| ) |
Contributor
There was a problem hiding this comment.
We could use an enum for this
class SSLMode(str, Enum):
preferred = "preferred"
required = "required"
disabled = "disabled"
Then we could just do this
Suggested change
| sslmode: Optional[str] = Field( | |
| None, # TODO: support for verify-ca and verify-full | |
| title="SSL Mode", | |
| description="The SSL mode to use for the connection. Valid values are 'required', 'preferred', and 'disabled'.", | |
| pattern=r"required|preferred|disabled", | |
| ) | |
| sslmode: Optional[SSLMode] = Field( | |
| None, # TODO: support for verify-ca and verify-full | |
| title="SSL Mode", | |
| description="The SSL mode to use for the connection. Valid values are 'required', 'preferred', and 'disabled'." | |
| ) |
Contributor
Author
There was a problem hiding this comment.
@galvana could I define that ENUM in connection_secrets_mysql.py?
| "title": "SSL Mode", | ||
| "description": "The SSL mode to use for the connection. Valid values are 'required', 'preferred', and 'disabled'.", | ||
| "type": "string", | ||
| "pattern": "required|preferred|disabled", |
Contributor
There was a problem hiding this comment.
You might need to remove this line if we go with the enum approach
Comment on lines
+61
to
+67
| def test_mysql_connector_build_uri_without_secrets( | ||
| connection_config_mysql, db: Session | ||
| ): | ||
| connection_config_mysql.secrets = None | ||
| connection_config_mysql.save(db) | ||
| with pytest.raises(ValueError): | ||
| MySQLConnector(configuration=connection_config_mysql) |
Contributor
There was a problem hiding this comment.
Replace this with the direct get_connect_args() tests to get that increase in code coverage
tvandort
reviewed
Apr 17, 2025
| title="SSH required", | ||
| description="Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections.", | ||
| ) | ||
| sslmode: Optional[MySQLSslMode] = Field( |
galvana
reviewed
Apr 17, 2025
| ) | ||
|
|
||
|
|
||
| class MySQLSslMode(str, Enum): |
Contributor
There was a problem hiding this comment.
nit: we should upper case all acronyms
Note: When using acronyms in CapWords, capitalize all the letters of the acronym. Thus HTTPServerError is better than HttpServerError.
https://peps.python.org/pep-0008/#descriptive-naming-styles
Suggested change
| class MySQLSslMode(str, Enum): | |
| class MySQLSSLMode(str, Enum): |
galvana
approved these changes
Apr 17, 2025
fides
|
||||||||||||||||||||||||||||
| Project |
fides
|
| Branch Review |
main
|
| Run status |
|
| Run duration | 00m 51s |
| Commit |
|
| Committer | wadesdev |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
5
|
| View all changes introduced in this branch ↗︎ | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes FIDES-1887
Description Of Changes
Adds sslmode field for MySQL; does not permit passing certificates through for verify-ca and verify-full
Code Changes
connect_argsargument for SSLSteps to Confirm
ssl: requiredfield, providingrequiredin sslmode field should result in a successful connection. Otherwise, connection will be unsuccessful.Pre-Merge Checklist
CHANGELOG.mdupdatedmaindowngrade()migration is correct and works