-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: add composite fs for post-analyzers (#4556)
- Loading branch information
Showing
5 changed files
with
136 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| package analyzer | ||
|
|
||
| import ( | ||
| "errors" | ||
| "io" | ||
| "io/fs" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
|
|
||
| "golang.org/x/xerrors" | ||
|
|
||
| "github.com/aquasecurity/trivy/pkg/mapfs" | ||
| "github.com/aquasecurity/trivy/pkg/syncx" | ||
| ) | ||
|
|
||
| // CompositeFS contains multiple filesystems for post-analyzers | ||
| type CompositeFS struct { | ||
| group AnalyzerGroup | ||
| dir string | ||
| files *syncx.Map[Type, *mapfs.FS] | ||
| } | ||
|
|
||
| func NewCompositeFS(group AnalyzerGroup) (*CompositeFS, error) { | ||
| tmpDir, err := os.MkdirTemp("", "analyzer-fs-*") | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("unable to create temporary directory: %w", err) | ||
| } | ||
|
|
||
| return &CompositeFS{ | ||
| group: group, | ||
| dir: tmpDir, | ||
| files: new(syncx.Map[Type, *mapfs.FS]), | ||
| }, nil | ||
| } | ||
|
|
||
| // CopyFileToTemp takes a file path and information, opens the file, copies its contents to a temporary file | ||
| func (c *CompositeFS) CopyFileToTemp(opener Opener, info os.FileInfo) (string, error) { | ||
| // Create a temporary file to which the file in the layer will be copied | ||
| // so that all the files will not be loaded into memory | ||
| f, err := os.CreateTemp(c.dir, "file-*") | ||
| if err != nil { | ||
| return "", xerrors.Errorf("create temp error: %w", err) | ||
| } | ||
| defer f.Close() | ||
|
|
||
| // Open a file in the layer | ||
| r, err := opener() | ||
| if err != nil { | ||
| return "", xerrors.Errorf("file open error: %w", err) | ||
| } | ||
| defer r.Close() | ||
|
|
||
| // Copy file content into the temporary file | ||
| if _, err = io.Copy(f, r); err != nil { | ||
| return "", xerrors.Errorf("copy error: %w", err) | ||
| } | ||
|
|
||
| if err = os.Chmod(f.Name(), info.Mode()); err != nil { | ||
| return "", xerrors.Errorf("chmod error: %w", err) | ||
| } | ||
|
|
||
| return f.Name(), nil | ||
| } | ||
|
|
||
| // CreateLink creates a link in the virtual filesystem that corresponds to a real file. | ||
| // The linked virtual file will have the same path as the real file path provided. | ||
| func (c *CompositeFS) CreateLink(analyzerTypes []Type, virtualPath, realPath string, setRoot bool) error { | ||
| // Create fs.FS for each post-analyzer that wants to analyze the current file | ||
| for _, t := range analyzerTypes { | ||
| // Since filesystem scanning may require access outside the specified path, (e.g. Terraform modules) | ||
| // it allows "../" access with "WithUnderlyingRoot". | ||
| var opts []mapfs.Option | ||
| if setRoot { | ||
| opts = append(opts, mapfs.WithUnderlyingRoot(filepath.Dir(realPath))) | ||
| } | ||
| mfs, _ := c.files.LoadOrStore(t, mapfs.New(opts...)) | ||
| if d := path.Dir(virtualPath); d != "." { | ||
| if err := mfs.MkdirAll(d, os.ModePerm); err != nil && !errors.Is(err, fs.ErrExist) { | ||
| return xerrors.Errorf("mapfs mkdir error: %w", err) | ||
| } | ||
| } | ||
| if err := mfs.WriteFile(virtualPath, realPath); err != nil { | ||
| return xerrors.Errorf("mapfs write error: %w", err) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Set sets the fs.FS for the specified post-analyzer | ||
| func (c *CompositeFS) Set(t Type, fs *mapfs.FS) { | ||
| c.files.Store(t, fs) | ||
| } | ||
|
|
||
| // Get returns the fs.FS for the specified post-analyzer | ||
| func (c *CompositeFS) Get(t Type) (*mapfs.FS, bool) { | ||
| return c.files.Load(t) | ||
| } | ||
|
|
||
| // Cleanup removes the temporary directory | ||
| func (c *CompositeFS) Cleanup() error { | ||
| return os.RemoveAll(c.dir) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters