FuzzedMethodDescription.kt

package org.utbot.fuzzer

import org.utbot.framework.plugin.api.ClassId
import org.utbot.framework.plugin.api.ExecutableId

/**
 * Method traverser is an object,
 * that helps to collect information about a method.
 *
 * @param name pretty name of the method
 * @param returnType type of returning value
 * @param parameters method parameters types
 * @param concreteValues any concrete values to be processed by fuzzer
 *
 */
class FuzzedMethodDescription(
    val name: String,
    val returnType: ClassId,
    val parameters: List<ClassId>,
    val concreteValues: Collection<FuzzedConcreteValue> = emptyList()
) {

    /**
     * Name that can be used to generate test names
     */
    var compilableName: String? = null

    /**
     * Class Name
     */
    var className: String? = null

    /**
     * Package Name
     */
    var packageName: String? = null

    /**
     * Returns parameter name by its index in the signature
     */
    var parameterNameMap: (Int) -> String? = { null }

    /**
     * For every parameter returns a list with acceptable types.
     * Usually it keeps upper bound.
     *
     * Every parameter can have several parameter types.
     * For example [Map] has two type parameters, [Collection] has only one.
     *
     * Fuzzer doesn't care about interconnection between these types, therefore it waits
     * that function already has all necessary information to bound this values.
     */
    var fuzzerType: (Int) -> FuzzedType? = { null }

    /**
     * Returns true if class should be mocked.
     */
    var shouldMock: (ClassId) -> Boolean = { false }

    /**
     * Map class id to indices of this class in parameters list.
     */
    val parametersMap: Map<ClassId, List<Int>> by lazy {
        val result = mutableMapOf<ClassId, MutableList<Int>>()
        parameters.forEachIndexed { index, classId ->
            result.computeIfAbsent(classId) { mutableListOf() }.add(index)
        }
        result
    }

    constructor(executableId: ExecutableId, concreteValues: Collection<FuzzedConcreteValue> = emptyList()) : this(
        executableId.classId.simpleName + "." + executableId.name,
        executableId.returnType,
        executableId.parameters,
        concreteValues
    )
}