tests/org.eclipse.emf.edapt.tests/src/org/eclipse/emf/edapt/tests/history/LifecycleTestBase.java

/*******************************************************************************
 * Copyright (c) 2007, 2010 BMW Car IT, Technische Universitaet Muenchen, and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 * BMW Car IT - Initial API and implementation
 * Technische Universitaet Muenchen - Major refactoring and extension
 *******************************************************************************/
package org.eclipse.emf.edapt.tests.history;

import java.io.IOException;
import java.util.Collections;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.edapt.history.reconstruction.EcoreForwardReconstructor;
import org.eclipse.emf.edapt.history.reconstruction.IntegrityChecker;
import org.eclipse.emf.edapt.history.reconstruction.Mapping;
import org.eclipse.emf.edapt.history.recorder.EditingDomainListener;
import org.eclipse.emf.edapt.history.util.HistoryUtils;
import org.eclipse.emf.edapt.internal.common.FileUtils;
import org.eclipse.emf.edapt.internal.common.ResourceUtils;
import org.eclipse.emf.edapt.internal.common.URIUtils;
import org.eclipse.emf.edapt.internal.migration.execution.internal.ClassLoaderFacade;
import org.eclipse.emf.edapt.migration.execution.MigratorRegistry;
import org.eclipse.emf.edapt.migration.test.MigrationTestBase;
import org.eclipse.emf.edapt.spi.history.History;
import org.eclipse.emf.edapt.spi.history.HistoryPackage;
import org.eclipse.emf.edapt.tests.util.TestUtils;
import org.eclipse.emf.edit.domain.EditingDomain;

import junit.framework.Assert;

/**
 * Test the full life cycle of coupled evolution: recording, migrator
 * generation, migration
 *
 * @author herrmama
 * @author $Author$
 * @version $Rev$
 * @levd.rating RED Rev:
 */
@SuppressWarnings({ "restriction", "deprecation" })
public abstract class LifecycleTestBase extends MigrationTestBase {

	/**
	 * Context URI
	 */
	private URI contextURI;

	/**
	 * URI for temporary content
	 */
	private URI tempURI;

	/**
	 * Identifier of the example
	 */
	private String id;

	/** Test the full lifecycle of Edapt. */
	protected void testLifecycle(String id) throws Exception {
		testLifecycle(id, 0);
	}

	/** Test the full lifecyle of Edapt. */
	protected void testLifecycle(String id, int expectedDifferences)
		throws Exception {
		this.id = id;
		prepare();
		checkRecording();
		checkMigration(expectedDifferences);
	}

	/**
	 * Delete old stuff
	 */
	private void prepare() {

		contextURI = URIUtils.getURI("data/" + id); //$NON-NLS-1$
		tempURI = contextURI.appendSegment("temp"); //$NON-NLS-1$

		FileUtils.deleteContents(URIUtils.getJavaFile(tempURI));
	}

	/**
	 * Test recording of changes to the history
	 */
	private void checkRecording() throws IOException {

		final History history = loadHistory();
		final EcoreForwardReconstructor reconstructor = reconstructSourceRelease(history);
		final EditingDomain editingDomain = TestUtils
			.createEditingDomain(reconstructor.getResourceSet());
		final EditingDomainListener listener = initRecorder(editingDomain);
		interpretHistory(history, reconstructor.getMapping(), listener);
	}

	/**
	 * load history
	 */
	private History loadHistory() throws IOException {
		HistoryPackage.eINSTANCE.getAdd();

		final URI historyURI = contextURI.appendSegment(id).appendFileExtension(
			HistoryUtils.HISTORY_FILE_EXTENSION);
		final History history = (History) ResourceUtils.loadResourceSet(historyURI)
			.getResources().get(0).getContents().get(0);
		return history;
	}

	/**
	 * reconstruct source release
	 */
	private EcoreForwardReconstructor reconstructSourceRelease(History history) {
		final EcoreForwardReconstructor reconstructor = new EcoreForwardReconstructor(
			tempURI);
		reconstructor.reconstruct(history.getFirstRelease(), false);

		final ResourceSet resourceSet = history.eResource().getResourceSet();
		for (final Resource resource : resourceSet.getResources()) {
			if (resource == HistoryUtils.getRootResource(resourceSet)
				|| resource == HistoryUtils.getHistoryResource(resourceSet)) {
				continue;
			}
			reconstructor.getResourceSet().getResources().add(resource);
		}
		return reconstructor;
	}

	/**
	 * init recorder
	 */
	private EditingDomainListener initRecorder(EditingDomain editingDomain) {
		final EditingDomainListener listener = new EditingDomainListener(
			editingDomain);
		listener.createHistory(Collections.singletonList(editingDomain
			.getResourceSet().getResources().get(0)));
		final IntegrityChecker checker = new IntegrityChecker(listener.getHistory());
		Assert.assertTrue(checker.check());
		listener.beginListening();
		return listener;
	}

	/**
	 * interpret history until target release
	 */
	private void interpretHistory(History history, Mapping mapping,
		EditingDomainListener listener) throws IOException {
		final EditingDomain domain = listener.getEditingDomain();
		final EcoreForwardReconstructor reconstructor = new EcoreForwardReconstructor(
			URI.createFileURI("test")); //$NON-NLS-1$
		reconstructor
			.addReconstructor(new HistoryInterpreter(listener, mapping));
		reconstructor.reconstruct(history.getLastRelease(), false);

		ResourceUtils.saveResourceSet(domain.getResourceSet(), null);

		Assert.assertTrue(new IntegrityChecker(listener.getHistory()).check());
	}

	/**
	 * Test the migration of a model
	 */
	private void checkMigration(int expectedDifferences) throws Exception {

		final URI sourceModelURI = contextURI.appendSegment(id + "_r0") //$NON-NLS-1$
			.appendFileExtension("xmi"); //$NON-NLS-1$
		final URI expectedTargetModelURI = contextURI.appendSegment(id + "_r1") //$NON-NLS-1$
			.appendFileExtension("xmi"); //$NON-NLS-1$
		final URI expectedTargetMetamodelURI = contextURI.appendSegment(id)
			.appendFileExtension(ResourceUtils.ECORE_FILE_EXTENSION);

		final URI historyURI = contextURI.appendSegment(id).appendFileExtension(
			HistoryUtils.HISTORY_FILE_EXTENSION);
		final ClassLoaderFacade loader = new ClassLoaderFacade(
			LifecycleTestBase.class.getClassLoader());
		MigratorRegistry.getInstance().registerMigrator(historyURI, loader);

		testMigration(sourceModelURI, expectedTargetModelURI,
			expectedTargetMetamodelURI, expectedDifferences);
	}
}