/
ArtifactsMojo.java
266 lines (236 loc) · 6.86 KB
/
ArtifactsMojo.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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
/*
* checksum-maven-plugin - http://checksum-maven-plugin.nicoulaj.net
* Copyright © 2010-2018 checksum-maven-plugin contributors
*
* 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 net.nicoulaj.maven.plugins.checksum.mojo;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import java.util.LinkedList;
import java.util.List;
/**
* Compute project artifacts checksum digests and store them in individual files and/or a summary file.
*
* @author <a href="mailto:julien.nicoulaud@gmail.com">Julien Nicoulaud</a>
* @since 1.0
*/
@Mojo(
name = ArtifactsMojo.NAME,
defaultPhase = LifecyclePhase.VERIFY,
requiresProject = true,
inheritByDefault = false,
threadSafe = true )
public class ArtifactsMojo
extends AbstractChecksumMojo
{
/**
* The mojo name.
*/
public static final String NAME = "artifacts";
/**
* Indicates whether the build will store checksums in separate files (one file per algorithm per artifact).
*
* @since 1.0
*/
@Parameter( defaultValue = "true" )
protected boolean individualFiles;
/**
* The directory where output files will be stored. Leave unset to have each file next to the source file.
*
* @since 1.0
*/
@Parameter
protected String individualFilesOutputDirectory;
/**
* Indicates whether the build will store checksums to a single CSV summary file.
*
* @since 1.0
*/
@Parameter( defaultValue = "false" )
protected boolean csvSummary;
/**
* The name of the summary file created if the option is activated.
*
* @see #csvSummary
* @since 1.0
*/
@Parameter( defaultValue = "artifacts-checksums.csv" )
protected String csvSummaryFile;
/**
* Indicates whether the build will store checksums to a single XML summary file.
*
* @since 1.0
*/
@Parameter( defaultValue = "false" )
protected boolean xmlSummary;
/**
* The name of the summary file created if the option is activated.
*
* @see #xmlSummary
* @since 1.0
*/
@Parameter( defaultValue = "artifacts-checksums.xml" )
protected String xmlSummaryFile;
/**
* Indicates whether the build will store checksums to a single shasum summary file.
*
* @since 1.3
*/
@Parameter( defaultValue = "false" )
protected boolean shasumSummary;
/**
* The name of the summary file created if the option is activated.
*
* @see #shasumSummary
* @since 1.3
*/
@Parameter( defaultValue = "artifacts-checksums.sha" )
protected String shasumSummaryFile;
/**
* Append the artifact filename in the generated checksum file.
* This parameter require the parameter individualFiles be equal to true.
*
* @see #individualFiles
* @since 1.4
*/
@Parameter (defaultValue = "false")
protected boolean appendFilename;
/**
* Constructor.
*/
public ArtifactsMojo() {
super(false, true, true);
}
/**
* Build the list of files from which digests should be generated.
*
* <p>The list is composed of the project main and attached artifacts.</p>
*
* @return the list of files that should be processed.
* @see #hasValidFile(org.apache.maven.artifact.Artifact)
*/
@Override
protected List<ChecksumFile> getFilesToProcess()
{
List<ChecksumFile> files = new LinkedList<>();
// Add project main artifact.
if ( hasValidFile( project.getArtifact() ) )
{
files.add( new ChecksumFile( "", project.getArtifact().getFile(), project.getArtifact().getType(),null ) );
}
// Add projects attached.
if ( project.getAttachedArtifacts() != null )
{
for ( Artifact artifact : (List<Artifact>) project.getAttachedArtifacts() )
{
if ( hasValidFile( artifact ) )
{
files.add( new ChecksumFile( "", artifact.getFile(), artifact.getType(), artifact.getClassifier() ) );
}
}
}
return files;
}
/**
* Decide whether the artifact file should be processed.
*
* <p>Excludes the project POM file and any file outside the build directory, because this could lead to writing
* files on the user local repository for example.</p>
*
* @param artifact the artifact to check.
* @return true if the artifact should be included in the files to process.
*/
protected boolean hasValidFile( Artifact artifact )
{
// Make sure the file exists.
boolean hasValidFile = artifact != null && artifact.getFile() != null && artifact.getFile().exists();
// Exclude project POM file.
hasValidFile = hasValidFile && !artifact.getFile().getPath().equals( project.getFile().getPath() );
// Exclude files outside of build directory.
hasValidFile = hasValidFile && artifact.getFile().getPath().startsWith( project.getBuild().getDirectory() );
return hasValidFile;
}
/**
* {@inheritDoc}
*/
@Override
protected boolean isIndividualFiles()
{
return individualFiles;
}
/**
* {@inheritDoc}
*/
@Override
protected String getIndividualFilesOutputDirectory()
{
return individualFilesOutputDirectory;
}
/**
* {@inheritDoc}
*/
@Override
protected boolean isAppendFilename(){
return this.appendFilename;
}
/**
* {@inheritDoc}
*/
@Override
protected boolean isCsvSummary()
{
return csvSummary;
}
/**
* {@inheritDoc}
*/
protected String getCsvSummaryFile()
{
return csvSummaryFile;
}
/**
* {@inheritDoc}
*/
@Override
protected boolean isXmlSummary()
{
return xmlSummary;
}
/**
* {@inheritDoc}
*/
@Override
protected String getXmlSummaryFile()
{
return xmlSummaryFile;
}
/**
* {@inheritDoc}
*/
@Override
protected boolean isShasumSummary()
{
return shasumSummary;
}
/**
* {@inheritDoc}
*/
@Override
protected String getShasumSummaryFile()
{
return shasumSummaryFile;
}
}