search

techouse / mysql-to-sqlite3

Transfer data from MySQL to SQLite
https://techouse.github.io/mysql-to-sqlite3/
MIT License
221 stars 31 forks source link

Support for MySQL SSL options (`--mysql-ssl-cert`, `--mysql-ssl-key`, `--mysql-ssl-ca`) #77

Open frugan-dev opened 5 months ago

frugan-dev commented 5 months ago

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:

ERROR 3159 (HY000): Connections using insecure transport are prohibited while --require_secure_transport=ON.

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:

coderabbitai[bot] commented 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 to false in the CodeRabbit configuration file.

Walkthrough

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.

Changes

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.

Sequence Diagram(s) (Beta)

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

Poem

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
techouse commented 5 months ago

Thanks for your contribution. 💪

Can you please fix the linter errors and add some extra tests for this feature (if possible)?

frugan-dev commented 5 months ago

Hi @techouse, ok I'll try in the next few days, be patient but I'm new to Python..

frugan-dev commented 3 months ago

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!

techouse commented 3 months ago

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.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 86.05%. Comparing base (75bca3f) to head (0f23724).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #77 +/- ## ========================================== + Coverage 85.85% 86.05% +0.19% ========================================== Files 8 8 Lines 629 638 +9 ========================================== + Hits 540 549 +9 Misses 89 89 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

techouse commented 3 months ago

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.

frugan-dev commented 3 months ago

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.

techouse commented 3 months ago

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. :)

frugan-dev commented 3 months ago

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!