io.qameta.allure.ConfigurationBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of allure-generator Show documentation
Show all versions of allure-generator Show documentation
Module allure-generator of Allure Framework.
/*
* Copyright 2016-2024 Qameta Software Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.qameta.allure;
import io.qameta.allure.allure1.Allure1Plugin;
import io.qameta.allure.allure2.Allure2Plugin;
import io.qameta.allure.category.CategoriesPlugin;
import io.qameta.allure.category.CategoriesTrendPlugin;
import io.qameta.allure.context.FreemarkerContext;
import io.qameta.allure.context.JacksonContext;
import io.qameta.allure.context.MarkdownContext;
import io.qameta.allure.context.RandomUidContext;
import io.qameta.allure.context.ReportInfoContext;
import io.qameta.allure.core.AttachmentsPlugin;
import io.qameta.allure.core.Configuration;
import io.qameta.allure.core.MarkdownDescriptionsPlugin;
import io.qameta.allure.core.Plugin;
import io.qameta.allure.core.TestsResultsPlugin;
import io.qameta.allure.duration.DurationPlugin;
import io.qameta.allure.duration.DurationTrendPlugin;
import io.qameta.allure.environment.Allure1EnvironmentPlugin;
import io.qameta.allure.executor.ExecutorPlugin;
import io.qameta.allure.ga.GaPlugin;
import io.qameta.allure.history.HistoryPlugin;
import io.qameta.allure.history.HistoryTrendPlugin;
import io.qameta.allure.idea.IdeaLinksPlugin;
import io.qameta.allure.influxdb.InfluxDbExportPlugin;
import io.qameta.allure.launch.LaunchPlugin;
import io.qameta.allure.mail.MailPlugin;
import io.qameta.allure.owner.OwnerPlugin;
import io.qameta.allure.prometheus.PrometheusExportPlugin;
import io.qameta.allure.retry.RetryPlugin;
import io.qameta.allure.retry.RetryTrendPlugin;
import io.qameta.allure.severity.SeverityPlugin;
import io.qameta.allure.status.StatusChartPlugin;
import io.qameta.allure.suites.SuitesPlugin;
import io.qameta.allure.summary.SummaryPlugin;
import io.qameta.allure.tags.TagsPlugin;
import io.qameta.allure.timeline.TimelinePlugin;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
/**
* Builder for {@link Configuration}.
*
* @see Configuration
* @since 2.0
*/
@SuppressWarnings({
"PMD.ExcessiveImports",
"ClassDataAbstractionCoupling",
"ClassFanOutComplexity"
})
public class ConfigurationBuilder {
private static final Logger LOGGER = LoggerFactory.getLogger(ConfigurationBuilder.class);
private static final String ALLURE_VERSION_TXT_PATH = "/allure-version.txt";
private static final String UNDEFINED = "Undefined";
private static final List BUNDLED_EXTENSIONS = Arrays.asList(
new MarkdownDescriptionsPlugin(),
new TagsPlugin(),
new RetryPlugin(),
new RetryTrendPlugin(),
new SeverityPlugin(),
new OwnerPlugin(),
new IdeaLinksPlugin(),
new HistoryPlugin(),
new HistoryTrendPlugin(),
new CategoriesPlugin(),
new CategoriesTrendPlugin(),
new DurationPlugin(),
new DurationTrendPlugin(),
new StatusChartPlugin(),
new TimelinePlugin(),
new SuitesPlugin(),
new TestsResultsPlugin(),
new AttachmentsPlugin(),
new MailPlugin(),
new InfluxDbExportPlugin(),
new PrometheusExportPlugin(),
new SummaryPlugin(),
new ExecutorPlugin(),
new LaunchPlugin(),
new Allure1Plugin(),
new Allure1EnvironmentPlugin(),
new Allure2Plugin(),
new GaPlugin()
);
private final List extensions = new ArrayList<>();
private final List plugins = new ArrayList<>();
private final String uuid;
private final String version;
private String reportName;
private String reportLanguage;
/**
* Instantiates a new Configuration builder.
*
* @deprecated use static factory methods {@link #empty()} or {@link #bundled()} instead.
*/
@Deprecated
public ConfigurationBuilder() {
this(getVersion());
}
/**
* Instantiates a new Configuration builder.
*
* @param version the report version
*/
private ConfigurationBuilder(final String version) {
this.version = version;
this.uuid = UUID.randomUUID().toString();
}
/**
* Use default configuration builder.
*
* @return the configuration builder
* @deprecated use {@link #bundled()} static factory method instead.
*/
@Deprecated
public ConfigurationBuilder useDefault() {
return withExtensions(Arrays.asList(
new ReportInfoContext(version, uuid),
new JacksonContext(),
new MarkdownContext(),
new FreemarkerContext(),
new RandomUidContext(),
new MarkdownDescriptionsPlugin(),
new TagsPlugin(),
new RetryPlugin(),
new RetryTrendPlugin(),
new SeverityPlugin(),
new OwnerPlugin(),
new IdeaLinksPlugin(),
new HistoryPlugin(),
new HistoryTrendPlugin(),
new CategoriesPlugin(),
new CategoriesTrendPlugin(),
new DurationPlugin(),
new DurationTrendPlugin(),
new StatusChartPlugin(),
new TimelinePlugin(),
new SuitesPlugin(),
new TestsResultsPlugin(),
new AttachmentsPlugin(),
new MailPlugin(),
new InfluxDbExportPlugin(),
new PrometheusExportPlugin(),
new SummaryPlugin(),
new ExecutorPlugin(),
new LaunchPlugin(),
new Allure1Plugin(),
new Allure1EnvironmentPlugin(),
new Allure2Plugin(),
new GaPlugin()
));
}
/**
* Bundled configuration builder.
*
* @return the configuration builder
*/
public static ConfigurationBuilder bundled() {
return empty()
.withExtensions(BUNDLED_EXTENSIONS);
}
/**
* Empty configuration builder.
*
* @return the configuration builder
*/
public static ConfigurationBuilder empty() {
final String allureVersion = getVersion();
return new ConfigurationBuilder(allureVersion)
.withExtensions(Arrays.asList(
new ReportInfoContext(allureVersion),
new JacksonContext(),
new MarkdownContext(),
new FreemarkerContext(),
new RandomUidContext()
));
}
/**
* From extensions configuration builder.
*
* @param extensions the extensions
* @return the configuration builder
* @deprecated use {@link #withExtensions(List)} instead.
*/
@Deprecated
public ConfigurationBuilder fromExtensions(final List extensions) {
return withExtensions(extensions);
}
/**
* From extensions configuration builder.
*
* @param extensions the extensions
* @return the configuration builder
*/
public ConfigurationBuilder withExtensions(final List extensions) {
this.extensions.addAll(extensions);
return this;
}
/**
* From plugins configuration builder.
*
* @param plugins the plugins
* @return the configuration builder
* @deprecated use {@link #withPlugins(List)} instead.
*/
@Deprecated
public ConfigurationBuilder fromPlugins(final List plugins) {
return withPlugins(plugins);
}
/**
* Withm plugins configuration builder.
*
* @param plugins the plugins
* @return the configuration builder
*/
public ConfigurationBuilder withPlugins(final List plugins) {
this.plugins.addAll(plugins);
plugins.stream()
.map(Plugin::getExtensions)
.forEach(this::withExtensions);
return this;
}
/**
* With report name configuration builder.
*
* @param reportName the report name
* @return the configuration builder
*/
public ConfigurationBuilder withReportName(final String reportName) {
this.reportName = reportName;
return this;
}
/**
* With report language configuration builder.
*
* @param reportLanguage the report language
* @return the configuration builder
*/
public ConfigurationBuilder withReportLanguage(final String reportLanguage) {
this.reportLanguage = reportLanguage;
return this;
}
/**
* Build configuration.
*
* @return the configuration
*/
public Configuration build() {
return new DefaultConfiguration(
this.uuid,
this.version,
this.reportName,
this.reportLanguage,
Collections.unmodifiableList(extensions),
Collections.unmodifiableList(plugins)
);
}
private static String getVersion() {
return getVersionFromFile()
.orElse(getVersionFromManifest().orElse(UNDEFINED));
}
private static Optional getVersionFromFile() {
try {
return Optional.of(IOUtils.resourceToString(ALLURE_VERSION_TXT_PATH, StandardCharsets.UTF_8))
.map(String::trim)
.filter(v -> !v.isEmpty())
.filter(v -> !"#project.version#".equals(v));
} catch (IOException e) {
LOGGER.debug("Could not read {} resource", ALLURE_VERSION_TXT_PATH, e);
return Optional.empty();
}
}
private static Optional getVersionFromManifest() {
return Optional.of(ConfigurationBuilder.class)
.map(Class::getPackage)
.map(Package::getImplementationVersion);
}
}