From: Tomáš Ďurovec <tomas.duro...@pantheon.tech>
The OSSession (and its subclasses) should accept PurePaths
for remote paths to translate from OS-unaware (PurePath)
to OS-aware (Path) only on the remote side. For local paths,
they should accept Paths, as Python is OS-aware locally.
Signed-off-by: Tomáš Ďurovec <tomas.duro...@pantheon.tech>
Signed-off-by: Luca Vizzarro <luca.vizza...@arm.com>
---
.../remote_session/remote_session.py | 24 ++++++----------
dts/framework/remote_session/ssh_session.py | 18 ++++--------
dts/framework/testbed_model/os_session.py | 28 ++++++++-----------
dts/framework/testbed_model/posix_session.py | 18 ++++--------
4 files changed, 30 insertions(+), 58 deletions(-)
diff --git a/dts/framework/remote_session/remote_session.py
b/dts/framework/remote_session/remote_session.py
index 8c580b070f..ab83f5b266 100644
--- a/dts/framework/remote_session/remote_session.py
+++ b/dts/framework/remote_session/remote_session.py
@@ -12,7 +12,7 @@
from abc import ABC, abstractmethod
from dataclasses import InitVar, dataclass, field
-from pathlib import PurePath
+from pathlib import Path, PurePath
from framework.config import NodeConfiguration
from framework.exception import RemoteCommandExecutionError
@@ -196,35 +196,29 @@ def is_alive(self) -> bool:
"""Check whether the remote session is still responding."""
@abstractmethod
- def copy_from(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_from(self, source_file: str | PurePath, destination_dir: str |
Path) -> None:
"""Copy a file from the remote Node to the local filesystem.
Copy `source_file` from the remote Node associated with this remote
session
- to `destination_file` on the local filesystem.
+ to `destination_dir` on the local filesystem.
Args:
source_file: The file on the remote Node.
- destination_file: A file or directory path on the local filesystem.
+ destination_dir: The directory path on the local filesystem where
the `source_file`
+ will be saved.
"""
@abstractmethod
- def copy_to(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_to(self, source_file: str | Path, destination_dir: str |
PurePath) -> None:
"""Copy a file from local filesystem to the remote Node.
- Copy `source_file` from local filesystem to `destination_file` on the
remote Node
+ Copy `source_file` from local filesystem to `destination_dir` on the
remote Node
associated with this remote session.
Args:
source_file: The file on the local filesystem.
- destination_file: A file or directory path on the remote Node.
+ destination_dir: The directory path on the remote Node where the
`source_file`
+ will be saved.
"""
@abstractmethod
diff --git a/dts/framework/remote_session/ssh_session.py
b/dts/framework/remote_session/ssh_session.py
index 66f8176833..329121913f 100644
--- a/dts/framework/remote_session/ssh_session.py
+++ b/dts/framework/remote_session/ssh_session.py
@@ -5,7 +5,7 @@
import socket
import traceback
-from pathlib import PurePath
+from pathlib import Path, PurePath
from fabric import Connection # type: ignore[import-untyped]
from invoke.exceptions import ( # type: ignore[import-untyped]
@@ -103,21 +103,13 @@ def is_alive(self) -> bool:
"""Overrides :meth:`~.remote_session.RemoteSession.is_alive`."""
return self.session.is_connected
- def copy_from(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_from(self, source_file: str | PurePath, destination_dir: str |
Path) -> None:
"""Overrides :meth:`~.remote_session.RemoteSession.copy_from`."""
- self.session.get(str(destination_file), str(source_file))
+ self.session.get(str(source_file), str(destination_dir))
- def copy_to(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_to(self, source_file: str | Path, destination_dir: str |
PurePath) -> None:
"""Overrides :meth:`~.remote_session.RemoteSession.copy_to`."""
- self.session.put(str(source_file), str(destination_file))
+ self.session.put(str(source_file), str(destination_dir))
def close(self) -> None:
"""Overrides :meth:`~.remote_session.RemoteSession.close`."""
diff --git a/dts/framework/testbed_model/os_session.py
b/dts/framework/testbed_model/os_session.py
index 79f56b289b..1aac3659bf 100644
--- a/dts/framework/testbed_model/os_session.py
+++ b/dts/framework/testbed_model/os_session.py
@@ -25,7 +25,7 @@
from abc import ABC, abstractmethod
from collections.abc import Iterable
from ipaddress import IPv4Interface, IPv6Interface
-from pathlib import PurePath
+from pathlib import Path, PurePath
from typing import Union
from framework.config import Architecture, NodeConfiguration, NodeInfo
@@ -178,35 +178,29 @@ def join_remote_path(self, *args: str | PurePath) ->
PurePath:
"""
@abstractmethod
- def copy_from(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_from(self, source_file: str | PurePath, destination_dir: str |
Path) -> None:
"""Copy a file from the remote node to the local filesystem.
Copy `source_file` from the remote node associated with this remote
- session to `destination_file` on the local filesystem.
+ session to `destination_dir` on the local filesystem.
Args:
- source_file: the file on the remote node.
- destination_file: a file or directory path on the local filesystem.
+ source_file: The file on the remote node.
+ destination_dir: The directory path on the local filesystem where
the `source_file`
+ will be saved.
"""
@abstractmethod
- def copy_to(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_to(self, source_file: str | Path, destination_dir: str |
PurePath) -> None:
"""Copy a file from local filesystem to the remote node.
- Copy `source_file` from local filesystem to `destination_file`
+ Copy `source_file` from local filesystem to `destination_dir`
on the remote node associated with this remote session.
Args:
- source_file: the file on the local filesystem.
- destination_file: a file or directory path on the remote node.
+ source_file: The file on the local filesystem.
+ destination_dir: The directory path on the remote Node where the
`source_file`
+ will be saved.
"""
@abstractmethod
diff --git a/dts/framework/testbed_model/posix_session.py
b/dts/framework/testbed_model/posix_session.py
index d279bb8b53..2449c0ab35 100644
--- a/dts/framework/testbed_model/posix_session.py
+++ b/dts/framework/testbed_model/posix_session.py
@@ -13,7 +13,7 @@
import re
from collections.abc import Iterable
-from pathlib import PurePath, PurePosixPath
+from pathlib import Path, PurePath, PurePosixPath
from framework.config import Architecture, NodeInfo
from framework.exception import DPDKBuildError, RemoteCommandExecutionError
@@ -85,21 +85,13 @@ def join_remote_path(self, *args: str | PurePath) ->
PurePosixPath:
"""Overrides :meth:`~.os_session.OSSession.join_remote_path`."""
return PurePosixPath(*args)
- def copy_from(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_from(self, source_file: str | PurePath, destination_dir: str |
Path) -> None:
"""Overrides :meth:`~.os_session.OSSession.copy_from`."""
- self.remote_session.copy_from(source_file, destination_file)
+ self.remote_session.copy_from(source_file, destination_dir)
- def copy_to(
- self,
- source_file: str | PurePath,
- destination_file: str | PurePath,
- ) -> None:
+ def copy_to(self, source_file: str | Path, destination_dir: str |
PurePath) -> None:
"""Overrides :meth:`~.os_session.OSSession.copy_to`."""
- self.remote_session.copy_to(source_file, destination_file)
+ self.remote_session.copy_to(source_file, destination_dir)
def remove_remote_dir(
self,
--
2.43.0
