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