ru.yandex.qatools.allure.utils

Class AllureResultsUtils

java.lang.Object

ru.yandex.qatools.allure.utils.AllureResultsUtils

public final class AllureResultsUtils
extends Object

Using to write test results (test suites and attachments) to result directory

Method Summary

Modifier and Type	Method and Description
static boolean	createDirectories(File dir) Try to create the directory named by this abstract pathname, including any necessary but nonexistent parent directories.
static Marshaller	createMarshallerForClass(Class<?> clazz) Creates a new Marshaller for given class.
static boolean	deleteAttachment(ru.yandex.qatools.allure.model.Attachment attachment) Remove attachment form resultsDirectory
static String	generateAttachmentName() Generate attachment name.
static String	getExtensionByMimeType(String type) Generate attachment extension from mime type
static File	getResultsDirectory() Returns results directory.
static Marshaller	marshaller(Class<?> clazz) Creates a new Marshaller for given class.
static void	setPropertySafely(Marshaller marshaller, String name, Object value) Try to set specified property to given marshaller
static void	setResultsDirectory(File resultsDirectory) Sets results directory.
static ru.yandex.qatools.allure.model.Attachment	writeAttachment(byte[] attachment, String title) Write attachment without specified type.
static ru.yandex.qatools.allure.model.Attachment	writeAttachment(byte[] attachment, String title, String type) Write attachment with specified type.
static ru.yandex.qatools.allure.model.Attachment	writeAttachmentSafely(byte[] attachment, String title, String type) Write attachment uses writeAttachment(byte[], String, String) (if specified attachment type not empty) or writeAttachment(byte[], String) otherwise.
static ru.yandex.qatools.allure.model.Attachment	writeAttachmentWithErrorMessage(Throwable throwable, String title) Write throwable as attachment.
static void	writeTestSuiteResult(ru.yandex.qatools.allure.model.TestSuiteResult testSuite) Marshal given testSuite to results folder.
static void	writeTestSuiteResult(ru.yandex.qatools.allure.model.TestSuiteResult testSuite, File testSuiteResultFile) Marshal TestSuiteResult to specified file uses BadXmlCharacterFilterWriter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getResultsDirectory

public static File getResultsDirectory()

Returns results directory. If resultsDirectory not set create new directory uses createResultsDirectory() method.

Returns:

results directory

createDirectories

public static boolean createDirectories(File dir)

Try to create the directory named by this abstract pathname, including any necessary but nonexistent parent directories.

Parameters:

dir - to create

Returns:

true, if directory successfully created, false otherwise

setResultsDirectory

public static void setResultsDirectory(File resultsDirectory)

Sets results directory. Use only for tests

Parameters:

resultsDirectory - results directory to set

writeTestSuiteResult

public static void writeTestSuiteResult(ru.yandex.qatools.allure.model.TestSuiteResult testSuite)

Marshal given testSuite to results folder. Shortcut for #writeTestSuiteResult(TestSuiteResult, File)

writeTestSuiteResult

public static void writeTestSuiteResult(ru.yandex.qatools.allure.model.TestSuiteResult testSuite,
                                        File testSuiteResultFile)

Marshal TestSuiteResult to specified file uses BadXmlCharacterFilterWriter. Name of file generated uses AllureNamingUtils.generateTestSuiteFileName()

Parameters:

testSuite - to marshal

marshaller

public static Marshaller marshaller(Class<?> clazz)

Creates a new Marshaller for given class. If marshaller created successfully, try to set following properties: Marshaller.JAXB_FORMATTED_OUTPUT and Marshaller.JAXB_ENCODING using setPropertySafely(javax.xml.bind.Marshaller, String, Object)

Parameters:

clazz - specified class

Returns:

a created marshaller

Throws:

AllureException - if can't create marshaller for given class.

createMarshallerForClass

public static Marshaller createMarshallerForClass(Class<?> clazz)

Creates a new Marshaller for given class.

Parameters:

clazz - specified class

Returns:

a created marshaller

Throws:

AllureException - if can't create marshaller for given class.

setPropertySafely

public static void setPropertySafely(Marshaller marshaller,
                                     String name,
                                     Object value)

Try to set specified property to given marshaller

Parameters:

marshaller - specified marshaller

name - name of property to set

value - value of property to set

deleteAttachment

public static boolean deleteAttachment(ru.yandex.qatools.allure.model.Attachment attachment)

Remove attachment form resultsDirectory

Parameters:

attachment - to remove

Returns:

true, if attachment removed successfully, false otherwise

writeAttachmentSafely

public static ru.yandex.qatools.allure.model.Attachment writeAttachmentSafely(byte[] attachment,
                                                                              String title,
                                                                              String type)

Write attachment uses writeAttachment(byte[], String, String) (if specified attachment type not empty) or writeAttachment(byte[], String) otherwise. If something went wrong uses writeAttachmentWithErrorMessage(Throwable, String)

Parameters:

attachment - which will write

title - attachment title

type - attachment type (should be valid mime-type, empty string or null)

Returns:

Created Attachment

writeAttachmentWithErrorMessage

public static ru.yandex.qatools.allure.model.Attachment writeAttachmentWithErrorMessage(Throwable throwable,
                                                                                        String title)

Write throwable as attachment.

Parameters:

throwable - to write

title - title of attachment

Returns:

Created Attachment

writeAttachment

public static ru.yandex.qatools.allure.model.Attachment writeAttachment(byte[] attachment,
                                                                        String title,
                                                                        String type)
                                                                 throws IOException

Write attachment with specified type. Generate attachment name uses generateAttachmentName(), attachment extension uses getExtensionByMimeType(String)

Parameters:

attachment - byte array with attachment

title - attachment title

type - valid mime-type of attachment

Returns:

Created Attachment

Throws:

IOException - if can't write attachment

writeAttachment

public static ru.yandex.qatools.allure.model.Attachment writeAttachment(byte[] attachment,
                                                                        String title)
                                                                 throws IOException

Write attachment without specified type. Using MimeTypes.detect(java.io.InputStream, org.apache.tika.metadata.Metadata) to autodetect attachment type from attachment content.

Parameters:

attachment - to write

title - attachment title

Returns:

Created Attachment

Throws:

IOException - if can't write attachment

generateAttachmentName

public static String generateAttachmentName()

Generate attachment name.

Returns:

generated name, looks like \"{uuid}-attachment\"

getExtensionByMimeType

public static String getExtensionByMimeType(String type)

Generate attachment extension from mime type

Parameters:

type - valid mime-type

Returns:

extension if it's known for specified mime-type, or empty string otherwise