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

Fix DB backup and restore and add database upgrade testing improvements #2607

Merged
merged 12 commits into from
Apr 11, 2024

Conversation

stefannica
Copy link
Contributor

@stefannica stefannica commented Apr 10, 2024

Describe changes

The database backup and restore feature is still broken for some scenarios and this PR is finally fixing it as well as adds regression testing to make sure we never break it again. The fix consists of three pieces:

  1. remove the DB dependency loop we introduced in 0.55.4 between the pipeline build and pipeline deployment tables
  2. enclose the table names in backticks because some table names are reserved keywords (e.g. triggers)
  3. the database row pagination issue that we fixed for the in-memory and file dump backup strategies hasn't been fixed for the database backup strategy. This PR also fixes that.

Side-changes

This PR also makes a few improvements to the existing database upgrade test scripts:

  • merges the two scripts we use to test database upgrades for mysql/sqlite and mariadb
  • reduces code duplication
  • uses pip install instead of git checkout to install past zenml versions
  • cleans up and reuses the same virtual enviroment for all installed zenml versions to reduce disk usage (useful for running upgrade tests locally)
  • uses a separate temporary location for the ZenML global configuration to avoid deleting the default one (useful for running upgrade tests locally)
  • tests the database backup & restore feature as part of each upgrade and targets both the file dump and database backup strategies. NOTE: as our database backup and restore feature didn't actually work properly until now for all the supported strategies, proper testing cannot be applied retrospectively to past releases.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • 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 change)
  • Other (add details above)

Copy link
Contributor

coderabbitai bot commented Apr 10, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@github-actions github-actions bot added the internal To filter out internal PRs and issues label Apr 10, 2024
@strickvl strickvl added tests Test suite additions or updates CI labels Apr 10, 2024
Copy link
Contributor

@avishniakov avishniakov left a comment

Choose a reason for hiding this comment

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

Thanks for that @stefannica! We just discussed it as a nice improvement with @strickvl during the lastest painful release, but I didn't start with it 🙂

@stefannica stefannica changed the title Database upgrade testing improvements Fix DB dependency loop and add database upgrade testing improvements Apr 11, 2024
@stefannica stefannica changed the title Fix DB dependency loop and add database upgrade testing improvements Fix DB backup and restore and add database upgrade testing improvements Apr 11, 2024
Copy link
Contributor

E2E template updates in examples/e2e have been pushed.

Copy link
Contributor

NLP template updates in examples/e2e_nlp have been pushed.

@stefannica stefannica merged commit a4e3c3d into develop Apr 11, 2024
56 checks passed
@stefannica stefannica deleted the ci/improve-upgrade-testing branch April 11, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI internal To filter out internal PRs and issues run-slow-ci tests Test suite additions or updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants