io.qameta.allure.core.Configuration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of allure-plugin-api Show documentation
Module allure-plugin-api of Allure Framework.
There is a newer version: 2.32.0
/*
 *  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.core;

import io.qameta.allure.Aggregator;
import io.qameta.allure.Context;
import io.qameta.allure.Extension;
import io.qameta.allure.Reader;
import io.qameta.allure.exception.ContextNotFoundException;

import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

/**
 * Report configuration.
 *
 * @since 2.0
 */
public interface Configuration {

    /**
     * Gets uuid.
     *
     * @return the uuid
     */
    default String getUuid() {
        return null;
    }

    /**
     * Gets version.
     *
     * @return the version
     */
    default String getVersion() {
        return null;
    }

    /**
     * Returns the report language. If not specified, uses "en".
     *
     * @return the report language.
     */
    default String getReportLanguage() {
        return null;
    }

    /**
     * Returns the report name.
     *
     * @return the report name.
     */
    default String getReportName() {
        return null;
    }

    /**
     * Returns all configured plugins.
     *
     * @return configured plugins.
     */
    List getPlugins();

    /**
     * Returns all configured aggregators.
     *
     * @return configured aggregators.
     * @deprecated for removal. Use {@link #getExtensions()} instead.
     */
    @Deprecated
    default List getAggregators() {
        return getExtensions(Aggregator.class);
    }

    /**
     * Returns all configured readers.
     *
     * @return configured readers.
     * @deprecated for removal. Use {@link #getExtensions()} instead.
     */
    @Deprecated
    default List getReaders() {
        return getExtensions(Reader.class);
    }

    /**
     * Returns all discovered extensions.
     *
     * @return configured extensions.
     */
    List getExtensions();

    /**
     * Returns all discovered extensions of specified type.
     *
     * @param            the type of extension.
     * @param extensionType the type of extension.
     * @return configured extensions.
     */
    default  List getExtensions(final Class extensionType) {
        return getExtensions().stream()
                .filter(extensionType::isInstance)
                .map(extensionType::cast)
                .collect(Collectors.toList());
    }

    /**
     * Resolve context by given type.
     *
     * @param          the java type of context's type.
     * @param          the java type of context.
     * @param contextType type of context to resolve.
     * @return resolved context.
     */
    default > Optional getContext(final Class contextType) {
        return getExtensions(contextType).stream()
                .findFirst();
    }

    /**
     * The same as {@link #getContext(Class)} but throws an exception
     * if context doesn't present.
     *
     * @param          the type parameter
     * @param          the type parameter
     * @param contextType the context type
     * @return resolved context.
     * @throws ContextNotFoundException if no such context present.
     */
    default > S requireContext(final Class contextType) {
        return getContext(contextType).orElseThrow(() -> new ContextNotFoundException(contextType));
    }
}