Skip to content
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.

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

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

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

frugan-dev
Copy link

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

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:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link

coderabbitai bot commented Jun 4, 2024

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
Loading

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9af779f and 03516c3.

Files selected for processing (4)
  • README.md (1 hunks)
  • docs/README.rst (1 hunks)
  • src/mysql_to_sqlite3/cli.py (3 hunks)
  • src/mysql_to_sqlite3/transporter.py (2 hunks)
Additional context used
LanguageTool
README.md

[locale-violation] ~5-~5: license must be spelled with a “c” when used as a noun in British English. Use “licence”. (LICENCE_LICENSE_NOUN_SINGULAR)
Context: ...10.2+|+10.3+|+10.4+|+10.5&color=C0765A) [![GitHub license](https://img.shields.io/github/license/...

Markdownlint
README.md

20-20: Expected: h2; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


31-31: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

Additional comments not posted (6)
docs/README.rst (1)

46-48: The documentation for the new SSL options is clear and concise.

src/mysql_to_sqlite3/cli.py (2)

103-105: The addition of SSL options in the CLI is implemented correctly.


Line range hint 148-182: The integration of SSL options into the main function is handled properly. Ensure that the mysql_ssl_disabled flag is tested thoroughly.

README.md (1)

71-73: The documentation for the new SSL options in the main README is clear and concise.

src/mysql_to_sqlite3/transporter.py (2)

91-96: The addition of SSL options in the MySQLtoSQLite class constructor is implemented correctly.


132-134: The use of SSL options in the MySQL connection setup is handled properly.

@techouse
Copy link
Owner

techouse commented Jun 4, 2024

Thanks for your contribution. 💪

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

@techouse techouse added the enhancement New feature or request label Jun 4, 2024
@techouse techouse assigned techouse and frugan-dev and unassigned techouse Jun 4, 2024
@frugan-dev
Copy link
Author

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

@techouse techouse marked this pull request as draft July 12, 2024 08:47
@frugan-dev
Copy link
Author

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 CPU does not support x86-64-v2 in the latest 8.4.0 docker-library/mysql#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
  1. 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?

  2. 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?).

  3. 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
Copy link
Owner

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.

Copy link

codecov bot commented Aug 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            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              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@techouse
Copy link
Owner

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
Copy link
Author

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
Copy link
Owner

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
Copy link
Author

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants