xref: /aosp_15_r20/external/guava/guava-testlib/README.md (revision fb5080426417cab6bd44d0ed3f37e47d42859579)
1*fb508042SAndroid Build Coastguard Worker# Guava Testlib: Google Testing Libraries for Java
2*fb508042SAndroid Build Coastguard Worker
3*fb508042SAndroid Build Coastguard WorkerGuava testlib is a set of Java classes for more convenient
4*fb508042SAndroid Build Coastguard Workerunit testing.
5*fb508042SAndroid Build Coastguard Worker
6*fb508042SAndroid Build Coastguard Worker## Adding Guava Testlib to your build
7*fb508042SAndroid Build Coastguard Worker
8*fb508042SAndroid Build Coastguard WorkerGuava testlib's Maven group ID is `com.google.guava` and its artifact ID is `guava-testlib`.
9*fb508042SAndroid Build Coastguard Worker
10*fb508042SAndroid Build Coastguard WorkerTo add a dependency on Guava testlib using Maven, use the following:
11*fb508042SAndroid Build Coastguard Worker
12*fb508042SAndroid Build Coastguard Worker```xml
13*fb508042SAndroid Build Coastguard Worker<dependency>
14*fb508042SAndroid Build Coastguard Worker  <groupId>com.google.guava</groupId>
15*fb508042SAndroid Build Coastguard Worker  <artifactId>guava-testlib</artifactId>
16*fb508042SAndroid Build Coastguard Worker  <version>33.3.0-jre</version>
17*fb508042SAndroid Build Coastguard Worker  <scope>test</scope>
18*fb508042SAndroid Build Coastguard Worker</dependency>
19*fb508042SAndroid Build Coastguard Worker```
20*fb508042SAndroid Build Coastguard Worker
21*fb508042SAndroid Build Coastguard WorkerTo add a dependency using Gradle:
22*fb508042SAndroid Build Coastguard Worker
23*fb508042SAndroid Build Coastguard Worker```gradle
24*fb508042SAndroid Build Coastguard Workerdependencies {
25*fb508042SAndroid Build Coastguard Worker  test 'com.google.guava:guava-testlib:33.3.0-jre'
26*fb508042SAndroid Build Coastguard Worker}
27*fb508042SAndroid Build Coastguard Worker```
28*fb508042SAndroid Build Coastguard Worker
29*fb508042SAndroid Build Coastguard Worker## Links
30*fb508042SAndroid Build Coastguard Worker
31*fb508042SAndroid Build Coastguard Worker-   [GitHub project](https://github.com/google/guava)
32*fb508042SAndroid Build Coastguard Worker-   [Issue tracker: Report a defect or feature request](https://github.com/google/guava/issues/new)
33*fb508042SAndroid Build Coastguard Worker-   [StackOverflow: Ask "how-to" and "why-didn't-it-work" questions](https://stackoverflow.com/questions/ask?tags=guava+java)
34*fb508042SAndroid Build Coastguard Worker-   [guava-discuss: For open-ended questions and discussion](https://groups.google.com/group/guava-discuss)
35*fb508042SAndroid Build Coastguard Worker
36*fb508042SAndroid Build Coastguard Worker## IMPORTANT WARNINGS
37*fb508042SAndroid Build Coastguard Worker
38*fb508042SAndroid Build Coastguard Worker1. APIs marked with the `@Beta` annotation at the class or method level
39*fb508042SAndroid Build Coastguard Workerare subject to change. They can be modified in any way, or even
40*fb508042SAndroid Build Coastguard Workerremoved, at any time. If your code is a library itself (i.e. it is
41*fb508042SAndroid Build Coastguard Workerused on the CLASSPATH of users outside your own control), you should
42*fb508042SAndroid Build Coastguard Workernot use beta APIs, unless you [repackage] them. **If your
43*fb508042SAndroid Build Coastguard Workercode is a library, we strongly recommend using the [Guava Beta Checker] to
44*fb508042SAndroid Build Coastguard Workerensure that you do not use any `@Beta` APIs!**
45*fb508042SAndroid Build Coastguard Worker
46*fb508042SAndroid Build Coastguard Worker[Guava Beta Checker]: https://github.com/google/guava-beta-checker
47*fb508042SAndroid Build Coastguard Worker
48*fb508042SAndroid Build Coastguard Worker<!-- References -->
49*fb508042SAndroid Build Coastguard Worker
50*fb508042SAndroid Build Coastguard Worker[repackage]: https://github.com/google/guava/wiki/UseGuavaInYourBuild#what-if-i-want-to-use-beta-apis-from-a-library-that-people-use-as-a-dependency
51