You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@netbeans.apache.org by GitBox <gi...@apache.org> on 2018/09/10 21:19:28 UTC
[GitHub] matthiasblaesing closed pull request #851: [NETBEANS-643] Mercurial
Annotate fails on file with spaces and leading dots
matthiasblaesing closed pull request #851: [NETBEANS-643] Mercurial Annotate fails on file with spaces and leading dots
URL: https://github.com/apache/incubator-netbeans/pull/851
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/ide/mercurial/src/org/netbeans/modules/mercurial/ui/annotate/AnnotateAction.java b/ide/mercurial/src/org/netbeans/modules/mercurial/ui/annotate/AnnotateAction.java
index ea9470a54b..37389bd8f5 100644
--- a/ide/mercurial/src/org/netbeans/modules/mercurial/ui/annotate/AnnotateAction.java
+++ b/ide/mercurial/src/org/netbeans/modules/mercurial/ui/annotate/AnnotateAction.java
@@ -282,7 +282,7 @@ private static void fillCommitMessages(AnnotateLine [] annotations, HgLogMessage
}
}
- private static AnnotateLine [] toAnnotateLines(List<String> annotations)
+ static AnnotateLine [] toAnnotateLines(List<String> annotations)
{
final int GROUP_AUTHOR = 1;
final int GROUP_REVISION = 2;
@@ -292,7 +292,37 @@ private static void fillCommitMessages(AnnotateLine [] annotations, HgLogMessage
List<AnnotateLine> lines = new ArrayList<AnnotateLine>();
int i = 0;
- Pattern p = Pattern.compile("^\\s*(\\S+\\b)\\s+(\\d+)\\s+(\\b\\S*):\\s*(\\d+):\\s(.*)$"); //NOI18N
+ /*
+ The output pattern of the mercurial blame command seems to be pretty
+ stable. In the test 3.1.2 and 4.5.3 were compared and found to yield
+ identical outputs.
+
+ Alternatives are currently not viable - while the JSON output sounds
+ better, it is not stable as it significantly changed from 4.0 to 4.5.3.
+
+ Oberservations:
+ - the output contains 5 elements:
+ - username
+ - revision number
+ - filename
+ - line number
+ - line content
+ - the username does not contains spaces
+ - there can be whitespace before the username (the column is right
+ aligned with the longest username
+ - the revision number is purely nummeric
+ - the revision number is right aligned and is padded with spaces
+ on the left side
+ - after the revision number exactly one space is placed
+ - the filename has no limit
+ - between the filename and the linenumber is a colon placed directly
+ behind the filename
+ - between the colon and the linenumber an unlimited number of spaces can
+ be present
+ - directly behind the linenumber a colon and a space is placed
+ - the rest of the line is the line content
+ */
+ Pattern p = Pattern.compile("^\\s*(\\S+)\\s+(\\d+) (.*?):\\s*(\\d+): (.*)$"); //NOI18N
for (String line : annotations) {
i++;
Matcher m = p.matcher(line);
diff --git a/ide/mercurial/test/unit/src/org/netbeans/modules/mercurial/ui/annotate/AnnotateActionTest.java b/ide/mercurial/test/unit/src/org/netbeans/modules/mercurial/ui/annotate/AnnotateActionTest.java
new file mode 100644
index 0000000000..0f5abf47b3
--- /dev/null
+++ b/ide/mercurial/test/unit/src/org/netbeans/modules/mercurial/ui/annotate/AnnotateActionTest.java
@@ -0,0 +1,196 @@
+/*
+ * 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.mercurial.ui.annotate;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import static junit.framework.TestCase.assertFalse;
+import static junit.framework.TestCase.assertNotNull;
+import static org.junit.Assert.assertEquals;
+import org.junit.Test;
+
+public class AnnotateActionTest {
+
+ private static class AnnotateTestCase {
+ private final String input;
+ private final String expectedUser;
+ private final String exectedRevision;
+ private final String expectedFilename;
+ private final int expectedLineNumber;
+ private final String expectedContent;
+
+ public AnnotateTestCase(String input, String expectedUser, String exectedRevision, String expectedFilename, int expectedLineNumber, String expectedContent) {
+ this.input = input;
+ this.expectedUser = expectedUser;
+ this.exectedRevision = exectedRevision;
+ this.expectedFilename = expectedFilename;
+ this.expectedLineNumber = expectedLineNumber;
+ this.expectedContent = expectedContent;
+ }
+
+ public void runTest(int idx) {
+ AnnotateLine[] resultLines = AnnotateAction.toAnnotateLines(Collections.singletonList(input));
+ assertNotNull(resultLines);
+ assertEquals(1, resultLines.length);
+ AnnotateLine result = resultLines[0];
+ assertNotNull(result);
+
+ assertFalse("Testcase " + idx + " resulted in FakeAnnotationLine", result.getClass().getName().contains("FakeAnnotationLine"));
+ assertEquals("Testcase " + idx, expectedUser, result.getUsername());
+ assertEquals("Testcase " + idx, expectedFilename, result.getFileName());
+ assertEquals("Testcase " + idx, exectedRevision, result.getRevision());
+ assertEquals("Testcase " + idx, expectedLineNumber, result.getPreviousLineNumber());
+ assertEquals("Testcase " + idx, expectedContent, result.getContent());
+ }
+ }
+
+ @Test
+ public void testToAnnotateLines() {
+ List<AnnotateTestCase> testInput = new ArrayList<>();
+ /*
+
+ Testcases were generated on Ubuntu 18.04 and debian Jessie (oldstable
+ by the time of creation). Outputs are marked with a leading ">"
+
+ ------------------------------------------------------------------------
+
+ mkdir sampledir
+ cd sampledir
+
+ hg --version
+
+ > Mercurial Distributed SCM (version 4.5.3)
+ > (see https://mercurial-scm.org for more information)
+
+ > Mercurial Distributed SCM (version 3.1.2)
+ > (siehe http://mercurial.selenic.com f?r mehr Information)
+
+ hg init
+ echo "Simplefile" > simplefile
+ echo "File with space" > file\ with\ space
+ echo "File with colon" > file\ \:\ with\ colon
+ echo "File with leading dot" > .fileWithLeadingDot
+ echo "File with leading and trailing space" > " leading and trailing space "
+ hg add simplefile file\ with\ space file\ \:\ with\ colon .fileWithLeadingDot " leading and trailing space "
+ hg commit -m "Simple user" -u "simpleuser"
+ hg annotate --repository . --number --user --line-number --follow simplefile file\ with\ space file\ \:\ with\ colon .fileWithLeadingDot " leading and trailing space "
+
+ > simpleuser 0 leading and trailing space :1: File with leading and trailing space
+ > simpleuser 0 .fileWithLeadingDot:1: File with leading dot
+ > simpleuser 0 file : with colon:1: File with colon
+ > simpleuser 0 file with space:1: File with space
+ > simpleuser 0 simplefile:1: Simplefile
+
+ echo "User with colon" > simplefile
+ echo "User with colon" > file\ with\ space
+ echo "User with colon" > file\ \:\ with\ colon
+ echo "User with colon" > .fileWithLeadingDot
+ echo "User with colon" > " leading and trailing space "
+ hg commit -m "User with colon" -u "simple:user"
+ hg annotate --repository . --number --user --line-number --follow simplefile file\ with\ space file\ \:\ with\ colon .fileWithLeadingDot " leading and trailing space "
+
+ > simple:user 1 leading and trailing space :1: User with colon
+ > simple:user 1 .fileWithLeadingDot:1: User with colon
+ > simple:user 1 file : with colon:1: User with colon
+ > simple:user 1 file with space:1: User with colon
+ > simple:user 1 simplefile:1: User with colon
+
+ echo "User with colon and space" > simplefile
+ echo "User with colon and space" > file\ with\ space
+ echo "User with colon and space" > file\ \:\ with\ colon
+ echo "User with colon and space" > .fileWithLeadingDot
+ echo "User with colon and space" > " leading and trailing space "
+ hg commit -m "User with colon and space" -u "simple : user"
+ hg annotate --repository . --number --user --line-number --follow simplefile file\ with\ space file\ \:\ with\ colon .fileWithLeadingDot " leading and trailing space "
+
+ > simple 2 leading and trailing space :1: User with colon and space
+ > simple 2 .fileWithLeadingDot:1: User with colon and space
+ > simple 2 file : with colon:1: User with colon and space
+ > simple 2 file with space:1: User with colon and space
+ > simple 2 simplefile:1: User with colon and space
+
+ echo "User with colon and space 2" > simplefile
+ echo "User with colon and space 2" > file\ with\ space
+ echo "User with colon and space 2" > file\ \:\ with\ colon
+ echo "User with colon and space 2" > .fileWithLeadingDot
+ echo "User with colon and space 2" > " leading and trailing space "
+ hg commit -m "User with colon and space 2" -u "simple\ :\ user"
+ hg annotate --repository . --number --user --line-number --follow simplefile file\ with\ space file\ \:\ with\ colon .fileWithLeadingDot " leading and trailing space "
+
+ > simple\ 3 leading and trailing space :1: User with colon and space 2
+ > simple\ 3 .fileWithLeadingDot:1: User with colon and space 2
+ > simple\ 3 file : with colon:1: User with colon and space 2
+ > simple\ 3 file with space:1: User with colon and space 2
+ > simple\ 3 simplefile:1: User with colon and space 2
+
+ echo "Complex user" > simplefile
+ echo "Complex user" > file\ with\ space
+ echo "Complex user" > file\ \:\ with\ colon
+ echo "Complex user" > .fileWithLeadingDot
+ echo "Complex user" > " leading and trailing space "
+ hg commit -m "Complex User" -u "Complex User <co...@testdomain.invalid>"
+ hg annotate --repository . --number --user --line-number --follow simplefile file\ with\ space file\ \:\ with\ colon .fileWithLeadingDot " leading and trailing space "
+
+ > complex:email 4 leading and trailing space :1: Complex user
+ > complex:email 4 .fileWithLeadingDot:1: Complex user
+ > complex:email 4 file : with colon:1: Complex user
+ > complex:email 4 file with space:1: Complex user
+ > complex:email 4 simplefile:1: Complex user
+
+ ------------------------------------------------------------------------
+
+ */
+ testInput.add(new AnnotateTestCase("simpleuser 0 simplefile:1: Simplefile", "simpleuser", "0", "simplefile", 1, "Simplefile"));
+ testInput.add(new AnnotateTestCase("simpleuser 0 file with space:1: File with space", "simpleuser", "0", "file with space", 1, "File with space"));
+ testInput.add(new AnnotateTestCase("simpleuser 0 file : with colon:1: File with colon", "simpleuser", "0", "file : with colon", 1, "File with colon"));
+ testInput.add(new AnnotateTestCase("simpleuser 0 .fileWithLeadingDot:1: File with leading dot", "simpleuser", "0", ".fileWithLeadingDot", 1, "File with leading dot"));
+ testInput.add(new AnnotateTestCase("simpleuser 0 leading and trailing space :1: File with leading and trailing space", "simpleuser", "0", " leading and trailing space ", 1, "File with leading and trailing space"));
+ testInput.add(new AnnotateTestCase("simple:user 1 simplefile:1: User with colon", "simple:user", "1", "simplefile", 1, "User with colon"));
+ testInput.add(new AnnotateTestCase("simple:user 1 file with space:1: User with colon", "simple:user", "1", "file with space", 1, "User with colon"));
+ testInput.add(new AnnotateTestCase("simple:user 1 file : with colon:1: User with colon", "simple:user", "1", "file : with colon", 1, "User with colon"));
+ testInput.add(new AnnotateTestCase("simple:user 1 .fileWithLeadingDot:1: User with colon", "simple:user", "1", ".fileWithLeadingDot", 1, "User with colon"));
+ testInput.add(new AnnotateTestCase("simple:user 1 leading and trailing space :1: User with colon", "simple:user", "1", " leading and trailing space ", 1, "User with colon"));
+ testInput.add(new AnnotateTestCase("simple 2 simplefile:1: User with colon and space", "simple", "2", "simplefile", 1, "User with colon and space"));
+ testInput.add(new AnnotateTestCase("simple 2 file with space:1: User with colon and space", "simple", "2", "file with space", 1, "User with colon and space"));
+ testInput.add(new AnnotateTestCase("simple 2 file : with colon:1: User with colon and space", "simple", "2", "file : with colon", 1, "User with colon and space"));
+ testInput.add(new AnnotateTestCase("simple 2 .fileWithLeadingDot:1: User with colon and space", "simple", "2", ".fileWithLeadingDot", 1, "User with colon and space"));
+ testInput.add(new AnnotateTestCase("simple 2 leading and trailing space :1: User with colon and space", "simple", "2", " leading and trailing space ", 1, "User with colon and space"));
+ testInput.add(new AnnotateTestCase("simple\\ 3 simplefile:1: User with colon and space 2", "simple\\", "3", "simplefile", 1, "User with colon and space 2"));
+ testInput.add(new AnnotateTestCase("simple\\ 3 file with space:1: User with colon and space 2", "simple\\", "3", "file with space", 1, "User with colon and space 2"));
+ testInput.add(new AnnotateTestCase("simple\\ 3 file : with colon:1: User with colon and space 2", "simple\\", "3", "file : with colon", 1, "User with colon and space 2"));
+ testInput.add(new AnnotateTestCase("simple\\ 3 .fileWithLeadingDot:1: User with colon and space 2", "simple\\", "3", ".fileWithLeadingDot", 1, "User with colon and space 2"));
+ testInput.add(new AnnotateTestCase("simple\\ 3 leading and trailing space :1: User with colon and space 2", "simple\\", "3", " leading and trailing space ", 1, "User with colon and space 2"));
+ testInput.add(new AnnotateTestCase("complex:email 4 simplefile:1: Complex user", "complex:email", "4", "simplefile", 1, "Complex user"));
+ testInput.add(new AnnotateTestCase("complex:email 4 file with space:1: Complex user", "complex:email", "4", "file with space", 1, "Complex user"));
+ testInput.add(new AnnotateTestCase("complex:email 4 file : with colon:1: Complex user", "complex:email", "4", "file : with colon", 1, "Complex user"));
+ testInput.add(new AnnotateTestCase("complex:email 4 .fileWithLeadingDot:1: Complex user", "complex:email", "4", ".fileWithLeadingDot", 1, "Complex user"));
+ testInput.add(new AnnotateTestCase("complex:email 4 leading and trailing space :1: Complex user", "complex:email", "4", " leading and trailing space ", 1, "Complex user"));
+ // One verification from the netbeans old codebase
+ testInput.add(new AnnotateTestCase(" jglick 2218 nbbuild/build.xml: 2: <!--", "jglick", "2218", "nbbuild/build.xml", 2, "<!--"));
+ // NETBEANS-643
+ testInput.add(new AnnotateTestCase("foo 8731 foo/ba r.baz: 98: Stuff", "foo", "8731", "foo/ba r.baz", 98, "Stuff"));
+ testInput.add(new AnnotateTestCase("foo 8731 .foo/bar.baz: 98: Stuff", "foo", "8731", ".foo/bar.baz", 98, "Stuff"));
+
+ for(int i = 0; i < testInput.size(); i++) {
+ testInput.get(i).runTest(i);
+ }
+ }
+
+}
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@netbeans.apache.org
For additional commands, e-mail: notifications-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists