/*
 * Copyright 2022 the original author or authors.
 *
 * 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 org.gradle.api.tasks.testing;

import org.gradle.api.Incubating;
import org.jspecify.annotations.Nullable;

/**
 * Contains serializable structural information about a test failure.
 *
 * @see org.gradle.api.tasks.testing.TestFailure
 * @since 7.6
 */
@Incubating
public interface TestFailureDetails {

    /**
     * Returns the failure message.
     *
     * @return the failure message
     */
    @Nullable
    String getMessage();

    /**
     * The fully-qualified name of the underlying exception type.
     *
     * @return the class name
     */
    String getClassName();

    /**
     * Returns the stacktrace of the failure.
     * <p>
     * The instances are created on the test worker side allowing the clients not to deal with non-serializable exceptions.
     *
     * @return the stacktrace string
     */
    String getStacktrace();

    /**
     * Returns true if the represented failure is recognized as an assertion failure.
     *
     * @return {@code true} for assertion failures
     */
    boolean isAssertionFailure();

    /**
     * Returns true if the represented failure is recognized as a file comparison failure.
     * <p>
     * If this field is {@code true}, then the {@link #getExpectedContent()} and {@link #getActualContent()} methods <i>might</i> return non-null values.
     *
     * @since 8.3
     * @return {@code true} if this failure is a file comparison failure
     */
    boolean isFileComparisonFailure();

    /**
     * Returns the expected content of a file comparison assertion failure.
     *
     * @since 8.3
     * @see #isFileComparisonFailure()
     * @return the expected file contents or {@code null} if the test framework doesn't supply detailed information on assertion failures, or it is not a file comparison failure
     */
    byte @Nullable [] getExpectedContent();

    /**
     * Returns the actual content of a file comparison assertion failure.
     *
     * @since 8.3
     * @see #isFileComparisonFailure()
     * @return the expected file contents or {@code null} if the test framework doesn't supply detailed information on assertion failures, or it is not a file comparison failure
     */
    byte @Nullable [] getActualContent();

    /**
     * Returns a string representation of the expected value for an assertion failure.
     * <p>
     * If the current instance does not represent an assertion failure, or the test failure doesn't provide any information about expected and actual values then the method returns {@code null}.
     *
     * @return The expected value
     */
    @Nullable
    String getExpected();

    /**
     * Returns a string representation of the actual value for an assertion failure.
     * <p>
     * If the current instance does not represent an assertion failure, or the test failure doesn't provide any information about expected and actual values then the method returns {@code null}.
     *
     * @return The actual value
     */
    @Nullable
    String getActual();

    /**
     * Is this an assumption failure?
     *
     * @since 8.14
     * @return true if this is an assumption failure
     */
    boolean isAssumptionFailure();

}
