aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/tools/benchmark/java/com/google/devtools/build/benchmark/Builder.java
blob: 603fd526d15cc1bfd96b165dba23c74ae2615f82 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// 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 com.google.devtools.build.benchmark;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.shell.CommandException;
import java.io.IOException;
import java.nio.file.Path;

/** Interface that includes methods for a building tool. */
interface Builder {

  /** Prepare anything the build needs. */
  void prepare() throws IOException, CommandException;

  /** Returns the binary path of the build tool of a specific {@code codeVersion}. */
  Path getBuildBinary(String codeVersion) throws IOException, CommandException;

  /** Return a list of code versions in {@code (from, to]}. */
  ImmutableList<String> getCodeVersionsBetween(String from, String to) throws CommandException;

  /** Returns a command for build under specific config. */
  ImmutableList<String> getCommandFromConfig(
      BuildTargetConfig targetConfig, BuildEnvConfig envConfig);

  /**
   * Build the given buildConfig using the given binary.
   *
   * @return elapsed time of the build
   */
  double buildAndGetElapsedTime(Path buildBinary, ImmutableList<String> args)
      throws CommandException;

  /** Clean the previous build results. */
  void clean() throws CommandException;
}