Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 4, 2025

Link issues

fixes #6357

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Introduce a recursive option and improve error handling for the DirectoryInfoExtensions.Copy method

New Features:

  • Add a recursive parameter to enable optional deep copying of subdirectories

Bug Fixes:

  • Throw DirectoryNotFoundException when the source directory does not exist

Enhancements:

  • Refactor the copy logic to create the destination folder first, copy files, and then conditionally recurse into subdirectories

Documentation:

  • Update XML comments to describe the recursive flag and exception behavior

Tests:

  • Update unit tests to specify the recursive argument and add a test for missing source directory exception

@bb-auto bb-auto bot added the enhancement New feature or request label Jul 4, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 4, 2025

Reviewer's Guide

This PR enhances the DirectoryInfoExtensions.Copy method by introducing a recursive flag, enforcing source directory validation, refactoring the copy implementation for files and subdirectories, and extending the unit tests to cover these new behaviors.

Class diagram for updated DirectoryInfoExtensions.Copy method

classDiagram
    class DirectoryInfoExtensions {
        +void Copy(DirectoryInfo dir, string destinationDir, bool recursive = true)
    }
Loading

Flow diagram for DirectoryInfoExtensions.Copy with recursive parameter

flowchart TD
    A[Check if source directory exists] -->|No| B[Throw DirectoryNotFoundException]
    A -->|Yes| C[Create destination directory]
    C --> D[Copy files from source to destination]
    D --> E{recursive?}
    E -- Yes --> F[For each subdirectory, call Copy recursively]
    E -- No --> G[End]
    F --> G
Loading

File-Level Changes

Change Details Files
Introduce recursive parameter and enrich method signature
  • Add a bool "recursive" parameter with default true
  • Update XML documentation to describe the new parameter and exception
  • Throw DirectoryNotFoundException if source directory does not exist
src/BootstrapBlazor/Extensions/DirectoryInfoExtensions.cs
Refactor copy logic for files and directories
  • Always create the destination directory before copying
  • Copy files via GetFiles and file.CopyTo without overwrite flag
  • If recursive is true, enumerate subdirectories and invoke Copy recursively
src/BootstrapBlazor/Extensions/DirectoryInfoExtensions.cs
Extend and update unit tests for new behavior
  • Pass the recursive argument in existing Copy_Ok test
  • Add a test case asserting DirectoryNotFoundException for missing source
test/UnitTest/Extensions/DirectoryInfoExtensionsTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6357 Update the Copy extension method for DirectoryInfo.
#6357 Add a recursive parameter to the Copy extension method.

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!

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

@bb-auto bb-auto bot added this to the 9.8.0 milestone Jul 4, 2025
@ArgoZhang ArgoZhang merged commit 48f8936 into main Jul 4, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-extensions branch July 4, 2025 06:10
Copy link
Contributor

@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 and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor/Extensions/DirectoryInfoExtensions.cs:39` </location>
<code_context>
-            }
-            else if (info is DirectoryInfo di)
+            string targetFilePath = Path.Combine(destinationDir, file.Name);
+            file.CopyTo(targetFilePath);
+        }
+
</code_context>

<issue_to_address>
File.CopyTo does not overwrite existing files, which may cause issues if destination files already exist.

The previous code allowed overwriting by passing 'true' to 'CopyTo'. To maintain this behavior and prevent exceptions when files exist, add 'true' as the second argument.
</issue_to_address>

### Comment 2
<location> `test/UnitTest/Extensions/DirectoryInfoExtensionsTest.cs:35` </location>
<code_context>

         var sourceDirInfo = new DirectoryInfo(sourceDir);
-        sourceDirInfo.Copy(destDir);
+        sourceDirInfo.Copy(destDir, true);
         Assert.True(Directory.Exists(destDir));
+
</code_context>

<issue_to_address>
Missing test for non-recursive copy (recursive = false).

Please add a test with 'recursive' set to false to confirm subdirectories are not copied when recursion is disabled.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        sourceDirInfo.Copy(destDir, true);
        Assert.True(Directory.Exists(destDir));

        // 测试源文件夹不存在的情况
        var sourceDirNotExists = new DirectoryInfo(Path.Combine(rootDir, "notexists"));
        var ex = Assert.Throws<DirectoryNotFoundException>(() => sourceDirNotExists.Copy(destDir, true));
        Assert.NotNull(ex);
=======
        sourceDirInfo.Copy(destDir, true);
        Assert.True(Directory.Exists(destDir));

        // Test non-recursive copy (recursive = false)
        var nonRecursiveDestDir = Path.Combine(rootDir, "nonRecursiveDest");
        sourceDirInfo.Copy(nonRecursiveDestDir, false);
        Assert.True(Directory.Exists(nonRecursiveDestDir));
        // Check that files in the root of sourceDir are copied
        foreach (var file in Directory.GetFiles(sourceDir))
        {
            var fileName = Path.GetFileName(file);
            Assert.True(File.Exists(Path.Combine(nonRecursiveDestDir, fileName)));
        }
        // Check that subdirectories are NOT copied
        foreach (var subDir in Directory.GetDirectories(sourceDir))
        {
            var subDirName = Path.GetFileName(subDir);
            Assert.False(Directory.Exists(Path.Combine(nonRecursiveDestDir, subDirName)));
        }

        // 测试源文件夹不存在的情况
        var sourceDirNotExists = new DirectoryInfo(Path.Combine(rootDir, "notexists"));
        var ex = Assert.Throws<DirectoryNotFoundException>(() => sourceDirNotExists.Copy(destDir, true));
        Assert.NotNull(ex);
>>>>>>> REPLACE

</suggested_fix>

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.

}
else if (info is DirectoryInfo di)
string targetFilePath = Path.Combine(destinationDir, file.Name);
file.CopyTo(targetFilePath);
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): File.CopyTo does not overwrite existing files, which may cause issues if destination files already exist.

The previous code allowed overwriting by passing 'true' to 'CopyTo'. To maintain this behavior and prevent exceptions when files exist, add 'true' as the second argument.

Comment on lines +35 to +41
sourceDirInfo.Copy(destDir, true);
Assert.True(Directory.Exists(destDir));

// 测试源文件夹不存在的情况
var sourceDirNotExists = new DirectoryInfo(Path.Combine(rootDir, "notexists"));
var ex = Assert.Throws<DirectoryNotFoundException>(() => sourceDirNotExists.Copy(destDir, true));
Assert.NotNull(ex);
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (testing): Missing test for non-recursive copy (recursive = false).

Please add a test with 'recursive' set to false to confirm subdirectories are not copied when recursion is disabled.

Suggested change
sourceDirInfo.Copy(destDir, true);
Assert.True(Directory.Exists(destDir));
// 测试源文件夹不存在的情况
var sourceDirNotExists = new DirectoryInfo(Path.Combine(rootDir, "notexists"));
var ex = Assert.Throws<DirectoryNotFoundException>(() => sourceDirNotExists.Copy(destDir, true));
Assert.NotNull(ex);
sourceDirInfo.Copy(destDir, true);
Assert.True(Directory.Exists(destDir));
// Test non-recursive copy (recursive = false)
var nonRecursiveDestDir = Path.Combine(rootDir, "nonRecursiveDest");
sourceDirInfo.Copy(nonRecursiveDestDir, false);
Assert.True(Directory.Exists(nonRecursiveDestDir));
// Check that files in the root of sourceDir are copied
foreach (var file in Directory.GetFiles(sourceDir))
{
var fileName = Path.GetFileName(file);
Assert.True(File.Exists(Path.Combine(nonRecursiveDestDir, fileName)));
}
// Check that subdirectories are NOT copied
foreach (var subDir in Directory.GetDirectories(sourceDir))
{
var subDirName = Path.GetFileName(subDir);
Assert.False(Directory.Exists(Path.Combine(nonRecursiveDestDir, subDirName)));
}
// 测试源文件夹不存在的情况
var sourceDirNotExists = new DirectoryInfo(Path.Combine(rootDir, "notexists"));
var ex = Assert.Throws<DirectoryNotFoundException>(() => sourceDirNotExists.Copy(destDir, true));
Assert.NotNull(ex);

@codecov
Copy link

codecov bot commented Jul 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6aa2bd6) to head (07d63d7).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6358   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          718       718           
  Lines        31607     31608    +1     
  Branches      4461      4461           
=========================================
+ Hits         31607     31608    +1     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

feat(DirectoryInfoExtensions): add recursive parameter

2 participants