Package dev.galasa.framework.spi

Interface IRunResult

public interface IRunResult

Method Summary

Modifier and Type	Method	Description
void	discard()
Path	getArtifactsRoot()
String	getLog()
default long	getLogSize()	Get the size of the run log in bytes without loading it into memory.
String	getRunId()
TestStructure	getTestStructure()
void	loadArtifact(String artifactPath)
void	loadArtifacts()
void	streamLog(OutputStream outputStream)	Stream the run log content directly to an OutputStream.

Method Details

getRunId

String getRunId()

getTestStructure

TestStructure getTestStructure()
                        throws ResultArchiveStoreException

Throws:

ResultArchiveStoreException

getArtifactsRoot

Path getArtifactsRoot()
               throws ResultArchiveStoreException

Throws:

ResultArchiveStoreException

getLog

String getLog()
       throws ResultArchiveStoreException

Throws:

ResultArchiveStoreException

streamLog

void streamLog(OutputStream outputStream)
        throws ResultArchiveStoreException

Stream the run log content directly to an OutputStream. This method is preferred for large logs to avoid memory issues.

Parameters:

outputStream - The stream to write log content to

Throws:

ResultArchiveStoreException - if there's an error accessing the log

getLogSize

default long getLogSize()
                 throws ResultArchiveStoreException

Get the size of the run log in bytes without loading it into memory. This is useful for setting Content-Length headers without reading the entire log.

Returns:

The log size in bytes, or -1 if size is unknown or cannot be determined efficiently

Throws:

ResultArchiveStoreException - if there's an error accessing the log metadata

discard

void discard()
      throws ResultArchiveStoreException

Throws:

ResultArchiveStoreException

loadArtifacts

void loadArtifacts()
            throws ResultArchiveStoreException

Throws:

ResultArchiveStoreException

loadArtifact

void loadArtifact(String artifactPath)
           throws ResultArchiveStoreException

Throws:

ResultArchiveStoreException