aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/logic/src/testFixtures/java/tools/refinery/logic/tests/QueryMatchers.java
blob: 40332a8c518de4c28112aad4438d39442164ac86 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/*
 * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.logic.tests;

import org.hamcrest.Matcher;
import tools.refinery.logic.dnf.Dnf;
import tools.refinery.logic.dnf.SymbolicParameter;
import tools.refinery.logic.literal.Literal;

import java.util.List;

public final class QueryMatchers {
	private QueryMatchers() {
		throw new IllegalStateException("This is a static utility class and should not be instantiated directly");
	}

	/**
	 * Compare two {@link Dnf} instances up to renaming of variables.
	 *
	 * @param expected The expected {@link Dnf} instance.
	 * @return A Hamcrest matcher for equality up to renaming of variables.
	 */
	public static Matcher<Dnf> structurallyEqualTo(Dnf expected) {
		return new StructurallyEqualTo(expected);
	}

	/**
	 * Compare a {@link Dnf} instance to another predicate in DNF form without constructing it.
	 * <p>
	 * This matcher should be used instead of {@link #structurallyEqualTo(Dnf)} when the validation and
	 * pre-processing associated with the {@link Dnf} constructor, i.e., validation of parameter directions,
	 * topological sorting of literals, and the reduction of trivial predicates is not desired. In particular, this
	 * matcher can be used to test for exact order of literal after pre-processing.
	 *
	 * @param expectedSymbolicParameters The expected list of symbolic parameters.
	 * @param expectedLiterals The expected clauses. Each clause is represented by a list of literals.
	 * @return A Hamcrest matcher for equality up to renaming of variables.
	 */
	public static Matcher<Dnf> structurallyEqualTo(List<SymbolicParameter> expectedSymbolicParameters,
												   List<? extends List<? extends Literal>> expectedLiterals) {
		return new StructurallyEqualToRaw(expectedSymbolicParameters, expectedLiterals);
	}
}