org.evosuite.coverage.dataflow.DefUseCoverageTestFitness Maven / Gradle / Ivy
/**
* 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 singleFitnessTime=0l */
public static long singleFitnessTime = 0l;
// debugging flags
private final static boolean DEBUG = Properties.DEFUSE_DEBUG_MODE;
private final static boolean PRINT_DEBUG = false;
// the Definition-Use pair
private String goalVariable;
private transient Use goalUse;
private transient Definition goalDefinition;
private DefUsePairType type;
private TestFitnessFunction goalDefinitionFitness;
private TestFitnessFunction goalUseFitness;
// coverage information
private Integer coveringObjectId = -1;
private transient ExecutionTrace coveringTrace = null;
private boolean covered = false;
// constructors
/**
* Creates a Definition-Use-Coverage goal for the given Definition and Use
*
* @param def
* a {@link org.evosuite.coverage.dataflow.Definition} object.
* @param use
* a {@link org.evosuite.coverage.dataflow.Use} object.
* @param type
* a
* {@link org.evosuite.coverage.dataflow.DefUseCoverageTestFitness.DefUsePairType}
* object.
*/
public DefUseCoverageTestFitness(Definition def, Use use, DefUsePairType type) {
if (def == null)
throw new IllegalArgumentException("null given for definition. type: "
+ type.toString());
if (use == null)
throw new IllegalArgumentException("null given for use. def was "
+ def.toString() + ". type: " + type.toString());
initRegularDefUse(def, use, type);
}
/**
* Used for Parameter-Uses
*
* Creates a goal that tries to cover the given Use
*
* @param use
* a {@link org.evosuite.coverage.dataflow.Use} object.
*/
public DefUseCoverageTestFitness(Use use) {
if (!use.isParameterUse())
throw new IllegalArgumentException(
"this constructor is only for Parameter-Uses");
initParameterUse(use);
}
private void initRegularDefUse(Definition def, Use use, DefUsePairType type) {
//if (!def.getVariableName().equals(use.getVariableName()))
// throw new IllegalArgumentException(
// "expect def and use to be for the same variable: \n" + def.toString()
// + "\n" + use.toString());
if (def.isLocalDU() && !type.equals(DefUsePairType.INTRA_METHOD))
throw new IllegalArgumentException(
"local variables can only be part of INTRA-METHOD pairs: \ntype:"
+ type.toString() + "\ndef:" + def.toString() + "\nuse:"
+ use.toString());
this.goalDefinition = def;
this.goalUse = use;
this.goalVariable = def.getVariableName();
this.goalDefinitionFitness = new StatementCoverageTestFitness(goalDefinition.getClassName(), goalDefinition.getMethodName(), goalDefinition.getInstructionId());
this.goalUseFitness = new StatementCoverageTestFitness(goalUse.getClassName(), goalUse.getMethodName(), goalUse.getInstructionId());
this.type = type;
}
private void initParameterUse(Use use) {
goalVariable = use.getVariableName();
goalDefinition = null;
goalDefinitionFitness = null;
goalUse = use;
goalUseFitness = new StatementCoverageTestFitness(goalUse.getClassName(), goalUse.getMethodName(), goalUse.getInstructionId());
this.type = DefUsePairType.PARAMETER;
}
/**
* {@inheritDoc}
*
* Calculates the DefUseCoverage test fitness for this goal
*
* Look at DefUseCoverageCalculations.calculateDUFitness() for more
* information
*/
@Override
public double getFitness(TestChromosome individual, ExecutionResult result) {
preFitnessDebugInfo(result, true);
long start = System.currentTimeMillis();
DefUseFitnessCalculator calculator = new DefUseFitnessCalculator(this,
individual, result);
// Deactivate coverage archive while measuring fitness, as auxiliar fitness functions
// could attempt to claim coverage for it in the archive
boolean archive = Properties.TEST_ARCHIVE;
Properties.TEST_ARCHIVE = false;
double fitness = calculator.calculateDUFitness();
Properties.TEST_ARCHIVE = archive;
if (ArrayUtil.contains(Properties.CRITERION, Criterion.DEFUSE) && fitness == 0.0)
setCovered(individual, result.getTrace(), -1); // TODO objectId wrong
postFitnessDebugInfo(individual, result, fitness);
singleFitnessTime += System.currentTimeMillis() - start;
updateIndividual(this, individual, fitness);
return fitness;
}
/**
* Used by DefUseCoverageSuiteFitness
*
* Simply call getFitness(TestChromosome,ExecutionResult) with a dummy
* TestChromosome The chromosome is used only for updateIndividual()
* anyways.
*
* @param result
* a {@link org.evosuite.testcase.execution.ExecutionResult} object.
* @return a double.
*/
public double getFitness(ExecutionResult result) {
TestChromosome dummy = new TestChromosome();
return getFitness(dummy, result);
}
public boolean isAlias() {
return goalDefinition != null ? !goalUse.getVariableName().equals(goalDefinition.getVariableName())
: false;
}
/**
* Returns the definitions to the goalVaraible coming after the
* goalDefinition and before the goalUse in their respective methods
*
* @return a {@link java.util.Set} object.
*/
public Set getPotentialOverwritingDefinitions() {
Set instructionsInBetween = getInstructionsInBetweenDU();
if (goalDefinition != null)
return DefUseExecutionTraceAnalyzer.getOverwritingDefinitionsIn(goalDefinition,
instructionsInBetween);
else
return DefUseExecutionTraceAnalyzer.getDefinitionsIn(goalVariable,
instructionsInBetween);
}
/**
* Return a set containing all CFGVertices that occur in the complete CFG
* after the goalDefinition and before the goalUse.
*
* It's pretty much the union of getInstructionsAfterGoalDefinition() and
* getInstructionsBeforeGoalUse(), except if the DU is in one method and the
* goalDefinition comes before the goalUse, then the intersection of the two
* sets is returned.
*
* If the goalDefinition is a Parameter-Definition only the CFGVertices
* before the goalUse are considered.
*
* @return a {@link java.util.Set} object.
*/
public Set getInstructionsInBetweenDU() {
Set previousInstructions = getInstructionsBeforeGoalUse();
if (goalDefinition != null) {
Set laterInstructions = getInstructionsAfterGoalDefinition();
if (goalDefinition.getInstructionId() < goalUse.getInstructionId()
&& goalDefinition.getMethodName().equals(goalUse.getMethodName())) {
// they are in the same method and definition comes before use => intersect sets
previousInstructions.retainAll(laterInstructions);
} else {
// otherwise take the union
previousInstructions.addAll(laterInstructions);
}
}
return previousInstructions;
}
/**
* Returns a set containing all CFGVertices in the goal definition method
* that come after the definition.
*
* Look at ControlFlowGraph.getLaterInstructionInMethod() for details
*
* @return a {@link java.util.Set} object.
*/
public Set getInstructionsAfterGoalDefinition() {
RawControlFlowGraph cfg = GraphPool.getInstance(TestGenerationContext.getInstance().getClassLoaderForSUT()).getRawCFG(goalDefinition.getClassName(),
goalDefinition.getMethodName());
BytecodeInstruction defVertex = cfg.getInstruction(goalDefinition.getInstructionId());
Set r = cfg.getLaterInstructionsInMethod(defVertex);
// for (BytecodeInstruction v : r) {
// v.setMethodName(goalDefinition.getMethodName());
// v.setClassName(goalDefinition.getClassName());
// }
return r;
}
/**
* Returns a set containing all CFGVertices in the goal use method that come
* before the goal use.
*
* Look at ControlFlowGraph.getPreviousInstructionInMethod() for details
*
* @return a {@link java.util.Set} object.
*/
public Set getInstructionsBeforeGoalUse() {
RawControlFlowGraph cfg = GraphPool.getInstance(TestGenerationContext.getInstance().getClassLoaderForSUT()).getRawCFG(goalUse.getClassName(),
goalUse.getMethodName());
BytecodeInstruction useVertex = cfg.getInstruction(goalUse.getInstructionId());
Set r = cfg.getPreviousInstructionsInMethod(useVertex);
// for (BytecodeInstruction v : r) {
// v.setMethodName(goalUse.getMethodName());
// v.setClassName(goalUse.getClassName());
// }
return r;
}
// debugging methods
/**
*
* setCovered
*
*
* @param individual
* a {@link org.evosuite.ga.Chromosome} object.
* @param trace
* a {@link org.evosuite.testcase.execution.ExecutionTrace} object.
* @param objectId
* a {@link java.lang.Integer} object.
*/
public void setCovered(TestChromosome individual, ExecutionTrace trace,
Integer objectId) {
if (PRINT_DEBUG) {
logger.debug("goal COVERED by object " + objectId);
logger.debug("==============================================================");
}
this.coveringObjectId = objectId;
updateIndividual(this, individual, 0);
if (DEBUG)
if (!DefUseFitnessCalculator.traceCoversGoal(this, individual, trace))
throw new IllegalStateException("calculation flawed. goal wasn't covered");
}
private void preFitnessDebugInfo(ExecutionResult result, boolean respectPrintFlag) {
if (PRINT_DEBUG || !respectPrintFlag) {
System.out.println("==============================================================");
System.out.println("current goal: " + toString());
System.out.println("current test:");
System.out.println(result.test.toCode());
}
}
private void postFitnessDebugInfo(Chromosome individual, ExecutionResult result,
double fitness) {
if (DEBUG) {
if (fitness != 0) {
if (PRINT_DEBUG) {
System.out.println("goal NOT COVERED. fitness: " + fitness);
System.out.println("==============================================================");
}
if (DefUseFitnessCalculator.traceCoversGoal(this, individual,
result.getTrace()))
throw new IllegalStateException(
"calculation flawed. goal was covered but fitness was "
+ fitness);
}
}
}
// --- Getter ---
/**
*
* Getter for the field coveringTrace.
*
*
* @return a {@link org.evosuite.testcase.execution.ExecutionTrace} object.
*/
public ExecutionTrace getCoveringTrace() {
return coveringTrace;
}
/**
*
* Getter for the field goalVariable.
*
*
* @return a {@link java.lang.String} object.
*/
public String getGoalVariable() {
return goalVariable;
}
/**
*
* Getter for the field coveringObjectId.
*
*
* @return a int.
*/
public int getCoveringObjectId() {
return coveringObjectId;
}
/**
*
* Getter for the field goalDefinition.
*
*
* @return a {@link org.evosuite.coverage.dataflow.Definition} object.
*/
public Definition getGoalDefinition() {
return goalDefinition;
}
/**
*
* Getter for the field goalUse.
*
*
* @return a {@link org.evosuite.coverage.dataflow.Use} object.
*/
public Use getGoalUse() {
return goalUse;
}
/**
*
* Getter for the field goalUseFitness.
*
*
* @return a {@link org.evosuite.testcase.TestFitnessFunction} object.
*/
public TestFitnessFunction getGoalUseFitness() {
return goalUseFitness;
}
/**
*
* Getter for the field goalDefinitionFitness.
*
*
* @return a {@link org.evosuite.testcase.TestFitnessFunction} object.
*/
public TestFitnessFunction getGoalDefinitionFitness() {
return goalDefinitionFitness;
}
/**
*
* isInterMethodPair
*
*
* @return a boolean.
*/
public boolean isInterMethodPair() {
return type.equals(DefUsePairType.INTER_METHOD);
}
/**
*
* isIntraClassPair
*
*
* @return a boolean.
*/
public boolean isIntraClassPair() {
return type.equals(DefUsePairType.INTRA_CLASS);
}
/**
*
* Getter for the field type.
*
*
* @return a
* {@link org.evosuite.coverage.dataflow.DefUseCoverageTestFitness.DefUsePairType}
* object.
*/
public DefUsePairType getType() {
return type;
}
/**
*
* isParameterGoal
*
*
* @return a boolean.
*/
public boolean isParameterGoal() {
return goalDefinition == null;
}
// --- Inherited from Object ---
/** {@inheritDoc} */
@Override
public String toString() {
StringBuffer r = new StringBuffer();
r.append(type.toString());
r.append("-Definition-Use-Pair");
r.append("\n\t");
if (isParameterGoal())
r.append("Parameter-Definition " + goalUse.getLocalVariableSlot()
+ " for method " + goalUse.getMethodName());
else
r.append(goalDefinition.toString());
r.append("\n\t");
r.append(goalUse.toString());
return r.toString();
}
/** {@inheritDoc} */
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result
+ ((goalDefinition == null) ? 0 : goalDefinition.hashCode());
result = prime * result + ((goalUse == null) ? 0 : goalUse.hashCode());
result = prime * result + ((goalVariable == null) ? 0 : goalVariable.hashCode());
result = prime * result + ((type == null) ? 0 : type.hashCode());
return result;
}
/** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
DefUseCoverageTestFitness other = (DefUseCoverageTestFitness) obj;
if (goalDefinition == null) {
if (other.goalDefinition != null)
return false;
} else if (!goalDefinition.equals(other.goalDefinition))
return false;
if (goalUse == null) {
if (other.goalUse != null)
return false;
} else if (!goalUse.equals(other.goalUse))
return false;
if (goalVariable == null) {
if (other.goalVariable != null)
return false;
} else if (!goalVariable.equals(other.goalVariable))
return false;
if (type != other.type)
return false;
return true;
}
/* (non-Javadoc)
* @see org.evosuite.testcase.TestFitnessFunction#compareTo(org.evosuite.testcase.TestFitnessFunction)
*/
@Override
public int compareTo(TestFitnessFunction other) {
if (other instanceof DefUseCoverageTestFitness) {
DefUseCoverageTestFitness otherFitness = (DefUseCoverageTestFitness) other;
// goalDefinition can be null for parameter goals
if (goalDefinition == null || otherFitness.getGoalDefinition() == null)
return goalUse.compareTo(otherFitness.getGoalUse());
if (goalDefinition.compareTo(otherFitness.getGoalDefinition()) == 0) {
return goalUse.compareTo(otherFitness.getGoalUse());
} else {
return goalDefinition.compareTo(otherFitness.getGoalDefinition());
}
}
return compareClassName(other);
}
/**
* @return the covered
*/
public boolean isCovered() {
return covered;
}
/**
* @param covered
* the covered to set
*/
public void setCovered(boolean covered) {
this.covered = covered;
}
/* (non-Javadoc)
* @see org.evosuite.testcase.TestFitnessFunction#getTargetClass()
*/
@Override
public String getTargetClass() {
return goalUse.getClassName();
}
/* (non-Javadoc)
* @see org.evosuite.testcase.TestFitnessFunction#getTargetMethod()
*/
@Override
public String getTargetMethod() {
return goalUse.getMethodName();
}
private void readObject(ObjectInputStream ois) throws ClassNotFoundException,
IOException {
DefUsePairType type = (DefUsePairType) ois.readObject();
Integer useId = (Integer) ois.readObject();
Integer defId = (Integer) ois.readObject();
Use use = DefUsePool.getUseByUseId(useId);
//TODO: Need to find a better solution.
if(use == null)
return;
if (type == DefUsePairType.PARAMETER) {
initParameterUse(use);
} else {
Definition def = DefUsePool.getDefinitionByDefId(defId);
initRegularDefUse(def, use, type);
}
}
/**
* Serialize, but need to abstract classloader away
*
* @param oos
* @throws IOException
*/
private void writeObject(ObjectOutputStream oos) throws IOException {
oos.writeObject(type);
oos.writeObject(Integer.valueOf(goalUse.useId));
if (goalDefinition != null)
oos.writeObject(Integer.valueOf(goalDefinition.defId));
else
oos.writeObject(0);
}
}