Skip to content

[#1389] Warn only once per invalid picocli.usage.width value #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.

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

Open
SAY-5 wants to merge 1 commit into
base: main
Choose a base branch
from
+50 −2
Open

[#1389] Warn only once per invalid picocli.usage.width value #2520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 13 additions & 2 deletions src/main/java/picocli/CommandLine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7745,6 +7745,11 @@ public static class UsageMessageSpec {
public final static int DEFAULT_USAGE_WIDTH = 80;
private final static int MINIMUM_USAGE_WIDTH = 55;
final static int DEFAULT_USAGE_LONG_OPTIONS_WIDTH = 20;
// remembers the last invalid picocli.usage.width value warned about, so the warning is logged only once per value
private static String lastWarnedInvalidWidthValue;

// resets the cached invalid picocli.usage.width value; intended for testing
static void resetUsageWidthWarningCache() { lastWarnedInvalidWidthValue = null; }
private final static int DEFAULT_SYNOPSIS_INDENT = -1; // by default, fall back to aligning to the synopsis heading
private final static double DEFAULT_SYNOPSIS_AUTO_INDENT_THRESHOLD = 0.5;
private final static double MAX_SYNOPSIS_AUTO_INDENT_THRESHOLD = 0.9;
Expand Down Expand Up @@ -7893,12 +7898,18 @@ private int getSysPropertyWidthOrDefault(int defaultWidth, boolean detectTermina
try {
int width = Integer.parseInt(userValue);
if (width < MINIMUM_USAGE_WIDTH) {
CommandLine.tracer().warn("Invalid picocli.usage.width value %d. Using minimum usage width %d.", width, MINIMUM_USAGE_WIDTH);
if (!userValue.equals(lastWarnedInvalidWidthValue)) {
lastWarnedInvalidWidthValue = userValue;
CommandLine.tracer().warn("Invalid picocli.usage.width value %d. Using minimum usage width %d.", width, MINIMUM_USAGE_WIDTH);
}
return MINIMUM_USAGE_WIDTH;
}
return width;
} catch (NumberFormatException ex) {
CommandLine.tracer().warn("Invalid picocli.usage.width value '%s'. Using usage width %d.", userValue, defaultWidth);
if (!userValue.equals(lastWarnedInvalidWidthValue)) {
lastWarnedInvalidWidthValue = userValue;
CommandLine.tracer().warn("Invalid picocli.usage.width value '%s'. Using usage width %d.", userValue, defaultWidth);
}
return defaultWidth;
}
}
Expand Down
37 changes: 37 additions & 0 deletions src/test/java/picocli/HelpTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3546,6 +3546,43 @@ public void testTooSmallUsageWidthPropertyValue() throws UnsupportedEncodingExce
assertEquals(format("[picocli WARN] Invalid picocli.usage.width value 54. Using minimum usage width 55.%n"), baos.toString("UTF-8"));
}

@Test
public void testInvalidUsageWidthPropertyValueWarnsOnlyOnce() throws UnsupportedEncodingException {
PrintStream originalErr = System.err;
ByteArrayOutputStream baos = new ByteArrayOutputStream(2500);
System.setErr(new PrintStream(baos));

System.clearProperty("picocli.trace");
UsageMessageSpec.resetUsageWidthWarningCache();
System.setProperty("picocli.usage.width", "bogus");
new UsageMessageSpec().width();
new UsageMessageSpec().width();
new UsageMessageSpec().width();
System.setErr(originalErr);
System.clearProperty("picocli.usage.width");

assertEquals(format("[picocli WARN] Invalid picocli.usage.width value 'bogus'. Using usage width 80.%n"), baos.toString("UTF-8"));
}

@Test
public void testInvalidUsageWidthPropertyValueWarnsAgainForDifferentValue() throws UnsupportedEncodingException {
PrintStream originalErr = System.err;
ByteArrayOutputStream baos = new ByteArrayOutputStream(2500);
System.setErr(new PrintStream(baos));

System.clearProperty("picocli.trace");
UsageMessageSpec.resetUsageWidthWarningCache();
System.setProperty("picocli.usage.width", "first");
new UsageMessageSpec().width();
System.setProperty("picocli.usage.width", "second");
new UsageMessageSpec().width();
System.setErr(originalErr);
System.clearProperty("picocli.usage.width");

assertEquals(format("[picocli WARN] Invalid picocli.usage.width value 'first'. Using usage width 80.%n" +
"[picocli WARN] Invalid picocli.usage.width value 'second'. Using usage width 80.%n"), baos.toString("UTF-8"));
}

@SuppressWarnings("deprecation")
@Test
public void testTextTableWithLargeWidth() {
Expand Down