Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ARCHETYPE-274] Conditionally include or exclude a file from archetype during generation #244

Merged
merged 8 commits into from
Jan 4, 2025
Merged

[ARCHETYPE-274] Conditionally include or exclude a file from archetype during generation #244

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
72c05af
[ARCHETYPE-274] Setup with Copilot: https://copilot-workspace.githubn…
Giovds Nov 22, 2024
8c2bbd1
[ARCHETYPE-274] Log different debug message and remove temp test files
Giovds Nov 22, 2024
2f76cef
[ARCHETYPE-274] Add integration test
Giovds Nov 22, 2024
32685c2
[ARCHETYPE-274] Minor improvements
Giovds Nov 22, 2024
e980722
[ARCHETYPE-274] Add Lincense to files and validate file content
Giovds Nov 22, 2024
99ec1f5
[ARCHETYPE-274] Correct file content check
Giovds Nov 22, 2024
6c5e4b7
[ARCHETYPE-274] run spotless with require new line at EOF
Giovds Dec 6, 2024
fcae821
[ARCHETYPE-274] Move to mdo version 1.1.0 and include a more detailed…
Giovds Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...type-common/src/main/java/org/apache/maven/archetype/creator/FilesetArchetypeCreator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,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);
Expand Down
11 changes: 11 additions & 0 deletions .../src/main/java/org/apache/maven/archetype/generator/DefaultFilesetArchetypeGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,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);

Expand Down
7 changes: 7 additions & 0 deletions archetype-models/archetype-descriptor/src/main/mdo/archetype-descriptor.mdo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,13 @@
<required>false</required>
<description>Encoding to use when filtering content.</description>
</field>
<field xml.attribute="true">
slawekjaranowski marked this conversation as resolved.
Show resolved Hide resolved
<name>includeCondition</name>
<version>1.0.0+</version>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think about put 1.1.0+ here ... we also need update version for model in plugin configuration

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be backwards compatible so that's why I put it in v1.0.0, but I'm fine with both. I'm not sure what the implications would be when adding it for 1.0.0

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we will publish next schema version, for backward compatible users can use old schema without new field ....

<type>String</type>
<required>false</required>
<description>Condition to include the fileset based on a property value.</description>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should contains more details ...

after looking into code and test I see that it is evaluated be velocity ... and should have a true value

</field>
<field>
<name>directory</name>
<version>1.0.0+</version>
Expand Down
18 changes: 18 additions & 0 deletions ...-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
44 changes: 44 additions & 0 deletions maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/archetype/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
60 changes: 60 additions & 0 deletions ...4_conditional_filesets/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
28 changes: 28 additions & 0 deletions ...CHETYPE-274_conditional_filesets/archetype/src/main/resources/archetype-resources/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
24 changes: 24 additions & 0 deletions ...ditional_filesets/archetype/src/main/resources/archetype-resources/src/main/java/App.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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");
}
}
20 changes: 20 additions & 0 deletions ...chetype/src/main/resources/archetype-resources/src/main/resources/exclude-with-filter.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
20 changes: 20 additions & 0 deletions ...type/src/main/resources/archetype-resources/src/main/resources/exclude-without-filter.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
20 changes: 20 additions & 0 deletions ...chetype/src/main/resources/archetype-resources/src/main/resources/include-with-filter.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
20 changes: 20 additions & 0 deletions ...type/src/main/resources/archetype-resources/src/main/resources/include-without-filter.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
22 changes: 22 additions & 0 deletions maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/invoker.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 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.

invoker.goals.1 = install
invoker.project.1 = archetype

invoker.goals.2 = org.apache.maven.plugins:maven-archetype-plugin:${project.version}:generate
invoker.userPropertiesFile = project.properties
48 changes: 48 additions & 0 deletions maven-archetype-plugin/src/it/projects/ARCHETYPE-274_conditional_filesets/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!--
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>org.apache.maven.plugins.archetype.its</groupId>
<artifactId>archetype274-parent</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>

<build>
<extensions>
<extension>
<groupId>org.apache.maven.archetype</groupId>
<artifactId>archetype-packaging</artifactId>
<version>@project.version@</version>
</extension>
</extensions>

<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-archetype-plugin</artifactId>
<version>@project.version@</version>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
Loading