com.trivago.cluecumber.engine.constants.Status Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cluecumber-engine Show documentation
The Cluecumber reporting engine.
The newest version!
/*
 * Copyright 2019 trivago N.V.
 *
 * 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.
 */
/*
 * Copyright 2023 trivago N.V.
 *
 * 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 com.trivago.cluecumber.engine.constants;

import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

/**
 * Enum to manage all states for steps and scenarios.
 */
public enum Status {
    /**
     * Failed status.
     */
    FAILED("failed"),
    /**
     * Skipped status.
     */
    SKIPPED("skipped"),
    /**
     * Pending status.
     */
    PENDING("pending"),
    /**
     * Undefined status.
     */
    UNDEFINED("undefined"),
    /**
     * Ambiguous status.
     */
    AMBIGUOUS("ambiguous"),
    /**
     * Passed status.
     */
    PASSED("passed"),
    /**
     * Ambiguous unused.
     */
    UNUSED("unused");

    /**
     * The three basic states: passed, failed and skipped.
     */
    public static final List BASIC_STATES = Arrays.asList(Status.FAILED, Status.SKIPPED, Status.PASSED);

    private final String status;

    Status(final String statusString) {
        this.status = statusString;
    }

    /**
     * Get a status enum from a status string.
     *
     * @param status The status string.
     * @return The matching {@link Status} enum.
     */
    public static Status fromString(final String status) {
        return valueOf(status.toUpperCase());
    }

    /**
     * Get a status enum from a status string.
     *
     * @return The matching {@link Status} enum.
     */
    public Status basicStatus() {
        switch (this) {
            case PASSED:
                return Status.PASSED;
            case FAILED:
                return Status.FAILED;
            default:
                return Status.SKIPPED;
        }
    }

    /**
     * Return the highest status from the given list of states.
     *
     * @param allStates The list of states.
     * @return The highest status.
     */
    public static Status getHighestBasicState(Set allStates) {
        return BASIC_STATES.stream().filter(
                basicState -> allStates.stream().anyMatch(allState -> allState.basicStatus() == basicState)
        ).findFirst().orElse(FAILED);
    }

    /**
     * Get the highest state from all states.
     *
     * @param allStates The list of states.
     * @return The highest status.
     */
    public static Status getHighestState(Set allStates) {
        return Arrays.stream(values())
                .filter(state -> allStates.stream()
                        .anyMatch(allState -> allState == state))
                .findFirst()
                .orElse(FAILED);
    }

    /**
     * Return the status string from this enum.
     *
     * @return The status string.
     */
    public String getStatusString() {
        return status;
    }
}