de.ppi.deepsampler.persistence.error.NoMatchingSamplerFoundException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deepsampler-persistence Show documentation

This module is the core of the persistence api in DeepSampler.

There is a newer version: 2.1.0

Show newest version

/*
 * Copyright 2022 PPI AG (Hamburg, Germany)
 * This program is made available under the terms of the MIT License.
 */

package de.ppi.deepsampler.persistence.error;

import de.ppi.deepsampler.core.internal.FuzzySearchUtility;
import de.ppi.deepsampler.core.model.SampleDefinition;

import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;

/**
 * The {@link NoMatchingSamplerFoundException} is thrown if a JSON file (or any other source of persistent Samples)
 * contains Samples that don't have a matching Sampler. A Sampler is defined using {@link de.ppi.deepsampler.core.api.PersistentSample#of(Object)}.
 *
 * A typical cause of this Exception is, that the signature of a sampled method has changed. Maybe the method name was refactored.
 * Since the complete method signature is saved in the JSON (or any other persistent medium) by default, the signature in the file might
 * not correspond to the refactored one in the code anymore.
 *
 * You can prevent situations like this, by defining the id of a Sample manually using PersistentSampler.of().hasId("MyId").
 * See {@link de.ppi.deepsampler.core.api.PersistentSampleBuilder#hasId(String)}.
 */
public class NoMatchingSamplerFoundException extends PersistenceException {


    public NoMatchingSamplerFoundException(String unusedSamplerId, List definedSampleDefinitions) {
        super("The persistent Sample with the id '%s' doesn't have a corresponding Sampler. %s" +
                "Please define a Sampler using PersistentSampler.of(...)", unusedSamplerId, guessCorrectSampler(unusedSamplerId, definedSampleDefinitions));
    }
  
    public NoMatchingSamplerFoundException(Collection unusedSamplerIds, List definedSampleDefinitions) {
        super("The following persistent Samples don't have a corresponding Sampler. " +
                "Please define a Sampler using PersistentSampler.of(...):\n%s", formatMissingSamplerIds(unusedSamplerIds, definedSampleDefinitions));
    }

    private static String formatMissingSamplerIds(Collection unusedSamplerIds, List definedSampleDefinitions) {
        return unusedSamplerIds.stream()
                .map(id -> "\t" + id + guessCorrectSampler(id, definedSampleDefinitions))
                .collect(Collectors.joining("\n"));
    }

    private static String guessCorrectSampler(String unusedSamplerId, List definedSampleDefinitions) {
        FuzzySearchUtility.Match match = FuzzySearchUtility.findClosestObject(unusedSamplerId, definedSampleDefinitions, SampleDefinition::getSampleId);

        if (match != null && match.getEquality() > 0.5) {
            if (!match.getMatchedObject().isMarkedForPersistence()) {
                return "\n\t\t" + match.getMatchedObject().getSampleId() + " seems to be quite similar, but it was not marked for persistence. " +
                        "Use PersistentSampler.of() instead of Sampler.of(), if the Sample should be provided from persistence.";
            }

            return "\n\t\t did you mean " + match.getMatchedObject().getSampleId() + "?";
        }

        return "";
    }
}