io.qameta.allure.entity.TestResult Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2019 Qameta Software OÜ
 *
 *  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.entity;

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
import lombok.experimental.Accessors;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collector;
import java.util.stream.Collectors;

import static java.util.Comparator.comparing;
import static java.util.Comparator.naturalOrder;
import static java.util.Comparator.nullsFirst;

/**
 * @author charlie (Dmitry Baev).
 */
@Data
@Accessors(chain = true)
@SuppressWarnings("PMD.TooManyFields")
public class TestResult implements Serializable, Nameable, Parameterizable, Statusable, Timeable {

    private static final long serialVersionUID = 1L;

    protected String uid;
    protected String name;
    protected String fullName;
    protected String historyId;
    protected String testId;
    protected Time time = new Time();
    protected String description;
    protected String descriptionHtml;
    protected Status status;
    protected String statusMessage;
    protected String statusTrace;

    protected boolean flaky;
    protected boolean newFailed;
    protected boolean newBroken;
    protected boolean newPassed;
    protected int retriesCount;
    protected boolean retriesStatusChange;

    //    Execution
    protected List beforeStages = new ArrayList<>();
    protected StageResult testStage;
    protected List afterStages = new ArrayList<>();

    //    Meta
    protected List labels = new ArrayList<>();
    protected List parameters = new ArrayList<>();
    protected List links = new ArrayList<>();
    protected boolean hidden;
    protected boolean retry;
    protected final Map extra = new HashMap<>();

    @JsonProperty
    public String getSource() {
        return getUid() + ".json";
    }

    public void addExtraBlock(final String blockName, final Object block) {
        extra.put(blockName, block);
    }

    @SuppressWarnings("unchecked")
    public  T getExtraBlock(final String blockName, final T defaultValue) {
        return (T) extra.computeIfAbsent(blockName, name -> defaultValue);
    }

    @SuppressWarnings("unchecked")
    public  T getExtraBlock(final String blockName) {
        return (T) extra.get(blockName);
    }

    public boolean hasExtraBlock(final String blockName) {
        return extra.containsKey(blockName);
    }

    public  T findAllLabels(final LabelName name, final Collector collector) {
        return findAllLabels(name.value(), collector);
    }

    public  T findAllLabels(final String name, final Collector collector) {
        return getLabels().stream()
                .filter(label -> name.equals(label.getName()))
                .map(Label::getValue)
                .collect(collector);
    }

    public List findAllLabels(final LabelName name) {
        return findAllLabels(name, Collectors.toList());
    }

    public List findAllLabels(final String name) {
        return findAllLabels(name, Collectors.toList());
    }

    public Optional findOneLabel(final LabelName name) {
        return findOneLabel(name.value());
    }

    public Optional findOneLabel(final String name) {
        return getLabels().stream()
                .filter(label -> name.equals(label.getName()))
                .findAny()
                .map(Label::getValue);
    }

    public void addLabelIfNotExists(final LabelName name, final String value) {
        addLabelIfNotExists(name.value(), value);
    }

    public void addLabelIfNotExists(final String name, final String value) {
        if (value == null || name == null) {
            return;
        }
        final Optional any = getLabels().stream()
                .map(Label::getName)
                .filter(name::equals)
                .findAny();
        if (!any.isPresent()) {
            addLabel(name, value);
        }
    }

    public void addLabel(final String name, final String value) {
        getLabels().add(new Label().setName(name).setValue(value));
    }

    public static Comparator comparingByTime() {
        return comparingByTimeAsc().reversed();
    }

    public static Comparator comparingByTimeAsc() {
        return comparing(
                TestResult::getTime,
                nullsFirst(comparing(Time::getStart, nullsFirst(naturalOrder())))
        );
    }

    public Map toMap() {
        final Map map = new HashMap<>();
        for (Label l : getLabels()) {
            map.put(l.getName(), l.getValue());
        }
        return map;
    }
}