1 package org.apache.maven.plugin.failsafe;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import org.apache.maven.plugin.MojoExecutionException;
23 import org.apache.maven.plugin.MojoFailureException;
24 import org.apache.maven.plugin.surefire.AbstractSurefireMojo;
25 import org.apache.maven.plugin.surefire.booterclient.ChecksumCalculator;
26 import org.apache.maven.plugins.annotations.LifecyclePhase;
27 import org.apache.maven.plugins.annotations.Mojo;
28 import org.apache.maven.plugins.annotations.Parameter;
29 import org.apache.maven.plugins.annotations.ResolutionScope;
30 import org.apache.maven.surefire.extensions.ForkNodeFactory;
31 import org.apache.maven.surefire.api.suite.RunResult;
32
33 import java.io.File;
34 import java.io.IOException;
35 import java.util.Arrays;
36 import java.util.Collections;
37 import java.util.List;
38
39 import static org.apache.maven.plugin.failsafe.util.FailsafeSummaryXmlUtils.writeSummary;
40
41
42
43
44
45
46
47 @Mojo( name = "integration-test", requiresProject = true, requiresDependencyResolution = ResolutionScope.TEST,
48 defaultPhase = LifecyclePhase.INTEGRATION_TEST, threadSafe = true )
49 public class IntegrationTestMojo
50 extends AbstractSurefireMojo
51 {
52
53 private static final String FAILSAFE_IN_PROGRESS_CONTEXT_KEY = "failsafe-in-progress";
54
55
56
57
58
59
60 @Parameter
61 private File classesDirectory;
62
63 @Parameter( defaultValue = "${project.build.outputDirectory}", readonly = true, required = true )
64 private File defaultClassesDirectory;
65
66
67
68
69
70
71
72 @Parameter( property = "skipITs" )
73 private boolean skipITs;
74
75
76
77
78 @Parameter( defaultValue = "${project.build.directory}/failsafe-reports" )
79 private File reportsDirectory;
80
81 @SuppressWarnings( "checkstyle:linelength" )
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104 @Parameter( property = "it.test" )
105 private String test;
106
107
108
109
110 @Parameter( defaultValue = "${project.build.directory}/failsafe-reports/failsafe-summary.xml", required = true )
111 private File summaryFile;
112
113
114
115
116 @Parameter( property = "failsafe.printSummary", defaultValue = "true" )
117 private boolean printSummary;
118
119
120
121
122
123 @Parameter( property = "failsafe.reportFormat", defaultValue = "brief" )
124 private String reportFormat;
125
126
127
128
129 @Parameter( property = "failsafe.useFile", defaultValue = "true" )
130 private boolean useFile;
131
132
133
134
135
136
137
138 @Parameter( property = "it.failIfNoSpecifiedTests", defaultValue = "true" )
139 private boolean failIfNoSpecifiedTests;
140
141
142
143
144
145
146
147
148
149 @Parameter( property = "maven.failsafe.debug" )
150 private String debugForkedProcess;
151
152
153
154
155
156
157
158 @Parameter( property = "failsafe.timeout" )
159 private int forkedProcessTimeoutInSeconds;
160
161
162
163
164
165
166
167
168
169
170 @Parameter( property = "failsafe.exitTimeout", defaultValue = "30" )
171 private int forkedProcessExitTimeoutInSeconds;
172
173
174
175
176
177
178
179
180
181
182
183 @Parameter( property = "failsafe.parallel.timeout" )
184 private double parallelTestsTimeoutInSeconds;
185
186
187
188
189
190
191
192
193
194
195
196
197 @Parameter( property = "failsafe.parallel.forcedTimeout" )
198 private double parallelTestsTimeoutForcedInSeconds;
199
200 @SuppressWarnings( "checkstyle:linelength" )
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 @Parameter( property = "failsafe.includes" )
229
230 private List<String> includes;
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 @Parameter( property = "failsafe.excludes" )
257
258 private List<String> excludes;
259
260
261
262
263
264
265
266
267 @Parameter( property = "failsafe.useSystemClassLoader", defaultValue = "true" )
268 private boolean useSystemClassLoader;
269
270
271
272
273
274
275
276
277
278
279
280
281 @Parameter( property = "failsafe.useManifestOnlyJar", defaultValue = "true" )
282 private boolean useManifestOnlyJar;
283
284
285
286
287
288
289
290
291 @Parameter( property = "encoding", defaultValue = "${project.reporting.outputEncoding}" )
292 private String encoding;
293
294
295
296
297
298
299
300 @Parameter( property = "failsafe.rerunFailingTestsCount", defaultValue = "0" )
301 private int rerunFailingTestsCount;
302
303
304
305
306
307
308
309
310
311
312 @Parameter( property = "failsafe.suiteXmlFiles" )
313 private File[] suiteXmlFiles;
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 @Parameter( property = "failsafe.runOrder", defaultValue = "filesystem" )
340 private String runOrder;
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355 @Parameter( property = "failsafe.runOrder.random.seed" )
356 private Long runOrderRandomSeed;
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375 @Parameter( property = "failsafe.includesFile" )
376 private File includesFile;
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395 @Parameter( property = "failsafe.excludesFile" )
396 private File excludesFile;
397
398
399
400
401
402
403
404
405
406
407
408
409 @Parameter( property = "failsafe.skipAfterFailureCount", defaultValue = "0" )
410 private int skipAfterFailureCount;
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429 @Parameter( property = "failsafe.shutdown", defaultValue = "exit" )
430 private String shutdown;
431
432
433
434
435
436
437
438
439
440 @Parameter( property = "failsafe.useModulePath", defaultValue = "true" )
441 private boolean useModulePath;
442
443
444
445
446
447
448
449
450
451
452
453
454
455 @Parameter( property = "failsafe.forkNode" )
456 private ForkNodeFactory forkNode;
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471 @Parameter( property = "failsafe.excludedEnvironmentVariables" )
472 private String[] excludedEnvironmentVariables;
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 @Parameter( property = "failsafe.enableProcessChecker" )
513 private String enableProcessChecker;
514
515 @Parameter( property = "failsafe.systemPropertiesFile" )
516 private File systemPropertiesFile;
517
518
519
520
521
522
523 @Parameter( property = "includeJUnit5Engines" )
524 private String[] includeJUnit5Engines;
525
526
527
528
529
530
531 @Parameter( property = "excludeJUnit5Engines" )
532 private String[] excludeJUnit5Engines;
533
534 @Override
535 protected int getRerunFailingTestsCount()
536 {
537 return rerunFailingTestsCount;
538 }
539
540 @Override
541 @SuppressWarnings( "unchecked" )
542 protected void handleSummary( RunResult summary, Exception firstForkException )
543 throws MojoExecutionException, MojoFailureException
544 {
545 File summaryFile = getSummaryFile();
546 if ( !summaryFile.getParentFile().isDirectory() )
547 {
548
549 summaryFile.getParentFile().mkdirs();
550 }
551
552 try
553 {
554 Object token = getPluginContext().get( FAILSAFE_IN_PROGRESS_CONTEXT_KEY );
555 writeSummary( summary, summaryFile, token != null );
556 }
557 catch ( Exception e )
558 {
559 throw new MojoExecutionException( e.getMessage(), e );
560 }
561
562 getPluginContext().put( FAILSAFE_IN_PROGRESS_CONTEXT_KEY, FAILSAFE_IN_PROGRESS_CONTEXT_KEY );
563 }
564
565 private boolean isJarArtifact( File artifactFile )
566 {
567 return artifactFile != null && artifactFile.isFile() && artifactFile.getName().toLowerCase().endsWith( ".jar" );
568 }
569
570 private static File toAbsoluteCanonical( File f )
571 {
572 try
573 {
574 return f == null ? null : f.getAbsoluteFile().getCanonicalFile();
575 }
576 catch ( IOException e )
577 {
578 throw new IllegalStateException( e.getLocalizedMessage(), e );
579 }
580 }
581
582 @Override
583 @SuppressWarnings( "deprecation" )
584 protected boolean isSkipExecution()
585 {
586 return isSkip() || isSkipTests() || isSkipITs() || isSkipExec();
587 }
588
589 @Override
590 protected String getPluginName()
591 {
592 return "failsafe";
593 }
594
595 @Override
596 protected String[] getDefaultIncludes()
597 {
598 return new String[]{ "**/IT*.java", "**/*IT.java", "**/*ITCase.java" };
599 }
600
601 @Override
602 protected String getReportSchemaLocation()
603 {
604 return "https://maven.apache.org/surefire/maven-failsafe-plugin/xsd/failsafe-test-report-3.0.xsd";
605 }
606
607 @Override
608 public boolean isSkipTests()
609 {
610 return skipTests;
611 }
612
613 @Override
614 @Deprecated
615 public void setSkipTests( boolean skipTests )
616 {
617 this.skipTests = skipTests;
618 }
619
620 public boolean isSkipITs()
621 {
622 return skipITs;
623 }
624
625 public void setSkipITs( boolean skipITs )
626 {
627 this.skipITs = skipITs;
628 }
629
630 @Override
631 @SuppressWarnings( "deprecation" )
632 @Deprecated
633 public boolean isSkipExec()
634 {
635 return skipExec;
636 }
637
638 @Override
639 @SuppressWarnings( "deprecation" )
640 @Deprecated
641 public void setSkipExec( boolean skipExec )
642 {
643 this.skipExec = skipExec;
644 }
645
646 @Override
647 public boolean isSkip()
648 {
649 return skip;
650 }
651
652 @Override
653 public void setSkip( boolean skip )
654 {
655 this.skip = skip;
656 }
657
658 @Override
659 public File getBasedir()
660 {
661 return basedir;
662 }
663
664 @Override
665 public void setBasedir( File basedir )
666 {
667 this.basedir = basedir;
668 }
669
670 @Override
671 public File getTestClassesDirectory()
672 {
673 return testClassesDirectory;
674 }
675
676 @Override
677 public void setTestClassesDirectory( File testClassesDirectory )
678 {
679 this.testClassesDirectory = testClassesDirectory;
680 }
681
682
683
684
685
686
687 @Override
688 public File getMainBuildPath()
689 {
690 File artifact = getProject().getArtifact().getFile();
691 boolean isDefaultClsDir = classesDirectory == null;
692 return isDefaultClsDir ? ( isJarArtifact( artifact ) ? artifact : defaultClassesDirectory ) : classesDirectory;
693 }
694
695 @Override
696 public void setMainBuildPath( File mainBuildPath )
697 {
698 classesDirectory = toAbsoluteCanonical( mainBuildPath );
699 }
700
701 public void setDefaultClassesDirectory( File defaultClassesDirectory )
702 {
703 this.defaultClassesDirectory = toAbsoluteCanonical( defaultClassesDirectory );
704 }
705
706 @Override
707 public File getReportsDirectory()
708 {
709 return reportsDirectory;
710 }
711
712 @Override
713 public void setReportsDirectory( File reportsDirectory )
714 {
715 this.reportsDirectory = reportsDirectory;
716 }
717
718 @Override
719 public String getTest()
720 {
721 return test;
722 }
723
724 @Override
725 public void setTest( String test )
726 {
727 this.test = test;
728 }
729
730 public File getSummaryFile()
731 {
732 return summaryFile;
733 }
734
735 public void setSummaryFile( File summaryFile )
736 {
737 this.summaryFile = summaryFile;
738 }
739
740 @Override
741 public boolean isPrintSummary()
742 {
743 return printSummary;
744 }
745
746 @Override
747 public void setPrintSummary( boolean printSummary )
748 {
749 this.printSummary = printSummary;
750 }
751
752 @Override
753 public String getReportFormat()
754 {
755 return reportFormat;
756 }
757
758 @Override
759 public void setReportFormat( String reportFormat )
760 {
761 this.reportFormat = reportFormat;
762 }
763
764 @Override
765 public boolean isUseFile()
766 {
767 return useFile;
768 }
769
770 @Override
771 public void setUseFile( boolean useFile )
772 {
773 this.useFile = useFile;
774 }
775
776 @Override
777 public String getDebugForkedProcess()
778 {
779 return debugForkedProcess;
780 }
781
782 @Override
783 public void setDebugForkedProcess( String debugForkedProcess )
784 {
785 this.debugForkedProcess = debugForkedProcess;
786 }
787
788 @Override
789 public int getForkedProcessTimeoutInSeconds()
790 {
791 return forkedProcessTimeoutInSeconds;
792 }
793
794 @Override
795 public void setForkedProcessTimeoutInSeconds( int forkedProcessTimeoutInSeconds )
796 {
797 this.forkedProcessTimeoutInSeconds = forkedProcessTimeoutInSeconds;
798 }
799
800 @Override
801 public int getForkedProcessExitTimeoutInSeconds()
802 {
803 return forkedProcessExitTimeoutInSeconds;
804 }
805
806 @Override
807 public void setForkedProcessExitTimeoutInSeconds( int forkedProcessExitTimeoutInSeconds )
808 {
809 this.forkedProcessExitTimeoutInSeconds = forkedProcessExitTimeoutInSeconds;
810 }
811
812 @Override
813 public double getParallelTestsTimeoutInSeconds()
814 {
815 return parallelTestsTimeoutInSeconds;
816 }
817
818 @Override
819 public void setParallelTestsTimeoutInSeconds( double parallelTestsTimeoutInSeconds )
820 {
821 this.parallelTestsTimeoutInSeconds = parallelTestsTimeoutInSeconds;
822 }
823
824 @Override
825 public double getParallelTestsTimeoutForcedInSeconds()
826 {
827 return parallelTestsTimeoutForcedInSeconds;
828 }
829
830 @Override
831 public void setParallelTestsTimeoutForcedInSeconds( double parallelTestsTimeoutForcedInSeconds )
832 {
833 this.parallelTestsTimeoutForcedInSeconds = parallelTestsTimeoutForcedInSeconds;
834 }
835
836 @Override
837 public boolean isUseSystemClassLoader()
838 {
839 return useSystemClassLoader;
840 }
841
842 @Override
843 public void setUseSystemClassLoader( boolean useSystemClassLoader )
844 {
845 this.useSystemClassLoader = useSystemClassLoader;
846 }
847
848 @Override
849 public boolean isUseManifestOnlyJar()
850 {
851 return useManifestOnlyJar;
852 }
853
854 @Override
855 public void setUseManifestOnlyJar( boolean useManifestOnlyJar )
856 {
857 this.useManifestOnlyJar = useManifestOnlyJar;
858 }
859
860 @Override
861 public String getEncoding()
862 {
863 return encoding;
864 }
865
866 @Override
867 public void setEncoding( String encoding )
868 {
869 this.encoding = encoding;
870 }
871
872
873
874 public boolean isTestFailureIgnore()
875 {
876 return true;
877 }
878
879 public void setTestFailureIgnore( boolean testFailureIgnore )
880 {
881
882 }
883
884 @Override
885 protected void addPluginSpecificChecksumItems( ChecksumCalculator checksum )
886 {
887 checksum.add( skipITs );
888 checksum.add( summaryFile );
889 }
890
891 @Override
892 public File getSystemPropertiesFile()
893 {
894 return systemPropertiesFile;
895 }
896
897 @Override
898 public void setSystemPropertiesFile( File systemPropertiesFile )
899 {
900 this.systemPropertiesFile = systemPropertiesFile;
901 }
902
903 @Override
904 public boolean getFailIfNoSpecifiedTests()
905 {
906 return failIfNoSpecifiedTests;
907 }
908
909 @Override
910 public void setFailIfNoSpecifiedTests( boolean failIfNoSpecifiedTests )
911 {
912 this.failIfNoSpecifiedTests = failIfNoSpecifiedTests;
913 }
914
915 @Override
916 public int getSkipAfterFailureCount()
917 {
918 return skipAfterFailureCount;
919 }
920
921 @Override
922 public String getShutdown()
923 {
924 return shutdown;
925 }
926
927 @Override
928 public List<String> getIncludes()
929 {
930 return includes;
931 }
932
933 @Override
934 public void setIncludes( List<String> includes )
935 {
936 this.includes = includes;
937 }
938
939 @Override
940 public List<String> getExcludes()
941 {
942 return excludes;
943 }
944
945 @Override
946 public void setExcludes( List<String> excludes )
947 {
948 this.excludes = excludes;
949 }
950
951 @Override
952 public File[] getSuiteXmlFiles()
953 {
954 return suiteXmlFiles.clone();
955 }
956
957 @Override
958 @SuppressWarnings( "UnusedDeclaration" )
959 public void setSuiteXmlFiles( File[] suiteXmlFiles )
960 {
961 this.suiteXmlFiles = suiteXmlFiles.clone();
962 }
963
964 @Override
965 public String getRunOrder()
966 {
967 return runOrder;
968 }
969
970 @Override
971 @SuppressWarnings( "UnusedDeclaration" )
972 public void setRunOrder( String runOrder )
973 {
974 this.runOrder = runOrder;
975 }
976
977 @Override
978 public Long getRunOrderRandomSeed()
979 {
980 return runOrderRandomSeed;
981 }
982
983 @Override
984 public void setRunOrderRandomSeed( Long runOrderRandomSeed )
985 {
986 this.runOrderRandomSeed = runOrderRandomSeed;
987 }
988
989 @Override
990 public File getIncludesFile()
991 {
992 return includesFile;
993 }
994
995 @Override
996 public File getExcludesFile()
997 {
998 return excludesFile;
999 }
1000
1001 @Override
1002 protected boolean useModulePath()
1003 {
1004 return useModulePath;
1005 }
1006
1007 @Override
1008 protected void setUseModulePath( boolean useModulePath )
1009 {
1010 this.useModulePath = useModulePath;
1011 }
1012
1013 @Override
1014 protected final List<File> suiteXmlFiles()
1015 {
1016 return hasSuiteXmlFiles() ? Arrays.asList( suiteXmlFiles ) : Collections.<File>emptyList();
1017 }
1018
1019 @Override
1020 protected final boolean hasSuiteXmlFiles()
1021 {
1022 return suiteXmlFiles != null && suiteXmlFiles.length != 0;
1023 }
1024
1025 @Override
1026 protected final ForkNodeFactory getForkNode()
1027 {
1028 return forkNode;
1029 }
1030
1031 @Override
1032 protected final String[] getExcludedEnvironmentVariables()
1033 {
1034 return excludedEnvironmentVariables == null ? new String[0] : excludedEnvironmentVariables;
1035 }
1036
1037 void setExcludedEnvironmentVariables( String[] excludedEnvironmentVariables )
1038 {
1039 this.excludedEnvironmentVariables = excludedEnvironmentVariables;
1040 }
1041
1042 @Override
1043 protected final String getEnableProcessChecker()
1044 {
1045 return enableProcessChecker;
1046 }
1047
1048 public String[] getIncludeJUnit5Engines()
1049 {
1050 return includeJUnit5Engines;
1051 }
1052
1053 @SuppressWarnings( "UnusedDeclaration" )
1054 public void setIncludeJUnit5Engines( String[] includeJUnit5Engines )
1055 {
1056 this.includeJUnit5Engines = includeJUnit5Engines;
1057 }
1058
1059 public String[] getExcludeJUnit5Engines()
1060 {
1061 return excludeJUnit5Engines;
1062 }
1063
1064 @SuppressWarnings( "UnusedDeclaration" )
1065 public void setExcludeJUnit5Engines( String[] excludeJUnit5Engines )
1066 {
1067 this.excludeJUnit5Engines = excludeJUnit5Engines;
1068 }
1069 }