[ARCHETYPE-274] Conditionally include or exclude a file from archetyp…

…e during generation (#244)

NOTICE.txt

@@ -1,3 +1,2 @@
 This product includes software developed by 
 The Apache Software Foundation (http://www.apache.org/).
-

archetype-common/src/main/java/org/apache/maven/archetype/creator/FilesetArchetypeCreator.java

@@ -183,8 +183,9 @@ public void createArchetype(ArchetypeCreationRequest request, ArchetypeCreationR
             Model pom = pomManager.readPom(project.getFile());
 
             List<String> excludePatterns = configurationProperties.getProperty(Constants.EXCLUDE_PATTERNS) != null
-                    ? Arrays.asList(
-                            StringUtils.split(configurationProperties.getProperty(Constants.EXCLUDE_PATTERNS), ","))
+                    ? Arrays.asList(configurationProperties
+                            .getProperty(Constants.EXCLUDE_PATTERNS)
+                            .split(","))
                     : Collections.emptyList();
 
             List<String> fileNames = resolveFileNames(pom, basedir, excludePatterns);

archetype-common/src/main/java/org/apache/maven/archetype/generator/DefaultFilesetArchetypeGenerator.java

@@ -780,6 +780,17 @@ private void processTemplates(
             FileSet fileSet = iterator.next();
             count++;
 
+            final String includeCondition = fileSet.getIncludeCondition();
+            if (includeCondition != null && !includeCondition.isEmpty()) {
+                final String evaluatedCondition = evaluateExpression(context, "includeCondition", includeCondition);
+                if (!Boolean.parseBoolean(evaluatedCondition)) {
+                    LOGGER.debug(String.format(
+                            "Skipping fileset %s due to includeCondition: %s being: %s",
+                            fileSet, includeCondition, evaluatedCondition));
+                    continue;
+                }
+            }
+
             List<String> fileSetResources =
                     archetypeFilesResolver.filterFiles(moduleOffset, fileSet, archetypeResources);
 

archetype-common/src/test/archetypes/basic-1.0/archetype-resources/pom.xml

@@ -40,4 +40,4 @@
     <!-- empty dependencies, with comments -->
   </dependencies>
 
-</project>
+</project>

archetype-common/src/test/archetypes/fileset-1.0/archetype-resources/pom.xml

@@ -35,4 +35,4 @@
     <module>subproject</module>
   </modules>
 
-</project>
+</project>

archetype-common/src/test/archetypes/fileset-1.0/archetype-resources/subproject/pom.xml

@@ -41,4 +41,4 @@
     <module>subsubproject</module>
   </modules>
 
-</project>
+</project>

archetype-common/src/test/archetypes/fileset-1.0/archetype-resources/subproject/subsubproject/pom.xml

@@ -37,4 +37,4 @@
   <name>Maven archetype Test Subsubfolder</name>
   <packaging>jar</packaging>
 
-</project>
+</project>

archetype-common/src/test/archetypes/old-1.0/archetype-resources/pom.xml

@@ -36,4 +36,4 @@
     <!-- empty dependencies, with comments -->
   </dependencies>
 
-</project>
+</project>

archetype-common/src/test/archetypes/partial-1.0/archetype-resources/pom.xml

@@ -58,4 +58,4 @@
       </plugin>
     </plugins>
   </reporting>
-</project>
+</project>

archetype-common/src/test/repository/org/apache/maven/archetypes/maven-archetype-quickstart/1.0-alpha-1-SNAPSHOT/maven-archetype-quickstart-1.0-alpha-1-SNAPSHOT.pom

@@ -23,4 +23,4 @@
   <modelVersion>4.0.0</modelVersion>
   <artifactId>maven-archetype-quickstart</artifactId>
   <version>1.0-alpha-1-SNAPSHOT</version>
-</project>
+</project>

archetype-models/archetype-descriptor/src/main/mdo/archetype-descriptor.mdo

@@ -162,6 +162,16 @@
           <required>false</required>
           <description>Encoding to use when filtering content.</description>
         </field>
+        <field xml.attribute="true">
+          <name>includeCondition</name>
+          <version>1.1.0+</version>
+          <type>String</type>
+          <required>false</required>
+          <description>A string value that should resolve to a boolean value to conditionally include filesets.
+          This condition should be either a boolean as String or a velocity template language statement that resolves
+          to a boolean value. If the descriptor contains includeCondition="${shouldInclude}" and the archetype has
+          a (required) property like shouldInclude=true the fileset is included.</description>
+        </field>
         <field>
           <name>directory</name>
           <version>1.0.0+</version>

archetype-samples/pom.xml

@@ -26,4 +26,4 @@
     <archetype.properties>archetype.properties</archetype.properties>
   </properties>
 
-</project>
+</project>

deploySite.sh

@@ -21,4 +21,3 @@
 
 mvn package site site:stage -Preporting $@
 mvn scm-publish:publish-scm $@
-

maven-archetype-plugin/src/it/projects/ARCHETYPE-241_filter-directory/archetype/src/main/resources/archetype-resources/__projectName__-test2/pom.xml

@@ -30,4 +30,4 @@ under the License.
   </parent>
   <artifactId>${projectName}-test2</artifactId>
 
-</project>
+</project>

maven-archetype-plugin/src/it/projects/ARCHETYPE-241_filter-directory/archetype/src/main/resources/archetype-resources/__rootArtifactId__-test1/pom.xml

@@ -30,4 +30,4 @@ under the License.
   </parent>
   <artifactId>${rootArtifactId}-test1</artifactId>
 
-</project>
+</project>

maven-archetype-plugin/src/it/projects/ARCHETYPE-241_filter-directory/archetype/src/main/resources/archetype-resources/pom.xml

@@ -33,4 +33,4 @@ under the License.
     <module>${projectName}-test2</module>
   </modules>
 
-</project>
+</project>

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype.properties

@@ -0,0 +1,18 @@
+# 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.
+
+excludePatterns=build.log,invoker.properties,verify.groovy

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/pom.xml

@@ -0,0 +1,44 @@
+<!--
+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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.apache.maven.plugins.archetype.its</groupId>
+        <artifactId>archetype274-parent</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>archetype274-archetype</artifactId>
+    <packaging>maven-archetype</packaging>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-archetype-plugin</artifactId>
+                <extensions>true</extensions>
+                <configuration>
+                    <archetypeDirectory>src/main/resources</archetypeDirectory>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ 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.
+  -->
+<archetype-descriptor name="include-condition-test">
+
+    <requiredProperties>
+        <requiredProperty key="extraSupport"/>
+        <requiredProperty key="anotherSupport"/>
+    </requiredProperties>
+
+    <fileSets>
+        <fileSet filtered="true" packaged="true">
+            <directory>src/main/java</directory>
+            <includes>
+                <include>**/*.java</include>
+            </includes>
+        </fileSet>
+        <fileSet filtered="false" packaged="false" includeCondition="${extraSupport}">
+            <directory>src/main/resources</directory>
+            <includes>
+                <include>**/include-without-filter.txt</include>
+            </includes>
+        </fileSet>
+        <fileSet filtered="true" packaged="false" includeCondition="${extraSupport}">
+            <directory>src/main/resources</directory>
+            <includes>
+                <include>**/include-with-filter.txt</include>
+            </includes>
+        </fileSet>
+        <fileSet filtered="true" packaged="false" includeCondition="${anotherSupport}">
+            <directory>src/main/resources</directory>
+            <includes>
+                <include>**/exclude-with-filter.txt</include>
+            </includes>
+        </fileSet>
+        <fileSet filtered="false" packaged="false" includeCondition="${anotherSupport}">
+            <directory>src/main/resources</directory>
+            <includes>
+                <include>**/exclude-without-filter.txt</include>
+            </includes>
+        </fileSet>
+    </fileSets>
+
+</archetype-descriptor>

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/src/main/resources/archetype-resources/pom.xml

@@ -0,0 +1,28 @@
+<!--
+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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>${groupId}</groupId>
+    <artifactId>${artifactId}</artifactId>
+    <version>${version}</version>
+    <packaging>pom</packaging>
+
+</project>

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/src/main/resources/archetype-resources/src/main/java/App.java

@@ -0,0 +1,24 @@
+/*
+ * 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.
+ */
+
+public class App {
+    public static void main(String[] args) {
+        System.out.println("This file should not be included");
+    }
+}

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/src/main/resources/archetype-resources/src/main/resources/exclude-with-filter.txt

@@ -0,0 +1,20 @@
+/*
+ * 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.
+*/
+
+this should be excluded: ${package}

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/src/main/resources/archetype-resources/src/main/resources/exclude-without-filter.txt

@@ -0,0 +1,20 @@
+/*
+ * 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.
+*/
+
+this should be excluded: ${package}

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/src/main/resources/archetype-resources/src/main/resources/include-with-filter.txt

@@ -0,0 +1,20 @@
+/*
+ * 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.
+*/
+
+this should be included: ${package}

maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/src/main/resources/archetype-resources/src/main/resources/include-without-filter.txt

@@ -0,0 +1,20 @@
+/*
+ * 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.
+*/
+
+this should be included: ${package}