Skip to content

simplify collation tests #1700

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

Merged
merged 2 commits into from
Apr 21, 2025
Merged

simplify collation tests #1700

merged 2 commits into from
Apr 21, 2025

Conversation

methane
Copy link
Member

@methane methane commented Apr 21, 2025

Description

Remove complex logic for MariaDB's character_set_collations behavior.
Instead, just avoid collations affected by the character_set_collations.

Checklist

  • Code compiles correctly
  • Created tests which fail without the change (if possible)
  • All tests passing
  • Extended the README / documentation, if necessary
  • Added myself / the copyright holder to the AUTHORS file

Summary by CodeRabbit

  • Tests
    • Simplified collation tests by removing handling of empty and default collations, and now only verifying explicit collations for exact matches.
  • Chores
    • Added a new author entry to the project’s AUTHORS list.

Copy link

coderabbitai bot commented Apr 21, 2025

Walkthrough

The TestCollation function in driver_test.go was refactored to simplify its logic. The test no longer handles empty or default collation cases, nor does it attempt to detect or adjust for MariaDB-specific collation overrides. Instead, it now iterates over a fixed list of explicit collations, appends each to the DSN, and asserts that the resulting connection collation matches the specified value exactly. The previous logic for parsing server variables and adjusting expectations based on detected overrides has been removed.

The AUTHORS file was updated to add a new individual author entry for Diego Dupin, inserted alphabetically without other changes.

Changes

File(s) Change Summary
driver_test.go Refactored TestCollation to remove handling of empty/default collations and MariaDB override logic. Now tests only explicit collations, always expects exact match, and simplifies the assertion logic.
AUTHORS Added new author entry "Diego Dupin <diego.dupin at gmail.com>" alphabetically between existing entries.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant MySQLServer

    loop For each explicit collation
        TestRunner->>MySQLServer: Connect with DSN (with collation param)
        TestRunner->>MySQLServer: Query @@collation_connection
        MySQLServer-->>TestRunner: Return current collation
        TestRunner->>TestRunner: Assert collation == expected
    end
Loading

Possibly related PRs

  • test stability improvement. #1698: Removes logic for detecting and adjusting expected collations based on MariaDB's character_set_collations override, directly modifying the same TestCollation function and its collation expectation handling.

Suggested reviewers

  • shogo82148

Poem

In the warren of code, a test was reborn,
No more chasing defaults or MariaDB scorn.
Collations now clear, each one put to the test—
No overrides lurking, just simple, direct.
A hop and a check, and the verdict is known,
The rabbit approves: the confusion is gone!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bfe6945 and 68069dd.

📒 Files selected for processing (2)
  • AUTHORS (1 hunks)
  • driver_test.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • AUTHORS
🚧 Files skipped from review as they are similar to previous changes (1)
  • driver_test.go
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: test (windows-latest, 1.24, mariadb-11.1)
  • GitHub Check: test (windows-latest, 1.24, mariadb-11.2)
  • GitHub Check: test (ubuntu-latest, 1.23, 9.0)
  • GitHub Check: test (ubuntu-latest, 1.22, 9.0)
  • GitHub Check: test (windows-latest, 1.24, mariadb-11.4)
  • GitHub Check: test (macos-latest, 1.24, 8.4)
  • GitHub Check: test (windows-latest, 1.24, 8.0)
  • GitHub Check: test (windows-latest, 1.24, 8.4)
  • GitHub Check: test (windows-latest, 1.24, 5.7)
  • GitHub Check: test (macos-latest, 1.24, mariadb-10.11)
  • GitHub Check: test (macos-latest, 1.24, mariadb-11.2)
  • GitHub Check: test (macos-latest, 1.24, mariadb-11.4)
  • GitHub Check: test (ubuntu-latest, 1.24, mariadb-11.1)
  • GitHub Check: test (ubuntu-latest, 1.24, mariadb-10.11)
  • GitHub Check: test (ubuntu-latest, 1.24, mariadb-10.6)
  • GitHub Check: test (ubuntu-latest, 1.24, mariadb-11.4)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@coveralls
Copy link

coveralls commented Apr 21, 2025

Coverage Status

coverage: 83.048%. remained the same
when pulling 68069dd on methane:fix-test2
into f433f1f on go-sql-driver:master.

@methane methane requested a review from Copilot April 21, 2025 06:59
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR simplifies collation tests for MariaDB by removing the complex logic that adjusted expected collations based on the server’s character_set_collations variable.

  • Removed the default collation variable and the dynamic logic that queried and processed @@character_set_collations.
  • Introduced subtests for each explicit collation in the testCollations slice.
Files not reviewed (1)
  • AUTHORS: Language not supported

@methane methane merged commit c786d41 into go-sql-driver:master Apr 21, 2025
38 checks passed
@methane methane deleted the fix-test2 branch April 21, 2025 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants