{"id":3606,"date":"2019-12-01T15:20:21","date_gmt":"2019-12-01T15:20:21","guid":{"rendered":"http:\/\/codethataint.com\/blog\/?p=3606"},"modified":"2025-04-03T12:34:07","modified_gmt":"2025-04-03T12:34:07","slug":"skipping-tests-across-multiple-child-modules-in-maven","status":"publish","type":"post","link":"https:\/\/codethataint.com\/blog\/skipping-tests-across-multiple-child-modules-in-maven\/","title":{"rendered":"Skipping Tests across Multiple Child Modules in Maven"},"content":{"rendered":"
\r\n<build>\r\n    <plugins>\r\n      <plugin>\r\n        <groupId>org.apache.maven.plugins<\/groupId>\r\n        <artifactId>maven-surefire-plugin<\/artifactId>\r\n        <version>2.9<\/version>\r\n        <configuration>\r\n          <excludes>\r\n            <exclude>${someModule.test.excludes}<\/exclude>\r\n          <\/excludes>\r\n          <includes>\r\n            <include>${someModule.test.includes}<\/include>\r\n          <\/includes>\r\n        <\/configuration>\r\n      <\/plugin>\r\n    <\/plugins>\r\n  <\/build>\r\n  <properties>\r\n    <someModule.skip.tests>false<\/someModule.skip.tests>\r\n    <skipTests>${someModule.skip.tests}<\/skipTests>\r\n    <someModule.test.includes>**\/*Test.java<\/someModule.test.includes>\r\n    <someModule.test.excludes>**\/*Test.java.bogus<\/someModule.test.excludes>\r\n  <\/properties>\r\n<\/pre>\n
Skip all Test<\/strong><\/p>\n
\r\nmvn -DsomeModule.skip.tests=true test\r\n<\/pre>\n
Include specific Test<\/strong><\/p>\n
\r\nmvn -DsomeModule.test.includes=\"**\/*IncludeTest.java\" test\r\n<\/pre>\n
Exclude specific Test<\/strong><\/p>\n
\r\nmvn -DsomeModule.test.excludes=\"**\/*ExcludeTest.java\" test\r\n<\/pre>\n
There would be scenarios where you need to skip few modules when building parent project because the unit test fail in child project. In such scenario we should define the surefire plugin at parent pom.xml and include and exclude the child modules for which the unit test should be executed.<\/p>\n
\r\n<project>\r\n  [...]\r\n  <build>\r\n    <plugins>\r\n      <plugin>\r\n        <groupId>org.apache.maven.plugins<\/groupId>\r\n        <artifactId>maven-surefire-plugin<\/artifactId>\r\n        <version>2.4.2<\/version>\r\n        <configuration>\r\n          <skipTests>true<\/skipTests>\r\n        <\/configuration>\r\n      <\/plugin>\r\n    <\/plugins>\r\n  <\/build>\r\n  [...]\r\n<\/project>\r\n<\/pre>\n
Rather than defining plugin(in our case surefire plugin), we can create a profile and define the behavior of plugins within the profile.<\/p>\n
\r\n<project>\r\n  [...]\r\n  <profiles>\r\n    <profile>\r\n      <id>noTest<\/id>\r\n      <activation>\r\n        <property>\r\n          <name>noTest<\/name>\r\n          <value>true<\/value>\r\n        <\/property>\r\n      <\/activation>\r\n      <build>\r\n        <plugins>\r\n          <plugin>\r\n            <groupId>org.apache.maven.plugins<\/groupId>\r\n            <artifactId>maven-surefire-plugin<\/artifactId>\r\n            <version>2.4.2<\/version>\r\n            <configuration>\r\n              <skipTests>true<\/skipTests>\r\n            <\/configuration>\r\n          <\/plugin>\r\n        <\/plugins>\r\n      <\/build>\r\n    <\/profile>\r\n  <\/profiles>\r\n  [...]\r\n<\/project>\r\n<\/pre>\n
Now lets include and exclude child modules for which unit test should be carried out<\/p>\n
Including Unit Test<\/strong>
\nOnly the following(ChildModule3.java) file would be included and others would be excluded<\/em><\/p>\n
\r\n<project>\r\n  [...]\r\n  <build>\r\n    <plugins>\r\n      <plugin>\r\n        <groupId>org.apache.maven.plugins<\/groupId>\r\n        <artifactId>maven-surefire-plugin<\/artifactId>\r\n        <version>3.0.0-M4<\/version>\r\n        <configuration>\r\n          <includes>\r\n            <include>ChildModule3.java<\/include>\r\n          <\/includes>\r\n        <\/configuration>\r\n      <\/plugin>\r\n    <\/plugins>\r\n  <\/build>\r\n  [...]\r\n<\/project>\r\n<\/pre>\n
Excluding Unit Test<\/strong>
\nOnly the following(ChildModule1.java, ChildModule2.java) file would be excluded<\/em><\/p>\n
\r\n<project>\r\n  [...]\r\n  <build>\r\n    <plugins>\r\n      <plugin>\r\n        <groupId>org.apache.maven.plugins<\/groupId>\r\n        <artifactId>maven-surefire-plugin<\/artifactId>\r\n        <version>3.0.0-M4<\/version>\r\n        <configuration>\r\n          <excludes>\r\n            <exclude>**\/ChildModule1.java<\/exclude>\r\n            <exclude>**\/ChildModule2.java<\/exclude>\r\n          <\/excludes>\r\n        <\/configuration>\r\n      <\/plugin>\r\n    <\/plugins>\r\n  <\/build>\r\n  [...]\r\n<\/project>\r\n<\/pre>\n
How to activate profile in command prompt<\/strong><\/p>\n
\r\n>>mvn clean install -PnoTest\r\n<\/pre>\n
How to see list of active Profiles<\/strong><\/p>\n
\r\n>>mvn help:active-profiles\r\n<\/pre>\n
If you want to know what version of an specific plugin you have installed you can do this:<\/p>\n
\r\nmvn -Dplugin=org.codehaus.mojo:wagon-maven-plugin help:describe\r\nmvn -Dplugin=groupId:artifactId help:describe\r\nmvn help:effective-pom\r\n<\/pre>\n
How to execute life cycle task using specific plugin<\/strong><\/p>\n
\r\n>>mvn groupID:artifactID:version:goal\r\n>>mvn org.apache.maven.plugins:maven-checkstyle-plugin:2.5:checkstyle\r\n\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins<\/groupId> <artifactId>maven-surefire-plugin<\/artifactId> <version>2.9<\/version> <configuration> <excludes> <exclude>${someModule.test.excludes}<\/exclude> <\/excludes> <includes> <include>${someModule.test.includes}<\/include> <\/includes> <\/configuration> <\/plugin> <\/plugins> <\/build> <properties> <someModule.skip.tests>false<\/someModule.skip.tests> <skipTests>${someModule.skip.tests}<\/skipTests> <someModule.test.includes>**\/*Test.java<\/someModule.test.includes> <someModule.test.excludes>**\/*Test.java.bogus<\/someModule.test.excludes> <\/properties> Skip all Test mvn -DsomeModule.skip.tests=true test Include specific Test mvn -DsomeModule.test.includes=”**\/*IncludeTest.java” test Exclude specific Test mvn -DsomeModule.test.excludes=”**\/*ExcludeTest.java” test There would be scenarios where you need to skip few modules when building parent… Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[215],"tags":[],"class_list":["post-3606","post","type-post","status-publish","format-standard","hentry","category-maven"],"_links":{"self":[{"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/posts\/3606","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/comments?post=3606"}],"version-history":[{"count":5,"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/posts\/3606\/revisions"}],"predecessor-version":[{"id":5506,"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/posts\/3606\/revisions\/5506"}],"wp:attachment":[{"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/media?parent=3606"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/categories?post=3606"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/codethataint.com\/blog\/wp-json\/wp\/v2\/tags?post=3606"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}