Skip to content

Commit

Permalink
[MCLEAN-111] Fix fast delete feature for filesets (#32)
Browse files Browse the repository at this point in the history
* Fix fast delete feature.
* Add integration test for the fast delete feature.
* Document the limitation of the fast delete method.
  • Loading branch information
wilx authored Oct 18, 2023
1 parent 4bb70fd commit 536c367
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 2 deletions.
18 changes: 18 additions & 0 deletions src/it/fast-delete/invoker.properties
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.

invoker.goals = install clean -Dorg.slf4j.simpleLogger.showThreadName=true -X -e
52 changes: 52 additions & 0 deletions src/it/fast-delete/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?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.
-->

<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>test</groupId>
<artifactId>fast-delete</artifactId>
<version>1.0-SNAPSHOT</version>

<name>Fast delete</name>
<description>Check that fast delete is invoked.</description>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>@project.version@</version>
<configuration>
<fast>true</fast>
<fastDir>${project.basedir}${file.separator}.fastdir</fastDir>
</configuration>
</plugin>
</plugins>
</build>

</project>
21 changes: 21 additions & 0 deletions src/it/fast-delete/verify.groovy
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* 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.
*/

File buildLog = new File(basedir, 'build.log')
return buildLog.text.contains('mvn-background-cleaner')
13 changes: 11 additions & 2 deletions src/main/java/org/apache/maven/plugins/clean/CleanMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,17 @@ public void execute() throws MojoExecutionException {
if (fileset.getDirectory() == null) {
throw new MojoExecutionException("Missing base directory for " + fileset);
}
GlobSelector selector = new GlobSelector(
fileset.getIncludes(), fileset.getExcludes(), fileset.isUseDefaultExcludes());
final String[] includes = fileset.getIncludes();
final String[] excludes = fileset.getExcludes();
final boolean useDefaultExcludes = fileset.isUseDefaultExcludes();
final GlobSelector selector;
if ((includes != null && includes.length != 0)
|| (excludes != null && excludes.length != 0)
|| useDefaultExcludes) {
selector = new GlobSelector(includes, excludes, useDefaultExcludes);
} else {
selector = null;
}
cleaner.delete(
fileset.getDirectory(), selector, fileset.isFollowSymlinks(), failOnError, retryOnError);
}
Expand Down
3 changes: 3 additions & 0 deletions src/site/apt/examples/delete_additional_files.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,6 @@ Delete Additional Files Not Exposed to Maven

You could also define file set rules in a parent POM. In this case, the clean plugin adds the subproject
basedir to the defined relative path.

<<Note:>> The <<<fast>>> delete method will not work for any <<<fileset>>> which defines any <<<includes>>>
or <<<excludes>>>, or sets <<<followSymlinks>>> to <<<false>>>, or sets <<<useDefaultExcludes>>> to <<<true>>>.

0 comments on commit 536c367

Please sign in to comment.