Skip to main content
summaryrefslogtreecommitdiffstats
blob: 73b9b3fa0c8b08d59bd6f42f972bce3ab943581d (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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
/**
 * Copyright (c) 2012 Obeo.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Obeo - initial API and implementation
 */
package org.eclipse.emf.compare.tests.fullcomparison;

import static junit.framework.Assert.assertEquals;
import static junit.framework.Assert.assertNotNull;
import static junit.framework.Assert.assertSame;
import static junit.framework.Assert.assertTrue;
import static org.eclipse.emf.compare.tests.framework.EMFCompareAssert.assertAdded;
import static org.eclipse.emf.compare.tests.framework.EMFCompareAssert.assertAddedToReference;
import static org.eclipse.emf.compare.tests.framework.EMFCompareAssert.assertAllMatched;
import static org.eclipse.emf.compare.tests.framework.EMFCompareAssert.assertChangedAttribute;
import static org.eclipse.emf.compare.tests.framework.EMFCompareAssert.assertChangedReference;
import static org.eclipse.emf.compare.tests.framework.EMFCompareAssert.assertRemoved;
import static org.eclipse.emf.compare.tests.framework.EMFCompareAssert.assertRemovedFromReference;

import com.google.common.collect.Lists;

import java.io.IOException;
import java.util.List;

import org.eclipse.emf.compare.Comparison;
import org.eclipse.emf.compare.Conflict;
import org.eclipse.emf.compare.ConflictKind;
import org.eclipse.emf.compare.Diff;
import org.eclipse.emf.compare.DifferenceSource;
import org.eclipse.emf.compare.Match;
import org.eclipse.emf.compare.MatchResource;
import org.eclipse.emf.compare.scope.IComparisonScope;
import org.eclipse.emf.compare.tests.framework.EMFCompareTestBase;
import org.eclipse.emf.compare.tests.framework.IdentifierMatchValidator;
import org.eclipse.emf.compare.tests.framework.NotifierTuple;
import org.eclipse.emf.compare.tests.framework.junit.EMFCompareTestRunner;
import org.eclipse.emf.compare.tests.framework.junit.annotation.BeforeMatch;
import org.eclipse.emf.compare.tests.framework.junit.annotation.ConflictTest;
import org.eclipse.emf.compare.tests.framework.junit.annotation.DiffTest;
import org.eclipse.emf.compare.tests.framework.junit.annotation.MatchTest;
import org.eclipse.emf.compare.tests.framework.junit.annotation.UseCase;
import org.eclipse.emf.compare.tests.fullcomparison.data.identifier.IdentifierMatchInputData;
import org.eclipse.emf.ecore.ENamedElement;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.junit.runner.RunWith;

@RunWith(EMFCompareTestRunner.class)
@SuppressWarnings("nls")
public class IdentifierComparisonTest extends EMFCompareTestBase {
	private IdentifierMatchInputData inputData = new IdentifierMatchInputData();

	@UseCase("Extended library three-way")
	public NotifierTuple extlibrary3WayTuple() throws IOException {
		final Resource left = inputData.getExtlibraryLeft();
		final Resource right = inputData.getExtlibraryRight();
		final Resource origin = inputData.getExtlibraryOrigin();

		return new NotifierTuple(left, right, origin);
	}

	@UseCase("Extended library two-way")
	public NotifierTuple extlibrary2WayTuple() throws IOException {
		final Resource left = inputData.getExtlibraryLeft();
		final Resource right = inputData.getExtlibraryRight();

		return new NotifierTuple(left, right, null);
	}

	@BeforeMatch
	public void beforeMatch(NotifierTuple tuple) {
		assertNotNull(tuple);
		assertTrue(tuple.getLeft() instanceof Resource);
		assertTrue(tuple.getRight() instanceof Resource);
		// We have both two-way and three-way use cases here
	}

	@MatchTest
	public void testIdentifierMatch(IComparisonScope scope, Comparison comparison) {
		final Resource left = (Resource)scope.getLeft();
		final Resource right = (Resource)scope.getRight();
		final Resource origin = (Resource)scope.getOrigin();
		assertSame(Boolean.valueOf(origin != null), Boolean.valueOf(comparison.isThreeWay()));

		assertSame(Integer.valueOf(1), Integer.valueOf(comparison.getMatchedResources().size()));
		final MatchResource matchedResource = comparison.getMatchedResources().get(0);
		assertEquals(left.getURI().toString(), matchedResource.getLeftURI());
		assertEquals(right.getURI().toString(), matchedResource.getRightURI());
		if (origin != null) {
			assertEquals(origin.getURI().toString(), matchedResource.getOriginURI());
		}

		// Validate that all matches point to sides that have the same IDs, and that there is only 1 Match for
		// one "ID" (if two EObjects on two different sides have the same ID, they share the same Match).
		final IdentifierMatchValidator validator = new IdentifierMatchValidator();
		validator.validate(comparison);

		// Make sure that we have a Match for all EObjects of this scope
		final List<EObject> leftChildren = getAllProperContent(left);
		final List<EObject> rightChildren = getAllProperContent(right);
		final List<EObject> originChildren = getAllProperContent(origin);

		assertAllMatched(leftChildren, comparison, scope);
		assertAllMatched(rightChildren, comparison, scope);
		assertAllMatched(originChildren, comparison, scope);
	}

	@DiffTest
	public void testIdentifierDiffTest(@SuppressWarnings("unused") IComparisonScope scope,
			Comparison comparison) {
		final List<Diff> differences = comparison.getDifferences();

		// See file org.eclipse.emf.compare.tests.model.mock.CHANGES for the description of these

		assertAdded(differences, "extlibrary.BookCategory.Encyclopedia", DifferenceSource.LEFT);
		assertAdded(differences, "extlibrary.BookCategory.Dictionary", DifferenceSource.LEFT);
		assertAdded(differences, "extlibrary.Magazine", DifferenceSource.LEFT);
		assertAdded(differences, "extlibrary.Magazine.title", DifferenceSource.LEFT);
		assertAdded(differences, "extlibrary.Magazine.pages", DifferenceSource.LEFT);
		assertAdded(differences, "extlibrary.Person.fullName", DifferenceSource.LEFT);

		assertRemoved(differences, "extlibrary.Periodical", DifferenceSource.LEFT);
		assertRemoved(differences, "extlibrary.Periodical.issuesPerYear", DifferenceSource.LEFT);
		assertRemoved(differences, "extlibrary.Person.firstName", DifferenceSource.LEFT);

		assertChangedAttribute(differences, "extlibrary.Lendable", "name", "Lendable", "Borrowable",
				DifferenceSource.LEFT);

		assertAddedToReference(differences, "extlibrary.Magazine", "eSuperTypes",
				"extlibrary.CirculatingItem", DifferenceSource.LEFT);
		assertRemovedFromReference(differences, "extlibrary.Periodical", "eSuperTypes", "extlibrary.Item",
				DifferenceSource.LEFT);

		assertChangedReference(differences, "extlibrary.Magazine.title", "eType", null, "ecore.EString",
				DifferenceSource.LEFT);
		assertChangedReference(differences, "extlibrary.Magazine.pages", "eType", null, "ecore.EInt",
				DifferenceSource.LEFT);
		assertChangedReference(differences, "extlibrary.Person.fullName", "eType", null, "ecore.EString",
				DifferenceSource.LEFT);

		assertChangedReference(differences, "extlibrary.Periodical.issuesPerYear", "eType", "ecore.EInt",
				null, DifferenceSource.LEFT);
		assertChangedReference(differences, "extlibrary.Person.firstName", "eType", "ecore.EString", null,
				DifferenceSource.LEFT);

		// some diffs change according to the presence of an origin.
		if (comparison.isThreeWay()) {
			// This one will be detected differently in two-way
			assertRemoved(differences, "extlibrary.Person.lastName", DifferenceSource.LEFT);
			assertChangedReference(differences, "extlibrary.Person.lastName", "eType", "ecore.EString", null,
					DifferenceSource.LEFT);

			final DifferenceSource side = DifferenceSource.RIGHT;
			assertAdded(differences, "extlibrary.BookCategory.Manga", side);
			assertAdded(differences, "extlibrary.BookCategory.Manhwa", side);
			assertAdded(differences, "extlibrary.Book.subtitle", side);
			assertAdded(differences, "extlibrary.Magazine", side);
			assertAdded(differences, "extlibrary.TitledItem", side);
			assertAdded(differences, "extlibrary.TitledItem.title", side);

			assertRemoved(differences, "extlibrary.Book.title", side);
			assertRemoved(differences, "extlibrary.AudioVisualItem.title", side);

			assertAddedToReference(differences, "extlibrary.Book", "eSuperTypes", "extlibrary.TitledItem",
					side);
			assertAddedToReference(differences, "extlibrary.Periodical", "eSuperTypes",
					"extlibrary.TitledItem", side);
			assertAddedToReference(differences, "extlibrary.AudioVisualItem", "eSuperTypes",
					"extlibrary.TitledItem", side);
			assertAddedToReference(differences, "extlibrary.Magazine", "eSuperTypes",
					"extlibrary.Periodical", side);

			assertChangedReference(differences, "extlibrary.Book.subtitle", "eType", null, "ecore.EString",
					side);
			assertChangedReference(differences, "extlibrary.TitledItem.title", "eType", null,
					"ecore.EString", side);

			assertChangedReference(differences, "extlibrary.Book.title", "eType", "ecore.EString", null, side);
			assertChangedReference(differences, "extlibrary.AudioVisualItem.title", "eType", "ecore.EString",
					null, side);

			/*
			 * The following are actually conflicts, most changes according to whether we are in three-way or
			 * not.
			 */
			assertChangedAttribute(differences, "extlibrary.AudioVisualItem.length", "name", "minutesLength",
					"length", DifferenceSource.LEFT);
			// These are actually pseudo-conflicts : same diff on both sides
			assertRemoved(differences, "extlibrary.BookOnTape.reader", DifferenceSource.LEFT);
			assertRemoved(differences, "extlibrary.BookOnTape.reader", DifferenceSource.RIGHT);
			assertRemoved(differences, "extlibrary.Periodical.title", DifferenceSource.LEFT);
			assertRemoved(differences, "extlibrary.Periodical.title", DifferenceSource.RIGHT);
			assertChangedReference(differences, "extlibrary.BookOnTape.reader", "eType", "extlibrary.Person",
					null, DifferenceSource.LEFT);
			assertChangedReference(differences, "extlibrary.BookOnTape.reader", "eType", "extlibrary.Person",
					null, DifferenceSource.RIGHT);
			assertChangedReference(differences, "extlibrary.Periodical.title", "eType", "ecore.EString",
					null, DifferenceSource.LEFT);
			assertChangedReference(differences, "extlibrary.Periodical.title", "eType", "ecore.EString",
					null, DifferenceSource.RIGHT);
			/*
			 * These changes can only be detected with an origin : lastName has been removed in the left model
			 * and thus only the removal can be detected in two-way. Likewise, "minutesLength" has been
			 * renamed in both left and right, and thus no mention of that value can be found in two-way
			 */
			assertChangedAttribute(differences, "extlibrary.Person.familyName", "name", "lastName",
					"familyName", side);
			assertChangedAttribute(differences, "extlibrary.AudioVisualItem.length", "name", "minutesLength",
					"minutes", side);
		} else {
			assertRemoved(differences, "extlibrary.Person.familyName", DifferenceSource.LEFT);
			assertChangedReference(differences, "extlibrary.Person.familyName", "eType", "ecore.EString",
					null, DifferenceSource.LEFT);

			final DifferenceSource side = DifferenceSource.LEFT;
			assertRemoved(differences, "extlibrary.BookCategory.Manga", side);
			assertRemoved(differences, "extlibrary.BookCategory.Manhwa", side);
			assertRemoved(differences, "extlibrary.Book.subtitle", side);
			assertRemoved(differences, "extlibrary.Magazine", side);
			assertRemoved(differences, "extlibrary.TitledItem", side);
			assertRemoved(differences, "extlibrary.TitledItem.title", side);

			assertAdded(differences, "extlibrary.Book.title", side);
			assertAdded(differences, "extlibrary.AudioVisualItem.title", side);

			assertRemovedFromReference(differences, "extlibrary.Book", "eSuperTypes",
					"extlibrary.TitledItem", side);
			assertRemovedFromReference(differences, "extlibrary.Periodical", "eSuperTypes",
					"extlibrary.TitledItem", side);
			assertRemovedFromReference(differences, "extlibrary.AudioVisualItem", "eSuperTypes",
					"extlibrary.TitledItem", side);
			assertRemovedFromReference(differences, "extlibrary.Magazine", "eSuperTypes",
					"extlibrary.Periodical", side);

			assertChangedReference(differences, "extlibrary.Book.subtitle", "eType", "ecore.EString", null,
					side);
			assertChangedReference(differences, "extlibrary.TitledItem.title", "eType", "ecore.EString",
					null, side);

			assertChangedReference(differences, "extlibrary.Book.title", "eType", null, "ecore.EString", side);
			assertChangedReference(differences, "extlibrary.AudioVisualItem.title", "eType", null,
					"ecore.EString", side);

			// This is a conflict, the expected diff is not the same in two-way
			assertChangedAttribute(differences, "extlibrary.AudioVisualItem.length", "name", "minutes",
					"length", DifferenceSource.LEFT);
		}

		// We should have no more differences than those
		assertTrue(differences.isEmpty());
	}

	@ConflictTest
	public void testIdentifierConflictTest(@SuppressWarnings("unused") IComparisonScope scope,
			Comparison comparison) {
		final List<Conflict> conflicts = comparison.getConflicts();

		if (!comparison.isThreeWay()) {
			assertTrue(conflicts.isEmpty());
			return;
		}

		assertEquals(5, conflicts.size());

		Conflict periodicalConflict = null;
		Conflict titleConflict = null;
		Conflict lastNameConflict = null;
		Conflict minutesLengthConflict = null;
		Conflict readerConflict = null;

		for (Conflict conflict : conflicts) {
			for (Diff diff : conflict.getDifferences()) {
				boolean breakLoop = false;
				final Match match = diff.getMatch();
				if (isMatchOf(match, "Periodical") && conflict.getDifferences().size() == 3) {
					periodicalConflict = conflict;
					breakLoop = true;
				} else if (isMatchOf(match, "Periodical")) {
					titleConflict = conflict;
					breakLoop = true;
				} else if (isMatchOf(match, "Person")) {
					lastNameConflict = conflict;
					breakLoop = true;
				} else if (isMatchOf(match, "BookOnTape")) {
					readerConflict = conflict;
					breakLoop = true;
				} else if (isMatchOf(match, "minutesLength")) {
					minutesLengthConflict = conflict;
					breakLoop = true;
				}
				if (breakLoop) {
					break;
				}
			}
		}

		assertNotNull(periodicalConflict);
		assertNotNull(titleConflict);
		assertNotNull(lastNameConflict);
		assertNotNull(minutesLengthConflict);
		assertNotNull(readerConflict);

		// These classic asserts will make the compiler happy.
		assert periodicalConflict != null;
		assert titleConflict != null;
		assert lastNameConflict != null;
		assert minutesLengthConflict != null;
		assert readerConflict != null;

		final List<Diff> periodicalDiffs = Lists.newArrayList(periodicalConflict.getDifferences());
		assertSame(ConflictKind.REAL, periodicalConflict.getKind());
		assertRemoved(periodicalDiffs, "extlibrary.Periodical", DifferenceSource.LEFT);
		assertAddedToReference(periodicalDiffs, "extlibrary.Periodical", "eSuperTypes",
				"extlibrary.TitledItem", DifferenceSource.RIGHT);
		assertAddedToReference(periodicalDiffs, "extlibrary.Magazine", "eSuperTypes",
				"extlibrary.Periodical", DifferenceSource.RIGHT);
		assertTrue(periodicalDiffs.isEmpty());

		final List<Diff> nameDiffs = Lists.newArrayList(lastNameConflict.getDifferences());
		assertSame(ConflictKind.REAL, lastNameConflict.getKind());
		assertRemoved(nameDiffs, "extlibrary.Person.lastName", DifferenceSource.LEFT);
		assertChangedAttribute(nameDiffs, "extlibrary.Person.familyName", "name", "lastName", "familyName",
				DifferenceSource.RIGHT);
		assertTrue(nameDiffs.isEmpty());

		final List<Diff> lengthDiffs = Lists.newArrayList(minutesLengthConflict.getDifferences());
		assertSame(ConflictKind.REAL, minutesLengthConflict.getKind());
		assertChangedAttribute(lengthDiffs, "extlibrary.AudioVisualItem.length", "name", "minutesLength",
				"length", DifferenceSource.LEFT);
		assertChangedAttribute(lengthDiffs, "extlibrary.AudioVisualItem.length", "name", "minutesLength",
				"minutes", DifferenceSource.RIGHT);
		assertTrue(lengthDiffs.isEmpty());

		final List<Diff> titleDiffs = Lists.newArrayList(titleConflict.getDifferences());
		assertSame(ConflictKind.PSEUDO, titleConflict.getKind());
		assertRemoved(titleDiffs, "extlibrary.Periodical.title", DifferenceSource.LEFT);
		assertChangedReference(titleDiffs, "extlibrary.Periodical.title", "eType", "ecore.EString", null,
				DifferenceSource.LEFT);
		assertChangedReference(titleDiffs, "extlibrary.Periodical.title", "eType", "ecore.EString", null,
				DifferenceSource.RIGHT);
		assertRemoved(titleDiffs, "extlibrary.Periodical.title", DifferenceSource.RIGHT);
		assertTrue(titleDiffs.isEmpty());

		final List<Diff> readerDiffs = Lists.newArrayList(readerConflict.getDifferences());
		assertSame(ConflictKind.PSEUDO, readerConflict.getKind());
		assertRemoved(readerDiffs, "extlibrary.BookOnTape.reader", DifferenceSource.LEFT);
		assertRemoved(readerDiffs, "extlibrary.BookOnTape.reader", DifferenceSource.RIGHT);
		assertChangedReference(readerDiffs, "extlibrary.BookOnTape.reader", "eType", "extlibrary.Person",
				null, DifferenceSource.LEFT);
		assertChangedReference(readerDiffs, "extlibrary.BookOnTape.reader", "eType", "extlibrary.Person",
				null, DifferenceSource.RIGHT);
		assertTrue(readerDiffs.isEmpty());
	}

	private boolean isMatchOf(Match match, String name) {
		boolean isMatch = false;
		if (match.getLeft() instanceof ENamedElement) {
			if (((ENamedElement)match.getLeft()).getName().equals(name)) {
				isMatch = true;
			}
		}
		if (!isMatch && match.getRight() instanceof ENamedElement) {
			if (((ENamedElement)match.getRight()).getName().equals(name)) {
				isMatch = true;
			}
		}
		if (!isMatch && match.getOrigin() instanceof ENamedElement) {
			if (((ENamedElement)match.getOrigin()).getName().equals(name)) {
				isMatch = true;
			}
		}
		return isMatch;
	}
}

Back to the top