mirror of
https://github.com/fluxcd/flux2.git
synced 2026-02-22 23:51:48 +00:00
46ad3b2e7a
When building OCI artifacts from directories containing symlinks (e.g., symlink trees created by Nix), the symlinked files are silently skipped because the underlying archive logic only handles regular files and directories. This results in empty or incomplete artifacts. This change adds a --resolve-symlinks flag to both 'flux build artifact' and 'flux push artifact' commands. When set, symlinks are resolved by copying their target contents into a temporary directory before building the artifact. This approach: - Preserves backward compatibility (default behavior unchanged) - Works with symlinks pointing outside the source directory - Handles symlinked files and directories - Cleans up the temporary directory after the build completes Fixes fluxcd/flux2#5055 Signed-off-by: rohansood10 <rohansood10@users.noreply.github.com>
115 lines
3.2 KiB
Go
115 lines
3.2 KiB
Go
/*
|
|
Copyright 2022 The Flux authors
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package main
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
. "github.com/onsi/gomega"
|
|
)
|
|
|
|
func Test_saveReaderToFile(t *testing.T) {
|
|
g := NewWithT(t)
|
|
|
|
testString := `apiVersion: v1
|
|
kind: ConfigMap
|
|
metadata:
|
|
name: myapp
|
|
data:
|
|
foo: bar`
|
|
|
|
tests := []struct {
|
|
name string
|
|
string string
|
|
expectErr bool
|
|
}{
|
|
{
|
|
name: "yaml",
|
|
string: testString,
|
|
},
|
|
{
|
|
name: "yaml with carriage return",
|
|
string: testString + "\r\n",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
tmpFile, err := saveReaderToFile(strings.NewReader(tt.string))
|
|
g.Expect(err).To(BeNil())
|
|
|
|
t.Cleanup(func() { _ = os.Remove(tmpFile) })
|
|
|
|
b, err := os.ReadFile(tmpFile)
|
|
if tt.expectErr {
|
|
g.Expect(err).To(Not(BeNil()))
|
|
return
|
|
}
|
|
|
|
g.Expect(err).To(BeNil())
|
|
g.Expect(string(b)).To(BeEquivalentTo(testString))
|
|
})
|
|
|
|
}
|
|
}
|
|
|
|
func Test_resolveSymlinks(t *testing.T) {
|
|
g := NewWithT(t)
|
|
|
|
// Create source directory with a real file
|
|
srcDir := t.TempDir()
|
|
realFile := filepath.Join(srcDir, "real.yaml")
|
|
g.Expect(os.WriteFile(realFile, []byte("apiVersion: v1\nkind: Namespace\nmetadata:\n name: test\n"), 0o644)).To(Succeed())
|
|
|
|
// Create a directory with symlinks pointing to files outside it
|
|
symlinkDir := t.TempDir()
|
|
symlinkFile := filepath.Join(symlinkDir, "linked.yaml")
|
|
g.Expect(os.Symlink(realFile, symlinkFile)).To(Succeed())
|
|
|
|
// Also add a regular file in the symlink dir
|
|
regularFile := filepath.Join(symlinkDir, "regular.yaml")
|
|
g.Expect(os.WriteFile(regularFile, []byte("apiVersion: v1\nkind: ConfigMap\n"), 0o644)).To(Succeed())
|
|
|
|
// Create a symlinked subdirectory
|
|
subDir := filepath.Join(srcDir, "subdir")
|
|
g.Expect(os.MkdirAll(subDir, 0o755)).To(Succeed())
|
|
g.Expect(os.WriteFile(filepath.Join(subDir, "nested.yaml"), []byte("nested"), 0o644)).To(Succeed())
|
|
g.Expect(os.Symlink(subDir, filepath.Join(symlinkDir, "linkeddir"))).To(Succeed())
|
|
|
|
// Resolve symlinks
|
|
resolved, err := resolveSymlinks(symlinkDir)
|
|
g.Expect(err).To(BeNil())
|
|
t.Cleanup(func() { os.RemoveAll(resolved) })
|
|
|
|
// Verify the regular file was copied
|
|
content, err := os.ReadFile(filepath.Join(resolved, "regular.yaml"))
|
|
g.Expect(err).To(BeNil())
|
|
g.Expect(string(content)).To(Equal("apiVersion: v1\nkind: ConfigMap\n"))
|
|
|
|
// Verify the symlinked file was resolved and copied
|
|
content, err = os.ReadFile(filepath.Join(resolved, "linked.yaml"))
|
|
g.Expect(err).To(BeNil())
|
|
g.Expect(string(content)).To(ContainSubstring("kind: Namespace"))
|
|
|
|
// Verify that the resolved file is a regular file, not a symlink
|
|
info, err := os.Lstat(filepath.Join(resolved, "linked.yaml"))
|
|
g.Expect(err).To(BeNil())
|
|
g.Expect(info.Mode().IsRegular()).To(BeTrue())
|
|
}
|