io.qameta.allure.DummyReportGenerator 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.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.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.plugin.DefaultPluginLoader;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
/**
* @author Artem Eroshenko [email protected]
* Date: 1/22/14
*/
@SuppressWarnings({
"PMD.ExcessiveImports",
"PMD.ClassNamingConventions",
"ClassFanOutComplexity",
"ClassDataAbstractionCoupling"
})
public final class DummyReportGenerator {
private static final Logger LOGGER = LoggerFactory.getLogger(DummyReportGenerator.class);
private static final int MIN_ARGUMENTS_COUNT = 2;
private static final List EXTENSIONS = Arrays.asList(
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()
);
private DummyReportGenerator() {
throw new IllegalStateException("Do not instance");
}
/**
* Generate Allure report data from directories with allure report results.
*
* @param args a list of directory paths. First (args.length - 1) arguments -
* results directories, last argument - the folder to generated data
*/
public static void main(final String... args) throws IOException {
if (args.length < MIN_ARGUMENTS_COUNT) {
LOGGER.error("There must be at least two arguments");
return;
}
final int lastIndex = args.length - 1;
final Path[] files = getFiles(args);
final List plugins = loadPlugins();
LOGGER.info("Found {} plugins", plugins.size());
plugins.forEach(plugin -> LOGGER.info(plugin.getConfig().getName()));
final Configuration configuration = new ConfigurationBuilder()
.withExtensions(EXTENSIONS)
.withPlugins(plugins)
.build();
final ReportGenerator generator = new ReportGenerator(configuration);
generator.generate(files[lastIndex], Arrays.asList(Arrays.copyOf(files, lastIndex)));
}
public static Path[] getFiles(final String... paths) {
return Arrays.stream(paths)
.map(Paths::get)
.toArray(Path[]::new);
}
public static List loadPlugins() throws IOException {
final Optional optional = Optional.ofNullable(System.getProperty("allure.plugins.directory"))
.map(Paths::get)
.filter(Files::isDirectory);
if (!optional.isPresent()) {
return Collections.emptyList();
}
final Path pluginsDirectory = optional.get();
LOGGER.info("Found plugins directory {}", pluginsDirectory);
final DefaultPluginLoader loader = new DefaultPluginLoader();
final ClassLoader classLoader = DummyReportGenerator.class.getClassLoader();
return Files.list(pluginsDirectory)
.filter(Files::isDirectory)
.map(pluginDir -> loader.loadPlugin(classLoader, pluginDir))
.filter(Optional::isPresent)
.map(Optional::get)
.collect(Collectors.toList());
}
}