prefix stdout with link/copy by MusicalNinjaDad · Pull Request #86 · MusicalNinjaDad/snaggle

MusicalNinjaDad · 2025-11-01T10:46:23Z

Summary by Sourcery

Prefix stdout messages of file operations with operation type and update tests to assert on these prefixes using a new AssertStdout helper.

New Features:

Add AssertStdout helper to verify operation prefixes in test output

Enhancements:

Prefix file operation logs with "link" or "copy" to indicate the action taken

Tests:

Replace raw stdout assertions with AssertStdout across unit tests
Add assertion in TestCommonBinaries to ensure linked files are prefixed with "link"

sourcery-ai · 2025-11-01T10:46:29Z

Reviewer's Guide

This PR adds explicit operation prefixes (“link” or “copy”) to both test assertions and runtime log output by introducing a new AssertStdout helper, updating existing tests to use it and enforce prefix expectations, and modifying the link function to emit the correct operation in its log messages.

Class diagram for new AssertStdout helper and link function changes

classDiagram
    class AssertStdout {
        +AssertStdout(t *testing.T, expected []string, actual []string)
    }
    class Link {
        +link(sourcePath string, targetDir string) error
        -op string
    }
    AssertStdout <.. TestCases : used by
    Link <.. log.Default : logs operation
    Link <.. internal.Copy : calls
    Link <.. internal.SameFile : calls

File-Level Changes

Change	Details	Files
Introduce AssertStdout helper in test utilities	Add AssertStdout function to validate and strip “link”/“copy” prefixes Iterate over actual output lines, assert prefix presence, and strip first 5 characters Compare stripped lines against expected values	`internal/testing/testdata.go`
Update snaggle tests to use AssertStdout and enforce link prefix	Replace Assert.ElementsMatch calls with AssertStdout Add loop to assert any line containing tc.Elf.Path starts with “link ”	`snaggle_test.go`
Adopt AssertStdout in CLI test suite	Replace Assert.ElementsMatch with AssertStdout in cli tests	`cmd/snaggle/cli_test.go`
Prefix log output with actual operation type	Introduce op variable initialized to “link” Set op to “copy” when falling back on copy Prepend op to log.Default().Println output	`snaggle.go`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#44	Show in stdout when source is a symlink: `originalSource (actualPath) -> target`	❌	The PR does not add logic to display the actual path when the source is a symlink; it only prefixes stdout with 'link' or 'copy'.
#44	When target is relative, show absolute path or prefix with '.'	❌	The PR does not modify stdout to show absolute paths or prefix with '.' when the target is relative.
#44	Let user know whether linking or copying each file in stdout	✅

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

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

The AssertStdout helper slices the first 5 characters to strip the prefix but only checks HasPrefix("copy") or HasPrefix("link"); it should validate "copy " and "link " (with the space) and adjust the slice accordingly to avoid off-by-one errors.
The assertion error message references "line" instead of "link"—update it to mention the correct prefix.
Consider defining constants for the "copy " and "link " prefixes to avoid hardcoding the length and make future changes safer.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The AssertStdout helper slices the first 5 characters to strip the prefix but only checks HasPrefix("copy") or HasPrefix("link"); it should validate "copy " and "link " (with the space) and adjust the slice accordingly to avoid off-by-one errors.
- The assertion error message references "line" instead of "link"—update it to mention the correct prefix.
- Consider defining constants for the "copy " and "link " prefixes to avoid hardcoding the length and make future changes safer.

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.}

codecov · 2025-11-01T10:47:15Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.56%. Comparing base (aac398e) to head (6d7202f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #86      +/-   ##
==========================================
+ Coverage   74.02%   74.56%   +0.53%     
==========================================
  Files          11       11              
  Lines         566      578      +12     
==========================================
+ Hits          419      431      +12     
  Misses        104      104              
  Partials       43       43

☔ 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.

MusicalNinjaDad added 3 commits November 1, 2025 10:43

test for prefix copy / link

de628b9

prefix stdout with copy/link

27de217

check linked file correctly reported

fcc23d9

MusicalNinjaDad linked an issue Nov 1, 2025 that may be closed by this pull request

Improved stdout from link() #44

Closed

sourcery-ai Bot reviewed Nov 1, 2025

View reviewed changes

MusicalNinjaDad added 2 commits November 1, 2025 10:48

update changelog

c89da05

check space is present after copy/link

51c13c6

MusicalNinjaDad removed a link to an issue Nov 1, 2025

Improved stdout from link() #44

Closed

MusicalNinjaDad linked an issue Nov 1, 2025 that may be closed by this pull request

let user know whether linking or copying each #87

Closed

Merge branch 'main' into 44_stdout

6d7202f

MusicalNinjaDad enabled auto-merge (squash) November 1, 2025 10:54

MusicalNinjaDad merged commit 7027441 into main Nov 1, 2025
11 checks passed

MusicalNinjaDad deleted the 44_stdout branch November 1, 2025 10:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

prefix stdout with link/copy#86

prefix stdout with link/copy#86
MusicalNinjaDad merged 6 commits into
mainfrom
44_stdout

MusicalNinjaDad commented Nov 1, 2025 •

edited by sourcery-ai Bot

Loading

Uh oh!

sourcery-ai Bot commented Nov 1, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Uh oh!

codecov Bot commented Nov 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

MusicalNinjaDad commented Nov 1, 2025 • edited by sourcery-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai Bot commented Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Class diagram for new AssertStdout helper and link function changes

File-Level Changes

Assessment against linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

MusicalNinjaDad commented Nov 1, 2025 •

edited by sourcery-ai Bot

Loading

sourcery-ai Bot commented Nov 1, 2025 •

edited

Loading

codecov Bot commented Nov 1, 2025 •

edited

Loading