Adds the Lsdir API to the Filesystem V1 API Group

Author: mauriciopoppe

client/api/filesystem/v1/api.pb.go

@@ -15,6 +15,9 @@ service Filesystem {
     // This may be used for unlinking a symlink created through CreateSymlink.
     rpc Rmdir(RmdirRequest) returns (RmdirResponse) {}
 
+    // Lsdir lists files in a directory
+    rpc Lsdir(LsdirRequest) returns (LsdirResponse) {}
+
     // CreateSymlink creates a symbolic link called target_path that points to source_path
     // in the host filesystem (target_path is the name of the symbolic link created,
     // source_path is the existing path).
@@ -86,6 +89,16 @@ message RmdirResponse {
     // Intentionally empty.
 }
 
+message LsdirRequest {
+    // The path to list files from.
+    string path = 1;
+}
+
+message LsdirResponse {
+    // The paths under that directory.
+    repeated string files = 1;
+}
+
 message CreateSymlinkRequest {
     // The path of the existing directory to be linked.
     // All special characters allowed by Windows in path names will be allowed

client/api/filesystem/v1/api.proto

@@ -18,6 +18,7 @@ type API interface {
 	PathValid(path string) (bool, error)
 	Mkdir(path string) error
 	Rmdir(path string, force bool) error
+	Lsdir(path string) ([]string, error)
 	CreateSymlink(oldname string, newname string) error
 	IsSymlink(path string) (bool, error)
 }
@@ -78,6 +79,21 @@ func (filesystemAPI) Rmdir(path string, force bool) error {
 	return os.Remove(path)
 }
 
+// Lsdir lists files under a directory
+func (filesystemAPI) Lsdir(path string) ([]string, error) {
+	dir, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer dir.Close()
+
+	names, err := dir.Readdirnames(-1)
+	if err != nil {
+		return nil, err
+	}
+	return names, nil
+}
+
 // CreateSymlink creates newname as a symbolic link to oldname.
 func (filesystemAPI) CreateSymlink(oldname, newname string) error {
 	return os.Symlink(oldname, newname)

client/groups/filesystem/v1/client_generated.go

@@ -61,6 +61,16 @@ type RmdirRequest struct {
 type RmdirResponse struct {
 }
 
+type LsdirRequest struct {
+	// The directory to list files from.
+	Path string
+}
+
+type LsdirResponse struct {
+	// The files under the directory.
+	Files []string
+}
+
 type CreateSymlinkRequest struct {
 	// The path of the existing directory to be linked.
 	// All special characters allowed by Windows in path names will be allowed

pkg/os/filesystem/api.go

@@ -167,6 +167,17 @@ func (s *Server) LinkPath(ctx context.Context, request *internal.LinkPathRequest
 	return &internal.LinkPathResponse{}, nil
 }
 
+func (s *Server) Lsdir(ctx context.Context, request *internal.LsdirRequest, version apiversion.Version) (*internal.LsdirResponse, error) {
+	klog.V(2).Infof("Request: Lsdir with path=%q", request.Path)
+	err := s.validatePathWindows(request.Path)
+	if err != nil {
+		klog.Errorf("failed validatePathWindows for path=%q, err=%v", request.Path, err)
+		return nil, err
+	}
+	names, err := s.hostAPI.Lsdir(request.Path)
+	return &internal.LsdirResponse{Files: names}, nil
+}
+
 func (s *Server) CreateSymlink(ctx context.Context, request *internal.CreateSymlinkRequest, version apiversion.Version) (*internal.CreateSymlinkResponse, error) {
 	klog.V(2).Infof("Request: CreateSymlink with targetPath=%q sourcePath=%q", request.TargetPath, request.SourcePath)
 	err := s.validatePathWindows(request.TargetPath)

pkg/server/filesystem/impl/types.go

@@ -25,6 +25,9 @@ func (fakeFileSystemAPI) Mkdir(path string) error {
 func (fakeFileSystemAPI) Rmdir(path string, force bool) error {
 	return nil
 }
+func (fakeFileSystemAPI) Lsdir(path string) ([]string, error) {
+	return nil, nil
+}
 func (fakeFileSystemAPI) CreateSymlink(tgt string, src string) error {
 	return nil
 }

pkg/server/filesystem/impl/types_generated.go

@@ -47,6 +47,9 @@ func (fakeFileSystemAPI) Mkdir(path string) error {
 func (fakeFileSystemAPI) Rmdir(path string, force bool) error {
 	return nil
 }
+func (fakeFileSystemAPI) Lsdir(path string) ([]string, error) {
+	return nil, nil
+}
 func (fakeFileSystemAPI) CreateSymlink(tgt string, src string) error {
 	return nil
 }