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

Go to download
/**
 * 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.net.URL;
import java.util.List;
import java.util.concurrent.TimeoutException;
import java.util.regex.Pattern;

import org.evosuite.Properties;
import org.evosuite.runtime.mock.EvoSuiteMock;
import org.evosuite.testcase.statements.Statement;
import org.evosuite.testcase.variable.VariableReference;
import org.evosuite.testcase.execution.ExecutionResult;
import org.evosuite.testcase.execution.Scope;
import org.evosuite.testcase.statements.ConstructorStatement;
import org.evosuite.testcase.statements.PrimitiveStatement;

public class InspectorTraceObserver extends AssertionTraceObserver {

	private static Pattern addressPattern = Pattern.compile(".*[\\w+\\.]+@[abcdef\\d]+.*", Pattern.MULTILINE);
	

	/* (non-Javadoc)
	 * @see org.evosuite.assertion.AssertionTraceObserver#visit(org.evosuite.testcase.StatementInterface, org.evosuite.testcase.Scope, org.evosuite.testcase.VariableReference)
	 */
	/** {@inheritDoc} */
	@Override
	protected void visit(Statement statement, Scope scope, VariableReference var) {
		// TODO: Check the variable class is complex?

		// We don't want inspector checks on string constants
		Statement declaringStatement = currentTest.getStatement(var.getStPosition());
		if (declaringStatement instanceof PrimitiveStatement)
			return;
		
		if(statement.isAssignmentStatement() && statement.getReturnValue().isArrayIndex())
			return;
		
		if(statement instanceof ConstructorStatement) {
			if(statement.getReturnValue().isWrapperType() || statement.getReturnValue().isAssignableTo(EvoSuiteMock.class))
				return;
		}

		if (var.isPrimitive() || var.isString() || var.isWrapperType())
			return;

		logger.debug("Checking for inspectors of " + var + " at statement "
		        + statement.getPosition());
		List inspectors = InspectorManager.getInstance().getInspectors(var.getVariableClass());

		InspectorTraceEntry entry = new InspectorTraceEntry(var);

		for (Inspector i : inspectors) {

			// No inspectors from java.lang.Object
			if (i.getMethod().getDeclaringClass().equals(Object.class))
				continue;

			try {
				Object target = var.getObject(scope);
				if (target != null) {

					// Don't call inspector methods on mock objects
					if(target.getClass().getCanonicalName().contains("EnhancerByMockito"))
						return;

					Object value = i.getValue(target);
					logger.debug("Inspector " + i.getMethodCall() + " is: " + value);

					// We need no assertions that include the memory location
					if (value instanceof String) {
						// String literals may not be longer than 32767
						if(((String)value).length() >= 32767)
							continue;

						// Maximum length of strings we look at
						if(((String)value).length() > Properties.MAX_STRING)
							continue;

						// If we suspect an Object hashCode not use this, as it may lead to flaky tests
						if(addressPattern.matcher((String)value).find())
							continue;
						// The word "hashCode" is also suspicious
						if(((String)value).toLowerCase().contains("hashcode"))
							continue;
						// Avoid asserting anything on values referring to mockito proxy objects
						if(((String)value).toLowerCase().contains("EnhancerByMockito"))
							continue;
						if(((String)value).toLowerCase().contains("$MockitoMock$"))
							continue;

						if(target instanceof URL) {
							// Absolute paths may be different between executions
							if(((String) value).startsWith("/") || ((String) value).startsWith("file:/"))
								continue;
						}
					}

					entry.addValue(i, value);
				}
			} catch (Exception e) {
				if (e instanceof TimeoutException) {
					logger.debug("Timeout during inspector call - deactivating inspector "
					        + i.getMethodCall());
					InspectorManager.getInstance().removeInspector(var.getVariableClass(), i);
				}
				logger.debug("Exception " + e + " / " + e.getCause());
				if (e.getCause() != null
				        && !e.getCause().getClass().equals(NullPointerException.class)) {
					logger.debug("Exception during call to inspector: " + e + " - "
					        + e.getCause());
				}
			}
		}
		logger.debug("Found " + entry.size() + " inspectors for " + var
		        + " at statement " + statement.getPosition());

		trace.addEntry(statement.getPosition(), var, entry);

	}

	@Override
	public void testExecutionFinished(ExecutionResult r, Scope s) {
		// do nothing
	}
}