|
| 1 | +/* |
| 2 | + * Copyright 2025 Google LLC |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.cloud.spanner.benchmarking; |
| 18 | + |
| 19 | +import com.google.cloud.spanner.benchmarking.BenchmarkValidator.BaselineResult.BenchmarkResult; |
| 20 | +import com.google.cloud.spanner.benchmarking.BenchmarkValidator.BaselineResult.BenchmarkResult.Percentile; |
| 21 | +import com.google.gson.Gson; |
| 22 | +import com.google.gson.reflect.TypeToken; |
| 23 | +import java.io.File; |
| 24 | +import java.io.IOException; |
| 25 | +import java.net.URL; |
| 26 | +import java.nio.file.Files; |
| 27 | +import java.nio.file.Paths; |
| 28 | +import java.util.ArrayList; |
| 29 | +import java.util.List; |
| 30 | +import java.util.Map; |
| 31 | + |
| 32 | +public class BenchmarkValidator { |
| 33 | + |
| 34 | + private final BaselineResult expectedResults; |
| 35 | + private final List<ActualBenchmarkResult> actualResults; |
| 36 | + |
| 37 | + public BenchmarkValidator(String baselineFile, String actualFile) { |
| 38 | + Gson gson = new Gson(); |
| 39 | + // Load expected result JSON from resource folder |
| 40 | + this.expectedResults = gson.fromJson(loadJsonFromResources(baselineFile), BaselineResult.class); |
| 41 | + // Load the actual result from current benchmarking run |
| 42 | + this.actualResults = |
| 43 | + gson.fromJson( |
| 44 | + loadJsonFromFile(actualFile), |
| 45 | + new TypeToken<ArrayList<ActualBenchmarkResult>>() {}.getType()); |
| 46 | + } |
| 47 | + |
| 48 | + void validate() { |
| 49 | + // Validating the resultant percentile against expected percentile with allowed threshold |
| 50 | + for (ActualBenchmarkResult actualResult : actualResults) { |
| 51 | + BenchmarkResult expectResult = expectedResults.benchmarkResultMap.get(actualResult.benchmark); |
| 52 | + if (expectResult == null) { |
| 53 | + throw new ValidationException( |
| 54 | + "Missing expected benchmark configuration for actual benchmarking"); |
| 55 | + } |
| 56 | + Map<String, Double> actualPercentilesMap = actualResult.primaryMetric.scorePercentiles; |
| 57 | + // We will only be comparing the percentiles(p50, p90, p90) which are configured in the |
| 58 | + // expected percentiles. This allows some checks to be disabled if required. |
| 59 | + for (Percentile expectedPercentile : expectResult.scorePercentiles) { |
| 60 | + String percentile = expectedPercentile.percentile; |
| 61 | + double difference = |
| 62 | + calculatePercentageDifference( |
| 63 | + expectedPercentile.baseline, actualPercentilesMap.get(percentile)); |
| 64 | + // if an absolute different in percentage is greater than allowed difference |
| 65 | + // Then we are throwing validation error |
| 66 | + if (Math.abs(Math.ceil(difference)) > expectedPercentile.difference) { |
| 67 | + throw new ValidationException( |
| 68 | + String.format( |
| 69 | + "[%s][%s] Expected percentile %s[+/-%s] but got %s", |
| 70 | + actualResult.benchmark, |
| 71 | + percentile, |
| 72 | + expectedPercentile.baseline, |
| 73 | + expectedPercentile.difference, |
| 74 | + actualPercentilesMap.get(percentile))); |
| 75 | + } |
| 76 | + } |
| 77 | + } |
| 78 | + } |
| 79 | + |
| 80 | + public static double calculatePercentageDifference(double base, double compareWith) { |
| 81 | + if (base == 0) { |
| 82 | + return 0.0; |
| 83 | + } |
| 84 | + return ((compareWith - base) / base) * 100; |
| 85 | + } |
| 86 | + |
| 87 | + private String loadJsonFromFile(String file) { |
| 88 | + try { |
| 89 | + return new String(Files.readAllBytes(Paths.get(file))); |
| 90 | + } catch (IOException e) { |
| 91 | + throw new ValidationException("Failed to read file: " + file, e); |
| 92 | + } |
| 93 | + } |
| 94 | + |
| 95 | + private String loadJsonFromResources(String baselineFile) { |
| 96 | + URL resourceUrl = getClass().getClassLoader().getResource(baselineFile); |
| 97 | + if (resourceUrl == null) { |
| 98 | + throw new ValidationException("File not found: " + baselineFile); |
| 99 | + } |
| 100 | + File file = new File(resourceUrl.getFile()); |
| 101 | + return loadJsonFromFile(file.getAbsolutePath()); |
| 102 | + } |
| 103 | + |
| 104 | + static class ActualBenchmarkResult { |
| 105 | + String benchmark; |
| 106 | + PrimaryMetric primaryMetric; |
| 107 | + |
| 108 | + static class PrimaryMetric { |
| 109 | + Map<String, Double> scorePercentiles; |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + static class BaselineResult { |
| 114 | + Map<String, BenchmarkResult> benchmarkResultMap; |
| 115 | + |
| 116 | + static class BenchmarkResult { |
| 117 | + List<Percentile> scorePercentiles; |
| 118 | + |
| 119 | + static class Percentile { |
| 120 | + String percentile; |
| 121 | + Double baseline; |
| 122 | + Double difference; |
| 123 | + } |
| 124 | + } |
| 125 | + } |
| 126 | + |
| 127 | + static class ValidationException extends RuntimeException { |
| 128 | + ValidationException(String message) { |
| 129 | + super(message); |
| 130 | + } |
| 131 | + |
| 132 | + ValidationException(String message, Throwable cause) { |
| 133 | + super(message, cause); |
| 134 | + } |
| 135 | + } |
| 136 | + |
| 137 | + private static String parseCommandLineArgs(String[] args, String key) { |
| 138 | + if (args == null) { |
| 139 | + return ""; |
| 140 | + } |
| 141 | + for (String arg : args) { |
| 142 | + if (arg.startsWith("--" + key)) { |
| 143 | + String[] splits = arg.split("="); |
| 144 | + if (splits.length == 2) { |
| 145 | + return splits[1].trim(); |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | + return ""; |
| 150 | + } |
| 151 | + |
| 152 | + public static void main(String[] args) { |
| 153 | + String actualFile = parseCommandLineArgs(args, "file"); |
| 154 | + new BenchmarkValidator("com/google/cloud/spanner/jmh/jmh-baseline.json", actualFile).validate(); |
| 155 | + } |
| 156 | +} |
0 commit comments