Add Bazel rules for Java

drinckes · drinckes · commit 8a0939e31cd5 · 2017-05-17T15:16:55.000+02:00
diff --git a/WORKSPACE b/WORKSPACE
@@ -22,3 +22,4 @@ http_archive(
 load("@io_bazel_rules_closure//closure:defs.bzl", "closure_repositories")
 
 closure_repositories()
+
diff --git a/java/BUILD b/java/BUILD
@@ -0,0 +1,67 @@
+
+java_library(
+    name = "openlocationcode",
+    srcs = [
+        "com/google/openlocationcode/OpenLocationCode.java",
+    ],
+)
+
+java_test(
+    name = "encoding_Test",
+    srcs = [
+        "com/google/openlocationcode/tests/EncodingTest.java",
+    ],
+    test_class = "com.google.openlocationcode.tests.EncodingTest",
+    size = "small",
+    deps = [
+        ":openlocationcode",
+    ],
+    data = [
+        "//test_data:test_data"
+    ],
+)
+
+java_test(
+    name = "precision_test",
+    srcs = [
+        "com/google/openlocationcode/tests/PrecisionTest.java",
+    ],
+    test_class = "com.google.openlocationcode.tests.PrecisionTest",
+    size = "small",
+    deps = [
+        ":openlocationcode",
+    ],
+    data = [
+        "//test_data:test_data"
+    ],
+)
+
+java_test(
+    name = "shortening_test",
+    srcs = [
+        "com/google/openlocationcode/tests/ShorteningTest.java",
+    ],
+    test_class = "com.google.openlocationcode.tests.ShorteningTest",
+    size = "small",
+    deps = [
+        ":openlocationcode",
+    ],
+    data = [
+        "//test_data:test_data"
+    ],
+)
+
+java_test(
+    name = "validity_test",
+    srcs = [
+        "com/google/openlocationcode/tests/ValidityTest.java",
+    ],
+    test_class = "com.google.openlocationcode.tests.ValidityTest",
+    size = "small",
+    deps = [
+        ":openlocationcode",
+    ],
+    data = [
+        "//test_data:test_data"
+    ],
+)
diff --git a/java/README.md b/java/README.md
@@ -1,47 +1,49 @@
 # Java Open Location Code library
 
-## Building
+## Building and Testing
 
-Create an empty `build` directory:
+Included is a `BUILD` file that uses the [Bazel](https://bazel.build/) build system to produce a JAR file and to run tests. You will need to install Bazel on your system to run the tests.
 
-```shell
-mkdir build
-```
+### Building the JAR file
 
-Compile the `com/google/openlocationcode/OpenLocationCode.java` file and then
-package it as a jar file:
+To build a JAR file, run:
 
-```shell
-javac -d build com/google/openlocationcode/OpenLocationCode.java
-cd build
-jar cvf OpenLocationCode.jar com/google/openlocationcode/OpenLocationCode*.class
-cd ..
 ```
-That's it - you'll have a jar file in `build/OpenLocationCode.jar`.
+$ bazel build java:openlocationcode
+INFO: Found 1 target...
+Target //java:openlocationcode up-to-date:
+  bazel-bin/java/libopenlocationcode.jar
+INFO: Elapsed time: 3.107s, Critical Path: 0.22s
+$
+```
 
-## Testing
+The JAR file is accessable using the path shown in the output.
 
-Download the `junit` and `hamcrest` jar files from [their repository](https://github.com/junit-team/junit4/wiki/Download-and-Install)
-and place them somewhere.
+If you cannot install Bazel, you can build the JAR file manually with:
 
-(This will assume you downloaded `junit-41.2.jar` and `hamcrest-core-1.3.jar`)
+```
+mkdir build
+javac -d build com/google/openlocationcode/OpenLocationCode.java
+```
 
-Build the `OpenLocationCode.jar` file as above.
+This will  create a JAR file in the `build` directory. Change that to a suitable location.
 
-Add all three files to your `CLASSPATH` variable (obviously use the real paths to the files):
+### Running tests
 
-```shell
-CLASSPATH=$CLASSPATH:build/OpenLocationCode.jar:/path/to/junit-4.12.jar:/path/to/hamcrest-core-1.3.jar
-```
+The tests read their data from the [`test_data`](https://github.com/google/open-location-code/tree/master/test_data) directory.
 
-Compile the test classes:
+Run the tests from the top-level github directory. This command will build the JAR file and test classes, and execute them:
 
-```shell
-javac -cp $CLASSPATH -d build com/google/openlocationcode/tests/*java
 ```
-
-Run the tests. Note that we need to use the `-cp` argument to give the location of the test classes and the test data files:
-
-```shell
-java -cp $CLASSPATH:build:../test_data: org.junit.runner.JUnitCore com.google.openlocationcode.tests.EncodingTest com.google.openlocationcode.tests.PrecisionTest com.google.openlocationcode.tests.ShorteningTest com.google.openlocationcode.tests.ValidityTest
+$ bazel test java:all
+INFO: Found 1 target and 4 test targets...
+INFO: Elapsed time: 0.657s, Critical Path: 0.46s
+//java:encoding_Test                                                     PASSED in 0.4s
+//java:precision_test                                                    PASSED in 0.4s
+//java:shortening_test                                                   PASSED in 0.4s
+//java:validity_test                                                     PASSED in 0.4s
+
+Executed 4 out of 4 tests: 4 tests pass.
+$
 ```
+
diff --git a/java/com/google/openlocationcode/tests/EncodingTest.java b/java/com/google/openlocationcode/tests/EncodingTest.java
@@ -7,6 +7,8 @@
 import org.junit.Test;
 
 import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileInputStream;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
@@ -46,7 +48,8 @@ public TestData(String line) {
 
   @Before
   public void setUp() throws Exception {
-    InputStream testDataStream = ClassLoader.getSystemResourceAsStream("encodingTests.csv");
+    File testFile = new File(System.getenv("JAVA_RUNFILES"), "openlocationcode/test_data/encodingTests.csv");
+    InputStream testDataStream = new FileInputStream(testFile);
     BufferedReader reader = new BufferedReader(new InputStreamReader(testDataStream));
     String line;
     while ((line = reader.readLine()) != null) {
diff --git a/java/com/google/openlocationcode/tests/ShorteningTest.java b/java/com/google/openlocationcode/tests/ShorteningTest.java
@@ -7,6 +7,8 @@
 import org.junit.Test;
 
 import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileInputStream;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
@@ -38,7 +40,8 @@ public TestData(String line) {
 
   @Before
   public void setUp() throws Exception {
-    InputStream testDataStream = ClassLoader.getSystemResourceAsStream("shortCodeTests.csv");
+    File testFile = new File(System.getenv("JAVA_RUNFILES"), "openlocationcode/test_data/shortCodeTests.csv");
+    InputStream testDataStream = new FileInputStream(testFile);
     BufferedReader reader = new BufferedReader(new InputStreamReader(testDataStream));
     String line;
     while ((line = reader.readLine()) != null) {
diff --git a/java/com/google/openlocationcode/tests/ValidityTest.java b/java/com/google/openlocationcode/tests/ValidityTest.java
@@ -7,6 +7,8 @@
 import org.junit.Test;
 
 import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileInputStream;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
@@ -42,7 +44,8 @@ public TestData(String line) {
 
   @Before
   public void setUp() throws Exception {
-    InputStream testDataStream = ClassLoader.getSystemResourceAsStream("validityTests.csv");
+    File testFile = new File(System.getenv("JAVA_RUNFILES"), "openlocationcode/test_data/validityTests.csv");
+    InputStream testDataStream = new FileInputStream(testFile);
     BufferedReader reader = new BufferedReader(new InputStreamReader(testDataStream));
     String line;
     while ((line = reader.readLine()) != null) {
diff --git a/test_data/BUILD b/test_data/BUILD
@@ -0,0 +1,5 @@
+filegroup(
+    name = "test_data",
+    srcs = glob(["*.csv"]),
+    visibility = ["//visibility:public"],
+)

Original file line number	Diff line number	Diff line change
`@@ -22,3 +22,4 @@ http_archive(`
`22`	`22`	`load("@io_bazel_rules_closure//closure:defs.bzl", "closure_repositories")`
`23`	`23`
`24`	`24`	`closure_repositories()`
	`25`	`+`