org.mockito.internal.verification.argumentmatching.ArgumentMatchingTool Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mockito-core Show documentation
Mockito mock objects library core API and implementation
There is a newer version: 5.12.0
/*
 * Copyright (c) 2007 Mockito contributors
 * This program is made available under the terms of the MIT License.
 */
package org.mockito.internal.verification.argumentmatching;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import org.mockito.ArgumentMatcher;
import org.mockito.internal.matchers.ContainsExtraTypeInfo;

@SuppressWarnings("rawtypes")
public class ArgumentMatchingTool {

    private ArgumentMatchingTool() {}

    /**
     * Suspiciously not matching arguments are those that don't match, the toString() representation is the same but types are different.
     */
    public static Integer[] getSuspiciouslyNotMatchingArgsIndexes(
            List matchers, Object[] arguments) {
        if (matchers.size() != arguments.length) {
            return new Integer[0];
        }

        List suspicious = new LinkedList<>();
        int i = 0;
        for (ArgumentMatcher m : matchers) {
            if (m instanceof ContainsExtraTypeInfo
                    && !safelyMatches(m, arguments[i])
                    && toStringEquals(m, arguments[i])
                    && !((ContainsExtraTypeInfo) m).typeMatches(arguments[i])) {
                suspicious.add(i);
            }
            i++;
        }
        return suspicious.toArray(new Integer[0]);
    }

    /**
     * Returns indexes of arguments not matching the provided matchers.
     */
    public static List getNotMatchingArgsIndexes(
            List matchers, Object[] arguments) {
        if (matchers.size() != arguments.length) {
            return Collections.emptyList();
        }

        List nonMatching = new ArrayList<>();
        int i = 0;
        for (ArgumentMatcher m : matchers) {
            if (!safelyMatches(m, arguments[i])) {
                nonMatching.add(i);
            }

            i++;
        }

        return nonMatching;
    }

    private static boolean safelyMatches(ArgumentMatcher m, Object arg) {
        try {
            return m.matches(arg);
        } catch (Throwable t) {
            return false;
        }
    }

    private static boolean toStringEquals(ArgumentMatcher m, Object arg) {
        return m.toString().equals(String.valueOf(arg));
    }

    /**
     * Suspiciously not matching arguments are those that don't match, and the classes have same simple name.
     */
    public static Set getNotMatchingArgsWithSameName(
            List matchers, Object[] arguments) {
        Map> classesHavingSameName = new HashMap<>();
        for (ArgumentMatcher m : matchers) {
            if (m instanceof ContainsExtraTypeInfo) {
                Object wanted = ((ContainsExtraTypeInfo) m).getWanted();
                if (wanted == null) {
                    continue;
                }
                Class wantedClass = wanted.getClass();
                classesHavingSameName
                        .computeIfAbsent(wantedClass.getSimpleName(), className -> new HashSet<>())
                        .add(wantedClass.getCanonicalName());
            }
        }
        for (Object argument : arguments) {
            if (argument == null) {
                continue;
            }
            Class wantedClass = argument.getClass();
            classesHavingSameName
                    .computeIfAbsent(wantedClass.getSimpleName(), className -> new HashSet<>())
                    .add(wantedClass.getCanonicalName());
        }
        return classesHavingSameName.entrySet().stream()
                .filter(classEntry -> classEntry.getValue().size() > 1)
                .map(classEntry -> classEntry.getKey())
                .collect(Collectors.toSet());
    }
}