✨ [filesystem] Added LsRecursive in filesystem to browse file sys…

…tem trees (#497)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->
### Description

- Introduced a way to perform recursive `ls`

### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [x]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

---------

Co-authored-by: Adrien CABARBAYE <[email protected]>

changes/20240828133012.feature

@@ -0,0 +1 @@
+✨  `[filesystem]` Added `LsRecursive` to browse file system trees and list their content

utils/filesystem/files.go

@@ -200,7 +200,6 @@ func (fs *VFS) walk(ctx context.Context, path string, info os.FileInfo, exclusio
 		}
 	}
 	return nil
-
 }
 
 func (fs *VFS) GetType() FilesystemType {
@@ -1129,6 +1128,53 @@ func (fs *VFS) LsWithExclusionPatterns(dir string, exclusionPatterns ...string)
 	return
 }
 
+func (fs *VFS) LsRecursive(ctx context.Context, dir string, includeDirectories bool) (files []string, err error) {
+	return fs.LsRecursiveWithExtensionPatternsAndLimits(ctx, dir, NoLimits(), includeDirectories)
+}
+
+func (fs *VFS) LsRecursiveWithExtensionPatterns(ctx context.Context, dir string, includeDirectories bool, exclusionPatterns ...string) (files []string, err error) {
+	return fs.LsRecursiveWithExtensionPatternsAndLimits(ctx, dir, NoLimits(), includeDirectories, exclusionPatterns...)
+}
+
+func (fs *VFS) LsRecursiveWithExtensionPatternsAndLimits(ctx context.Context, dir string, limits ILimits, includeDirectories bool, exclusionPatterns ...string) (files []string, err error) {
+	err = parallelisation.DetermineContextError(ctx)
+	if err != nil {
+		return
+	}
+	if limits == nil {
+		err = fmt.Errorf("%w: missing file system limits", commonerrors.ErrUndefined)
+		return
+	}
+
+	fn := func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+
+		currentDepth, err := FileTreeDepth(fs, dir, path)
+		if err != nil {
+			return err
+		}
+
+		if limits.Apply() && currentDepth >= limits.GetMaxDepth() {
+			return filepath.SkipDir
+		}
+
+		if limits.Apply() && int64(len(files)) >= limits.GetMaxFileCount() {
+			return fmt.Errorf("number of files exceeds the limit of %d: %w", limits.GetMaxFileCount(), commonerrors.ErrTooLarge)
+		}
+
+		if includeDirectories || !info.IsDir() {
+			files = append(files, path)
+		}
+
+		return nil
+	}
+
+	err = fs.WalkWithContextAndExclusionPatterns(ctx, dir, fn, exclusionPatterns...)
+	return
+}
+
 func LsWithExclusionPatterns(fs FS, dir string, regexes []*regexp.Regexp) (names []string, err error) {
 	if isDir, subErr := fs.IsDir(dir); !isDir || subErr != nil {
 		err = fmt.Errorf("path [%v] is not a directory: %w", dir, commonerrors.ErrInvalid)
@@ -1146,7 +1192,6 @@ func LsWithExclusionPatterns(fs FS, dir string, regexes []*regexp.Regexp) (names
 	}
 	names, err = ExcludeFiles(AllNames, regexes)
 	return
-
 }
 
 func (fs *VFS) LsFromOpenedDirectory(dir File) ([]string, error) {
@@ -1160,6 +1205,22 @@ func (fs *VFS) LsFromOpenedDirectory(dir File) ([]string, error) {
 	return dir.Readdirnames(-1)
 }
 
+func (fs *VFS) LsRecursiveFromOpenedDirectory(ctx context.Context, dir File, includeDirectories bool) (files []string, err error) {
+	err = parallelisation.DetermineContextError(ctx)
+	if err != nil {
+		return
+	}
+	if dir == nil {
+		return nil, fmt.Errorf("%w: supplied directory was undefined", commonerrors.ErrUndefined)
+	}
+	err = fs.checkWhetherUnderlyingResourceIsClosed()
+	if err != nil {
+		return nil, fmt.Errorf("%w: underlying resource is closed", commonerrors.ErrUndefined)
+	}
+
+	return fs.LsRecursive(ctx, dir.Name(), includeDirectories)
+}
+
 func (fs *VFS) Lls(dir string) (files []os.FileInfo, err error) {
 	err = fs.checkWhetherUnderlyingResourceIsClosed()
 	if err != nil {