org.evosuite.assertion.AssertionTraceObserver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evosuite-client Show documentation
The newest version!
/**
 * Copyright (C) 2010-2018 Gordon Fraser, Andrea Arcuri and EvoSuite
 * contributors
 *
 * This file is part of EvoSuite.
 *
 * EvoSuite is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3.0 of the License, or
 * (at your option) any later version.
 *
 * EvoSuite is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with EvoSuite. If not, see .
 */
/**
 * 
 */
package org.evosuite.assertion;

import java.util.Set;

import org.evosuite.testcase.statements.*;
import org.evosuite.testcase.variable.VariableReference;
import org.evosuite.testcase.execution.CodeUnderTestException;
import org.evosuite.testcase.execution.ExecutionObserver;
import org.evosuite.testcase.execution.ExecutionTracer;
import org.evosuite.testcase.execution.Scope;

import org.evosuite.Properties;
import org.evosuite.TestGenerationContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 
 * Abstract AssertionTraceObserver class.
 * 
 * 
 * @author Gordon Fraser
 */
public abstract class AssertionTraceObserver extends
        ExecutionObserver {

	/** Constant logger */
	protected static final Logger logger = LoggerFactory.getLogger(AssertionTraceObserver.class);

	protected OutputTrace trace = new OutputTrace();

	protected boolean checkThread() {
		return ExecutionTracer.isThreadNeqCurrentThread();
	}
	
	/* (non-Javadoc)
	 * @see org.evosuite.testcase.ExecutionObserver#output(int, java.lang.String)
	 */
	/** {@inheritDoc} */
	@Override
	public synchronized void output(int position, String output) {
		// Default behavior is to ignore console output

	}

	/**
	 * 
	 * visitDependencies
	 * 
	 * 
	 * @param statement
	 *            a {@link org.evosuite.testcase.statements.Statement} object.
	 * @param scope
	 *            a {@link org.evosuite.testcase.execution.Scope} object.
	 */
	protected void visitDependencies(Statement statement, Scope scope) {
		Set dependencies = currentTest.getDependencies(statement.getReturnValue());
		
		if(Properties.isRegression()){
			if (!hasCUT(statement, dependencies)){
				return;
			}
		}
		
		for (VariableReference var : dependencies) {
			if(var.isVoid())
				continue;
			// No assertions on mocked objects
			if(statement.getTestCase().getStatement(var.getStPosition()) instanceof FunctionalMockStatement)
				continue;
			if (!var.isVoid()) {
				try {
					visit(statement, scope, var);
				} catch (CodeUnderTestException e) {
					// ignore
				}
			}
		}
	}
	

	/**
	 * 
	 * visitReturnValue
	 * 
	 * 
	 * @param statement
	 *            a {@link org.evosuite.testcase.statements.Statement} object.
	 * @param scope
	 *            a {@link org.evosuite.testcase.execution.Scope} object.
	 */
	protected void visitReturnValue(Statement statement, Scope scope) {
		
		if(Properties.isRegression()){
			Set dependencies = currentTest.getDependencies(statement.getReturnValue());
			if (!hasCUT(statement, dependencies)){
				return;
			}
		}
		
		if (statement.getReturnClass().equals(void.class))
			return;
		
		// No need to assert anything about values just assigned
		if(statement.isAssignmentStatement())
			return;

		try {
			visit(statement, scope, statement.getReturnValue());
		} catch (CodeUnderTestException e) {
			// ignore
		}

	}
	
	
	/*
	 * Whether or not the target has the class under test.
	 * This is to avoid generating assertions for statements
	 * that are not assignable from the CUT.
	 */
	private boolean hasCUT(Statement statement, Set dependencies){
		boolean hasCUT = false;
		if (statement instanceof MethodStatement) {
			MethodStatement ms = (MethodStatement) statement;
			if (Properties
					.getTargetClassRegression(
							ms.getMethod().getDeclaringClass().getClassLoader() == TestGenerationContext.getInstance()
									.getClassLoaderForSUT()).isAssignableFrom(
							ms.getMethod().getDeclaringClass()))
				hasCUT = true;
		}
		for (VariableReference var : dependencies) {
			if (Properties
					.getTargetClassRegression(
							var.getVariableClass().getClassLoader() == TestGenerationContext.getInstance()
									.getClassLoaderForSUT()).isAssignableFrom(
							var.getVariableClass())) {
				hasCUT = true;
				break;
			}
		}
		return hasCUT;
	}

	/**
	 * 
	 * visit
	 * 
	 * 
	 * @param statement
	 *            a {@link org.evosuite.testcase.statements.Statement} object.
	 * @param scope
	 *            a {@link org.evosuite.testcase.execution.Scope} object.
	 * @param var
	 *            a {@link org.evosuite.testcase.variable.VariableReference} object.
	 */
	protected abstract void visit(Statement statement, Scope scope,
	        VariableReference var) throws CodeUnderTestException;

	/* (non-Javadoc)
	 * @see org.evosuite.testcase.ExecutionObserver#statement(org.evosuite.testcase.StatementInterface, org.evosuite.testcase.Scope, java.lang.Throwable)
	 */
	/** {@inheritDoc} */
	@Override
	public synchronized void afterStatement(Statement statement, Scope scope,
	        Throwable exception) {
		//if(checkThread())
		//	return;
		
		// No assertions are created for mock statements
		if(statement instanceof FunctionalMockStatement)
			return;

        // No assertions for primitives
        if(statement instanceof PrimitiveStatement)
            return;


        // By default, no assertions are created for statements that threw exceptions
		if(exception != null)
			return;

		if(statement instanceof FieldStatement) {
			// Only need to check returnvalue here, nothing else can have changed
			visitReturnValue(statement, scope);
		}
		else {
			visitDependencies(statement, scope);
		}
	}

	/* (non-Javadoc)
	 * @see org.evosuite.testcase.ExecutionObserver#beforeStatement(org.evosuite.testcase.StatementInterface, org.evosuite.testcase.Scope)
	 */
	@Override
	public synchronized void beforeStatement(Statement statement, Scope scope) {
		// Do nothing
	}

	/* (non-Javadoc)
	 * @see org.evosuite.testcase.ExecutionObserver#clear()
	 */
	/** {@inheritDoc} */
	@Override
	public synchronized void clear() {
		//if(!checkThread())
		//	return;

		trace.clear();
	}

	/**
	 * 
	 * Getter for the field trace.
	 * 
	 * 
	 * @return a {@link org.evosuite.assertion.OutputTrace} object.
	 */
	public synchronized OutputTrace getTrace() {
		return trace.clone();
	}

}