org.evosuite.coverage.io.output.OutputCoverageFactory 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.coverage.io.output;

import static org.evosuite.coverage.io.IOCoverageConstants.ARRAY_EMPTY;
import static org.evosuite.coverage.io.IOCoverageConstants.ARRAY_NONEMPTY;
import static org.evosuite.coverage.io.IOCoverageConstants.BOOL_FALSE;
import static org.evosuite.coverage.io.IOCoverageConstants.BOOL_TRUE;
import static org.evosuite.coverage.io.IOCoverageConstants.CHAR_ALPHA;
import static org.evosuite.coverage.io.IOCoverageConstants.CHAR_DIGIT;
import static org.evosuite.coverage.io.IOCoverageConstants.CHAR_OTHER;
import static org.evosuite.coverage.io.IOCoverageConstants.NUM_NEGATIVE;
import static org.evosuite.coverage.io.IOCoverageConstants.NUM_POSITIVE;
import static org.evosuite.coverage.io.IOCoverageConstants.NUM_ZERO;
import static org.evosuite.coverage.io.IOCoverageConstants.REF_NONNULL;
import static org.evosuite.coverage.io.IOCoverageConstants.REF_NULL;
import static org.evosuite.coverage.io.IOCoverageConstants.STRING_EMPTY;
import static org.evosuite.coverage.io.IOCoverageConstants.STRING_NONEMPTY;

import org.evosuite.Properties;
import org.evosuite.TestGenerationContext;
import org.evosuite.assertion.CheapPurityAnalyzer;
import org.evosuite.assertion.Inspector;
import org.evosuite.assertion.InspectorManager;
import org.evosuite.coverage.MethodNameMatcher;
import org.evosuite.graphs.cfg.BytecodeInstructionPool;
import org.evosuite.setup.TestClusterUtils;
import org.evosuite.setup.TestUsageChecker;
import org.evosuite.testsuite.AbstractFitnessFactory;
import org.objectweb.asm.Type;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * @author Jose Miguel Rojas
 */
public class OutputCoverageFactory extends AbstractFitnessFactory {

    private static final Logger logger = LoggerFactory.getLogger(OutputCoverageFactory.class);

    /*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.evosuite.coverage.TestCoverageFactory#getCoverageGoals()
	 */

    /**
     * {@inheritDoc}
     */
    @Override
    public List getCoverageGoals() {
        List goals = new ArrayList();

        long start = System.currentTimeMillis();
        String targetClass = Properties.TARGET_CLASS;

        final MethodNameMatcher matcher = new MethodNameMatcher();
        for (String className : BytecodeInstructionPool.getInstance(TestGenerationContext.getInstance().getClassLoaderForSUT()).knownClasses()) {
            if (!(targetClass.equals("") || className.endsWith(targetClass)))
                continue;

            for (Method method : TestClusterUtils.getClass(className).getDeclaredMethods()) {
                String methodName = method.getName() + Type.getMethodDescriptor(method);
                if (!TestUsageChecker.canUse(method) || !matcher.methodMatches(methodName) || methodName.equals("hashCode()I"))
                    continue;
                logger.info("Adding goals for method " + className + "." + methodName);
                Type returnType = Type.getReturnType(method);

                switch (returnType.getSort()) {
                    case Type.BOOLEAN:
                        goals.add(createGoal(className, methodName, returnType, BOOL_TRUE));
                        goals.add(createGoal(className, methodName, returnType, BOOL_FALSE));
                        break;
                    case Type.CHAR:
                        goals.add(createGoal(className, methodName, returnType, CHAR_ALPHA));
                        goals.add(createGoal(className, methodName, returnType, CHAR_DIGIT));
                        goals.add(createGoal(className, methodName, returnType, CHAR_OTHER));
                        break;
                    case Type.BYTE:
                    case Type.SHORT:
                    case Type.INT:
                    case Type.FLOAT:
                    case Type.LONG:
                    case Type.DOUBLE:
                        goals.add(createGoal(className, methodName, returnType, NUM_NEGATIVE));
                        goals.add(createGoal(className, methodName, returnType, NUM_ZERO));
                        goals.add(createGoal(className, methodName, returnType, NUM_POSITIVE));
                        break;
                    case Type.ARRAY:
                        goals.add(createGoal(className, methodName, returnType, REF_NULL));
                        goals.add(createGoal(className, methodName, returnType, ARRAY_EMPTY));
                        goals.add(createGoal(className, methodName, returnType, ARRAY_NONEMPTY));
                        break;
                    case Type.OBJECT:
                        goals.add(createGoal(className, methodName, returnType, REF_NULL));
                        //goals.add(new OutputCoverageTestFitness(new OutputCoverageGoal(className, methodName, returnType.toString(), REF_NONNULL)));
                        if (returnType.getClassName().equals("java.lang.String")) {
                            goals.add(createGoal(className, methodName, returnType, STRING_EMPTY));
                            goals.add(createGoal(className, methodName, returnType, STRING_NONEMPTY));
                            break;
                        }
                        boolean observerGoalsAdded = false;
                        Class returnClazz = method.getReturnType();
                        for(Inspector inspector : InspectorManager.getInstance().getInspectors(returnClazz)) {
                            String insp = inspector.getMethodCall() + Type.getMethodDescriptor(inspector.getMethod());
                            Type t = Type.getReturnType(inspector.getMethod());
                            if (t.getSort() == Type.BOOLEAN) {
                                goals.add(createGoal(className, methodName, returnType, REF_NONNULL + ":" + returnType.getClassName() + ":" + insp + ":" + BOOL_TRUE));
                                goals.add(createGoal(className, methodName, returnType, REF_NONNULL + ":" + returnType.getClassName() + ":" + insp + ":" + BOOL_FALSE));
                                observerGoalsAdded = true;
                            } else if (Arrays.asList(new Integer[]{Type.BYTE, Type.SHORT, Type.INT, Type.FLOAT, Type.LONG, Type.DOUBLE}).contains(t.getSort())) {
                                goals.add(createGoal(className, methodName, returnType, REF_NONNULL + ":" + returnType.getClassName() + ":" + insp + ":" + NUM_NEGATIVE));
                                goals.add(createGoal(className, methodName, returnType, REF_NONNULL + ":" + returnType.getClassName() + ":" + insp + ":" + NUM_ZERO));
                                goals.add(createGoal(className, methodName, returnType, REF_NONNULL + ":" + returnType.getClassName() + ":" + insp + ":" + NUM_POSITIVE));
                                observerGoalsAdded = true;
                            }
                        }
                        if (!observerGoalsAdded)
                            goals.add(createGoal(className, methodName, returnType, REF_NONNULL));
                        break;
                    default:
                        // Ignore
                        // TODO: what to do with the sort for METHOD?
                        break;
                }
            }
        }
        goalComputationTime = System.currentTimeMillis() - start;
        return goals;
    }

    public static OutputCoverageTestFitness createGoal(String className, String methodName, Type returnType, String suffix) {
        return new OutputCoverageTestFitness(new OutputCoverageGoal(className, methodName, returnType, suffix));
    }

    /**
     * Returns list of inspector methods in a given class.
     * An inspector is a cheap-pure method with no arguments.
     *
     * @param className A class name
     */
    public static List getInspectors(String className) {
        List pureMethods = CheapPurityAnalyzer.getInstance().getPureMethods(className);
        List inspectors = new ArrayList<>();
        for (String pm : pureMethods) {
            if ((Type.getArgumentTypes(pm.substring(pm.indexOf('('))).length == 0) &&
                    ! (pm.substring(0, pm.indexOf("(")).equals("")))
                inspectors.add(pm);
        }
        return inspectors;
    }
}