Make CommandResult a dataclass (#722)

Author: amaslenn

testinfra/backend/ansible.py

@@ -58,11 +58,9 @@ def run(self, command: str, *args: str, **kwargs: Any) -> base.CommandResult:
 out=self.run_ansible("shell", module_args=command, check=False)
 returnself.result(
 out["rc"],
-command,
-stdout_bytes=None,
-stderr_bytes=None,
-stdout=out["stdout"],
-stderr=out["stderr"],
+self.encode(command),
+out["stdout"],
+out["stderr"],
  )
 
 defrun_ansible(

testinfra/backend/base.py

@@ -17,7 +17,7 @@
 importshlex
 importsubprocess
 importurllib.parse
-fromtypingimportTYPE_CHECKING, Any, Optional
+fromtypingimportTYPE_CHECKING, Any, Optional, Union
 
 ifTYPE_CHECKING:
 importtestinfra.host
@@ -33,6 +33,7 @@ class HostSpec:
 password: Optional[str]
 
 
+@dataclasses.dataclass
 classCommandResult:
 """Object that encapsulates all returned details of the command execution.
 
@@ -51,24 +52,11 @@ class CommandResult:
  False
  """
 
-def__init__(
-self,
-backend: "BaseBackend",
-exit_status: int,
-command: bytes,
-stdout_bytes: bytes,
-stderr_bytes: bytes,
-stdout: Optional[str] =None,
-stderr: Optional[str] =None,
- ):
-self.exit_status=exit_status
-self._stdout_bytes=stdout_bytes
-self._stderr_bytes=stderr_bytes
-self._stdout=stdout
-self._stderr=stderr
-self.command=command
-self._backend=backend
-super().__init__()
+backend: "BaseBackend"
+exit_status: int
+command: bytes
+_stdout: Union[str, bytes]
+_stderr: Union[str, bytes]
 
 @property
 defsucceeded(self) ->bool:
@@ -104,8 +92,8 @@ def stdout(self) -> str:
  >>> host.run("mkdir -v new_directory").stdout
  mkdir: created directory 'new_directory'
  """
-ifself._stdoutisNone:
-self._stdout=self._backend.decode(self._stdout_bytes)
+ifisinstance(self._stdout, bytes):
+returnself.backend.decode(self._stdout)
 returnself._stdout
 
 @property
@@ -115,8 +103,8 @@ def stderr(self) -> str:
  >>> host.run("mkdir new_directory").stderr
  mkdir: cannot create directory 'new_directory': File exists
  """
-ifself._stderrisNone:
-self._stderr=self._backend.decode(self._stderr_bytes)
+ifisinstance(self._stderr, bytes):
+returnself.backend.decode(self._stderr)
 returnself._stderr
 
 @property
@@ -126,9 +114,9 @@ def stdout_bytes(self) -> bytes:
  >>> host.run("mkdir -v new_directory").stdout_bytes
  b"mkdir: created directory 'new_directory'"
  """
-ifself._stdout_bytesisNone:
-self._stdout_bytes=self._backend.encode(self._stdout)
-returnself._stdout_bytes
+ifisinstance(self._stdout, str):
+returnself.backend.encode(self._stdout)
+returnself._stdout
 
 @property
 defstderr_bytes(self) ->bytes:
@@ -137,19 +125,9 @@ def stderr_bytes(self) -> bytes:
  >>> host.run("mkdir new_directory").stderr_bytes
  b"mkdir: cannot create directory 'new_directory': File exists"
  """
-ifself._stderr_bytesisNone:
-self._stderr_bytes=self._backend.encode(self._stderr)
-returnself._stderr_bytes
-
-def__repr__(self) ->str:
-return (
-"CommandResult(command={!r}, exit_status={}, stdout={!r}, ""stderr={!r})"
- ).format(
-self.command,
-self.exit_status,
-self._stdout_bytesorself._stdout,
-self._stderr_bytesorself._stderr,
- )
+ifisinstance(self._stderr, str):
+returnself.backend.encode(self._stderr)
+returnself._stderr
 
 
 classBaseBackend(metaclass=abc.ABCMeta):
@@ -337,7 +315,15 @@ def encode(self, data: str) -> bytes:
 exceptUnicodeEncodeError:
 returndata.encode(self.encoding)
 
-defresult(self, *args: Any, **kwargs: Any) ->CommandResult:
-result=CommandResult(self, *args, **kwargs)
+defresult(
+self, rc: int, cmd: bytes, stdout: Union[str, bytes], stderr: Union[str, bytes]
+ ) ->CommandResult:
+result=CommandResult(
+backend=self,
+exit_status=rc,
+command=cmd,
+_stdout=stdout,
+_stderr=stderr,
+ )
 logger.debug("RUN %s", result)
 returnresult

testinfra/backend/salt.py

@@ -40,9 +40,7 @@ def run(self, command: str, *args: str, **kwargs: Any) -> base.CommandResult:
 out=self.run_salt("cmd.run_all", [command])
 returnself.result(
 out["retcode"],
-command,
-out["stdout"].encode("utf8"),
-out["stderr"].encode("utf8"),
+self.encode(command),
 stdout=out["stdout"],
 stderr=out["stderr"],
  )

testinfra/backend/winrm.py

@@ -88,7 +88,7 @@ def run_winrm(self, command: str, *args: str) -> base.CommandResult:
 stdout, stderr, rc=p.get_command_output(shell_id, command_id)
 p.cleanup_command(shell_id, command_id)
 p.close_shell(shell_id)
-returnself.result(rc, command, stdout, stderr)
+returnself.result(rc, self.encode(command), stdout, stderr)
 
 @staticmethod
 defquote(command: str, *args: str) ->str: