1 package org.apache.maven.plugin.surefire;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import java.io.File;
23 import java.util.HashMap;
24 import java.util.List;
25 import java.util.Map;
26 import java.util.Properties;
27
28 import org.apache.maven.artifact.factory.ArtifactFactory;
29 import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
30 import org.apache.maven.artifact.repository.ArtifactRepository;
31 import org.apache.maven.artifact.resolver.ArtifactResolver;
32 import org.apache.maven.execution.MavenSession;
33 import org.apache.maven.plugin.MojoExecutionException;
34 import org.apache.maven.plugin.MojoFailureException;
35 import org.apache.maven.plugin.surefire.booterclient.ChecksumCalculator;
36 import org.apache.maven.project.MavenProject;
37 import org.apache.maven.surefire.suite.RunResult;
38 import org.apache.maven.toolchain.ToolchainManager;
39 import org.codehaus.plexus.util.StringUtils;
40
41
42
43
44
45
46
47
48
49
50
51
52 public class SurefirePlugin
53 extends AbstractSurefireMojo
54 implements SurefireReportParameters
55 {
56
57
58
59
60
61
62
63
64 private boolean skipTests;
65
66
67
68
69
70
71
72
73 private boolean skipExec;
74
75
76
77
78
79
80
81
82 private boolean skip;
83
84
85
86
87
88
89
90 private boolean testFailureIgnore;
91
92
93
94
95
96
97
98 private File basedir;
99
100
101
102
103
104
105
106 private File testClassesDirectory;
107
108
109
110
111
112
113
114 private File classesDirectory;
115
116
117
118
119
120
121
122 private MavenProject project;
123
124
125
126
127
128
129
130
131 private List classpathDependencyExcludes;
132
133
134
135
136
137
138
139
140
141
142
143
144
145 private String classpathDependencyScopeExclude;
146
147
148
149
150
151
152
153 private List additionalClasspathElements;
154
155
156
157
158
159
160 private File reportsDirectory;
161
162
163
164
165
166
167
168
169 private File testSourceDirectory;
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184 private String test;
185
186
187
188
189
190
191
192
193
194
195
196
197
198 private List includes;
199
200
201
202
203
204
205
206
207
208
209
210
211 private List excludes;
212
213
214
215
216
217
218
219
220
221 private ArtifactRepository localRepository;
222
223
224
225
226
227
228
229 private Properties systemProperties;
230
231
232
233
234
235
236
237 private Map systemPropertyVariables;
238
239
240
241
242
243
244
245 private File systemPropertiesFile;
246
247
248
249
250
251
252
253
254 private Properties properties;
255
256
257
258
259
260
261
262
263 private Map pluginArtifactMap;
264
265
266
267
268
269
270
271
272 private Map projectArtifactMap;
273
274
275
276
277
278
279 private boolean printSummary;
280
281
282
283
284
285
286 private String reportFormat;
287
288
289
290
291
292
293 private boolean useFile;
294
295
296
297
298
299
300
301
302 private boolean redirectTestOutputToFile;
303
304
305
306
307
308
309
310 private Boolean failIfNoTests;
311
312
313
314
315
316
317
318
319 private String forkMode;
320
321
322
323
324
325
326
327
328
329 private String jvm;
330
331
332
333
334
335
336
337 private String argLine;
338
339
340
341
342
343
344
345
346
347
348 private String debugForkedProcess;
349
350
351
352
353
354
355
356
357 private int forkedProcessTimeoutInSeconds;
358
359
360
361
362
363
364
365 private Map environmentVariables = new HashMap();
366
367
368
369
370
371
372
373 private File workingDirectory;
374
375
376
377
378
379
380
381
382
383
384 private boolean childDelegation;
385
386
387
388
389
390
391
392
393
394 private String groups;
395
396
397
398
399
400
401
402
403
404 private String excludedGroups;
405
406
407
408
409
410
411
412
413
414
415
416 private File[] suiteXmlFiles;
417
418
419
420
421
422
423
424 private String junitArtifactName;
425
426
427
428
429
430
431
432 private String testNGArtifactName;
433
434
435
436
437
438
439
440
441 private int threadCount;
442
443
444
445
446
447
448
449 private boolean perCoreThreadCount;
450
451
452
453
454
455
456
457
458
459 private boolean useUnlimitedThreads;
460
461
462
463
464
465
466
467
468
469
470
471
472 private String parallel;
473
474
475
476
477
478
479
480 private boolean trimStackTrace;
481
482
483
484
485
486
487 private ArtifactResolver artifactResolver;
488
489
490
491
492
493
494 private ArtifactFactory artifactFactory;
495
496
497
498
499
500
501
502 private List remoteRepositories;
503
504
505
506
507
508
509 private ArtifactMetadataSource metadataSource;
510
511 private Properties originalSystemProperties;
512
513
514
515
516 private Properties internalSystemProperties = new Properties();
517
518
519
520
521
522
523
524 private boolean disableXmlReport;
525
526
527
528
529
530
531
532
533
534 private boolean useSystemClassLoader;
535
536
537
538
539
540
541
542
543
544
545
546
547 private boolean useManifestOnlyJar;
548
549
550
551
552
553
554
555
556 private boolean enableAssertions;
557
558
559
560
561
562
563
564
565 private MavenSession session;
566
567
568
569
570
571
572
573 private String objectFactory;
574
575
576
577
578
579
580 private Boolean parallelMavenExecution;
581
582
583
584
585
586
587
588
589
590
591
592
593 private String runOrder;
594
595
596
597
598 private ToolchainManager toolchainManager;
599
600 protected void handleSummary( Summary summary )
601 throws MojoExecutionException, MojoFailureException
602 {
603 assertNoException( summary );
604 assertNoFailureOrTimeout( summary );
605 writeSummary( summary );
606 }
607
608 private void assertNoException( Summary summary )
609 throws MojoExecutionException
610 {
611 if ( !summary.isErrorFree() )
612 {
613 Exception cause = summary.getFirstException();
614 throw new MojoExecutionException( cause.getMessage(), cause );
615 }
616 }
617
618 private void assertNoFailureOrTimeout( Summary summary )
619 throws MojoExecutionException
620 {
621 if ( summary.isFailureOrTimeout() )
622 {
623 throw new MojoExecutionException( "Failure or timeout" );
624 }
625 }
626
627 private void writeSummary( Summary summary )
628 throws MojoFailureException
629 {
630 RunResult result = summary.getResultOfLastSuccessfulRun();
631 SurefireHelper.reportExecution( this, result, getLog() );
632 }
633
634 protected boolean isSkipExecution()
635 {
636 return isSkip() || isSkipTests() || isSkipExec();
637 }
638
639 protected String getPluginName()
640 {
641 return "surefire";
642 }
643
644 protected String[] getDefaultIncludes()
645 {
646 return new String[]{"**/Test*.java", "**/*Test.java", "**/*TestCase.java"};
647 }
648
649
650
651 public boolean isSkipTests()
652 {
653 return skipTests;
654 }
655
656 public void setSkipTests( boolean skipTests )
657 {
658 this.skipTests = skipTests;
659 }
660
661
662
663
664 public boolean isSkipExec()
665 {
666 return skipExec;
667 }
668
669
670
671
672 public void setSkipExec( boolean skipExec )
673 {
674 this.skipExec = skipExec;
675 }
676
677 public boolean isSkip()
678 {
679 return skip;
680 }
681
682 public void setSkip( boolean skip )
683 {
684 this.skip = skip;
685 }
686
687 public boolean isTestFailureIgnore()
688 {
689 return testFailureIgnore;
690 }
691
692 public void setTestFailureIgnore( boolean testFailureIgnore )
693 {
694 this.testFailureIgnore = testFailureIgnore;
695 }
696
697 public File getBasedir()
698 {
699 return basedir;
700 }
701
702 public void setBasedir( File basedir )
703 {
704 this.basedir = basedir;
705 }
706
707 public File getTestClassesDirectory()
708 {
709 return testClassesDirectory;
710 }
711
712 public void setTestClassesDirectory( File testClassesDirectory )
713 {
714 this.testClassesDirectory = testClassesDirectory;
715 }
716
717 public File getClassesDirectory()
718 {
719 return classesDirectory;
720 }
721
722 public void setClassesDirectory( File classesDirectory )
723 {
724 this.classesDirectory = classesDirectory;
725 }
726
727 public MavenProject getProject()
728 {
729 return project;
730 }
731
732 public void setProject( MavenProject project )
733 {
734 this.project = project;
735 }
736
737 public List getClasspathDependencyExcludes()
738 {
739 return classpathDependencyExcludes;
740 }
741
742 public void setClasspathDependencyExcludes( List classpathDependencyExcludes )
743 {
744 this.classpathDependencyExcludes = classpathDependencyExcludes;
745 }
746
747 public String getClasspathDependencyScopeExclude()
748 {
749 return classpathDependencyScopeExclude;
750 }
751
752 public void setClasspathDependencyScopeExclude( String classpathDependencyScopeExclude )
753 {
754 this.classpathDependencyScopeExclude = classpathDependencyScopeExclude;
755 }
756
757 public List getAdditionalClasspathElements()
758 {
759 return additionalClasspathElements;
760 }
761
762 public void setAdditionalClasspathElements( List additionalClasspathElements )
763 {
764 this.additionalClasspathElements = additionalClasspathElements;
765 }
766
767 public File getReportsDirectory()
768 {
769 return reportsDirectory;
770 }
771
772 public void setReportsDirectory( File reportsDirectory )
773 {
774 this.reportsDirectory = reportsDirectory;
775 }
776
777 public File getTestSourceDirectory()
778 {
779 return testSourceDirectory;
780 }
781
782 public void setTestSourceDirectory( File testSourceDirectory )
783 {
784 this.testSourceDirectory = testSourceDirectory;
785 }
786
787 public String getTest()
788 {
789 if ( StringUtils.isBlank( test ) )
790 {
791 return null;
792 }
793 int index = test.indexOf( '#' );
794 if ( index >= 0 )
795 {
796 return test.substring( 0, index );
797 }
798 return test;
799 }
800
801
802
803
804 public String getTestMethod()
805 {
806 if ( StringUtils.isBlank( test ) )
807 {
808 return null;
809 }
810 int index = this.test.indexOf( '#' );
811 if ( index >= 0 )
812 {
813 return this.test.substring( index + 1, this.test.length() );
814 }
815 return null;
816 }
817
818 public void setTest( String test )
819 {
820 this.test = test;
821 }
822
823 public List getIncludes()
824 {
825 return includes;
826 }
827
828 public void setIncludes( List includes )
829 {
830 this.includes = includes;
831 }
832
833 public List getExcludes()
834 {
835 return excludes;
836 }
837
838 public void setExcludes( List excludes )
839 {
840 this.excludes = excludes;
841 }
842
843 public ArtifactRepository getLocalRepository()
844 {
845 return localRepository;
846 }
847
848 public void setLocalRepository( ArtifactRepository localRepository )
849 {
850 this.localRepository = localRepository;
851 }
852
853
854
855
856 public Properties getSystemProperties()
857 {
858 return systemProperties;
859 }
860
861
862
863
864 public void setSystemProperties( Properties systemProperties )
865 {
866 this.systemProperties = systemProperties;
867 }
868
869 public Map getSystemPropertyVariables()
870 {
871 return systemPropertyVariables;
872 }
873
874 public void setSystemPropertyVariables( Map systemPropertyVariables )
875 {
876 this.systemPropertyVariables = systemPropertyVariables;
877 }
878
879 public File getSystemPropertiesFile()
880 {
881 return systemPropertiesFile;
882 }
883
884 public void setSystemPropertiesFile( File systemPropertiesFile )
885 {
886 this.systemPropertiesFile = systemPropertiesFile;
887 }
888
889 public Properties getProperties()
890 {
891 return properties;
892 }
893
894 public void setProperties( Properties properties )
895 {
896 this.properties = properties;
897 }
898
899 public Map getPluginArtifactMap()
900 {
901 return pluginArtifactMap;
902 }
903
904 public void setPluginArtifactMap( Map pluginArtifactMap )
905 {
906 this.pluginArtifactMap = pluginArtifactMap;
907 }
908
909 public Map getProjectArtifactMap()
910 {
911 return projectArtifactMap;
912 }
913
914 public void setProjectArtifactMap( Map projectArtifactMap )
915 {
916 this.projectArtifactMap = projectArtifactMap;
917 }
918
919 public boolean isPrintSummary()
920 {
921 return printSummary;
922 }
923
924 public void setPrintSummary( boolean printSummary )
925 {
926 this.printSummary = printSummary;
927 }
928
929 public String getReportFormat()
930 {
931 return reportFormat;
932 }
933
934 public void setReportFormat( String reportFormat )
935 {
936 this.reportFormat = reportFormat;
937 }
938
939 public boolean isUseFile()
940 {
941 return useFile;
942 }
943
944 public void setUseFile( boolean useFile )
945 {
946 this.useFile = useFile;
947 }
948
949 public boolean isRedirectTestOutputToFile()
950 {
951 return redirectTestOutputToFile;
952 }
953
954 public void setRedirectTestOutputToFile( boolean redirectTestOutputToFile )
955 {
956 this.redirectTestOutputToFile = redirectTestOutputToFile;
957 }
958
959 public Boolean getFailIfNoTests()
960 {
961 return failIfNoTests;
962 }
963
964 public void setFailIfNoTests( Boolean failIfNoTests )
965 {
966 this.failIfNoTests = failIfNoTests;
967 }
968
969 public String getForkMode()
970 {
971 return forkMode;
972 }
973
974 public void setForkMode( String forkMode )
975 {
976 this.forkMode = forkMode;
977 }
978
979 public String getJvm()
980 {
981 return jvm;
982 }
983
984 public void setJvm( String jvm )
985 {
986 this.jvm = jvm;
987 }
988
989 public String getArgLine()
990 {
991 return argLine;
992 }
993
994 public void setArgLine( String argLine )
995 {
996 this.argLine = argLine;
997 }
998
999 public String getDebugForkedProcess()
1000 {
1001 return debugForkedProcess;
1002 }
1003
1004 public void setDebugForkedProcess( String debugForkedProcess )
1005 {
1006 this.debugForkedProcess = debugForkedProcess;
1007 }
1008
1009 public int getForkedProcessTimeoutInSeconds()
1010 {
1011 return forkedProcessTimeoutInSeconds;
1012 }
1013
1014 public void setForkedProcessTimeoutInSeconds( int forkedProcessTimeoutInSeconds )
1015 {
1016 this.forkedProcessTimeoutInSeconds = forkedProcessTimeoutInSeconds;
1017 }
1018
1019 public Map getEnvironmentVariables()
1020 {
1021 return environmentVariables;
1022 }
1023
1024 public void setEnvironmentVariables( Map environmentVariables )
1025 {
1026 this.environmentVariables = environmentVariables;
1027 }
1028
1029 public File getWorkingDirectory()
1030 {
1031 return workingDirectory;
1032 }
1033
1034 public void setWorkingDirectory( File workingDirectory )
1035 {
1036 this.workingDirectory = workingDirectory;
1037 }
1038
1039 public boolean isChildDelegation()
1040 {
1041 return childDelegation;
1042 }
1043
1044 public void setChildDelegation( boolean childDelegation )
1045 {
1046 this.childDelegation = childDelegation;
1047 }
1048
1049 public String getGroups()
1050 {
1051 return groups;
1052 }
1053
1054 public void setGroups( String groups )
1055 {
1056 this.groups = groups;
1057 }
1058
1059 public String getExcludedGroups()
1060 {
1061 return excludedGroups;
1062 }
1063
1064 public void setExcludedGroups( String excludedGroups )
1065 {
1066 this.excludedGroups = excludedGroups;
1067 }
1068
1069 public File[] getSuiteXmlFiles()
1070 {
1071 return suiteXmlFiles;
1072 }
1073
1074 public void setSuiteXmlFiles( File[] suiteXmlFiles )
1075 {
1076 this.suiteXmlFiles = suiteXmlFiles;
1077 }
1078
1079 public String getJunitArtifactName()
1080 {
1081 return junitArtifactName;
1082 }
1083
1084 public void setJunitArtifactName( String junitArtifactName )
1085 {
1086 this.junitArtifactName = junitArtifactName;
1087 }
1088
1089 public String getTestNGArtifactName()
1090 {
1091 return testNGArtifactName;
1092 }
1093
1094 public void setTestNGArtifactName( String testNGArtifactName )
1095 {
1096 this.testNGArtifactName = testNGArtifactName;
1097 }
1098
1099 public int getThreadCount()
1100 {
1101 return threadCount;
1102 }
1103
1104 public void setThreadCount( int threadCount )
1105 {
1106 this.threadCount = threadCount;
1107 }
1108
1109 public boolean getPerCoreThreadCount()
1110 {
1111 return perCoreThreadCount;
1112 }
1113
1114 public void setPerCoreThreadCount( boolean perCoreThreadCount )
1115 {
1116 this.perCoreThreadCount = perCoreThreadCount;
1117 }
1118
1119 public boolean getUseUnlimitedThreads()
1120 {
1121 return useUnlimitedThreads;
1122 }
1123
1124 public void setUseUnlimitedThreads( boolean useUnlimitedThreads )
1125 {
1126 this.useUnlimitedThreads = useUnlimitedThreads;
1127 }
1128
1129 public String getParallel()
1130 {
1131 return parallel;
1132 }
1133
1134 public void setParallel( String parallel )
1135 {
1136 this.parallel = parallel;
1137 }
1138
1139 public boolean isTrimStackTrace()
1140 {
1141 return trimStackTrace;
1142 }
1143
1144 public void setTrimStackTrace( boolean trimStackTrace )
1145 {
1146 this.trimStackTrace = trimStackTrace;
1147 }
1148
1149 public ArtifactResolver getArtifactResolver()
1150 {
1151 return artifactResolver;
1152 }
1153
1154 public void setArtifactResolver( ArtifactResolver artifactResolver )
1155 {
1156 this.artifactResolver = artifactResolver;
1157 }
1158
1159 public ArtifactFactory getArtifactFactory()
1160 {
1161 return artifactFactory;
1162 }
1163
1164 public void setArtifactFactory( ArtifactFactory artifactFactory )
1165 {
1166 this.artifactFactory = artifactFactory;
1167 }
1168
1169 public List getRemoteRepositories()
1170 {
1171 return remoteRepositories;
1172 }
1173
1174 public void setRemoteRepositories( List remoteRepositories )
1175 {
1176 this.remoteRepositories = remoteRepositories;
1177 }
1178
1179 public ArtifactMetadataSource getMetadataSource()
1180 {
1181 return metadataSource;
1182 }
1183
1184 public void setMetadataSource( ArtifactMetadataSource metadataSource )
1185 {
1186 this.metadataSource = metadataSource;
1187 }
1188
1189 public Properties getOriginalSystemProperties()
1190 {
1191 return originalSystemProperties;
1192 }
1193
1194 public void setOriginalSystemProperties( Properties originalSystemProperties )
1195 {
1196 this.originalSystemProperties = originalSystemProperties;
1197 }
1198
1199 public Properties getInternalSystemProperties()
1200 {
1201 return internalSystemProperties;
1202 }
1203
1204 public void setInternalSystemProperties( Properties internalSystemProperties )
1205 {
1206 this.internalSystemProperties = internalSystemProperties;
1207 }
1208
1209 public boolean isDisableXmlReport()
1210 {
1211 return disableXmlReport;
1212 }
1213
1214 public void setDisableXmlReport( boolean disableXmlReport )
1215 {
1216 this.disableXmlReport = disableXmlReport;
1217 }
1218
1219 public boolean isUseSystemClassLoader()
1220 {
1221 return useSystemClassLoader;
1222 }
1223
1224 public void setUseSystemClassLoader( boolean useSystemClassLoader )
1225 {
1226 this.useSystemClassLoader = useSystemClassLoader;
1227 }
1228
1229 public boolean isUseManifestOnlyJar()
1230 {
1231 return useManifestOnlyJar;
1232 }
1233
1234 public void setUseManifestOnlyJar( boolean useManifestOnlyJar )
1235 {
1236 this.useManifestOnlyJar = useManifestOnlyJar;
1237 }
1238
1239 public boolean isEnableAssertions()
1240 {
1241 return enableAssertions;
1242 }
1243
1244 public void setEnableAssertions( boolean enableAssertions )
1245 {
1246 this.enableAssertions = enableAssertions;
1247 }
1248
1249 public MavenSession getSession()
1250 {
1251 return session;
1252 }
1253
1254 public void setSession( MavenSession session )
1255 {
1256 this.session = session;
1257 }
1258
1259 public String getObjectFactory()
1260 {
1261 return objectFactory;
1262 }
1263
1264 public void setObjectFactory( String objectFactory )
1265 {
1266 this.objectFactory = objectFactory;
1267 }
1268
1269 public ToolchainManager getToolchainManager()
1270 {
1271 return toolchainManager;
1272 }
1273
1274 public void setToolchainManager( ToolchainManager toolchainManager )
1275 {
1276 this.toolchainManager = toolchainManager;
1277 }
1278
1279 public boolean isMavenParallel()
1280 {
1281 return parallelMavenExecution != null && parallelMavenExecution.booleanValue();
1282 }
1283
1284 public String getRunOrder()
1285 {
1286 return runOrder;
1287 }
1288
1289 public void setRunOrder( String runOrder )
1290 {
1291 this.runOrder = runOrder;
1292 }
1293
1294 protected void addPluginSpecificChecksumItems( ChecksumCalculator checksum )
1295 {
1296 }
1297
1298 }