aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/test/java/com/google/devtools/build/lib/testutil/Suite.java
blob: 43590d463ca79b6ffcfbd40ea6fbc5b6d316140a (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
// Copyright 2014 Google Inc. 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.lib.testutil;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * Test annotations used to select which tests to run in a given situation.
 */
public enum Suite {

  /**
   * It's so blazingly fast and lightweight we run it whenever we make any
   * build.lib change. This size is the default.
   */
  SMALL_TESTS,

  /**
   * It's a bit too slow to run all the time, but it still tests some
   * unit of functionality. May run external commands such as gcc, for example.
   */
  MEDIUM_TESTS,

  /**
   * I don't even want to think about running this one after every edit,
   * but I don't mind if the continuous build runs it, and I'm happy to have
   * it before making a release.
   */
  LARGE_TESTS,

  /**
   * These tests take a long time. They should only ever be run manually and probably from their
   * own Blaze test target.
   */
  ENORMOUS_TESTS;

  /**
   * Given a class, determine the test size.
   */
  public static Suite getSize(Class<?> clazz) {
    return getAnnotationElementOrDefault(clazz, "size");
  }

  /**
   * Given a class, determine the suite it belongs to.
   */
  public static String getSuiteName(Class<?> clazz) {
    return getAnnotationElementOrDefault(clazz, "suite");
  }

  /**
   * Given a class, determine if it is flaky.
   */
  public static boolean isFlaky(Class<?> clazz) {
    return getAnnotationElementOrDefault(clazz, "flaky");
  }

  /**
   * Returns the value of the given element in the {@link TestSpec} annotation of the given class,
   * or the default value of that element if the class doesn't have a {@link TestSpec} annotation.
   */
  @SuppressWarnings("unchecked")
  private static <T> T getAnnotationElementOrDefault(Class<?> clazz, String elementName) {
    TestSpec spec = clazz.getAnnotation(TestSpec.class);
    try {
      Method method = TestSpec.class.getMethod(elementName);
      return spec != null ? (T) method.invoke(spec) : (T) method.getDefaultValue();
    } catch (NoSuchMethodException e) {
      throw new IllegalStateException("no such element " + elementName, e);
    } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
      throw new IllegalStateException("can't invoke accessor for element " + elementName, e);
    }
  }
}