Open frugan-dev opened 5 months ago
[!IMPORTANT]
Review skipped
Draft detected.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yaml
file in this repository. To trigger a single review, invoke the@coderabbitai review
command.You can disable this status message by setting the
reviews.review_status
tofalse
in the CodeRabbit configuration file.
The changes introduce new SSL configuration options for MySQL connections, enhancing security by allowing users to specify paths for SSL certificate, key, and CA certificate files. Additionally, a skip-ssl
option is added to disable SSL encryption. These updates affect the CLI interface and the internal handling of MySQL connections in the codebase.
Files | Change Summary |
---|---|
README.md , docs/README.rst |
Added documentation for new SSL options in MySQL connection settings. |
src/mysql_to_sqlite3/cli.py |
Introduced CLI options for specifying paths to SSL certificate, key, and CA certificate files. |
src/mysql_to_sqlite3/... |
Enhanced MySQL connection setup to handle new SSL parameters in transporter.py . |
sequenceDiagram
participant User
participant CLI
participant Transporter
participant MySQL
User->>CLI: Provide SSL options (--mysql-ssl-cert, --mysql-ssl-key, --mysql-ssl-ca)
CLI->>Transporter: Pass SSL options
Transporter->>MySQL: Establish connection with SSL parameters
MySQL-->>Transporter: Confirm connection
Transporter-->>CLI: Notify successful connection
CLI-->>User: Display connection status
In fields of code, where data flows, A rabbit hops, with SSL it shows. Certificates in paw, secure and bright, MySQL connections, safe in the night. Skip or secure, the choice is clear, With every hop, no need to fear.
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Thanks for your contribution. 💪
Can you please fix the linter errors and add some extra tests for this feature (if possible)?
Hi @techouse, ok I'll try in the next few days, be patient but I'm new to Python..
Hi @techouse, sorry for the delay, I fixed the linters errors and added new ssl tests. Here are some considerations:
1) I added tox.*.ini
in the .gitignore file, because on my pc the mysql:latest
image did not run (see https://github.com/docker-library/mysql/issues/1055) and I had to create a tox.override.ini
file:
[testenv]
allowlist_externals = pytest
commands = pytest -v --cov=src/mysql_to_sqlite3 --cov-report=xml --docker-mysql-image=mysql:8-oraclelinux8
and run the tests this way:
tox -c tox.ini -c tox.override.ini
2) Locally I had to use a value of mysql_connection_retries: int = 50
here, as the default value was not sufficient; I have not committed the change, but perhaps it is a good idea to increase it, what do you think?
3) I captured the container logs here, because passing self-signed certificates to the container kept giving me the error Lost connection to MySQL server during query
and I didn't understand why..
In the end I understood that it was just a permissions problem, which for now I solved like this, but maybe there is a more elegant solution (option user
here?).
4) I added a random suffix to the name of the created containers to avoid errors like Conflict. The container name "/pytest_mysql_to_sqlite3" is already in use by container "xxx". You have to remove (or rename) that container to be able to reuse that name.")
.
Let me know if that works out!
Hi @frugan-dev
Looks like there are still some fundamental errors in your code.
You don't have to use tox to test it locally, running something like
pytest -v -x
should do the trick.
As for the Tox setup, please do not commit / git-track these changes as they are specific to your setup and do not reflect a wider problem.
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 86.05%. Comparing base (
75bca3f
) to head (0f23724
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Locally I had to use a value of mysql_connection_retries: int = 50 here, as the default value was not sufficient; I have not committed the change, but perhaps it is a good idea to increase it, what do you think?
Hmm, this was never an issue before. Maybe it's SSL-specific. You can try to commit the change to 50
but that seems obscenely high to me.
Looks like there are still some fundamental errors in your code.
Thanks, I made some fixes. Local testing with Docker works, but on GitHub there would be some adjustments to be made to support self-signed certificates.
As for the Tox setup, please do not commit / git-track these changes as they are specific to your setup and do not reflect a wider problem.
Sure, I only committed the .gitignore
change, so as to allow the use of a tox.override.ini
file locally.
Local testing with Docker works, but on GitHub there would be some adjustments to be made to support self-signed certificates.
Commit whatever you think is necessary to make the CI tests pass. :)
Locally I had to use a value of mysql_connection_retries: int = 50 here, as the default value was not sufficient; I have not committed the change, but perhaps it is a good idea to increase it, what do you think?
Hmm, this was never an issue before. Maybe it's SSL-specific. You can try to commit the change to
50
but that seems obscenely high to me.
Actually on my PC it connects after about 20-25 attempts, but for now let's leave it like this, there's no problem.. I wouldn't want the increase to affect the execution time of the CI tests.
Local testing with Docker works, but on GitHub there would be some adjustments to be made to support self-signed certificates.
Commit whatever you think is necessary to make the CI tests pass. :)
Ok I'll take a look ASAP!
Pull Request: Add MySQL SSL Options
Description
This pull request adds support for MySQL SSL options (
--mysql-ssl-cert
,--mysql-ssl-key
,--mysql-ssl-ca
), that allow users to specify the paths to SSL certificate, key, and CA certificate files when connecting to MySQL databases that require secure transport (--require_secure_transport=ON
). This enhancement aims to address the issue where connections using insecure transport are prohibited due to MySQL server settings, e.g. when this error message appears:Type of change
How Has This Been Tested?
These changes have been tested locally by connecting to MySQL databases with
--require_secure_transport=ON
using the newly introduced SSL options.Checklist: