Package io.qameta.allure

Interface AllureResultsWriter

All Known Implementing Classes:
FileSystemResultsWriter
public interface AllureResultsWriter
Since:
1.0-BETA2

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    write(io.qameta.allure.model.Globals globals)
    Writes Allure globals bean.
    void
    write(io.qameta.allure.model.TestResult testResult)
    Writes Allure test result bean.
    void
    write(io.qameta.allure.model.TestResultContainer testResultContainer)
    Writes Allure test result container bean.
    void
    write(String source, InputStream attachment)
    Writes given attachment.

  • Method Details

    • write

      void write(io.qameta.allure.model.TestResult testResult)
      Writes Allure test result bean.
      Parameters:
      testResult - the given bean to write.
      Throws:
      AllureResultsWriteException - if some error occurs during operation.

    • write

      void write(io.qameta.allure.model.TestResultContainer testResultContainer)
      Writes Allure test result container bean.
      Parameters:
      testResultContainer - the given bean to write.
      Throws:
      AllureResultsWriteException - if some error occurs during operation.

    • write

      default void write(io.qameta.allure.model.Globals globals)
      Writes Allure globals bean.

      The default implementation preserves compatibility with custom writers that predate global artifacts. Such writers do not persist globals until they override this method.

      Parameters:
      globals - the given bean to write.
      Throws:
      AllureResultsWriteException - if an overriding implementation fails during operation.

    • write

      void write(String source, InputStream attachment)
      Writes given attachment. Will close the given stream.
      Parameters:
      source - the file name of the attachment. Make sure that file name matches the following glob: 
      *-attachment*
      . The right way to generate attachment is generate UUID, determinate attachment extension and then use it as 
      {UUID}-attachment.{ext}
      attachment - the steam that contains attachment body.