This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch feat/WW-5864-struts-maven-plugin-watch in repository https://gitbox.apache.org/repos/asf/struts.git
commit b87303edbc708b51a266f882c0daca44c0927be8 Author: Lukasz Lenart <[email protected]> AuthorDate: Sat Nov 14 09:25:00 2026 +0100 WW-5864 fix(tools): follow plugin-level filters and escaping settings Reads <filters>, <useBuildFilters>, <escapeWindowsPaths>, <supportMultiLineFiltering> and <fileNameFiltering> from the effective maven-resources-plugin configuration, watches the combined filter files, and warns when <outputDirectory> or <skip> is set. Co-Authored-By: Claude Opus 5.5 <[email protected]> --- .../maven/watch/FilteringResourcePusher.java | 10 ++- .../maven/watch/ResourcesPluginSettings.java | 81 ++++++++++++++++------ .../org/apache/struts2/maven/watch/WatchMojo.java | 10 +-- .../maven/watch/FilteringResourcePusherTest.java | 47 ++++++++++++- .../maven/watch/ResourcesPluginSettingsTest.java | 48 +++++++++++++ 5 files changed, 167 insertions(+), 29 deletions(-) diff --git a/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/FilteringResourcePusher.java b/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/FilteringResourcePusher.java index a4641fc7f..2ce8c029b 100644 --- a/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/FilteringResourcePusher.java +++ b/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/FilteringResourcePusher.java @@ -37,14 +37,16 @@ public final class FilteringResourcePusher implements ResourcePusher { private final MavenSession session; private final ResourcesPluginSettings settings; private final Path outputDirectory; + private final List<String> filterFiles; public FilteringResourcePusher(MavenResourcesFiltering filtering, MavenProject project, MavenSession session, - ResourcesPluginSettings settings, Path outputDirectory) { + ResourcesPluginSettings settings, Path outputDirectory, List<Path> filterFiles) { this.filtering = filtering; this.project = project; this.session = session; this.settings = settings; this.outputDirectory = outputDirectory; + this.filterFiles = filterFiles.stream().map(Path::toString).toList(); } @Override @@ -58,7 +60,11 @@ public final class FilteringResourcePusher implements ResourcePusher { MavenResourcesExecution execution = new MavenResourcesExecution( List.of(resource), outputDirectory.toFile(), project, settings.getEncoding(), - project.getBuild().getFilters(), List.of(), session); + filterFiles, List.of(), session); + execution.setInjectProjectBuildFilters(false); + execution.setEscapeWindowsPaths(settings.isEscapeWindowsPaths()); + execution.setSupportMultiLineFiltering(settings.isSupportMultiLineFiltering()); + execution.setFilterFilenames(settings.isFileNameFiltering()); execution.setPropertiesEncoding(settings.getPropertiesEncoding()); execution.setDelimiters(settings.getDelimiters(), settings.isUseDefaultDelimiters()); execution.setEscapeString(settings.getEscapeString()); diff --git a/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/ResourcesPluginSettings.java b/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/ResourcesPluginSettings.java index 8640f5c77..849a35b67 100644 --- a/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/ResourcesPluginSettings.java +++ b/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/ResourcesPluginSettings.java @@ -23,6 +23,7 @@ import org.apache.maven.model.PluginExecution; import org.apache.maven.project.MavenProject; import org.codehaus.plexus.util.xml.Xpp3Dom; +import java.nio.file.Path; import java.util.ArrayList; import java.util.Collections; import java.util.LinkedHashSet; @@ -40,28 +41,33 @@ public final class ResourcesPluginSettings { private final String escapeString; private final List<String> nonFilteredFileExtensions; private final boolean addDefaultExcludes; - - private ResourcesPluginSettings(String encoding, String propertiesEncoding, LinkedHashSet<String> delimiters, - boolean useDefaultDelimiters, String escapeString, - List<String> nonFilteredFileExtensions, boolean addDefaultExcludes) { - this.encoding = encoding; - this.propertiesEncoding = propertiesEncoding; - this.delimiters = delimiters; - this.useDefaultDelimiters = useDefaultDelimiters; - this.escapeString = escapeString; - this.nonFilteredFileExtensions = Collections.unmodifiableList(nonFilteredFileExtensions); - this.addDefaultExcludes = addDefaultExcludes; + private final List<String> filters; + private final boolean useBuildFilters; + private final boolean escapeWindowsPaths; + private final boolean supportMultiLineFiltering; + private final boolean fileNameFiltering; + private final String outputDirectory; + private final boolean skip; + + private ResourcesPluginSettings(Xpp3Dom configuration, String projectEncoding) { + this.encoding = text(configuration, "encoding", projectEncoding); + this.propertiesEncoding = text(configuration, "propertiesEncoding", null); + this.delimiters = new LinkedHashSet<>(texts(configuration, "delimiters")); + this.useDefaultDelimiters = flag(configuration, "useDefaultDelimiters", "true"); + this.escapeString = text(configuration, "escapeString", null); + this.nonFilteredFileExtensions = Collections.unmodifiableList(texts(configuration, "nonFilteredFileExtensions")); + this.addDefaultExcludes = flag(configuration, "addDefaultExcludes", "true"); + this.filters = Collections.unmodifiableList(texts(configuration, "filters")); + this.useBuildFilters = flag(configuration, "useBuildFilters", "true"); + this.escapeWindowsPaths = flag(configuration, "escapeWindowsPaths", "true"); + this.supportMultiLineFiltering = flag(configuration, "supportMultiLineFiltering", "false"); + this.fileNameFiltering = flag(configuration, "fileNameFiltering", "false"); + this.outputDirectory = text(configuration, "outputDirectory", null); + this.skip = flag(configuration, "skip", "false"); } public static ResourcesPluginSettings from(Xpp3Dom configuration, String projectEncoding) { - return new ResourcesPluginSettings( - text(configuration, "encoding", projectEncoding), - text(configuration, "propertiesEncoding", null), - new LinkedHashSet<>(texts(configuration, "delimiters")), - flag(configuration, "useDefaultDelimiters"), - text(configuration, "escapeString", null), - texts(configuration, "nonFilteredFileExtensions"), - flag(configuration, "addDefaultExcludes")); + return new ResourcesPluginSettings(configuration, projectEncoding); } public static Xpp3Dom effectiveResourcesConfiguration(MavenProject project) { @@ -83,8 +89,8 @@ public final class ResourcesPluginSettings { return child == null || child.getValue() == null ? fallback : child.getValue(); } - private static boolean flag(Xpp3Dom configuration, String name) { - return Boolean.parseBoolean(text(configuration, name, "true")); + private static boolean flag(Xpp3Dom configuration, String name, String defaultValue) { + return Boolean.parseBoolean(text(configuration, name, defaultValue)); } private static List<String> texts(Xpp3Dom configuration, String name) { @@ -127,4 +133,37 @@ public final class ResourcesPluginSettings { public boolean isAddDefaultExcludes() { return addDefaultExcludes; } + + public List<Path> filterFiles(List<String> buildFilters, Path basedir) { + List<String> combined = new ArrayList<>(); + if (useBuildFilters) { + combined.addAll(buildFilters); + } + combined.addAll(filters); + return combined.stream().map(basedir::resolve).toList(); + } + + public boolean isEscapeWindowsPaths() { + return escapeWindowsPaths; + } + + public boolean isSupportMultiLineFiltering() { + return supportMultiLineFiltering; + } + + public boolean isFileNameFiltering() { + return fileNameFiltering; + } + + public List<String> warnings() { + List<String> warnings = new ArrayList<>(); + if (outputDirectory != null) { + warnings.add("maven-resources-plugin <outputDirectory> " + outputDirectory + + " is ignored; struts:watch writes to the project's build output directory"); + } + if (skip) { + warnings.add("maven-resources-plugin <skip> is true; struts:watch pushes resources regardless"); + } + return warnings; + } } diff --git a/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/WatchMojo.java b/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/WatchMojo.java index 9d0b94407..fc73a4828 100644 --- a/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/WatchMojo.java +++ b/tools/struts-maven-plugin/src/main/java/org/apache/struts2/maven/watch/WatchMojo.java @@ -95,20 +95,22 @@ public class WatchMojo extends AbstractMojo { ResourcesPluginSettings settings = ResourcesPluginSettings.from( ResourcesPluginSettings.effectiveResourcesConfiguration(project), project.getProperties().getProperty("project.build.sourceEncoding")); + for (String warning : settings.warnings()) { + getLog().warn(warning); + } + List<Path> filterFiles = settings.filterFiles(project.getBuild().getFilters(), basedir); List<WatchedRoot> roots = project.getResources().stream() .map(resource -> WatchedRoot.of(resource, basedir)) .toList(); ResourceScanner scanner = new ResourceScanner(roots, settings.isAddDefaultExcludes()); FilteringResourcePusher filteringPusher = - new FilteringResourcePusher(resourcesFiltering, project, session, settings, outputDirectory); + new FilteringResourcePusher(resourcesFiltering, project, session, settings, outputDirectory, + filterFiles); ResourcePusher pusher = loggingPusher(filteringPusher, basedir); pushStaleOutputs(scanner.scan(), filteringPusher::outputPathOf, pusher, (message, e) -> getLog().error(message, e)); - List<Path> filterFiles = project.getBuild().getFilters().stream() - .map(filter -> basedir.resolve(filter)) - .toList(); ResourceWatcher watcher = new ResourceWatcher(scanner, pusher, filterFiles, message -> getLog().debug(message), (message, e) -> getLog().error(message, e)); watcher.start(); diff --git a/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/FilteringResourcePusherTest.java b/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/FilteringResourcePusherTest.java index 15ee57494..32d76efb9 100644 --- a/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/FilteringResourcePusherTest.java +++ b/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/FilteringResourcePusherTest.java @@ -25,6 +25,7 @@ import org.apache.maven.project.MavenProject; import org.apache.maven.shared.filtering.DefaultMavenFileFilter; import org.apache.maven.shared.filtering.DefaultMavenResourcesFiltering; import org.codehaus.plexus.util.xml.Xpp3Dom; +import org.codehaus.plexus.util.xml.Xpp3DomBuilder; import org.junit.Before; import org.junit.Rule; import org.junit.Test; @@ -32,6 +33,7 @@ import org.junit.rules.TemporaryFolder; import org.sonatype.plexus.build.incremental.ThreadBuildContext; import java.io.IOException; +import java.io.StringReader; import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; @@ -60,8 +62,9 @@ public class FilteringResourcePusherTest { DefaultMavenResourcesFiltering filtering = new DefaultMavenResourcesFiltering(new DefaultMavenFileFilter(new ThreadBuildContext()), new ThreadBuildContext()); MavenSession session = new MavenSession(null, new DefaultMavenExecutionRequest(), new DefaultMavenExecutionResult(), project); - return new FilteringResourcePusher(filtering, project, session, - ResourcesPluginSettings.from(configuration, "UTF-8"), output); + ResourcesPluginSettings settings = ResourcesPluginSettings.from(configuration, "UTF-8"); + return new FilteringResourcePusher(filtering, project, session, settings, output, + settings.filterFiles(project.getBuild().getFilters(), temp.getRoot().toPath())); } private SourceFile write(String relativePath, byte[] content, boolean filtering, String targetPath) throws IOException { @@ -179,4 +182,44 @@ public class FilteringResourcePusherTest { assertThat(output.resolve("a.properties")).doesNotExist(); } + + @Test + public void pushSubstitutesPropertiesFromPluginLevelFilters() throws IOException { + Files.writeString(temp.getRoot().toPath().resolve("extra.properties"), "extra=from-plugin-filter\n"); + SourceFile file = write("a.properties", "name=${extra}\n", true); + + pusher(configuration("<filters><filter>extra.properties</filter></filters>")).push(file); + + assertThat(output.resolve("a.properties")).hasContent("name=from-plugin-filter"); + } + + @Test + public void pushSubstitutesPropertiesFromBuildFilters() throws IOException { + Files.writeString(temp.getRoot().toPath().resolve("build.properties"), "fromBuild=yes\n"); + project.getBuild().addFilter("build.properties"); + SourceFile file = write("a.properties", "v=${fromBuild}\n", true); + + pusher(null).push(file); + + assertThat(output.resolve("a.properties")).hasContent("v=yes"); + } + + @Test + public void useBuildFiltersFalseIgnoresBuildFilters() throws IOException { + Files.writeString(temp.getRoot().toPath().resolve("build.properties"), "fromBuild=yes\n"); + project.getBuild().addFilter("build.properties"); + SourceFile file = write("a.properties", "v=${fromBuild}\n", true); + + pusher(configuration("<useBuildFilters>false</useBuildFilters>")).push(file); + + assertThat(output.resolve("a.properties")).hasContent("v=${fromBuild}"); + } + + private static Xpp3Dom configuration(String children) { + try { + return Xpp3DomBuilder.build(new StringReader("<configuration>" + children + "</configuration>")); + } catch (Exception e) { + throw new IllegalArgumentException(e); + } + } } diff --git a/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/ResourcesPluginSettingsTest.java b/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/ResourcesPluginSettingsTest.java index a7e05ed66..c97e2b1f8 100644 --- a/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/ResourcesPluginSettingsTest.java +++ b/tools/struts-maven-plugin/src/test/java/org/apache/struts2/maven/watch/ResourcesPluginSettingsTest.java @@ -26,6 +26,7 @@ import org.codehaus.plexus.util.xml.Xpp3DomBuilder; import org.junit.Test; import java.io.StringReader; +import java.nio.file.Path; import java.util.List; import static org.assertj.core.api.Assertions.assertThat; @@ -42,6 +43,53 @@ public class ResourcesPluginSettingsTest { assertThat(settings.isAddDefaultExcludes()).isTrue(); assertThat(settings.getNonFilteredFileExtensions()).isEmpty(); assertThat(settings.getEscapeString()).isNull(); + assertThat(settings.isEscapeWindowsPaths()).isTrue(); + assertThat(settings.isSupportMultiLineFiltering()).isFalse(); + assertThat(settings.isFileNameFiltering()).isFalse(); + assertThat(settings.filterFiles(List.of("build.properties"), Path.of("/base"))) + .containsExactly(Path.of("/base/build.properties")); + assertThat(settings.warnings()).isEmpty(); + } + + @Test + public void readsFilterFileAndEscapingSettings() throws Exception { + Xpp3Dom configuration = Xpp3DomBuilder.build(new StringReader( + "<configuration><filters><filter>plugin.properties</filter></filters>" + + "<escapeWindowsPaths>false</escapeWindowsPaths>" + + "<supportMultiLineFiltering>true</supportMultiLineFiltering>" + + "<fileNameFiltering>true</fileNameFiltering></configuration>")); + + ResourcesPluginSettings settings = ResourcesPluginSettings.from(configuration, "UTF-8"); + + assertThat(settings.isEscapeWindowsPaths()).isFalse(); + assertThat(settings.isSupportMultiLineFiltering()).isTrue(); + assertThat(settings.isFileNameFiltering()).isTrue(); + assertThat(settings.filterFiles(List.of("build.properties"), Path.of("/base"))) + .containsExactly(Path.of("/base/build.properties"), Path.of("/base/plugin.properties")); + } + + @Test + public void useBuildFiltersFalseKeepsOnlyPluginFilters() throws Exception { + Xpp3Dom configuration = Xpp3DomBuilder.build(new StringReader( + "<configuration><useBuildFilters>false</useBuildFilters>" + + "<filters><filter>plugin.properties</filter></filters></configuration>")); + + ResourcesPluginSettings settings = ResourcesPluginSettings.from(configuration, "UTF-8"); + + assertThat(settings.filterFiles(List.of("build.properties"), Path.of("/base"))) + .containsExactly(Path.of("/base/plugin.properties")); + } + + @Test + public void warnsAboutOutputDirectoryAndSkip() throws Exception { + Xpp3Dom configuration = Xpp3DomBuilder.build(new StringReader( + "<configuration><outputDirectory>/elsewhere</outputDirectory><skip>true</skip></configuration>")); + + ResourcesPluginSettings settings = ResourcesPluginSettings.from(configuration, "UTF-8"); + + assertThat(settings.warnings()).hasSize(2); + assertThat(settings.warnings().get(0)).contains("<outputDirectory>", "/elsewhere"); + assertThat(settings.warnings().get(1)).contains("<skip>"); } @Test
