forked from mojohaus/flatten-maven-plugin
/
FlattenMojo.java
1319 lines (1211 loc) · 55.2 KB
/
FlattenMojo.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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package org.codehaus.mojo.flatten;
/*
* 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.util.Queue;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Activation;
import org.apache.maven.model.Build;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Exclusion;
import org.apache.maven.model.Model;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.Profile;
import org.apache.maven.model.Repository;
import org.apache.maven.model.RepositoryPolicy;
import org.apache.maven.model.building.DefaultModelBuildingRequest;
import org.apache.maven.model.building.ModelBuildingException;
import org.apache.maven.model.building.ModelBuildingRequest;
import org.apache.maven.model.building.ModelBuildingResult;
import org.apache.maven.model.building.ModelProblemCollector;
import org.apache.maven.model.interpolation.ModelInterpolator;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.apache.maven.model.io.xpp3.MavenXpp3Writer;
import org.apache.maven.model.profile.ProfileActivationContext;
import org.apache.maven.model.profile.ProfileInjector;
import org.apache.maven.model.profile.ProfileSelector;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.dependency.tree.DependencyNode;
import org.apache.maven.shared.dependency.tree.DependencyTreeBuilder;
import org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException;
import org.apache.maven.shared.dependency.tree.traversal.DependencyNodeVisitor;
import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver;
import org.codehaus.mojo.flatten.cifriendly.CiInterpolator;
import org.codehaus.mojo.flatten.model.resolution.FlattenModelResolver;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.impl.ArtifactDescriptorReader;
import org.eclipse.aether.resolution.ArtifactDescriptorException;
import org.eclipse.aether.resolution.ArtifactDescriptorRequest;
import org.eclipse.aether.resolution.ArtifactDescriptorResult;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.ext.DefaultHandler2;
import javax.inject.Inject;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import java.util.Set;
/**
* This MOJO realizes the goal <code>flatten</code> that generates the flattened POM and {@link #isUpdatePomFile()
* potentially updates the POM file} so that the current {@link MavenProject}'s {@link MavenProject#getFile() file}
* points to the flattened POM instead of the original <code>pom.xml</code> file. The flattened POM is a reduced version
* of the original POM with the focus to contain only the important information for consuming it. Therefore information
* that is only required for maintenance by developers and to build the project artifact(s) are stripped. Starting from
* here we specify how the flattened POM is created from the original POM and its project:<br>
* <table>
* <caption></caption>
* <tr>
* <th>Element</th>
* <th>Transformation</th>
* <th>Note</th>
* </tr>
* <tr>
* <td>{@link Model#getModelVersion() modelVersion}</td>
* <td>Fixed to "4.0.0"</td>
* <td>New maven versions will once be able to evolve the model version without incompatibility to older versions if
* flattened POMs get deployed.</td>
* </tr>
* <tr>
* <td>{@link Model#getGroupId() groupId}<br>
* {@link Model#getArtifactId() artifactId}<br>
* {@link Model#getVersion() version}<br>
* {@link Model#getPackaging() packaging}</td>
* <td>resolved</td>
* <td>copied to the flattened POM but with inheritance from {@link Model#getParent() parent} as well as with all
* variables and defaults resolved. These elements are technically required for consumption.</td>
* </tr>
* <tr>
* <td>{@link Model#getLicenses() licenses}</td>
* <td>resolved</td>
* <td>copied to the flattened POM but with inheritance from {@link Model#getParent() parent} as well as with all
* variables and defaults resolved. The licenses would not be required in flattened POM. However, they make sense for
* publication and deployment and are important for consumers of your artifact.</td>
* </tr>
* <tr>
* <td>{@link Model#getDependencies() dependencies}</td>
* <td>resolved specially</td>
* <td>flattened POM contains the actual dependencies of the project. Test dependencies are removed. Variables and
* {@link Model#getDependencyManagement() dependencyManagement} is resolved to get fixed dependency attributes
* (especially {@link Dependency#getVersion() version}). If {@link #isEmbedBuildProfileDependencies()
* embedBuildProfileDependencies} is set to <code>true</code>, then also build-time driven {@link Profile}s will be
* evaluated and may add {@link Dependency dependencies}. For further details see {@link Profile}s below.</td>
* </tr>
* <tr>
* <td>{@link Model#getProfiles() profiles}</td>
* <td>resolved specially</td>
* <td>only the {@link Activation} and the {@link Dependency dependencies} of a {@link Profile} are copied to the
* flattened POM. If you set the parameter {@link #isEmbedBuildProfileDependencies() embedBuildProfileDependencies} to
* <code>true</code> then only profiles {@link Activation activated} by {@link Activation#getJdk() JDK} or
* {@link Activation#getOs() OS} will be added to the flattened POM while the other profiles are triggered by the
* current build setup and if activated their impact on dependencies is embedded into the resulting flattened POM.</td>
* </tr>
* <tr>
* <td>{@link Model#getName() name}<br>
* {@link Model#getDescription() description}<br>
* {@link Model#getUrl() url}<br>
* {@link Model#getInceptionYear() inceptionYear}<br>
* {@link Model#getOrganization() organization}<br>
* {@link Model#getScm() scm}<br>
* {@link Model#getDevelopers() developers}<br>
* {@link Model#getContributors() contributors}<br>
* {@link Model#getMailingLists() mailingLists}<br>
* {@link Model#getPluginRepositories() pluginRepositories}<br>
* {@link Model#getIssueManagement() issueManagement}<br>
* {@link Model#getCiManagement() ciManagement}<br>
* {@link Model#getDistributionManagement() distributionManagement}</td>
* <td>configurable</td>
* <td>Will be stripped from the flattened POM by default. You can configure all of the listed elements inside
* <code>pomElements</code> that should be kept in the flattened POM (e.g. {@literal
* <pomElements><name/><description/><developers/><contributors/></pomElements>}). For common use-cases there are
* predefined modes available via the parameter <code>flattenMode</code> that should be used in preference.</td>
* </tr>
* <tr>
* <td>{@link Model#getPrerequisites() prerequisites}</td>
* <td>configurable</td>
* <td>Like above but by default NOT removed if packaging is "maven-plugin".</td>
* </tr>
* <tr>
* <td>{@link Model#getRepositories() repositories}</td>
* <td>configurable</td>
* <td>Like two above but by default NOT removed. If you want have it removed, you need to use the parameter
* <code>pomElements</code> and configure the child element <code>repositories</code> with value <code>flatten</code>.
* </td>
* </tr>
* <tr>
* <td>{@link Model#getParent() parent}<br>
* {@link Model#getBuild() build}<br>
* {@link Model#getDependencyManagement() dependencyManagement}<br>
* {@link Model#getProperties() properties}<br>
* {@link Model#getModules() modules}<br>
* {@link Model#getReporting() reporting}</td>
* <td>configurable</td>
* <td>These elements should typically be completely stripped from the flattened POM. However for ultimate flexibility
* (e.g. if you only want to resolve variables in a POM with packaging pom) you can also configure to keep these
* elements. We strictly recommend to use this feature with extreme care and only if packaging is pom (for "Bill of
* Materials"). In the latter case you configure the parameter <code>flattenMode</code> to the value
* <code>bom</code>.<br>
* If the <code>build</code> element contains plugins in the <code>build/plugins</code> section which are configured to
* load <a href="http://maven.apache.org/pom.html#Extensions">extensions</a>, a reduced <code>build</code> element
* containing these plugins will be kept in the flattened pom.</td>
* </tr>
* </table>
*
* @author Joerg Hohwiller (hohwille at users.sourceforge.net)
*/
@SuppressWarnings( "deprecation" )
// CHECKSTYLE_OFF: LineLength
@Mojo( name = "flatten", requiresProject = true, requiresDirectInvocation = false, executionStrategy = "once-per-session", requiresDependencyCollection = ResolutionScope.RUNTIME, threadSafe = true )
// CHECKSTYLE_ON: LineLength
public class FlattenMojo
extends AbstractFlattenMojo
{
private static final int INITIAL_POM_WRITER_SIZE = 4096;
/**
* The Maven Project.
*/
@Parameter( defaultValue = "${project}", readonly = true, required = true )
private MavenProject project;
/**
* The flag to indicate if the generated flattened POM shall be set as POM file to the current project. By default
* this is only done for projects with packaging other than <code>pom</code>. You may want to also do this for
* <code>pom</code> packages projects by setting this parameter to <code>true</code> or you can use
* <code>false</code> in order to only generate the flattened POM but never set it as POM file. If
* <code>flattenMode</code> is set to bom the default value will be <code>true</code>.
*/
@Parameter( property = "updatePomFile" )
private Boolean updatePomFile;
/** The {@link ArtifactRepository} required to resolve POM using {@link #modelBuilder}. */
@Parameter( defaultValue = "${localRepository}", readonly = true, required = true )
private ArtifactRepository localRepository;
/**
* Profiles activated by OS or JDK are valid ways to have different dependencies per environment. However, profiles
* activated by property of file are less clear. When setting this parameter to <code>true</code>, the latter
* dependencies will be written as direct dependencies of the project. <strong>This is not how Maven2 and Maven3
* handles dependencies</strong>. When keeping this property <code>false</code>, all profiles will stay in the
* flattened-pom.
*/
@Parameter( defaultValue = "false" )
private Boolean embedBuildProfileDependencies;
/**
* The {@link MojoExecution} used to get access to the raw configuration of {@link #pomElements} as empty tags are
* mapped to null.
*/
@Parameter( defaultValue = "${mojo}", readonly = true, required = true )
private MojoExecution mojoExecution;
/**
* The {@link Model} that defines how to handle additional POM elements. Please use <code>flattenMode</code> in
* preference if possible. This parameter is only for ultimate flexibility.
*/
@Parameter( required = false )
private FlattenDescriptor pomElements;
/**
* Dictates whether dependency exclusions stanzas should be included in the flattened POM. By default exclusions
* will be included in the flattened POM but if you wish to omit exclusions stanzas from being present then set
* this configuration property to <code>true</code>.
*
* @since 1.3.0
*/
@Parameter( defaultValue = "false", required = false )
private boolean omitExclusions;
/**
* The different possible values for flattenMode:
* <table border="1" summary="">
* <thead>
* <tr>
* <td>Mode</td>
* <td>Description</td>
* </tr>
* </thead> <tbody>
* <tr>
* <td>oss</td>
* <td>For Open-Source-Software projects that want to keep all {@link FlattenDescriptor optional POM elements}
* except for {@link Model#getRepositories() repositories} and {@link Model#getPluginRepositories()
* pluginRepositories}.</td>
* <tr>
* <td>ossrh</td>
* <td>Keeps all {@link FlattenDescriptor optional POM elements} that are required for
* <a href="https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide">OSS
* Repository-Hosting</a>.</td>
* </tr>
* <tr>
* <td>bom</td>
* <td>Like {@link #ossrh} but additionally keeps {@link Model#getDependencyManagement() dependencyManagement} and
* {@link Model#getProperties() properties}. Especially it will keep the {@link Model#getDependencyManagement()
* dependencyManagement} <em>as-is</em> without resolving parent influences and import-scoped dependencies. This is
* useful if your POM represents a <a href=
* "http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies"
* >BOM (Bill Of Material)</a> and you do not want to deploy it as is (to remove parent and resolve version
* variables, etc.).</td>
* </tr>
* <tr>
* <td>defaults</td>
* <td>The default mode that removes all {@link FlattenDescriptor optional POM elements} except
* {@link Model#getRepositories() repositories}.</td>
* </tr>
* <tr>
* <td>clean</td>
* <td>Removes all {@link FlattenDescriptor optional POM elements}.</td>
* </tr>
* <tr>
* <td>fatjar</td>
* <td>Removes all {@link FlattenDescriptor optional POM elements} and all {@link Model#getDependencies()
* dependencies}.</td>
* </tr>
* <tr>
* <td>resolveCiFriendliesOnly</td>
* <td>Only resolves variables revision, sha1 and changelist. Keeps everything else.
* See <a href="https://maven.apache.org/maven-ci-friendly.html">Maven CI Friendly</a> for further details.</td>
* </tr>
* </tbody>
* </table>
*/
@Parameter( property = "flatten.mode", required = false )
private FlattenMode flattenMode;
/**
* The different possible values for flattenDependencyMode:
* <table border="1" summary="">
* <thead>
* <tr>
* <td>Mode</td>
* <td>Description</td>
* </tr>
* </thead><tbody>
* <tr>
* <td>direct</td>
* <td>Flatten only the direct dependency versions. This is the default mode and compatible with Flatten Plugin prior to 1.2.0.</td>
* <tr>
* <td>all</td>
* <td><p>Flatten both direct and transitive dependencies. This will examine the full dependency tree, and pull up
* all transitive dependencies as a direct dependency, and setting their versions appropriately.</p>
* <p>This is recommended if you are releasing a library that uses dependency management to manage dependency
* versions.</p></td>
* </tr>
* </tbody>
* </table>
*/
@Parameter( property = "flatten.dependency.mode", required = false )
private FlattenDependencyMode flattenDependencyMode;
/**
* The ArtifactFactory required to resolve POM using {@link #modelBuilder}.
*/
// Neither ArtifactFactory nor DefaultArtifactFactory tells what to use instead
@Component
private ArtifactFactory artifactFactory;
/**
* The {@link ModelInterpolator} used to resolve variables.
*/
@Component( role = ModelInterpolator.class )
private ModelInterpolator modelInterpolator;
/**
* The {@link ModelInterpolator} used to resolve variables.
*/
@Component( role = CiInterpolator.class)
private CiInterpolator modelCiFriendlyInterpolator;
/**
* The {@link MavenSession} used to get user properties.
*/
@Parameter( defaultValue = "${session}", readonly = true, required = true )
private MavenSession session;
@Component
private DependencyResolver dependencyResolver;
@Component( hint = "default" )
private DependencyTreeBuilder dependencyTreeBuilder;
@Component(role = ArtifactDescriptorReader.class)
private ArtifactDescriptorReader artifactDescriptorReader;
@Inject
private ModelBuilderThreadSafetyWorkaround modelBuilderThreadSafetyWorkaround;
/**
* The constructor.
*/
public FlattenMojo()
{
super();
}
/**
* {@inheritDoc}
*/
public void execute()
throws MojoExecutionException, MojoFailureException
{
getLog().info( "Generating flattened POM of project " + this.project.getId() + "..." );
File originalPomFile = this.project.getFile();
Model flattenedPom = createFlattenedPom( originalPomFile );
String headerComment = extractHeaderComment( originalPomFile );
File flattenedPomFile = getFlattenedPomFile();
writePom( flattenedPom, flattenedPomFile, headerComment );
if ( isUpdatePomFile() )
{
this.project.setPomFile( flattenedPomFile );
}
}
/**
* This method extracts the XML header comment if available.
*
* @param xmlFile is the XML {@link File} to parse.
* @return the XML comment between the XML header declaration and the root tag or <code>null</code> if NOT
* available.
* @throws MojoExecutionException if anything goes wrong.
*/
protected String extractHeaderComment( File xmlFile )
throws MojoExecutionException
{
try
{
SAXParser parser = SAXParserFactory.newInstance().newSAXParser();
SaxHeaderCommentHandler handler = new SaxHeaderCommentHandler();
parser.setProperty( "http://xml.org/sax/properties/lexical-handler", handler );
parser.parse( xmlFile, handler );
return handler.getHeaderComment();
}
catch ( Exception e )
{
throw new MojoExecutionException( "Failed to parse XML from " + xmlFile, e );
}
}
/**
* Writes the given POM {@link Model} to the given {@link File}.
*
* @param pom the {@link Model} of the POM to write.
* @param pomFile the {@link File} where to write the given POM will be written to. {@link File#getParentFile()
* Parent directories} are {@link File#mkdirs() created} automatically.
* @param headerComment is the content of a potential XML comment at the top of the XML (after XML declaration and
* before root tag). May be <code>null</code> if not present and to be omitted in target POM.
* @throws MojoExecutionException if the operation failed (e.g. due to an {@link IOException}).
*/
protected void writePom( Model pom, File pomFile, String headerComment )
throws MojoExecutionException
{
File parentFile = pomFile.getParentFile();
if ( !parentFile.exists() )
{
boolean success = parentFile.mkdirs();
if ( !success )
{
throw new MojoExecutionException( "Failed to create directory " + pomFile.getParent() );
}
}
// MavenXpp3Writer could internally add the comment but does not expose such feature to API!
// Instead we have to write POM XML to String and do post processing on that :(
MavenXpp3Writer pomWriter = new MavenXpp3Writer();
StringWriter stringWriter = new StringWriter( INITIAL_POM_WRITER_SIZE );
try
{
pomWriter.write( stringWriter, pom );
}
catch ( IOException e )
{
throw new MojoExecutionException( "Internal I/O error!", e );
}
StringBuffer buffer = stringWriter.getBuffer();
if ( !StringUtils.isEmpty( headerComment ) )
{
int projectStartIndex = buffer.indexOf( "<project" );
if ( projectStartIndex >= 0 )
{
buffer.insert( projectStartIndex, "<!--" + headerComment + "-->\n" );
}
else
{
getLog().warn( "POM XML post-processing failed: no project tag found!" );
}
}
writeStringToFile( buffer.toString(), pomFile, pom.getModelEncoding() );
}
/**
* Writes the given <code>data</code> to the given <code>file</code> using the specified <code>encoding</code>.
*
* @param data is the {@link String} to write.
* @param file is the {@link File} to write to.
* @param encoding is the encoding to use for writing the file.
* @throws MojoExecutionException if anything goes wrong.
*/
protected void writeStringToFile( String data, File file, String encoding )
throws MojoExecutionException
{
if (System.getProperty("os.name").contains("Windows"))
{
data = data.replaceAll("\n","\r\n");
}
byte[] binaryData;
try
{
binaryData = data.getBytes( encoding );
if ( file.isFile() && file.canRead() && file.length() == binaryData.length )
{
try (InputStream inputStream = new FileInputStream( file ))
{
byte[] buffer = new byte[binaryData.length];
inputStream.read( buffer );
if ( Arrays.equals( buffer, binaryData ) )
{
getLog().debug( "Arrays.equals( buffer, binaryData ) " );
return;
}
getLog().debug( "Not Arrays.equals( buffer, binaryData ) " );
}
catch ( IOException e )
{
// ignore those exceptions, we will overwrite the file
getLog().debug( "Issue reading file: " + file.getPath(), e );
}
}
else
{
getLog().debug( "file: " + file + ",file.length(): " + file.length() + ", binaryData.length: " + binaryData.length );
}
} catch ( IOException e )
{
throw new MojoExecutionException( "cannot read String as bytes" , e );
}
try (OutputStream outStream = new FileOutputStream( file ))
{
outStream.write( binaryData );
}
catch ( IOException e )
{
throw new MojoExecutionException( "Failed to write to " + file, e );
}
}
/**
* This method creates the flattened POM what is the main task of this plugin.
*
* @param pomFile is the name of the original POM file to read and transform.
* @return the {@link Model} of the flattened POM.
* @throws MojoExecutionException if anything goes wrong (e.g. POM can not be processed).
* @throws MojoFailureException if anything goes wrong (logical error).
*/
protected Model createFlattenedPom( File pomFile ) throws MojoExecutionException, MojoFailureException
{
ModelBuildingRequest buildingRequest = createModelBuildingRequest( pomFile );
Model effectivePom = createEffectivePom( buildingRequest, isEmbedBuildProfileDependencies(), this.flattenMode );
Model flattenedPom = new Model();
// keep original encoding (we could also normalize to UTF-8 here)
String modelEncoding = effectivePom.getModelEncoding();
if ( StringUtils.isEmpty( modelEncoding ) )
{
modelEncoding = "UTF-8";
}
flattenedPom.setModelEncoding( modelEncoding );
Model cleanPom = null;
try {
cleanPom = createCleanPom( effectivePom );
}
catch (Exception e) {
throw new MojoExecutionException("failed to create a clean pom", e);
}
FlattenDescriptor descriptor = getFlattenDescriptor();
Model originalPom = getOriginalModel();
Model resolvedPom = this.project.getModel();
Model interpolatedPom = createResolvedPom( buildingRequest );
// copy the configured additional POM elements...
for ( PomProperty<?> property : PomProperty.getPomProperties() )
{
if ( property.isElement() )
{
Model sourceModel = getSourceModel( descriptor, property, effectivePom, originalPom, resolvedPom,
interpolatedPom, cleanPom );
if ( sourceModel == null )
{
if ( property.isRequired() )
{
throw new MojoFailureException( "Property " + property.getName()
+ " is required and can not be removed!" );
}
}
else
{
property.copy( sourceModel, flattenedPom );
}
}
}
return flattenedPom;
}
private Model createResolvedPom( ModelBuildingRequest buildingRequest ) throws MojoExecutionException {
LoggingModelProblemCollector problems = new LoggingModelProblemCollector( getLog() );
Model originalModel = getOriginalModel();
if (this.flattenMode == FlattenMode.resolveCiFriendliesOnly) {
return this.modelCiFriendlyInterpolator.interpolateModel( originalModel, this.project.getModel().getProjectDirectory(),
buildingRequest, problems );
}
return this.modelInterpolator.interpolateModel( originalModel, this.project.getModel().getProjectDirectory(),
buildingRequest, problems );
}
private Model getOriginalModel() throws MojoExecutionException {
MavenXpp3Reader reader = new MavenXpp3Reader();
try {
return reader.read( new FileInputStream( this.project.getFile() ) );
}
catch ( IOException | XmlPullParserException e ) {
throw new MojoExecutionException( "Error reading raw model.", e );
}
}
/**
* This method creates the clean POM as a {@link Model} where to copy elements from that shall be
* {@link ElementHandling#flatten flattened}. Will be mainly empty but contains some the minimum elements that have
* to be kept in flattened POM.
*
* @param effectivePom is the effective POM.
* @return the clean POM.
* @throws MojoExecutionException if anything goes wrong.
*/
protected Model createCleanPom( Model effectivePom ) throws MojoExecutionException
{
Model cleanPom = new Model();
cleanPom.setGroupId( effectivePom.getGroupId() );
cleanPom.setArtifactId( effectivePom.getArtifactId() );
cleanPom.setVersion( effectivePom.getVersion() );
cleanPom.setPackaging( effectivePom.getPackaging() );
cleanPom.setLicenses( effectivePom.getLicenses() );
// fixed to 4.0.0 forever :)
cleanPom.setModelVersion( "4.0.0" );
// plugins with extensions must stay
Build build = effectivePom.getBuild();
if ( build != null )
{
for ( Plugin plugin : build.getPlugins() )
{
if ( plugin.isExtensions() )
{
Build cleanBuild = cleanPom.getBuild();
if ( cleanBuild == null )
{
cleanBuild = new Build();
cleanPom.setBuild( cleanBuild );
}
Plugin cleanPlugin = new Plugin();
cleanPlugin.setGroupId( plugin.getGroupId() );
cleanPlugin.setArtifactId( plugin.getArtifactId() );
cleanPlugin.setVersion( plugin.getVersion() );
cleanPlugin.setExtensions( true );
cleanBuild.addPlugin( cleanPlugin );
}
}
}
// transform profiles...
Dependencies managedDependencies = new Dependencies();
if ( effectivePom.getDependencyManagement() != null && effectivePom.getDependencyManagement().getDependencies() != null )
{
managedDependencies.addAll( effectivePom.getDependencyManagement().getDependencies() );
}
for ( Profile profile : effectivePom.getProfiles() )
{
if ( !isEmbedBuildProfileDependencies() || !isBuildTimeDriven( profile.getActivation() ) )
{
if ( !isEmpty( profile.getDependencies() ) || !isEmpty( profile.getRepositories() ) )
{
List<Dependency> strippedDependencies = new ArrayList<>();
for ( Dependency dep : profile.getDependencies() )
{
Dependency parsedDep = dep.clone();
if ( managedDependencies.contains( parsedDep ) )
{
parsedDep.setVersion( managedDependencies.resolve( parsedDep ).getVersion() );
String managedDepScope = managedDependencies.resolve( parsedDep ).getScope();
if ( managedDepScope != null )
{
parsedDep.setScope( managedDepScope );
}
if ( parsedDep.getScope() == null )
{
parsedDep.setScope( "compile" );
}
String managedDepOptional = managedDependencies.resolve( parsedDep ).getOptional();
if ( managedDepOptional != null )
{
parsedDep.setOptional( managedDepOptional );
}
if ( parsedDep.getOptional() == null )
{
parsedDep.setOptional( "false" );
}
}
Dependency flattenedDep = createFlattenedDependency( parsedDep );
if ( flattenedDep != null )
{
strippedDependencies.add( flattenedDep );
}
}
if ( !strippedDependencies.isEmpty() || !isEmpty( profile.getRepositories() ) )
{
Profile strippedProfile = new Profile();
strippedProfile.setId( profile.getId() );
strippedProfile.setActivation( profile.getActivation() );
strippedProfile.setDependencies( strippedDependencies.isEmpty() ? null : strippedDependencies );
strippedProfile.setRepositories( profile.getRepositories() );
cleanPom.addProfile( strippedProfile );
}
}
}
}
// transform dependencies...
List<Dependency> dependencies = createFlattenedDependencies( effectivePom );
cleanPom.setDependencies( dependencies );
return cleanPom;
}
private Model getSourceModel( FlattenDescriptor descriptor, PomProperty<?> property, Model effectivePom,
Model originalPom, Model resolvedPom, Model interpolatedPom, Model cleanPom )
{
ElementHandling handling = descriptor.getHandling( property );
getLog().debug( "Property " + property.getName() + " will be handled using " + handling
+ " in flattened POM." );
switch ( handling )
{
case expand:
return effectivePom;
case keep:
return originalPom;
case resolve:
return resolvedPom;
case interpolate:
return interpolatedPom;
case flatten:
return cleanPom;
case remove:
return null;
default:
throw new IllegalStateException( handling.toString() );
}
}
/**
* Creates a flattened {@link List} of {@link Repository} elements where those from super-POM are omitted.
*
* @param repositories is the {@link List} of {@link Repository} elements. May be <code>null</code>.
* @return the flattened {@link List} of {@link Repository} elements or <code>null</code> if <code>null</code> was
* given.
*/
protected static List<Repository> createFlattenedRepositories( List<Repository> repositories )
{
if ( repositories != null )
{
List<Repository> flattenedRepositories = new ArrayList<Repository>( repositories.size() );
for ( Repository repo : repositories )
{
// filter inherited repository section from super POM (see MOJO-2042)...
if ( !isCentralRepositoryFromSuperPom( repo ) )
{
flattenedRepositories.add( repo );
}
}
return flattenedRepositories;
}
return repositories;
}
private FlattenDescriptor getFlattenDescriptor()
throws MojoFailureException
{
FlattenDescriptor descriptor = this.pomElements;
if ( descriptor == null )
{
FlattenMode mode = this.flattenMode;
if ( mode == null )
{
mode = FlattenMode.defaults;
}
else if ( this.flattenMode == FlattenMode.minimum )
{
getLog().warn( "FlattenMode " + FlattenMode.minimum + " is deprecated!" );
}
descriptor = mode.getDescriptor();
if ( "maven-plugin".equals( this.project.getPackaging() ) )
{
descriptor.setPrerequisites( ElementHandling.expand );
}
}
else
{
if ( descriptor.isEmpty() )
{
// legacy approach...
// Can't use Model itself as empty elements are never null, so you can't recognize if it was set or not
Xpp3Dom rawDescriptor = this.mojoExecution.getConfiguration().getChild( "pomElements" );
descriptor = new FlattenDescriptor( rawDescriptor );
}
if ( this.flattenMode != null )
{
descriptor = descriptor.merge( this.flattenMode.getDescriptor() );
}
}
return descriptor;
}
/**
* This method determines if the given {@link Repository} section is identical to what is defined from the super
* POM.
*
* @param repo is the {@link Repository} section to check.
* @return <code>true</code> if maven central default configuration, <code>false</code> otherwise.
*/
private static boolean isCentralRepositoryFromSuperPom( Repository repo )
{
if ( repo != null )
{
if ( "central".equals( repo.getId() ) )
{
RepositoryPolicy snapshots = repo.getSnapshots();
if ( snapshots != null && !snapshots.isEnabled() )
{
return true;
}
}
}
return false;
}
private ModelBuildingRequest createModelBuildingRequest( File pomFile )
{
FlattenModelResolver resolver = new FlattenModelResolver( this.localRepository, this.artifactFactory,
this.dependencyResolver, this.session.getProjectBuildingRequest(), getReactorModelsFromSession() );
Properties userProperties = this.session.getUserProperties();
List<String> activeProfiles = this.session.getRequest().getActiveProfiles();
// @formatter:off
ModelBuildingRequest buildingRequest =
new DefaultModelBuildingRequest().setUserProperties( userProperties ).setSystemProperties( System.getProperties() ).setPomFile( pomFile ).setModelResolver( resolver ).setActiveProfileIds( activeProfiles );
// @formatter:on
return buildingRequest;
}
private List<MavenProject> getReactorModelsFromSession()
{
// robust approach for 'special' environments like m2e (Eclipse plugin) which don't provide allProjects
List<MavenProject> models = this.session.getAllProjects();
if ( models == null )
{
models = this.session.getProjects();
}
if ( models == null )
{
models = Collections.emptyList();
}
return models;
}
/**
* Creates the effective POM for the given <code>pomFile</code> trying its best to match the core maven behaviour.
*
* @param buildingRequest {@link ModelBuildingRequest}
* @param embedBuildProfileDependencies embed build profiles yes/no.
* @param flattenMode the flattening mode
* @return the parsed and calculated effective POM.
* @throws MojoExecutionException if anything goes wrong.
*/
protected Model createEffectivePom( ModelBuildingRequest buildingRequest,
final boolean embedBuildProfileDependencies, final FlattenMode flattenMode )
throws MojoExecutionException
{
ModelBuildingResult buildingResult;
try
{
ProfileInjector customInjector = new ProfileInjector()
{
public void injectProfile( Model model, Profile profile, ModelBuildingRequest request,
ModelProblemCollector problems )
{
List<String> activeProfileIds = request.getActiveProfileIds();
if ( activeProfileIds.contains( profile.getId() ) )
{
Properties merged = new Properties();
merged.putAll( model.getProperties() );
merged.putAll( profile.getProperties() );
model.setProperties( merged );
}
}
};
ProfileSelector customSelector = new ProfileSelector()
{
public List<Profile> getActiveProfiles( Collection<Profile> profiles, ProfileActivationContext context,
ModelProblemCollector problems )
{
List<Profile> activeProfiles = new ArrayList<Profile>( profiles.size() );
for ( Profile profile : profiles )
{
Activation activation = profile.getActivation();
if ( !embedBuildProfileDependencies || isBuildTimeDriven( activation ) )
{
activeProfiles.add( profile );
}
}
return activeProfiles;
}
};
buildingResult = modelBuilderThreadSafetyWorkaround.build( buildingRequest, customInjector, customSelector );
}
catch ( ModelBuildingException e )
{
throw new MojoExecutionException( e.getMessage(), e );
}
Model effectivePom = buildingResult.getEffectiveModel();
// LoggingModelProblemCollector problems = new LoggingModelProblemCollector( getLog() );
// Model interpolatedModel =
// this.modelInterpolator.interpolateModel( this.project.getOriginalModel(),
// effectivePom.getProjectDirectory(), buildingRequest, problems );
// remove Repositories from super POM (central)
effectivePom.setRepositories( createFlattenedRepositories( effectivePom.getRepositories() ) );
return effectivePom;
}
/**
* Null-safe check for {@link Collection#isEmpty()}.
*
* @param collection is the {@link Collection} to test. May be <code>null</code>.
* @return <code>true</code> if <code>null</code> or {@link Collection#isEmpty() empty}, <code>false</code>
* otherwise.
*/
private boolean isEmpty( Collection<?> collection )
{
if ( collection == null )
{
return true;
}
return collection.isEmpty();
}
/**
* @return <code>true</code> if build-dependent profiles (triggered by OS or JDK) should be evaluated and their
* effect (variables and dependencies) are resolved and embedded into the flattened POM while the profile
* itself is stripped. Otherwise if <code>false</code> the profiles will remain untouched.
*/
public boolean isEmbedBuildProfileDependencies()
{
return this.embedBuildProfileDependencies.booleanValue();
}
/**
* @param activation is the {@link Activation} of a {@link Profile}.
* @return <code>true</code> if the given {@link Activation} is build-time driven, <code>false</code> otherwise (if
* it is triggered by OS or JDK).
*/
protected static boolean isBuildTimeDriven( Activation activation )
{
if ( activation == null )
{
return true;
}
if ( StringUtils.isEmpty( activation.getJdk() ) && activation.getOs() == null )
{
return true;
}
return false;
}
/**
* Creates the {@link List} of {@link Dependency dependencies} for the flattened POM. These are all resolved
* {@link Dependency dependencies} except for those added from {@link Profile profiles}.
*