aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/language/src/test/java/tools/refinery/language/tests/formatting2/ProblemFormatterTest.java
blob: 4a15f9de2e9c7b33e97a1c66827dd8e38fbf70ef (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/*
 * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.language.tests.formatting2;

import com.google.inject.Inject;
import com.google.inject.Provider;
import org.eclipse.xtext.formatting2.FormatterRequest;
import org.eclipse.xtext.formatting2.IFormatter2;
import org.eclipse.xtext.formatting2.regionaccess.ITextRegionAccess;
import org.eclipse.xtext.formatting2.regionaccess.ITextReplacement;
import org.eclipse.xtext.formatting2.regionaccess.TextRegionAccessBuilder;
import org.eclipse.xtext.resource.XtextResource;
import org.eclipse.xtext.testing.InjectWith;
import org.eclipse.xtext.testing.extensions.InjectionExtension;
import org.eclipse.xtext.testing.util.ParseHelper;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import tools.refinery.language.model.problem.Problem;
import tools.refinery.language.tests.ProblemInjectorProvider;

import java.util.List;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;

@ExtendWith(InjectionExtension.class)
@InjectWith(ProblemInjectorProvider.class)
class ProblemFormatterTest {
	@Inject
	private ParseHelper<Problem> parseHelper;

	@Inject
	private Provider<FormatterRequest> formatterRequestProvider;

	@Inject
	private TextRegionAccessBuilder regionBuilder;

	@Inject
	private IFormatter2 formatter2;

	@Test
	void problemNameTest() {
		testFormatter("  problem  problem  .  ", "problem problem.\n");
	}

	@Test
	void assertionTest() {
		testFormatter("  equals (  a  ,  b  ,  *  )  :  true  .  ", "equals(a, b, *): true.\n");
	}

	@Test
	void defaultAssertionTest() {
		testFormatter("  default  equals (  a  ,  b  ,  *  )  :  true  .  ", "default equals(a, b, *): true.\n");
	}

	@Test
	void assertionShortTrueTest() {
		testFormatter("  equals (  a  ,  b  ,  *  )  .  ", "equals(a, b, *).\n");
	}

	@Test
	void defaultAssertionShortTrueTest() {
		testFormatter("  default  equals (  a  ,  b  ,  *  )  .  ", "default equals(a, b, *).\n");
	}

	@Test
	void assertionShortFalseTest() {
		testFormatter("  !  equals (  a  ,  b  ,  *  )  .  ", "!equals(a, b, *).\n");
	}

	@Test
	void defaultAssertionShortFalseTest() {
		testFormatter("  default  !  equals (  a  ,  b  ,  *  )  .  ", "default !equals(a, b, *).\n");
	}

	@Test
	void assertionShortUnknownTest() {
		testFormatter("  ?  equals (  a  ,  b  ,  *  )  .  ", "?equals(a, b, *).\n");
	}

	@Test
	void defaultAssertionShortUnknownTest() {
		testFormatter("  default  ?  equals (  a  ,  b  ,  *  )  .  ", "default ?equals(a, b, *).\n");
	}

	@Test
	void multipleAssertionsTest() {
		testFormatter("  exists (  a  )  .  ?  equals  (  a  ,  a  ).", """
				exists(a).
				?equals(a, a).
				""");
	}

	@Test
	void multipleAssertionsNamedProblemTest() {
		testFormatter("  problem  foo  .  exists (  a  )  .  ?  equals  (  a  ,  a  ).", """
				problem foo.

				exists(a).
				?equals(a, a).
				""");
	}

	@Test
	void classWithoutBodyTest() {
		testFormatter("  class  Foo  .  ", "class Foo.\n");
	}

	@Test
	void abstractClassWithoutBodyTest() {
		testFormatter("  abstract  class  Foo  .  ", "abstract class Foo.\n");
	}

	@Test
	void classExtendsWithoutBodyTest() {
		testFormatter("  class  Foo.  class  Bar  .  class  Quux  extends  Foo  ,  Bar  .  ", """
				class Foo.

				class Bar.

				class Quux extends Foo, Bar.
				""");
	}

	@Test
	void classWithEmptyBodyTest() {
		testFormatter("  class  Foo  {  }  ", """
				class Foo {
				}
				""");
	}

	@Test
	void classExtendsWithBodyTest() {
		testFormatter("  class  Foo.  class  Bar  .  class  Quux  extends  Foo  ,  Bar  {  }  ", """
				class Foo.

				class Bar.

				class Quux extends Foo, Bar {
				}
				""");
	}

	@Test
	void predicateWithoutBodyTest() {
		testFormatter("  pred  foo  (  node  a  ,  b  )  .  ", "pred foo(node a, b).\n");
	}

	@Test
	void predicateWithBodyTest() {
		testFormatter(
				"  pred  foo  (  node  a  ,  b  )  <->  equal  (a  ,  _c  )  ,  !  equal  (  a  ,  b  )  ;  equal+(  a  ,  b  )  .  ",
				"pred foo(node a, b) <-> equal(a, _c), !equal(a, b); equal+(a, b).\n");
	}

	@Test
	void predicatesWithoutBodyTest() {
		testFormatter("  pred  foo  (  node  a  ,  b  )  .  pred  bar  (  node  c  )  .  ", """
				pred foo(node a, b).

				pred bar(node c).
				""");
	}

	@Test
	void predicateCommentsTest() {
		testFormatter("""
				  % Some foo
				pred  foo  (  node  a  ,  b  )  .
				  % Some bar
				pred  bar  (  node  c  )  .
				""", """
				% Some foo
				pred foo(node a, b).

				% Some bar
				pred bar(node c).
				""");
	}

	@Test
	void atomDeclarationTest() {
		testFormatter("  atom  a  ,  b  .  ", "atom a, b.\n");
	}

	@Test
	void mixedDeclarationsTest() {
		testFormatter("""
				problem test.
				pred foo(node a).
				class Foo.
				foo(n1, n2).
				atom i1.
				!foo(i1, n1).
				pred bar(node a, node b).
				pred quux().
				default !bar(*, *).
				""", """
				problem test.

				pred foo(node a).

				class Foo.

				foo(n1, n2).
				atom i1.
				!foo(i1, n1).

				pred bar(node a, node b).

				pred quux().

				default !bar(*, *).
				""");
	}

	private void testFormatter(String toFormat, String expected) {
		Problem problem;
		try {
			problem = parseHelper.parse(toFormat);
		} catch (Exception e) {
			throw new RuntimeException("Failed to parse document", e);
		}
		var resource = (XtextResource) problem.eResource();
		FormatterRequest request = formatterRequestProvider.get();
		request.setAllowIdentityEdits(false);
		request.setFormatUndefinedHiddenRegionsOnly(false);
		ITextRegionAccess regionAccess = regionBuilder.forNodeModel(resource).create();
		request.setTextRegionAccess(regionAccess);
		List<ITextReplacement> replacements = formatter2.format(request);
		var formattedString = regionAccess.getRewriter().renderToString(replacements);
		assertThat(formattedString.replace("\r\n", "\n"), equalTo(expected.replace("\r\n", "\n")));
	}
}