io.qameta.allure

Class Commands

java.lang.Object

io.qameta.allure.Commands

public class Commands
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Commands(java.nio.file.Path allureHome)

Method Summary

Modifier and Type	Method and Description
protected io.qameta.allure.core.Configuration	createReportConfiguration(ConfigOptions profile) Creates report configuration for a given profile.
ExitCode	generate(java.nio.file.Path reportDirectory, java.util.List<java.nio.file.Path> resultsDirectories, boolean clean, ConfigOptions profile)
CommandlineConfig	getConfig(ConfigOptions configOptions)
java.util.Optional<java.nio.file.Path>	getConfigFile(ConfigOptions configOptions)
java.lang.String	getConfigFileName(java.lang.String profile)
ExitCode	listPlugins(ConfigOptions configOptions)
ExitCode	open(java.nio.file.Path reportDirectory, java.lang.String host, int port)
protected void	openBrowser(java.net.URI url) Open the given url in default system browser.
ExitCode	serve(java.util.List<java.nio.file.Path> resultsDirectories, java.lang.String host, int port, ConfigOptions configOptions)
protected org.eclipse.jetty.server.Server	setUpServer(java.lang.String host, int port, java.nio.file.Path reportDirectory) Set up Jetty server to serve Allure Report.

Methods inherited from class java.lang.Object

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

Constructor Detail

Commands

public Commands(java.nio.file.Path allureHome)

Method Detail

getConfig

public CommandlineConfig getConfig(ConfigOptions configOptions)

getConfigFile

public java.util.Optional<java.nio.file.Path> getConfigFile(ConfigOptions configOptions)

getConfigFileName

public java.lang.String getConfigFileName(java.lang.String profile)

generate

public ExitCode generate(java.nio.file.Path reportDirectory,
                         java.util.List<java.nio.file.Path> resultsDirectories,
                         boolean clean,
                         ConfigOptions profile)

serve

public ExitCode serve(java.util.List<java.nio.file.Path> resultsDirectories,
                      java.lang.String host,
                      int port,
                      ConfigOptions configOptions)

open

public ExitCode open(java.nio.file.Path reportDirectory,
                     java.lang.String host,
                     int port)

listPlugins

public ExitCode listPlugins(ConfigOptions configOptions)

createReportConfiguration

protected io.qameta.allure.core.Configuration createReportConfiguration(ConfigOptions profile)

Creates report configuration for a given profile.

Parameters:

profile - selected profile.

Returns:

created report configuration.

setUpServer

protected org.eclipse.jetty.server.Server setUpServer(java.lang.String host,
                                                      int port,
                                                      java.nio.file.Path reportDirectory)
                                               throws java.io.IOException

Set up Jetty server to serve Allure Report.

Throws:

java.io.IOException

openBrowser

protected void openBrowser(java.net.URI url)
                    throws java.io.IOException

Open the given url in default system browser.

Throws:

java.io.IOException