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

test(LayoutSplitebar): add unit test for LayoutSplitebar #5443

Merged
merged 4 commits into from
Feb 25, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 25, 2025

add unit test for LayoutSidebar

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5442

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Renames the LayoutSidebar component to LayoutSplitebar to correct a typo and adds unit tests for the renamed component.

Tests:

  • Adds unit tests for the LayoutSplitebar component, covering basic rendering and parameter setting.

Chores:

  • Renames LayoutSidebar to LayoutSplitebar to fix a typo.

Copy link

sourcery-ai bot commented Feb 25, 2025

Reviewer's Guide by Sourcery

This pull request renames the LayoutSidebar component to LayoutSplitebar and adds unit tests for both the LayoutSplitebar and Layout components. The renaming improves clarity regarding the component's purpose as a split bar. Additionally, an unused import was removed from the javascript file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Renamed LayoutSidebar to LayoutSplitebar to better reflect its functionality as a split bar within the layout.
  • Renamed the LayoutSidebar.razor file to LayoutSplitebar.razor.
  • Renamed the LayoutSidebar.razor.cs file to LayoutSplitebar.razor.cs.
  • Renamed the LayoutSidebar.razor.scss file to LayoutSplitebar.razor.scss.
  • Updated the component's class name from LayoutSidebar to LayoutSplitebar in the corresponding C# file.
  • Updated the component's tag name from layout-sidebar to layout-splitebar in the corresponding scss file.
  • Updated the component's javascript file from LayoutSidebar.razor.js to LayoutSplitebar.razor.js.
  • Updated references to the component in MainLayout.razor and Layout.razor.
  • Updated the javascript file to use layout-splitebar-body class selector.
src/BootstrapBlazor/Components/Layout/LayoutSplitebar.razor
src/BootstrapBlazor/Components/Layout/LayoutSplitebar.razor.cs
src/BootstrapBlazor/Components/Layout/LayoutSplitebar.razor.scss
src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor
src/BootstrapBlazor/Components/Layout/Layout.razor
src/BootstrapBlazor/Components/Layout/LayoutSplitebar.razor.js
src/BootstrapBlazor/wwwroot/scss/components.scss
Added a unit test for the LayoutSplitebar component to ensure it renders correctly with specified parameters.
  • Created a new test file LayoutSplitebarTest.cs.
  • Added a test method LayoutSplitebar_Ok to verify the component's rendering with different ContainerSelector, Min, and Max parameters.
  • Verified that the component renders the correct data attributes based on the provided parameters.
test/UnitTest/Components/LayoutSplitebarTest.cs
Added a unit test for the Layout component to ensure it renders correctly when ShowSplitBar is enabled.
  • Added a test method ShowLayouSidebar_Ok to verify the component's rendering when ShowSplitBar is enabled.
  • Verified that the component renders the layout-splitebar element.
test/UnitTest/Components/LayoutTest.cs
Removed unused Data module import from LayoutSplitebar javascript file.
  • Removed import Data from "../../modules/data.js" from LayoutSplitebar.razor.js.
src/BootstrapBlazor/Components/Layout/LayoutSplitebar.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5442 Add a unit test for the LayoutSidebar component to improve code coverage.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The file name change from LayoutSidebar to LayoutSplitebar is a breaking change and should be mentioned in the commit message.
  • The new test LayoutSplitebarTest.cs should be in the same folder as LayoutTest.cs.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang changed the title test(LayoutSidebar): add unit test for LayoutSidebar test(LayoutSplitebar): add unit test for LayoutSplitebar Feb 25, 2025
Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1333636) to head (53d76d4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #5443      +/-   ##
===========================================
+ Coverage   99.97%   100.00%   +0.02%     
===========================================
  Files         646       646              
  Lines       29350     29350              
  Branches     4129      4129              
===========================================
+ Hits        29343     29350       +7     
+ Misses          7         0       -7     

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

@bb-auto bb-auto bot added the test This is unit test label Feb 25, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 25, 2025
@ArgoZhang ArgoZhang merged commit 97eb165 into main Feb 25, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the test-layoutsidebar branch February 25, 2025 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
test This is unit test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

test(LayoutSidebar): add unit test for LayoutSidebar
1 participant