org.gradle.performance.results.ResultsStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation

Gradle 6.9.1 API redistribution.

There is a newer version: 8.11.1

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.performance.results;

import java.io.Closeable;
import java.util.Collections;
import java.util.List;
import java.util.Map;

public interface ResultsStore extends Closeable {
    /**
     * Returns the performance experiments known to this store, in display order.
     */
    List getPerformanceExperiments();

    /**
     * Returns the n most recent instances of the given test which are younger than the max age.
     *
     * This returns all the executions which are either from the channel or in the list of provided teamcity build ids.
     */
    default PerformanceTestHistory getTestResults(PerformanceExperiment experiment, int mostRecentN, int maxDaysOld, String channel, List teamcityBuildIds) {
        return getTestResults(experiment, mostRecentN, maxDaysOld, Collections.singletonList(channel), teamcityBuildIds);
    }

    /**
     * Returns the n most recent instances of the given test which are younger than the max age.
     *
     * This returns all the executions which either match the channel patterns or are in the list of provided teamcity build ids.
     */
    PerformanceTestHistory getTestResults(PerformanceExperiment experiment, int mostRecentN, int maxDaysOld, List channelPatterns, List teamcityBuildIds);

    /**
     * Returns the estimated duration for each experiment in milliseconds.
     */
    Map getEstimatedExperimentDurationsInMillis();
}