Skip to content

Avoid empty body warnings imposed by default activation of expandEmptyElements #2520

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions lib/src/main/java/com/diffplug/spotless/pom/SortPomCfg.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2021-2024 DiffPlug
* Copyright 2021-2025 DiffPlug
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -27,7 +27,7 @@ public class SortPomCfg implements Serializable {

public String lineSeparator = System.getProperty("line.separator");

public boolean expandEmptyElements = true;
Copy link
Member

Choose a reason for hiding this comment

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

I'm not a maven user - does this affect end-user behavior enough that we should note it in the CHANGELOG.md?

Copy link
Contributor Author

@Pankraz76 Pankraz76 Jun 25, 2025

Choose a reason for hiding this comment

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

Might not be important enough to warrant urgent attention.

On the other hand, many of these cases may now be obsolete, since the Convention over Configuration principle is now fixed and no longer needs to be overridden, from outside.

Ideally, a new build should even fail, given attention that the config has now changed, as the relevant client code is now redundant/wrong:

<expandEmptyElements>false</expandEmptyElements>

https://github.com/apache/maven-parent/blob/f4ab7c2eb04865071186c57a263243c72b6e8d52/pom.xml#L1236

If you want me to add some notes, let me know.

public boolean expandEmptyElements;

public boolean spaceBeforeCloseEmptyElement = false;

Expand Down
177 changes: 177 additions & 0 deletions lib/src/test/java/com/diffplug/spotless/pom/SortPomCfgTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
/*
* Copyright 2025 DiffPlug
*
* Licensed 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.
*/
package com.diffplug.spotless.pom;

import static org.assertj.core.api.Assertions.assertThat;

import org.junit.jupiter.api.Test;

class SortPomCfgTest {

@Test
void testDefaultValues() {
SortPomCfg cfg = new SortPomCfg();

// Test default values using AssertJ
assertThat(cfg.version).isEqualTo("4.0.0");
assertThat(cfg.encoding).isEqualTo("UTF-8");
assertThat(cfg.lineSeparator).isEqualTo(System.getProperty("line.separator"));
assertThat(cfg.expandEmptyElements).isFalse();
assertThat(cfg.spaceBeforeCloseEmptyElement).isFalse();
assertThat(cfg.keepBlankLines).isTrue();
assertThat(cfg.endWithNewline).isTrue();
assertThat(cfg.nrOfIndentSpace).isEqualTo(2);
assertThat(cfg.indentBlankLines).isFalse();
assertThat(cfg.indentSchemaLocation).isFalse();
assertThat(cfg.indentAttribute).isNull();
assertThat(cfg.predefinedSortOrder).isEqualTo("recommended_2008_06");
assertThat(cfg.quiet).isFalse();
assertThat(cfg.sortOrderFile).isNull();
assertThat(cfg.sortDependencies).isNull();
assertThat(cfg.sortDependencyManagement).isNull();
assertThat(cfg.sortDependencyExclusions).isNull();
assertThat(cfg.sortPlugins).isNull();
assertThat(cfg.sortProperties).isFalse();
assertThat(cfg.sortModules).isFalse();
assertThat(cfg.sortExecutions).isFalse();
}

@Test
void testFieldSetters() {
SortPomCfg cfg = new SortPomCfg();

// Set all fields
cfg.version = "4.1.0";
cfg.encoding = "ISO-8859-1";
cfg.lineSeparator = "\n";
cfg.expandEmptyElements = true;
cfg.spaceBeforeCloseEmptyElement = true;
cfg.keepBlankLines = false;
cfg.endWithNewline = false;
cfg.nrOfIndentSpace = 4;
cfg.indentBlankLines = true;
cfg.indentSchemaLocation = true;
cfg.indentAttribute = "attribute";
cfg.predefinedSortOrder = "custom";
cfg.quiet = true;
cfg.sortOrderFile = "sortOrder.xml";
cfg.sortDependencies = "groupId,artifactId";
cfg.sortDependencyManagement = "scope,groupId";
cfg.sortDependencyExclusions = "artifactId";
cfg.sortPlugins = "groupId";
cfg.sortProperties = true;
cfg.sortModules = true;
cfg.sortExecutions = true;

// Verify all set values with AssertJ
assertThat(cfg.version).isEqualTo("4.1.0");
assertThat(cfg.encoding).isEqualTo("ISO-8859-1");
assertThat(cfg.lineSeparator).isEqualTo("\n");
assertThat(cfg.expandEmptyElements).isTrue();
assertThat(cfg.spaceBeforeCloseEmptyElement).isTrue();
assertThat(cfg.keepBlankLines).isFalse();
assertThat(cfg.endWithNewline).isFalse();
assertThat(cfg.nrOfIndentSpace).isEqualTo(4);
assertThat(cfg.indentBlankLines).isTrue();
assertThat(cfg.indentSchemaLocation).isTrue();
assertThat(cfg.indentAttribute).isEqualTo("attribute");
assertThat(cfg.predefinedSortOrder).isEqualTo("custom");
assertThat(cfg.quiet).isTrue();
assertThat(cfg.sortOrderFile).isEqualTo("sortOrder.xml");
assertThat(cfg.sortDependencies).isEqualTo("groupId,artifactId");
assertThat(cfg.sortDependencyManagement).isEqualTo("scope,groupId");
assertThat(cfg.sortDependencyExclusions).isEqualTo("artifactId");
assertThat(cfg.sortPlugins).isEqualTo("groupId");
assertThat(cfg.sortProperties).isTrue();
assertThat(cfg.sortModules).isTrue();
assertThat(cfg.sortExecutions).isTrue();
}

@Test
void testNullHandling() {
SortPomCfg cfg = new SortPomCfg();

// Set nullable fields to null
cfg.version = null;
cfg.encoding = null;
cfg.lineSeparator = null;
cfg.indentAttribute = null;
cfg.predefinedSortOrder = null;
cfg.sortOrderFile = null;
cfg.sortDependencies = null;
cfg.sortDependencyManagement = null;
cfg.sortDependencyExclusions = null;
cfg.sortPlugins = null;

// Verify null values with AssertJ
assertThat(cfg.version).isNull();
assertThat(cfg.encoding).isNull();
assertThat(cfg.lineSeparator).isNull();
assertThat(cfg.indentAttribute).isNull();
assertThat(cfg.predefinedSortOrder).isNull();
assertThat(cfg.sortOrderFile).isNull();
assertThat(cfg.sortDependencies).isNull();
assertThat(cfg.sortDependencyManagement).isNull();
assertThat(cfg.sortDependencyExclusions).isNull();
assertThat(cfg.sortPlugins).isNull();
}

@Test
void testBooleanFieldsEdgeCases() {
SortPomCfg cfg = new SortPomCfg();

// Toggle all boolean fields
cfg.expandEmptyElements = !cfg.expandEmptyElements;
cfg.spaceBeforeCloseEmptyElement = !cfg.spaceBeforeCloseEmptyElement;
cfg.keepBlankLines = !cfg.keepBlankLines;
cfg.endWithNewline = !cfg.endWithNewline;
cfg.indentBlankLines = !cfg.indentBlankLines;
cfg.indentSchemaLocation = !cfg.indentSchemaLocation;
cfg.quiet = !cfg.quiet;
cfg.sortProperties = !cfg.sortProperties;
cfg.sortModules = !cfg.sortModules;
cfg.sortExecutions = !cfg.sortExecutions;

// Verify all boolean fields are toggled
assertThat(cfg.expandEmptyElements).isTrue();
assertThat(cfg.spaceBeforeCloseEmptyElement).isTrue();
assertThat(cfg.keepBlankLines).isFalse();
assertThat(cfg.endWithNewline).isFalse();
assertThat(cfg.indentBlankLines).isTrue();
assertThat(cfg.indentSchemaLocation).isTrue();
assertThat(cfg.quiet).isTrue();
assertThat(cfg.sortProperties).isTrue();
assertThat(cfg.sortModules).isTrue();
assertThat(cfg.sortExecutions).isTrue();
}

@Test
void testNumericFieldEdgeCases() {
SortPomCfg cfg = new SortPomCfg();

// Test minimum value
cfg.nrOfIndentSpace = 0;
assertThat(cfg.nrOfIndentSpace).isZero();

// Test negative value
cfg.nrOfIndentSpace = -1;
assertThat(cfg.nrOfIndentSpace).isNegative();

// Test large value
cfg.nrOfIndentSpace = Integer.MAX_VALUE;
assertThat(cfg.nrOfIndentSpace).isEqualTo(Integer.MAX_VALUE);
}
}
Loading