Don't skip symlinks during local source upload by dollierp · Pull Request #355 · shipwright-io/cli

dollierp · 2025-11-06T09:30:15Z

Changes

Don't skip symlinks during local source upload

/kind bug

Submitter Checklist

Includes tests if functionality changed/was added
Includes docs if changes are user-facing
Set a kind label on this PR
Release notes block has been filled in, or marked NONE

See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.

Release Notes

Don't skip symlinks during local source upload

Signed-off-by: Denis Ollier <dollierp@redhat.com>

openshift-ci · 2025-11-06T09:30:24Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign heavywombat for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

IrvingMg

Thanks for the PR!

Overall, LGTM. I left a couple of comments. It would also be nice to have unit tests for at least basic cases, as the changes are related to the core functionality of the upload command.

IrvingMg · 2026-03-23T08:38:25Z

pkg/shp/streamer/tar.go

 // skipPath inspect each path and makes sure it skips files the tar helper can't handle.
 func (t *Tar) skipPath(fpath string, stat fs.FileInfo) bool {
-	if !stat.Mode().IsRegular() {
+	if !stat.Mode().IsRegular() && !(stat.Mode()&fs.ModeSymlink != 0) {


Suggested change

if !stat.Mode().IsRegular() && !(stat.Mode()&fs.ModeSymlink != 0) {

if !stat.Mode().IsRegular() && stat.Mode()&fs.ModeSymlink == 0 {

nit

IrvingMg · 2026-03-23T09:23:54Z

pkg/shp/streamer/util.go

+		target, err := os.Readlink(fpath)
+		if err != nil {
+			return err
+		}
+
+		header.Linkname = target


Should we add validation or a warning if the symlink points outside the source directory?

Signed-off-by: Denis Ollier <dollierp@redhat.com>

dollierp · 2026-04-06T13:30:53Z

Hi @IrvingMg,

Thanks for your review.

I updated the PR with new changes trying to address your remarks.

Regards,

Copilot

Pull request overview

This PR fixes a bug where symlinks were being skipped during local source uploads. Previously, the tar helper would skip any file that wasn't a regular file (including symlinks, directories, and other special file types). The changes now allow symlinks to be included in the tar archive while still skipping unsupported file types.

Changes:

Modified skipPath function to exclude symlinks from being skipped (allowing them to be processed)
Added symlink handling in writeFileToTar to read symlink targets, detect if they point outside the source directory, and properly set the tar header linkname
Added isSymlinkTargetOutsideOfDir function to check if symlink targets escape the source directory and warn appropriately
Updated test to verify that symlinks are captured in the tar archive
Fixed documentation from "buildrun" to "build" command references

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
pkg/shp/streamer/tar.go	Modified skipPath condition to allow symlinks through filtering
pkg/shp/streamer/util.go	Added symlink handling logic with safety check for targets pointing outside source directory
pkg/shp/streamer/tar_test.go	Enhanced test to verify symlinks are included in tar output
pkg/shp/cmd/build/upload.go	Fixed documentation typo from "buildrun" to "build"
docs/shp_build_upload.md	Updated documentation examples to match corrected command

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pkg/shp/streamer/util.go

IrvingMg · 2026-04-08T13:54:39Z

Hi @dollierp, thanks for the changes.

There’s one more Copilot comment, could you take a look?

dollierp · 2026-04-08T14:07:01Z

Hi @IrvingMg,

I updated the PR to make Copilot happy.

Let me know if something else is missing.

Regards.

IrvingMg

Thanks again for the changes. I left a couple more comments.

IrvingMg · 2026-04-08T15:04:46Z

pkg/shp/streamer/util.go

+
+		if outside, _ := isSymlinkTargetOutsideOfDir(absSrc, absTarget); outside {
+			relPath, _ := filepath.Rel(src, fpath)
+			fmt.Fprintf(os.Stderr, "WARNING: symlink %q points outside the source directory %q (target: %q)\n", relPath, absSrc, target)


Could we send the error through ioStreams.ErrOut?

IrvingMg · 2026-04-08T15:05:38Z

test/symlink/symlink_inside_tree

@@ -0,0 +1 @@
+../../test


Would it be possible to create and delete the symlink at runtime to avoid committing it?

Signed-off-by: Denis Ollier <dollierp@redhat.com>

dollierp · 2026-04-09T19:02:55Z

Hi @IrvingMg,

I tried to address your latest remarks and updated the PR.

Regards,

IrvingMg

Thanks for the update, looks good overall. Just a few final comments from my side.

IrvingMg · 2026-04-10T08:31:52Z

pkg/shp/streamer/util.go

+	return nil
+}
+
+func isSymlinkTargetOutsideOfDir(dir, target string) (bool, error) {


nit: Is it possible to replace this with https://pkg.go.dev/path/filepath#IsLocal?

IrvingMg · 2026-04-10T08:33:53Z

pkg/shp/streamer/tar_test.go

+
+	stdErr := errOut.String()
+
+	t.Run("symlinks", func(_ *testing.T) {


Since *testing.T is unused, should we drop the t.Run wrapper?

IrvingMg · 2026-04-10T08:35:38Z

pkg/shp/streamer/tar_test.go

+	os.Symlink("../test", baseDir+"/test/symlink_inside_tree")
+	os.Symlink("../../foobar/test", baseDir+"/test/symlink_outside_tree")
+
+	defer os.Remove(baseDir + "/test/symlink_inside_tree")


Instead of deferring, I think we can use t.Cleanup.

IrvingMg · 2026-04-10T08:42:26Z

pkg/shp/streamer/tar_test.go

+	ioStreams, _, _, errOut := genericclioptions.NewTestIOStreams()
+
+	baseDir := "../../.."
+	os.Symlink("../test", baseDir+"/test/symlink_inside_tree")


It might be a good idea to check the error here and fail in case of an error. For example:

if err := os.Symlink("../test", baseDir+"/test/symlink_inside_tree"); err != nil { t.Fatalf("setup symlink: %v", err) } t.Cleanup(func() { os.Remove(baseDir + "/test/symlink_inside_tree") })

Don't skip symlinks during local source upload

39c0684

Signed-off-by: Denis Ollier <dollierp@redhat.com>

openshift-ci bot added the release-note label Nov 6, 2025

pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 6, 2025

openshift-ci bot added the kind/bug Categorizes issue or PR as related to a bug. label Nov 6, 2025

openshift-ci bot requested review from HeavyWombat and adambkaplan November 6, 2025 09:30

shipwright-ci-bot added this to Issues Nov 6, 2025

IrvingMg reviewed Mar 23, 2026

View reviewed changes

dollierp added 2 commits April 6, 2026 10:23

Warn if a symlink is pointing outside of the source tree

19b7371

Signed-off-by: Denis Ollier <dollierp@redhat.com>

Add unit tests for symlinks with local source upload

559611d

Signed-off-by: Denis Ollier <dollierp@redhat.com>

Copilot AI review requested due to automatic review settings April 6, 2026 13:28

dollierp force-pushed the symlinks branch from ec7519c to 668d3e3 Compare April 6, 2026 13:28

Copilot started reviewing on behalf of dollierp April 6, 2026 13:29 View session

Copilot AI reviewed Apr 6, 2026

View reviewed changes

pkg/shp/streamer/util.go Outdated Show resolved Hide resolved

dollierp requested a review from IrvingMg April 6, 2026 13:37

dollierp force-pushed the symlinks branch from 668d3e3 to 7b317ce Compare April 8, 2026 14:04

IrvingMg reviewed Apr 8, 2026

View reviewed changes

Send warning to ioStreams.ErrOut

1c914e6

Signed-off-by: Denis Ollier <dollierp@redhat.com>

dollierp force-pushed the symlinks branch from 7b317ce to 1c914e6 Compare April 9, 2026 18:04

pull-request-size bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 9, 2026

dollierp requested a review from Copilot April 9, 2026 18:06

Copilot started reviewing on behalf of dollierp April 9, 2026 18:07 View session

dollierp requested a review from IrvingMg April 9, 2026 19:03

IrvingMg reviewed Apr 10, 2026

View reviewed changes

	if !stat.Mode().IsRegular() && !(stat.Mode()&fs.ModeSymlink != 0) {
	if !stat.Mode().IsRegular() && stat.Mode()&fs.ModeSymlink == 0 {


		stdErr := errOut.String()

		t.Run("symlinks", func(_ *testing.T) {

		@@ -0,0 +1 @@
		../../test No newline at end of file

Conversation

dollierp commented Nov 6, 2025 • edited by SaschaSchwarze0 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Submitter Checklist

Release Notes

Uh oh!

openshift-ci bot commented Nov 6, 2025

Uh oh!

IrvingMg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dollierp commented Apr 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

IrvingMg commented Apr 8, 2026

Uh oh!

dollierp commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IrvingMg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dollierp commented Apr 9, 2026

Uh oh!

IrvingMg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dollierp commented Nov 6, 2025 •

edited by SaschaSchwarze0

Loading

dollierp commented Apr 8, 2026 •

edited

Loading