Skip to content

Commit a42abc8

Browse files
author
Jason Faust
committed
Allow -log argument for Eclipse compiler
If the -log argument is used, the resulting log file is scanned for compiler output, both text and xml formatting supported. Otherwise a temporary log file is used to capture compiler output. * Eclipse compiler updated to 3.15.0 * Unit tests refactored * Output emitted as "INFO" are reported as Kind.NOTE * Column count adjusted to be 1-based index
1 parent acbb668 commit a42abc8

25 files changed

+1704
-265
lines changed

‎plexus-compiler-test/src/main/java/org/codehaus/plexus/compiler/AbstractCompilerTest.java

+77-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
package org.codehaus.plexus.compiler;
2-
3-
/**
1+
/*
42
* The MIT License
53
*
64
* Copyright (c) 2004, The Codehaus
@@ -23,17 +21,17 @@
2321
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2422
* SOFTWARE.
2523
*/
24+
package org.codehaus.plexus.compiler;
2625

2726
import org.apache.maven.artifact.Artifact;
2827
import org.apache.maven.artifact.DefaultArtifact;
2928
import org.apache.maven.artifact.handler.DefaultArtifactHandler;
3029
import org.apache.maven.artifact.test.ArtifactTestCase;
3130
import org.apache.maven.artifact.versioning.VersionRange;
32-
31+
import org.codehaus.plexus.compiler.CompilerMessage.Kind;
3332
import org.codehaus.plexus.util.FileUtils;
3433
import org.codehaus.plexus.util.StringUtils;
3534

36-
import javax.print.DocFlavor;
3735
import java.io.File;
3836
import java.util.ArrayList;
3937
import java.util.Collection;
@@ -42,9 +40,6 @@
4240
import java.util.List;
4341
import java.util.TreeSet;
4442

45-
/**
46-
*
47-
*/
4843
public abstract class AbstractCompilerTest
4944
extends ArtifactTestCase
5045
{
@@ -91,6 +86,22 @@ protected void configureCompilerConfig( CompilerConfiguration compilerConfig )
9186

9287
}
9388

89+
90+
/**
91+
* Called once per compile iteration to allow configuration customization for
92+
* tests.
93+
*
94+
* @param compilerConfig
95+
* configuration used for this compile iteration.
96+
* @param filename
97+
* file about to be compiled this iteration.
98+
* @since 2.8.6
99+
*/
100+
protected void configureCompilerConfig(CompilerConfiguration compilerConfig, String filename)
101+
{
102+
configureCompilerConfig( compilerConfig );
103+
}
104+
94105
public void testCompilingSources()
95106
throws Exception
96107
{
@@ -113,14 +124,16 @@ public void testCompilingSources()
113124

114125
int numCompilerErrors = compilerErrorCount( messages );
115126

116-
int numCompilerWarnings = messages.size() - numCompilerErrors;
127+
int numCompilerWarnings = compilerWarningCount( messages );
128+
129+
int numCompilerNotes = compilerNoteCount( messages );
117130

118131
if ( expectedErrors() != numCompilerErrors )
119132
{
120133
System.out.println( numCompilerErrors + " error(s) found:" );
121134
for ( CompilerMessage error : messages )
122135
{
123-
if ( !error.isError() )
136+
if ( error.getKind() != Kind.ERROR )
124137
{
125138
continue;
126139
}
@@ -139,7 +152,7 @@ public void testCompilingSources()
139152
System.out.println( numCompilerWarnings + " warning(s) found:" );
140153
for ( CompilerMessage error : messages )
141154
{
142-
if ( error.isError() )
155+
if ( error.getKind() == Kind.ERROR || error.getKind() == Kind.NOTE )
143156
{
144157
continue;
145158
}
@@ -153,6 +166,25 @@ public void testCompilingSources()
153166
assertEquals( "Wrong number of compilation warnings.", expectedWarnings(), numCompilerWarnings );
154167
}
155168

169+
if ( expectedNotes() != numCompilerNotes )
170+
{
171+
System.out.println( numCompilerWarnings + " notes(s) found:" );
172+
for (CompilerMessage error : messages)
173+
{
174+
if ( error.getKind() != Kind.NOTE )
175+
{
176+
continue;
177+
}
178+
179+
System.out.println( "----" );
180+
System.out.println( error.getFile() );
181+
System.out.println( error.getMessage() );
182+
System.out.println( "----" );
183+
}
184+
185+
assertEquals( "Wrong number of compilation notes.", expectedNotes(), numCompilerNotes );
186+
}
187+
156188
assertEquals( new TreeSet<>( normalizePaths( expectedOutputFiles() ) ), files );
157189
}
158190

@@ -190,7 +222,7 @@ private List<CompilerConfiguration> getCompilerConfigurations()
190222

191223
compilerConfig.setForceJavacCompilerUse( this.forceJavacCompilerUse );
192224

193-
configureCompilerConfig( compilerConfig );
225+
configureCompilerConfig( compilerConfig, filename );
194226

195227
String target = getTargetVersion();
196228
if( StringUtils.isNotEmpty( target) )
@@ -221,7 +253,6 @@ public String getSourceVersion()
221253
return null;
222254
}
223255

224-
225256
private List<String> normalizePaths( Collection<String> relativePaths )
226257
{
227258
List<String> normalizedPaths = new ArrayList<String>();
@@ -232,16 +263,32 @@ private List<String> normalizePaths( Collection<String> relativePaths )
232263
return normalizedPaths;
233264
}
234265

235-
protected int compilerErrorCount( List<CompilerMessage> messages )
266+
private int compilerErrorCount(List<CompilerMessage> messages)
267+
{
268+
return countKind( messages, Kind.ERROR );
269+
}
270+
271+
private int compilerWarningCount(List<CompilerMessage> messages)
272+
{
273+
return messages.size() - (compilerErrorCount( messages ) + compilerNoteCount( messages ));
274+
}
275+
276+
private int compilerNoteCount(List<CompilerMessage> messages)
236277
{
237-
int count = 0;
278+
return countKind( messages, Kind.NOTE );
279+
}
238280

239-
for ( CompilerMessage message : messages )
281+
private int countKind(List<CompilerMessage> messages, Kind kind)
282+
{
283+
int c = 0;
284+
for (CompilerMessage message : messages)
240285
{
241-
count += message.isError() ? 1 : 0;
286+
if ( message.getKind() == kind )
287+
{
288+
c++;
289+
}
242290
}
243-
244-
return count;
291+
return c;
245292
}
246293

247294
protected int expectedErrors()
@@ -254,6 +301,17 @@ protected int expectedWarnings()
254301
return 0;
255302
}
256303

304+
/**
305+
* Count of output generated at the {@link Kind#NOTE} level.
306+
*
307+
* @return count
308+
* @since 2.8.6
309+
*/
310+
protected int expectedNotes()
311+
{
312+
return 0;
313+
}
314+
257315
protected Collection<String> expectedOutputFiles()
258316
{
259317
return Collections.emptyList();

‎plexus-compilers/plexus-compiler-eclipse/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<dependency>
2222
<groupId>org.eclipse.jdt</groupId>
2323
<artifactId>ecj</artifactId>
24-
<version>3.13.100</version>
24+
<version>3.15.0</version>
2525
</dependency>
2626
</dependencies>
2727

‎plexus-compilers/plexus-compiler-eclipse/src/main/java/org/codehaus/plexus/compiler/eclipse/EcjLogParser.java

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package org.codehaus.plexus.compiler.eclipse;
2+
3+
import java.io.File;
4+
import java.util.List;
5+
6+
import org.codehaus.plexus.compiler.CompilerMessage;
7+
8+
/**
9+
* Log parser interface.
10+
*
11+
* @author <a href="mailto:[email protected]">Jason Faust</a>
12+
* @since 2.8.6
13+
*/
14+
public interface EcjLogParser {
15+
16+
/**
17+
* Pares an Eclipse Compiler log file.
18+
*
19+
* @param logFile file to parse.
20+
* @param errorsAsWarnings if errors should be down-graded to warnings.
21+
* @return the messages.
22+
* @throws Exception on parse errors.
23+
*/
24+
List<CompilerMessage> parse(File logFile, boolean errorsAsWarnings) throws Exception;
25+
26+
}

‎plexus-compilers/plexus-compiler-eclipse/src/main/java/org/codehaus/plexus/compiler/eclipse/EcjResponseParser.java

+22-5
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,19 @@
1616
import java.util.List;
1717

1818
/**
19+
* Created on 2018-03-31.
20+
*
1921
* @author <a href="mailto:[email protected]">Frits Jalvingh</a>
20-
* Created on 31-3-18.
22+
* @author <a href="mailto:[email protected]">Jason Faust</a>
2123
*/
22-
public class EcjResponseParser {
24+
public class EcjResponseParser implements EcjLogParser {
2325
/*--------------------------------------------------------------*/
2426
/* CODING: Decode ECJ -log format results. */
2527
/*--------------------------------------------------------------*/
2628
/**
2729
* Scan the specified response file for compilation messages.
2830
*/
31+
@Override
2932
public List<CompilerMessage> parse(File xmltf, boolean errorsAsWarnings) throws Exception {
3033
//if(xmltf.length() < 80)
3134
// return;
@@ -87,18 +90,32 @@ private void decodeProblems(List<CompilerMessage> list, String sourcePath, XMLSt
8790
private void decodeProblem(List<CompilerMessage> list, String sourcePath, XMLStreamReader xsr, boolean errorsAsWarnings) throws Exception {
8891
String id = xsr.getAttributeValue(null, "optionKey"); // Key for the problem
8992
int startline = getInt(xsr, "line");
90-
int column = getInt(xsr, "charStart");
91-
int endCol = getInt(xsr, "charEnd");
93+
int column = 0;
94+
int endCol = 0;
9295
String sev = xsr.getAttributeValue(null, "severity");
9396
String message = "Unknown message?";
9497

95-
//-- Go watch for "message"
98+
//-- Go watch for "message" and "source_context"
9699
while(xsr.hasNext()) {
97100
int type = xsr.nextTag();
98101
if(type == XMLStreamConstants.START_ELEMENT) {
99102
if("message".equals(xsr.getLocalName())) {
100103
message = xsr.getAttributeValue(null, "value");
101104
}
105+
if("source_context".equals(xsr.getLocalName())) {
106+
column = getInt(xsr, "sourceStart");
107+
if (column != -1) {
108+
column += 1; // Offset to 1-based index
109+
} else {
110+
column = 0;
111+
}
112+
endCol = getInt(xsr, "sourceEnd");
113+
if (endCol != -1) {
114+
endCol += 2; // Offset to 1-based index with one-after counting
115+
} else {
116+
endCol = 0;
117+
}
118+
}
102119
ignoreTillEnd(xsr);
103120

104121
} else if(type == XMLStreamConstants.END_ELEMENT) {

‎plexus-compilers/plexus-compiler-eclipse/src/main/java/org/codehaus/plexus/compiler/eclipse/EcjTextLogParser.java

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
package org.codehaus.plexus.compiler.eclipse;
2+
3+
import java.io.BufferedReader;
4+
import java.io.File;
5+
import java.io.FileInputStream;
6+
import java.io.InputStreamReader;
7+
import java.nio.charset.StandardCharsets;
8+
import java.util.ArrayList;
9+
import java.util.LinkedList;
10+
import java.util.List;
11+
import java.util.regex.Matcher;
12+
import java.util.regex.Pattern;
13+
14+
import org.codehaus.plexus.compiler.CompilerMessage;
15+
import org.codehaus.plexus.compiler.CompilerMessage.Kind;
16+
17+
/**
18+
* Parser for non-XML Eclipse Compiler output.
19+
*
20+
* @author <a href="mailto:[email protected]">Jason Faust</a>
21+
* @since 2.8.6
22+
*/
23+
public class EcjTextLogParser implements EcjLogParser {
24+
25+
private static final String TEN_DASH = "----------";
26+
private static final String PATTERN_LEVEL_FILE = "^\\d+\\.\\s+(\\w+)\\s+in\\s+(.*)\\s+\\(at line (\\d+)\\)$";
27+
28+
private Pattern levelFile = Pattern.compile(PATTERN_LEVEL_FILE);
29+
30+
@Override
31+
public List<CompilerMessage> parse(File logFile, boolean errorsAsWarnings) throws Exception {
32+
List<CompilerMessage> ret = new ArrayList<>();
33+
try (BufferedReader in = new BufferedReader(
34+
new InputStreamReader(new FileInputStream(logFile), StandardCharsets.UTF_8))) {
35+
String line;
36+
List<String> buffer = new LinkedList<>();
37+
boolean header = true;
38+
39+
while ((line = in.readLine()) != null) {
40+
if (header) {
41+
if (!line.startsWith(TEN_DASH)) {
42+
continue;
43+
}
44+
header = false;
45+
}
46+
if (line.startsWith(TEN_DASH)) {
47+
if (!buffer.isEmpty()) {
48+
ret.add(parse(buffer, errorsAsWarnings));
49+
}
50+
buffer.clear();
51+
} else {
52+
buffer.add(line);
53+
}
54+
}
55+
}
56+
return ret;
57+
}
58+
59+
private CompilerMessage parse(List<String> buffer, boolean errorsAsWarnings) {
60+
61+
Kind kind = null;
62+
String file = null;
63+
int lineNum = 0;
64+
int startCol = 0;
65+
int endCol = 0;
66+
String message = null;
67+
68+
// First line, kind, file, lineNum
69+
if (buffer.size() > 1) {
70+
String str = buffer.get(0);
71+
Matcher matcher = levelFile.matcher(str);
72+
if (matcher.find()) {
73+
file = matcher.group(2);
74+
kind = decodeKind(matcher.group(1), errorsAsWarnings);
75+
lineNum = Integer.parseInt(matcher.group(3));
76+
}
77+
}
78+
79+
// Last line, message
80+
if (buffer.size() >= 2) {
81+
String str = buffer.get(buffer.size() - 1);
82+
message = str.trim();
83+
}
84+
85+
// 2nd to last line, columns
86+
if (buffer.size() >= 3) {
87+
String str = buffer.get(buffer.size() - 2);
88+
startCol = str.indexOf('^');
89+
endCol = str.lastIndexOf('^') + 1;
90+
}
91+
92+
return new CompilerMessage(file, kind, lineNum, startCol, lineNum, endCol, message);
93+
}
94+
95+
private Kind decodeKind(String str, boolean errorsAsWarnings) {
96+
if (str.equals("ERROR")) {
97+
return errorsAsWarnings ? Kind.WARNING : Kind.ERROR;
98+
}
99+
if (str.equals("INFO")) {
100+
return Kind.NOTE;
101+
}
102+
return Kind.WARNING;
103+
}
104+
105+
}

0 commit comments

Comments
 (0)