GaudiTesting.FixtureResult.FixtureResult Class Reference

Public Member Functions
	__init__ (self, subprocess.CompletedProcess completed_process, datetime start_time, datetime end_time, ProcessTimeoutError|ExceededStreamError|None run_exception, list[str] command, list[str] expanded_command, dict env, str cwd)
	elapsed_time (self)
dict	to_dict (self)

Static Public Member Functions
	format_value (value)

Public Attributes
	completed_process = completed_process
	start_time = start_time
	end_time = end_time
	run_exception = run_exception
	command = command
	expanded_command = expanded_command
	runtime_environment = env
	cwd = cwd

Detailed Description

A class to encapsulate the results of a subprocess execution in a test fixture.

Definition at line 29 of file FixtureResult.py.

Constructor & Destructor Documentation

__init__()

GaudiTesting.FixtureResult.FixtureResult.__init__	(		self,
		subprocess.CompletedProcess	completed_process,
		datetime	start_time,
		datetime	end_time,
		ProcessTimeoutError | ExceededStreamError | None	run_exception,
		list[str]	command,
		list[str]	expanded_command,
		dict	env,
		str	cwd )

Definition at line 34 of file FixtureResult.py.

    ):
        self.completed_process = completed_process
        self.start_time = start_time
        self.end_time = end_time
        self.run_exception = run_exception
        self.command = command
        self.expanded_command = expanded_command
        self.runtime_environment = env
        self.cwd = cwd
 

Member Function Documentation

elapsed_time()

GaudiTesting.FixtureResult.FixtureResult.elapsed_time

(

self

)

Definition at line 54 of file FixtureResult.py.

    def elapsed_time(self):
        return self.end_time - self.start_time
 

format_value()

GaudiTesting.FixtureResult.FixtureResult.format_value ( value )

static

Format a given value to a string representation.

Definition at line 58 of file FixtureResult.py.

    def format_value(value):
        """
        Format a given value to a string representation.
        """
        if isinstance(value, list):
            return repr(value)
        elif isinstance(value, dict):
            return "\n".join(f"{k}={v}" for k, v in value.items())
        return str(value or "")
 

to_dict()

dict GaudiTesting.FixtureResult.FixtureResult.to_dict

(

self

)

Convert the attributes of the FixtureResult into a dictionary.

Definition at line 68 of file FixtureResult.py.

    def to_dict(self) -> dict:
        """
        Convert the attributes of the FixtureResult into a dictionary.
        """
        properties = {attr: getattr(self, attr) for attr in vars(self)}
        properties.update(
            {
                "stdout": CodeWrapper(
                    self.completed_process.stdout.decode(
                        "utf-8", errors="backslashreplace"
                    ),
                    "console",
                )
                if self.completed_process.stdout
                else None,
                "stderr": CodeWrapper(
                    self.completed_process.stderr.decode(
                        "utf-8", errors="backslashreplace"
                    ),
                    "console",
                )
                if self.completed_process.stderr
                else None,
                "return_code": self.completed_process.returncode
                if self.completed_process.returncode
                else None,
                "elapsed_time": self.elapsed_time(),
                "stack_trace": self.run_exception.stack_trace
                if hasattr(self.run_exception, "stack_trace")
                else None,
                "stream_exceeded": self.run_exception.exceeded_stream
                if hasattr(self.run_exception, "exceeded_stream")
                else None,
            }
        )
        formatted_properties = {
            key: self.format_value(value) for key, value in properties.items()
        }
        return formatted_properties

Member Data Documentation

command

GaudiTesting.FixtureResult.FixtureResult.command = command

Definition at line 49 of file FixtureResult.py.

completed_process

GaudiTesting.FixtureResult.FixtureResult.completed_process = completed_process

Definition at line 45 of file FixtureResult.py.

cwd

GaudiTesting.FixtureResult.FixtureResult.cwd = cwd

Definition at line 52 of file FixtureResult.py.

end_time

GaudiTesting.FixtureResult.FixtureResult.end_time = end_time

Definition at line 47 of file FixtureResult.py.

expanded_command

GaudiTesting.FixtureResult.FixtureResult.expanded_command = expanded_command

Definition at line 50 of file FixtureResult.py.

run_exception

GaudiTesting.FixtureResult.FixtureResult.run_exception = run_exception

Definition at line 48 of file FixtureResult.py.

runtime_environment

GaudiTesting.FixtureResult.FixtureResult.runtime_environment = env

Definition at line 51 of file FixtureResult.py.

start_time

GaudiTesting.FixtureResult.FixtureResult.start_time = start_time

Definition at line 46 of file FixtureResult.py.

---

The documentation for this class was generated from the following file:

• GaudiPolicy/python/GaudiTesting/FixtureResult.py