ghost: fix lstree

lstree returns should include the root path.

Author: aitjcize

overlord/ghost.go

@@ -572,7 +572,7 @@ func (ghost *Ghost) handleFstatRequest(req *Request) error {
 		result["is_dir"] = fileInfo.IsDir()
 		result["perm"] = fileInfo.Mode().Perm()
 		result["size"] = fileInfo.Size()
-		result["mod_time"] = fileInfo.ModTime().Unix()
+		result["mtime"] = fileInfo.ModTime().Unix()
 		isSymlink := (fileInfo.Mode() & os.ModeSymlink) != 0
 		result["is_symlink"] = isSymlink
 
@@ -1492,20 +1492,12 @@ func (ghost *Ghost) ListTree(path string) ([]map[string]interface{}, error) {
 			return err
 		}
 
-		relPath, err := filepath.Rel(path, filePath)
-		if err != nil {
-			return err
-		}
-		if relPath == "." {
-			return nil
-		}
 		isSymlink := (info.Mode() & os.ModeSymlink) != 0
 		entry := map[string]interface{}{
-			"name":       info.Name(),
 			"path":       filePath,
 			"size":       info.Size(),
 			"perm":       info.Mode().Perm(),
-			"mod_time":   info.ModTime().Unix(),
+			"mtime":      info.ModTime().Unix(),
 			"is_dir":     info.IsDir(),
 			"is_symlink": isSymlink,
 		}

py/ghost.py

@@ -847,6 +847,26 @@ def timeout_handler(x):
     self._last_ping = self.Timestamp()
     self.SendRequest('ping', {}, timeout_handler, _PING_TIMEOUT)
 
+  def _Fstat(self, path):
+    if not os.path.isabs(path):
+      raise RuntimeError(f"absolute path required: {path}")
+
+    entry = {'exists': os.path.exists(path)}
+    if entry['exists']:
+      stat_info = os.lstat(path)
+      entry['path'] = path
+      entry['perm'] = stat_info.st_mode
+      entry['size'] = stat_info.st_size
+      entry['mtime'] = int(stat_info.st_mtime)
+      entry['is_dir'] = os.path.isdir(path)
+      entry['is_symlink'] = stat.S_ISLNK(stat_info.st_mode)
+
+      if entry['is_symlink']:
+        entry['link_target'] = os.readlink(path)
+        entry['is_dir'] = False
+
+    return entry
+
   def HandleListTreeRequest(self, msg):
     """Handle a request to list directory contents recursively."""
     payload = msg['payload']
@@ -862,46 +882,20 @@ def HandleListTreeRequest(self, msg):
         raise RuntimeError(f"No such file or directory: {path}")
 
       entries = []
+      entries.append(self._Fstat(path))
       for root, dirs, files in os.walk(path):
         for file in files:
           file_path = os.path.join(root, file)
           try:
-            file_stat = os.lstat(file_path)
-            entry = {
-              'name': file,
-              'path': file_path,
-              'size': file_stat.st_size,
-              'perm': file_stat.st_mode,
-              'mtime': int(file_stat.st_mtime),
-              'is_dir': False,
-              'is_symlink': stat.S_ISLNK(file_stat.st_mode),
-            }
-            if entry['is_symlink']:
-              entry['link_target'] = os.readlink(file_path)
-
-            entries.append(entry)
+            entries.append(self._Fstat(file_path))
           except OSError as e:
             logging.exception(e)
             pass
 
         for dir in dirs:
           dir_path = os.path.join(root, dir)
           try:
-            dir_stat = os.lstat(dir_path)
-            entry = {
-              'name': dir,
-              'path': dir_path,
-              'size': dir_stat.st_size,
-              'perm': dir_stat.st_mode,
-              'mtime': int(dir_stat.st_mtime),
-              'is_dir': True,
-              'is_symlink': stat.S_ISLNK(dir_stat.st_mode),
-            }
-            if entry['is_symlink']:
-              entry['is_dir'] = False
-              entry['link_target'] = os.readlink(dir_path)
-
-            entries.append(entry)
+            entries.append(self._Fstat(dir_path))
           except OSError:
             pass
 
@@ -924,21 +918,7 @@ def HandleFstatRequest(self, msg):
     path = os.path.expanduser(path)
 
     try:
-      result = {'exists': os.path.exists(path)}
-
-      if result['exists']:
-        stat_info = os.stat(path)
-        result['is_dir'] = os.path.isdir(path)
-        result['perm'] = stat_info.st_mode
-        result['size'] = stat_info.st_size
-        result['mod_time'] = int(stat_info.st_mtime)
-        result['is_symlink'] = stat.S_ISLNK(stat_info.st_mode)
-
-        if result['is_symlink']:
-          result['link_target'] = os.readlink(path)
-          result['iis_dir'] = False
-
-      self.SendResponse(msg, SUCCESS, result)
+      self.SendResponse(msg, SUCCESS, self._Fstat(path))
     except Exception as e:
       self.SendErrorResponse(msg, str(e))
 

py/ovl.py

@@ -42,6 +42,7 @@
 _CERT_DIR = os.path.expanduser('~/.config/ovl')
 
 _DEBUG = False
+_DEBUG_NO_KILL = True
 _ESCAPE = '~'
 _BUFSIZ = 8192
 _DEFAULT_HTTPS_PORT = 443
@@ -746,6 +747,29 @@ def ParseMethodSubCommands(cls):
   return cls
 
 
+class FileEntry:
+  """Class to represent a file entry with its metadata."""
+
+  def __init__(self, path, perm=0o644, is_symlink=False, link_target='', is_dir=False):
+    self.path = path
+    self.perm = perm
+    self.is_symlink = is_symlink
+    self.link_target = link_target
+    self.is_dir = is_dir
+
+  def __repr__(self):
+    return f"{self.ftype} {self.path} {oct(self.perm)[2:]} {self.link_target}"
+
+  @property
+  def name(self):
+    return os.path.basename(self.path.rstrip('/'))
+
+  @property
+  def ftype(self):
+    if self.is_dir:
+      return 'd'
+    return 'l' if self.is_symlink else 'f'
+
 @ParseMethodSubCommands
 class OverlordCliClient:
   """Overlord command line interface client."""
@@ -912,7 +936,7 @@ def CheckDaemon(self):
     self._state = DaemonState.FromDict(self._server.State())
     sha1sum = GetVersionDigest()
 
-    if sha1sum != self._state.version_sha1sum:
+    if sha1sum != self._state.version_sha1sum and not _DEBUG_NO_KILL:
       print('ovl server is out of date.  killing...')
       KillGraceful(self._server.GetPid())
       self.StartServer()
@@ -1125,27 +1149,6 @@ def KillSSHTunnel(self):
     if self._state.ssh_pid is not None:
       KillGraceful(self._state.ssh_pid)
 
-  # FileEntry class to represent file entries
-  class FileEntry:
-    """Class to represent a file entry with its metadata."""
-
-    def __init__(self, path, perm=0o644, is_symlink=False, link_target='', is_dir=False):
-      self.path = path
-      self.perm = perm
-      self.is_symlink = is_symlink
-      self.link_target = link_target
-      self.is_dir = is_dir
-
-    @property
-    def name(self):
-      return os.path.basename(self.path.rstrip('/'))
-
-    @property
-    def ftype(self):
-      if self.is_dir:
-        return 'd'
-      return 'l' if self.is_symlink else 'f'
-
   def _SizeToHuman(self, size_in_bytes):
     """Convert size in bytes to human readable format.
 
@@ -1318,7 +1321,7 @@ def _LsTree(self, path):
         is_symlink = entry.get('is_symlink', False)
         link_target = entry.get('link_target', '')
 
-        entries.append(self.FileEntry(
+        entries.append(FileEntry(
             path=file_path,
             perm=perm,
             is_symlink=is_symlink,
@@ -1710,7 +1713,7 @@ def _LocalLsTree(self, path):
       is_symlink = os.path.islink(path)
       link_target = os.readlink(path) if is_symlink else ''
 
-      return [self.FileEntry(
+      return [FileEntry(
           path=path,
           perm=perm,
           is_symlink=is_symlink,
@@ -1728,7 +1731,7 @@ def _LocalLsTree(self, path):
         is_symlink = os.path.islink(dir_path)
         link_target = os.readlink(dir_path) if is_symlink else ''
 
-        results.append(self.FileEntry(
+        results.append(FileEntry(
             path=dir_path,
             perm=perm,
             is_symlink=is_symlink,
@@ -1744,7 +1747,7 @@ def _LocalLsTree(self, path):
         is_symlink = os.path.islink(file_path)
         link_target = os.readlink(file_path) if is_symlink else ''
 
-        results.append(self.FileEntry(
+        results.append(FileEntry(
             path=file_path,
             perm=perm,
             is_symlink=is_symlink,

py/ovl_unittest.py

@@ -9,7 +9,7 @@
 # Add scripts directory to Python path
 sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
 
-from ovl import OverlordCliClient
+from ovl import OverlordCliClient, FileEntry
 
 
 class FileSystemTestCase(unittest.TestCase):
@@ -60,15 +60,15 @@ def _build_file_entries(self, base_path, structure, path_prefix=""):
             abs_path = os.path.join(base_path, full_path)
 
             if info["is_dir"]:
-                entries.append(self.cli.FileEntry(path=abs_path, is_dir=True))
+                entries.append(FileEntry(path=abs_path, is_dir=True))
                 if "children" in info:
                     entries.extend(
                         self._build_file_entries(
                             base_path, info["children"], full_path
                         )
                     )
             else:
-                entries.append(self.cli.FileEntry(path=abs_path, is_dir=False))
+                entries.append(FileEntry(path=abs_path, is_dir=False))
 
         return entries
 
@@ -124,28 +124,31 @@ def Fstat(self, path):
             if self.remote_exists and self.remote_is_dir:
                 return {
                     "exists": True,
+                    "path": path,
                     "is_dir": True,
                     "mode": 0o755,
                     "size": 4096,
-                    "modTime": "2023-01-01T00:00:00Z",
+                    "mtime": "2023-01-01T00:00:00Z",
                 }
             elif self.remote_exists and not self.remote_is_dir:
                 return {
                     "exists": True,
+                    "path": path,
                     "is_dir": False,
                     "mode": 0o644,
                     "size": 1024,
-                    "modTime": "2023-01-01T00:00:00Z",
+                    "mtime": "2023-01-01T00:00:00Z",
                 }
             else:
                 return {"exists": False}
         elif path == os.path.join(self.user_home, "single_file"):
             return {
                 "exists": True,
+                "path": path,
                 "is_dir": False,
                 "mode": 0o644,
                 "size": 1024,
-                "modTime": "2023-01-01T00:00:00Z",
+                "mtime": "2023-01-01T00:00:00Z",
             }
         return {"exists": False}
 
@@ -443,42 +446,36 @@ def LsTree(self, path):
             path = os.path.join(self.remote_root, path)
 
         if path == os.path.join(self.remote_root, "single_file"):
-            return [self.cli.FileEntry(path=path, is_dir=False)]
+            return [FileEntry(path=path, is_dir=False)]
         elif path == os.path.join(self.remote_root, "some_dir"):
             # Create a list to hold all entries
             entries = []
 
-            # Add the root directory entry
-            entries.append(self.cli.FileEntry(path=path, is_dir=True))
+            entries.append(FileEntry(path=path, is_dir=True))
 
-            # Add entry for a/b file
             entries.append(
-                self.cli.FileEntry(
+                FileEntry(
                     path=os.path.join(path, "a/b"), is_dir=False
                 )
             )
 
-            # Add entry for a directory
             entries.append(
-                self.cli.FileEntry(
+                FileEntry(
                     path=os.path.join(path, "a"), is_dir=True
                 )
             )
 
-            # Add entry for a/c directory
             entries.append(
-                self.cli.FileEntry(
+                FileEntry(
                     path=os.path.join(path, "a/c"), is_dir=True
                 )
             )
 
-            # Add entry for a/c/d file
             entries.append(
-                self.cli.FileEntry(
+                FileEntry(
                     path=os.path.join(path, "a/c/d"), is_dir=False
                 )
             )
-
             return entries
         else:
             raise RuntimeError("ls: No such file or directory")