query/tests/org.eclipse.acceleo.query.tests/src/org/eclipse/acceleo/query/runtime/test/EvaluationServiceStatusTests.java

/*******************************************************************************
 * Copyright (c) 2015 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.acceleo.query.runtime.test;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import org.eclipse.acceleo.query.parser.AstBuilderListener;
import org.eclipse.acceleo.query.runtime.AcceleoQueryEvaluationException;
import org.eclipse.acceleo.query.runtime.IService;
import org.eclipse.acceleo.query.runtime.Query;
import org.eclipse.acceleo.query.runtime.ServiceUtils;
import org.eclipse.acceleo.query.runtime.impl.EvaluationServices;
import org.eclipse.acceleo.query.runtime.impl.QueryEnvironment;
import org.eclipse.acceleo.query.runtime.lookup.basic.BasicLookupEngine;
import org.eclipse.emf.common.util.BasicDiagnostic;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.ecore.EAttribute;
import org.eclipse.emf.ecore.EcorePackage;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.junit.Before;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

public class EvaluationServiceStatusTests {

	private static final String NON_EOBJECT_FEATURE_ACCESS = "Couldn't find the aqlFeatureAccess(java.lang.Integer,java.lang.String) service";

	private static final String SERVICE_NOT_FOUND = "Couldn't find the noservice(java.lang.Integer) service";

	private static final String VARIABLE_NOT_FOUND = "Couldn't find the novariable variable";

	private static final String UNKNOWN_FEATURE = "Feature noname not found in EClass EAttribute";

	Map<String, Object> variables;

	BasicLookupEngine engine;

	QueryEnvironment queryEnvironment;

	EvaluationServices services;

	@Before
	public void setup() {
		queryEnvironment = (QueryEnvironment)Query.newEnvironmentWithDefaultServices(null);
		engine = queryEnvironment.getLookupEngine();
		final Set<IService> servicesToRegister = ServiceUtils.getServices(queryEnvironment,
				TestServiceDefinition.class);
		ServiceUtils.registerServices(queryEnvironment, servicesToRegister);
		variables = new HashMap<String, Object>();
		variables.put("x", 1);
		variables.put("y", 2);
		services = new EvaluationServices(queryEnvironment);
	}

	/**
	 * Tests that, when an unknown variable is accessed, an error is emitted with the following message :
	 */
	@Test
	public void variableNotFoundStatusTest() {
		Diagnostic status = new BasicDiagnostic();
		services.getVariableValue(variables, "novariable", status);

		assertEquals(Diagnostic.ERROR, status.getSeverity());
		assertEquals(1, status.getChildren().size());

		Diagnostic child = status.getChildren().iterator().next();
		assertEquals(Diagnostic.ERROR, child.getSeverity());
		assertEquals(VARIABLE_NOT_FOUND, child.getMessage());
		assertNull(child.getException());
	}

	@Test
	public void featureNotFoundStatusTest() {
		EAttribute attribute = (EAttribute)EcoreUtil.create(EcorePackage.Literals.EATTRIBUTE);
		attribute.setName("attr0");

		Diagnostic status = new BasicDiagnostic();
		services.call(AstBuilderListener.FEATURE_ACCESS_SERVICE_NAME, new Object[] {attribute, "noname" },
				status);

		assertEquals(Diagnostic.WARNING, status.getSeverity());
		assertEquals(1, status.getChildren().size());

		Diagnostic child = status.getChildren().iterator().next();
		assertTrue(child.getMessage().endsWith("\n\t" + UNKNOWN_FEATURE));
		assertTrue(child.getException().getMessage().endsWith("\n\t" + UNKNOWN_FEATURE));
	}

	@Test
	public void featureAccessOnObjectStatusTest() {
		Diagnostic status = new BasicDiagnostic();
		services.call(AstBuilderListener.FEATURE_ACCESS_SERVICE_NAME, new Object[] {new Integer(1),
				"containment" }, status);

		assertEquals(Diagnostic.WARNING, status.getSeverity());
		assertEquals(1, status.getChildren().size());

		Diagnostic child = status.getChildren().iterator().next();
		assertEquals(NON_EOBJECT_FEATURE_ACCESS, child.getMessage());
		assertNull(child.getException());
	}

	@Test
	public void serviceNotFoundStatusTest() {
		Diagnostic status = new BasicDiagnostic();
		services.call("noservice", new Object[] {1 }, status);

		assertEquals(Diagnostic.WARNING, status.getSeverity());
		assertEquals(1, status.getChildren().size());

		Diagnostic child = status.getChildren().iterator().next();
		assertEquals(SERVICE_NOT_FOUND, child.getMessage());
		assertNull(child.getException());
	}

	@Test
	public void serviceReturnsNullStatusTest() {
		Diagnostic status = new BasicDiagnostic();
		services.call("serviceReturnsNull", new Object[] {1 }, status);

		assertEquals(Diagnostic.OK, status.getSeverity());
		assertEquals(0, status.getChildren().size());
	}

	@Test
	public void serviceThrowsExceptionStatusTest() {
		Diagnostic status = new BasicDiagnostic();
		services.call("serviceThrowsException", new Object[] {1 }, status);

		// TODO shouldn't this be an error level?
		assertEquals(Diagnostic.WARNING, status.getSeverity());
		assertEquals(1, status.getChildren().size());

		Diagnostic child = status.getChildren().iterator().next();
		assertEquals(
				"serviceThrowsException(java.lang.Object) with arguments [1] failed:\n\tThis is the purpose of this service.",
				child.getMessage());
		assertTrue(child.getException() instanceof AcceleoQueryEvaluationException);
		assertTrue(child.getException().getCause() instanceof NullPointerException);
		assertEquals("This is the purpose of this service.", child.getException().getCause().getMessage());
	}
}