Add TreeSubject over antlr3 trees
Change-Id: Id9e4cf87d480465d701e03c38e1c5bcb74bb2f3c
diff --git a/antlr3/BUILD b/antlr3/BUILD
index fc96715..2d3050e 100644
--- a/antlr3/BUILD
+++ b/antlr3/BUILD
@@ -20,7 +20,8 @@
name = "query_parser",
srcs = [":query"],
visibility = [
- "//java/com/google/gerrit/index:__pkg__",
+ "//java/com/google/gerrit/index:__subpackages__",
+ "//javatests/com/google/gerrit:__subpackages__",
"//javatests/com/google/gerrit/index:__pkg__",
"//plugins:__pkg__",
],
diff --git a/java/com/google/gerrit/index/query/testing/BUILD b/java/com/google/gerrit/index/query/testing/BUILD
new file mode 100644
index 0000000..030b327
--- /dev/null
+++ b/java/com/google/gerrit/index/query/testing/BUILD
@@ -0,0 +1,16 @@
+package(
+ default_testonly = True,
+ default_visibility = ["//visibility:public"],
+)
+
+java_library(
+ name = "testing",
+ srcs = glob(["*.java"]),
+ deps = [
+ "//antlr3:query_parser",
+ "//java/com/google/gerrit/index",
+ "//lib:guava",
+ "//lib/antlr:java-runtime",
+ "//lib/truth",
+ ],
+)
diff --git a/java/com/google/gerrit/index/query/testing/TreeSubject.java b/java/com/google/gerrit/index/query/testing/TreeSubject.java
new file mode 100644
index 0000000..c60b363
--- /dev/null
+++ b/java/com/google/gerrit/index/query/testing/TreeSubject.java
@@ -0,0 +1,73 @@
+// Copyright (C) 2019 The Android Open Source Project
+//
+// 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.gerrit.index.query.testing;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.truth.Truth.assertAbout;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.truth.FailureMetadata;
+import com.google.common.truth.Subject;
+import com.google.gerrit.index.query.QueryParser;
+import org.antlr.runtime.tree.Tree;
+
+public class TreeSubject extends Subject<TreeSubject, Tree> {
+ public static TreeSubject assertThat(Tree actual) {
+ return assertAbout(TreeSubject::new).that(actual);
+ }
+
+ private TreeSubject(FailureMetadata failureMetadata, Tree tree) {
+ super(failureMetadata, tree);
+ }
+
+ public void hasType(int expectedType) {
+ isNotNull();
+ check("getType()").that(typeName(actual().getType())).isEqualTo(typeName(expectedType));
+ }
+
+ public void hasText(String expectedText) {
+ requireNonNull(expectedText);
+ isNotNull();
+ check("getText()").that(actual().getText()).isEqualTo(expectedText);
+ }
+
+ public void hasNoChildren() {
+ isNotNull();
+ check("getChildCount()").that(actual().getChildCount()).isEqualTo(0);
+ }
+
+ public void hasChildCount(int expectedChildCount) {
+ checkArgument(
+ expectedChildCount > 0, "expected child count must be positive: %s", expectedChildCount);
+ isNotNull();
+ check("getChildCount()").that(actual().getChildCount()).isEqualTo(expectedChildCount);
+ }
+
+ public TreeSubject child(int childIndex) {
+ isNotNull();
+ return check("getChild(%s)", childIndex)
+ .about(TreeSubject::new)
+ .that(actual().getChild(childIndex));
+ }
+
+ private static String typeName(int type) {
+ checkArgument(
+ type >= 0 && type < QueryParser.tokenNames.length,
+ "invalid token type %s, max is %s",
+ type,
+ QueryParser.tokenNames.length - 1);
+ return QueryParser.tokenNames[type];
+ }
+}
diff --git a/javatests/com/google/gerrit/index/BUILD b/javatests/com/google/gerrit/index/BUILD
index e3436bc..a1f60de 100644
--- a/javatests/com/google/gerrit/index/BUILD
+++ b/javatests/com/google/gerrit/index/BUILD
@@ -9,6 +9,7 @@
"//antlr3:query_parser",
"//java/com/google/gerrit/index",
"//java/com/google/gerrit/index:query_exception",
+ "//java/com/google/gerrit/index/query/testing",
"//java/com/google/gerrit/testing:gerrit-test-util",
"//lib:guava",
"//lib:junit",
diff --git a/javatests/com/google/gerrit/index/query/QueryParserTest.java b/javatests/com/google/gerrit/index/query/QueryParserTest.java
index 2175f7d..cf1f035 100644
--- a/javatests/com/google/gerrit/index/query/QueryParserTest.java
+++ b/javatests/com/google/gerrit/index/query/QueryParserTest.java
@@ -14,7 +14,10 @@
package com.google.gerrit.index.query;
-import static org.junit.Assert.assertEquals;
+import static com.google.gerrit.index.query.QueryParser.FIELD_NAME;
+import static com.google.gerrit.index.query.QueryParser.SINGLE_WORD;
+import static com.google.gerrit.index.query.QueryParser.parse;
+import static com.google.gerrit.index.query.testing.TreeSubject.assertThat;
import com.google.gerrit.testing.GerritBaseTests;
import org.antlr.runtime.tree.Tree;
@@ -22,27 +25,13 @@
public class QueryParserTest extends GerritBaseTests {
@Test
- public void projectBare() throws QueryParseException {
- Tree r;
-
- r = parse("project:tools/gerrit");
- assertSingleWord("project", "tools/gerrit", r);
-
- r = parse("project:tools/*");
- assertSingleWord("project", "tools/*", r);
- }
-
- private static void assertSingleWord(String name, String value, Tree r) {
- assertEquals(QueryParser.FIELD_NAME, r.getType());
- assertEquals(name, r.getText());
- assertEquals(1, r.getChildCount());
- final Tree c = r.getChild(0);
- assertEquals(QueryParser.SINGLE_WORD, c.getType());
- assertEquals(value, c.getText());
- assertEquals(0, c.getChildCount());
- }
-
- private static Tree parse(String str) throws QueryParseException {
- return QueryParser.parse(str);
+ public void fieldNameAndValue() throws Exception {
+ Tree r = parse("project:tools/gerrit");
+ assertThat(r).hasType(FIELD_NAME);
+ assertThat(r).hasText("project");
+ assertThat(r).hasChildCount(1);
+ assertThat(r).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).hasText("tools/gerrit");
+ assertThat(r).child(0).hasNoChildren();
}
}
