net.jqwik.engine.properties.PropertyCheckResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jqwik-engine Show documentation
Jqwik Engine module
There is a newer version: 1.9.1
package net.jqwik.engine.properties;

import java.util.*;

import org.opentest4j.*;

import net.jqwik.api.*;
import net.jqwik.api.lifecycle.*;
import net.jqwik.engine.support.*;

import static net.jqwik.engine.properties.PropertyCheckResult.Status.*;

public interface PropertyCheckResult {

	enum Status {
		SATISFIED,
		FALSIFIED,
		ERRONEOUS,
		EXHAUSTED
	}

	Status status();

	String propertyName();

	/**
	 * @return The number of times a property has been tried including all tries rejected by a precondition aka assumption
	 */
	int countTries();

	/**
	 * @return The number of times a property has actually been evaluated not counting the tries that were rejected by a
	 *         precondition aka assumption
	 */
	int countChecks();

	String randomSeed();

	Optional sample();

	Optional originalSample();

	Optional throwable();

	GenerationMode generation();

	default PropertyExecutionResult toExecutionResult() {
		if (status() == SATISFIED)
			return PropertyExecutionResult.successful(randomSeed());
		Throwable throwable = throwable().orElse(new AssertionFailedError(toString()));
		List sample = sample().orElse(null);
		return PropertyExecutionResult.failed(throwable, randomSeed(), sample);
	}

	abstract class ResultBase implements PropertyCheckResult {

		protected final Status status;
		protected final String propertyName;
		protected final int tries;
		protected final int checks;
		protected final String randomSeed;
		protected final GenerationMode generation;

		ResultBase(Status status, String propertyName, int tries, int checks, String randomSeed, GenerationMode generation) {
			this.status = status;
			this.propertyName = propertyName;
			this.tries = tries;
			this.checks = checks;
			this.randomSeed = randomSeed;
			this.generation = generation;
		}

		@Override
		public String propertyName() {
			return propertyName;
		}

		@Override
		public Status status() {
			return status;
		}

		@Override
		public int countChecks() {
			return checks;
		}

		@Override
		public int countTries() {
			return tries;
		}

		@Override
		public String randomSeed() {
			return randomSeed;
		}

		@Override
		public Optional sample() {
			return Optional.empty();
		}

		@Override
		public Optional originalSample() {
			return Optional.empty();
		}

		@Override
		public Optional throwable() {
			return Optional.empty();
		}

		@Override
		public GenerationMode generation() {
			return generation;
		}
	}

	static PropertyCheckResult satisfied(String stereotype, String propertyName, int tries, int checks, String randomSeed, GenerationMode generation) {
		return new ResultBase(Status.SATISFIED, propertyName, tries, checks, randomSeed, generation) {
			@Override
			public String toString() {
				return String.format("%s [%s] satisfied", stereotype, propertyName);
			}
		};
	}

	static PropertyCheckResult failure(
		String stereotype, String propertyName, int tries, int checks, String randomSeed, GenerationMode generation,
		List