This is an automated email from the ASF dual-hosted git repository.
geertjan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/netbeans.git
The following commit(s) were added to refs/heads/master by this push:
new 597cca0 Adding hint for missing /ref in @compile jtreg tags. (#1360)
597cca0 is described below
commit 597cca026744e32e5a34eb1ffc607cf795728886
Author: Jan Lahoda <[email protected]>
AuthorDate: Wed Sep 4 13:34:12 2019 +0200
Adding hint for missing /ref in @compile jtreg tags. (#1360)
---
.../java/openjdk/jtreg/MissingRefOutputHint.java | 135 +++++++++++++++++++++
.../modules/java/openjdk/jtreg/TagParser.java | 4 +-
.../openjdk/jtreg/MissingRefOutputHintTest.java | 95 +++++++++++++++
3 files changed, 232 insertions(+), 2 deletions(-)
diff --git
a/java/java.openjdk.project/src/org/netbeans/modules/java/openjdk/jtreg/MissingRefOutputHint.java
b/java/java.openjdk.project/src/org/netbeans/modules/java/openjdk/jtreg/MissingRefOutputHint.java
new file mode 100644
index 0000000..9012fde
--- /dev/null
+++
b/java/java.openjdk.project/src/org/netbeans/modules/java/openjdk/jtreg/MissingRefOutputHint.java
@@ -0,0 +1,135 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.netbeans.modules.java.openjdk.jtreg;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+
+import com.sun.source.tree.Tree.Kind;
+import com.sun.source.util.TreePath;
+import java.io.IOException;
+import org.netbeans.api.java.source.CompilationInfo;
+import org.netbeans.modules.java.openjdk.jtreg.TagParser.Result;
+import org.netbeans.spi.editor.hints.ErrorDescription;
+import org.netbeans.spi.java.hints.ErrorDescriptionFactory;
+import org.netbeans.spi.java.hints.Hint;
+import org.netbeans.spi.java.hints.Hint.Options;
+import org.netbeans.spi.java.hints.HintContext;
+import org.netbeans.spi.java.hints.JavaFix;
+import org.netbeans.spi.java.hints.TriggerTreeKind;
+import org.openide.util.NbBundle.Messages;
+
+@Hint(displayName = "#DN_MissingRefOutputHint", description =
"#DESC_MissingRefOutputHint", category = "general", options=Options.NO_BATCH)
+@Messages({
+ "DN_MissingRefOutputHint=Missing Reference Output",
+ "DESC_MissingRefOutputHint=Checks for missing reference output in jtreg
@compile tags."
+})
+public class MissingRefOutputHint {
+
+ @TriggerTreeKind(Kind.COMPILATION_UNIT)
+ @Messages({
+ "ERR_NoRef=Reference output missing",
+ "ERR_RefFileMissing=Reference output file is missing",
+ })
+ public static List<ErrorDescription> computeWarning(HintContext ctx) {
+ Result tags = TagParser.parseTags(ctx.getInfo());
+ List<ErrorDescription> result = new ArrayList<>();
+ for (Tag tag : tags.getTags()) {
+ if (!"compile".equals(tag.getName())) {
+ continue;
+ }
+ if (tag.getValue().startsWith("/")) {
+ String firstParam = tag.getValue().split("[\\s]+", 2)[0];
+ boolean hasFail = false;
+ boolean hasRef = false;
+ int pos = tag.getTagEnd();
+ for (String opt : firstParam.split("/")) {
+ if ("fail".equals(opt)) {
+ hasFail = true;
+ } else if (opt.startsWith("ref=")) {
+ hasRef = true;
+ String fileName = opt.substring(4);
+ if
(ctx.getInfo().getFileObject().getParent().getFileObject(fileName) == null) {
+ ErrorDescription idealED =
ErrorDescriptionFactory.forName(ctx, ctx.getPath(),
Bundle.ERR_RefFileMissing(), new CreateRefFileFixImpl(ctx.getInfo(),
ctx.getPath(), fileName).toEditorFix());
+
+
result.add(org.netbeans.spi.editor.hints.ErrorDescriptionFactory.createErrorDescription(idealED.getSeverity(),
idealED.getDescription(), idealED.getFixes(), ctx.getInfo().getFileObject(),
pos + 4, pos + fileName.length() + 4));
+ }
+ }
+ pos += opt.length() + 1;
+ }
+ if (hasFail && !hasRef) {
+ ErrorDescription idealED =
ErrorDescriptionFactory.forName(ctx, ctx.getPath(), Bundle.ERR_NoRef(), new
AddRefFixImpl(ctx.getInfo(), ctx.getPath(), tag.getTagEnd() +
firstParam.length()).toEditorFix());
+
+
result.add(org.netbeans.spi.editor.hints.ErrorDescriptionFactory.createErrorDescription(idealED.getSeverity(),
idealED.getDescription(), idealED.getFixes(), ctx.getInfo().getFileObject(),
tag.getTagStart(), tag.getTagEnd()));
+ }
+ }
+ }
+ return result;
+ }
+
+ private static final class AddRefFixImpl extends JavaFix {
+
+ private final int pos;
+
+ public AddRefFixImpl(CompilationInfo info, TreePath tp, int pos) {
+ super(info, tp);
+ this.pos = pos;
+ }
+
+ @Override
+ @Messages("FIX_AddRefOutput=Add /ref output")
+ protected String getText() {
+ return Bundle.FIX_AddRefOutput();
+ }
+
+ @Override
+ protected void performRewrite(TransformationContext ctx) throws
IOException {
+ String fileName = ctx.getWorkingCopy().getFileObject().getName() +
".out";
+
+ ctx.getWorkingCopy().rewriteInComment(pos, 0, "/ref=" + fileName);
+ if
(ctx.getWorkingCopy().getFileObject().getParent().getFileObject(fileName) ==
null) {
+
ctx.getWorkingCopy().getFileObject().getParent().createData(fileName);
+ }
+ }
+ }
+
+ private static final class CreateRefFileFixImpl extends JavaFix {
+
+ private final String fileName;
+
+ public CreateRefFileFixImpl(CompilationInfo info, TreePath tp, String
fileName) {
+ super(info, tp);
+ this.fileName = fileName;
+ }
+
+ @Override
+ @Messages("FIX_CreateRefOutput=Create reference output file")
+ protected String getText() {
+ return Bundle.FIX_CreateRefOutput();
+ }
+
+ @Override
+ protected void performRewrite(TransformationContext ctx) throws
IOException {
+
ctx.getWorkingCopy().getFileObject().getParent().createData(fileName);
+ }
+
+ }
+}
diff --git
a/java/java.openjdk.project/src/org/netbeans/modules/java/openjdk/jtreg/TagParser.java
b/java/java.openjdk.project/src/org/netbeans/modules/java/openjdk/jtreg/TagParser.java
index 239aba3..c570ae6 100644
---
a/java/java.openjdk.project/src/org/netbeans/modules/java/openjdk/jtreg/TagParser.java
+++
b/java/java.openjdk.project/src/org/netbeans/modules/java/openjdk/jtreg/TagParser.java
@@ -44,7 +44,7 @@ public class TagParser {
"test", "bug", "summary", "library", "author", "modules",
"requires", "key", "library", "modules"
);
- private static final Pattern TAG_PATTERN =
Pattern.compile("@([a-zA-Z]+)(\\s+|$)");
+ private static final Pattern TAG_PATTERN =
Pattern.compile("@([a-zA-Z]+)(\\s+|/|$)");
public static Result parseTags(CompilationInfo info) {
return
parseTags(info.getTokenHierarchy().tokenSequence(JavaTokenId.language()));
@@ -91,7 +91,7 @@ public class TagParser {
start = pos;
tagStart = pos + m.start();
tagEnd = pos + m.end(1);
- tagText.append(line.substring(m.end()));
+ tagText.append(line.substring(m.end(1)));
} else if (tagName != null) {
int asterisk = line.indexOf('*');
tagText.append(line.substring(asterisk + 1));
diff --git
a/java/java.openjdk.project/test/unit/src/org/netbeans/modules/java/openjdk/jtreg/MissingRefOutputHintTest.java
b/java/java.openjdk.project/test/unit/src/org/netbeans/modules/java/openjdk/jtreg/MissingRefOutputHintTest.java
new file mode 100644
index 0000000..7533de1
--- /dev/null
+++
b/java/java.openjdk.project/test/unit/src/org/netbeans/modules/java/openjdk/jtreg/MissingRefOutputHintTest.java
@@ -0,0 +1,95 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.netbeans.modules.java.openjdk.jtreg;
+
+import org.junit.Test;
+import org.netbeans.modules.java.hints.test.api.HintTest;
+
+public class MissingRefOutputHintTest {
+
+ @Test
+ public void testNoRefOutput() throws Exception {
+ HintTest.create()
+ .input("/*@test\n" +
+ " *@compile/fail Test.java\n" +
+ " */\n" +
+ "class Test {\n" +
+ "}\n")
+ .run(MissingRefOutputHint.class)
+ .findWarning("1:2-1:10:verifier:" + Bundle.ERR_NoRef())
+ .applyFix()
+ .assertVerbatimOutput("/*@test\n" +
+ " *@compile/fail/ref=Test.out
Test.java\n" +
+ " */\n" +
+ "class Test {\n" +
+ "}\n")
+ .assertVerbatimOutput("test/Test.out",
+ "");
+ }
+
+ @Test
+ public void testMissingRefOutputFile() throws Exception {
+ HintTest.create()
+ .input("/*@test\n" +
+ " *@compile/fail/ref=Test.out Test.java\n" +
+ " */\n" +
+ "class Test {\n" +
+ "}\n")
+ .run(MissingRefOutputHint.class)
+ .findWarning("1:20-1:28:verifier:" +
Bundle.ERR_RefFileMissing())
+ .applyFix()
+ .assertVerbatimOutput("/*@test\n" +
+ " *@compile/fail/ref=Test.out
Test.java\n" +
+ " */\n" +
+ "class Test {\n" +
+ "}\n")
+ .assertVerbatimOutput("test/Test.out",
+ "");
+ }
+
+ @Test
+ public void testNoIssues() throws Exception {
+ HintTest.create()
+ .input("/*@test\n" +
+ " *@compile/fail/ref=Test.out Test.java\n" +
+ " */\n" +
+ "class Test {\n" +
+ "}\n")
+ .input("test/Test.out",
+ "Output",
+ false)
+ .run(MissingRefOutputHint.class)
+ .assertWarnings();
+ }
+
+ @Test
+ public void testMultipleIssues() throws Exception {
+ HintTest.create()
+ .input("/*@test\n" +
+ " *@compile/fail Test.java\n" +
+ " *@compile/fail/ref=Test.out2 Test.java\n" +
+ " */\n" +
+ "class Test {\n" +
+ "}\n")
+ .run(MissingRefOutputHint.class)
+ .assertWarnings("1:2-1:10:verifier:" + Bundle.ERR_NoRef(),
+ "2:20-2:29:verifier:" +
Bundle.ERR_RefFileMissing());
+ }
+
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
