-
Notifications
You must be signed in to change notification settings - Fork 5
/
VerifierMojo.java
252 lines (221 loc) · 8.08 KB
/
VerifierMojo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
package org.apache.maven.plugins.verifier;
/*
* 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.
*/
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/*
* 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.
*/
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.verifier.model.Verifications;
import org.apache.maven.plugins.verifier.model.io.xpp3.VerificationsXpp3Reader;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* Verifies the existence or non-existence of files/directories and optionally checks file content against a regular
* expression.
*
* @author <a href="vmassol@apache.org">Vincent Massol</a>
*/
@Mojo( name = "verify", defaultPhase = LifecyclePhase.INTEGRATION_TEST )
public class VerifierMojo
extends AbstractMojo
{
/**
* Project base directory (prepended to relative file paths).
*/
@Parameter( property = "basedir", required = true )
private File basedir;
/**
* The file containing the verifications to perform.
*/
@Parameter( property = "verifier.verificationFile", defaultValue = "${basedir}/src/test/verifier/verifications.xml",
required = true )
private File verificationFile;
/**
* Whether the build will fail on verification errors.
*/
@Parameter( property = "verifier.failOnError", defaultValue = "true", required = true )
private boolean failOnError;
private VerificationResultPrinter resultPrinter = new ConsoleVerificationResultPrinter( getLog() );
/**
* {@inheritDoc}
*/
public void execute()
throws MojoExecutionException
{
VerificationResult results = verify();
resultPrinter.print( results );
// Fail the build if there are errors
if ( this.failOnError && results.hasFailures() )
{
throw new MojoExecutionException( "There are test failures" );
}
}
/**
* @param file the file path of the file to check (can be relative or absolute). If relative
* the project's basedir will be prefixed.
* @return the absolute file path of the file to check
*/
protected File getAbsoluteFileToCheck( File file )
{
File result = file;
if ( !file.isAbsolute() )
{
result = new File( basedir, file.getPath() );
}
return result;
}
private VerificationResult verify()
throws MojoExecutionException
{
VerificationResult results = new VerificationResult();
try ( Reader reader = new FileReader( verificationFile ) )
{
VerificationsXpp3Reader xppReader = new VerificationsXpp3Reader();
Verifications verifications = xppReader.read( reader );
for ( org.apache.maven.plugins.verifier.model.File file : verifications.getFiles() )
{
// Transform the file to check into an absolute path prefixing the basedir if
// the location is relative
if ( file.getLocation() != null )
{
file.setLocation( getAbsoluteFileToCheck( new File( file.getLocation() ) ).getPath() );
verifyFile( file, results );
}
else
{
throw new MojoExecutionException( "Missing <location> element" );
}
}
}
catch ( XmlPullParserException | IOException e )
{
throw new MojoExecutionException( "Error while verifying files", e );
}
return results;
}
private boolean verifyFile( org.apache.maven.plugins.verifier.model.File fileCheck, VerificationResult results )
throws IOException
{
boolean result;
result = verifyFileExistence( fileCheck, results );
if ( result && fileCheck.getContains() != null )
{
result = result && verifyFileContent( fileCheck, results );
}
return result;
}
private boolean verifyFileContent( org.apache.maven.plugins.verifier.model.File fileCheck,
VerificationResult results )
throws IOException
{
boolean result = false;
getLog().debug( "Verifying contents of " + fileCheck.getLocation() );
Pattern pattern = Pattern.compile( fileCheck.getContains() );
// Note: Very inefficient way as we load the whole file in memory. If you have a better
// idea, please submit it!
Matcher matcher = pattern.matcher( FileUtils.fileRead( new File( fileCheck.getLocation() ) ) );
if ( matcher.find() )
{
result = true;
}
else
{
results.addContentFailure( fileCheck );
}
return result;
}
private boolean verifyFileExistence( org.apache.maven.plugins.verifier.model.File fileCheck,
VerificationResult results )
{
boolean result;
File physicalFile = new File( fileCheck.getLocation() );
if ( fileCheck.isExists() )
{
getLog().debug( "Verifying existence of " + physicalFile );
result = physicalFile.exists();
if ( !result )
{
results.addExistenceFailure( fileCheck );
}
}
else
{
getLog().debug( "Verifying absence of " + physicalFile );
result = !physicalFile.exists();
if ( !result )
{
results.addNonExistenceFailure( fileCheck );
}
}
return result;
}
/**
* @param theBasedir Set the base directory.
*/
public void setBaseDir( File theBasedir )
{
this.basedir = theBasedir;
}
/**
* @param file Set the file for verification.
*/
public void setVerificationFile( File file )
{
this.verificationFile = file;
}
/**
* @param printer The verification result printer {@link VerificationResultPrinter}
*/
public void setVerificationResultPrinter( VerificationResultPrinter printer )
{
this.resultPrinter = printer;
}
/**
* @param failOnError true to fail on error false otherwise.
*/
public void setFailOnError( boolean failOnError )
{
this.failOnError = failOnError;
}
}