Improving unit test coverage

Author: bobbylight

.github/workflows/gradle.yml

@@ -37,4 +37,13 @@ jobs:
       # Note: Assumes we're running on Ubuntu
       # https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md
       - name: Build with Gradle
-        run: xvfb-run ./gradlew build -xsign -xpublish --warning-mode all
+        run: xvfb-run ./gradlew build jacocoTestReport -xsign -xpublish --warning-mode all
+
+      - name: Submit coverage data to codecov
+        uses: codecov/codecov-action@v5
+        if: matrix.java == '17'
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          disable_search: true
+          files: ./RSTAUI/build/reports/jacoco/test/jacocoTestReport.xml
+          name: codecov

README.md

@@ -1,6 +1,8 @@
 # RSTAUI
 ![Java Build](https://github.com/bobbylight/RSTAUI/actions/workflows/gradle.yml/badge.svg)
 ![Java Build](https://github.com/bobbylight/RSTAUI/actions/workflows/codeql-analysis.yml/badge.svg)
+![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fifesoft/rstaui/badge.svg)
+[![codecov](https://codecov.io/gh/bobbylight/RSTAUI/branch/master/graph/badge.svg?token=Hktq3vfINy)](https://codecov.io/gh/bobbylight/RSTAUI)
 
 This is a library for adding the following dialogs to an application using `RSyntaxTextArea` as an
 editor:

RSTAUI/build.gradle

@@ -2,7 +2,7 @@ plugins {
     id 'java-library'
 }
 
-['base', 'distribution', 'maven-publish', 'signing'].each { apply plugin: it }
+['base', 'jacoco', 'distribution', 'maven-publish', 'signing'].each { apply plugin: it }
 
 base {
     archivesName = 'rstaui'
@@ -14,10 +14,18 @@ dependencies {
     testImplementation platform('org.junit:junit-bom:5.12.1')
     testImplementation 'org.junit.jupiter:junit-jupiter'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    testImplementation 'org.mockito:mockito-core:5.15.2'
 }
 
 ext.isReleaseVersion = !project.version.endsWith('SNAPSHOT')
 
+jacocoTestReport {
+    reports {
+        xml.required = true // codecov depends on xml format report
+        html.required = true
+    }
+}
+
 java {
     withSourcesJar()
     withJavadocJar()

RSTAUI/src/main/java/org/fife/rsta/ui/CollapsibleSectionPanel.java

@@ -168,7 +168,9 @@ private void focusMainComponent() {
 		if (center instanceof JScrollPane) {
 			center = ((JScrollPane)center).getViewport().getView();
 		}
-		center.requestFocusInWindow();
+		if (center != null) {
+			center.requestFocusInWindow();
+		}
 	}
 
 
@@ -188,6 +190,16 @@ public JComponent getDisplayedBottomComponent() {
 	}
 
 
+	/**
+	 * Returns the number of ticks for the animation.
+	 *
+	 * @return The total number of ticks.
+	 */
+	protected int getTotalTicks() {
+		return totalTicks;
+	}
+
+
 	/**
 	 * Hides the currently displayed "bottom" component with a slide-out
 	 * animation.
@@ -238,6 +250,16 @@ private void installKeystrokes() {
 	}
 
 
+	/**
+	 * Toggles whether this component animates when showing or hiding.
+	 *
+	 * @param animate Whether the display is animated.
+	 */
+	public void setAnimate(boolean animate) {
+		this.animate = animate;
+	}
+
+
 	/**
 	 * Sets the amount of time, in milliseconds, it should take for a
 	 * "collapsible panel" to show or hide.  The default is <code>120</code>.

RSTAUI/src/main/java/org/fife/rsta/ui/GoToDialog.java

@@ -172,6 +172,22 @@ private boolean attemptToGetGoToLine() {
 	}
 
 
+	/**
+	 * Programmatically clicks the Cancel button.  Used for testing purposes.
+	 */
+	void clickCancelButton() {
+		cancelButton.doClick(0);
+	}
+
+
+	/**
+	 * Programmatically clicks the OK button. Used for testing purposes.
+	 */
+	protected void clickOkButton() {
+		okButton.doClick(0);
+	}
+
+
 	/**
 	 * Returns a panel containing the OK and Cancel buttons.  This panel is
 	 * added to the bottom of this dialog.  Applications that don't like these
@@ -238,6 +254,7 @@ public String getErrorDialogTitle() {
 	 * @return The line number the user decided to go to, or <code>-1</code>
 	 *         if the dialog was canceled.  If valid, this will be 1-based,
 	 *         not 0-based.
+	 * @see #setLineNumber(int)
 	 */
 	public int getLineNumber() {
 		return lineNumber;
@@ -267,6 +284,18 @@ public void setErrorDialogTitle(String title) {
 	}
 
 
+	/**
+	 * Sets the line number displayed in this dialog.
+	 *
+	 * @param lineNumber The new line number.
+	 * @see #getLineNumber()
+	 */
+	protected void setLineNumber(int lineNumber) {
+		this.lineNumber = lineNumber;
+		lineNumberField.setText(String.valueOf(lineNumber));
+	}
+
+
 	/**
 	 * Sets the maximum line number for them to enter.
 	 *

RSTAUI/src/main/java/org/fife/rsta/ui/TextFilePropertiesDialog.java

@@ -18,7 +18,6 @@
 import java.awt.event.ActionListener;
 import java.io.File;
 import java.nio.charset.Charset;
-import java.nio.charset.StandardCharsets;
 import java.text.BreakIterator;
 import java.text.CharacterIterator;
 import java.text.MessageFormat;
@@ -75,7 +74,7 @@ public class TextFilePropertiesDialog extends EscapableDialog
 	};
 
 	private static final String[] LINE_TERMINATORS = {
-		System.getProperty("line.separator"), "\r", "\n", "\r\n"
+		System.lineSeparator(), "\r", "\n", "\r\n"
 	};
 
 	/**
@@ -258,7 +257,6 @@ private String getSelectedLineTerminator() {
 		return LINE_TERMINATORS[terminatorCombo.getSelectedIndex()];
 	}
 
-
 	private void init(TextEditorPane textArea) {
 
 		this.textArea = textArea;
@@ -385,13 +383,22 @@ private void init(TextEditorPane textArea) {
 	}
 
 
+	/**
+	 * Returns whether this modal is dirty and will persist changes.
+	 *
+	 * @return Whether the modal is dirty.
+	 */
+	boolean isCloseable() {
+		return okButton != null && okButton.isEnabled();
+	}
+
+
 	/**
 	 * Sets the encoding selected by this dialog.
 	 *
-	 * @param encoding The desired encoding.  If this value is invalid or not
-	 *        supported by this OS, <code>US-ASCII</code> is used.
+	 * @param encoding The desired encoding.
 	 */
-	private void setEncoding(String encoding) {
+	protected void setEncoding(String encoding) {
 
 		Charset cs1 = Charset.forName(encoding);
 
@@ -404,22 +411,10 @@ private void setEncoding(String encoding) {
 				return;
 			}
 		}
-
-		// Encoding not found: select default.
-		cs1 = StandardCharsets.US_ASCII;
-		for (int i=0; i<count; i++) {
-			String item = encodingCombo.getItemAt(i);
-			Charset cs2 = Charset.forName(item);
-			if (cs1.equals(cs2)) {
-				encodingCombo.setSelectedIndex(i);
-				return;
-			}
-		}
-
 	}
 
 
-	private void setSelectedLineTerminator(String terminator) {
+	protected void setSelectedLineTerminator(String terminator) {
 		for (int i=0; i<LINE_TERMINATORS.length; i++) {
 			if (LINE_TERMINATORS[i].equals(terminator)) {
 				terminatorCombo.setSelectedIndex(i);

RSTAUI/src/main/java/org/fife/rsta/ui/UIUtil.java

@@ -7,14 +7,12 @@
  */
 package org.fife.rsta.ui;
 
-import java.awt.Color;
-import java.awt.Component;
-import java.awt.ComponentOrientation;
-import java.awt.Container;
-import java.lang.reflect.Method;
+import java.awt.*;
+import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.*;
+import java.util.List;
 import javax.swing.BorderFactory;
 import javax.swing.JButton;
 import javax.swing.JComboBox;
@@ -35,10 +33,6 @@
  */
 public final class UIUtil {
 
-	private static boolean desktopCreationAttempted;
-	private static Object desktop;
-	private static final Object LOCK_DESKTOP_CREATION = new Object();
-
 	/**
 	 * A very common border that can be shared across many components.
 	 */
@@ -59,7 +53,7 @@ private UIUtil() {
 	 * @param uri The URI to open.  If this is <code>null</code>, nothing
 	 *        happens and this method returns <code>false</code>.
 	 * @return Whether the operation was successful.  This will be
-	 *         <code>false</code> on JRE's older than 1.6.
+	 *         <code>false</code> on systems without desktop support.
 	 * @see #browse(URI)
 	 */
 	public static boolean browse(String uri) {
@@ -80,24 +74,20 @@ public static boolean browse(String uri) {
 	 * @param uri The URI to open.  If this is <code>null</code>, nothing
 	 *        happens and this method returns <code>false</code>.
 	 * @return Whether the operation was successful.  This will be
-	 *         <code>false</code> on JRE's older than 1.6.
+	 *         <code>false</code> on systems without desktop support.
 	 * @see #browse(String)
 	 */
 	public static boolean browse(URI uri) {
 
 		boolean success = false;
 
-		if (uri!=null) {
-			Object desktop = getDesktop();
-			if (desktop!=null) {
+		if (uri!=null && Desktop.isDesktopSupported()) {
+			Desktop desktop = Desktop.getDesktop();
+			if (desktop.isSupported(Desktop.Action.BROWSE)) {
 				try {
-					Method m = desktop.getClass().getDeclaredMethod(
-								"browse", URI.class);
-					m.invoke(desktop, uri);
+					desktop.browse(uri);
 					success = true;
-				} catch (RuntimeException re) {
-					throw re; // Keep FindBugs happy
-				} catch (Exception e) {
+				} catch (IOException ioe) {
 					// Ignore, just return "false" below.
 				}
 			}
@@ -170,47 +160,6 @@ public static <T> List<T> getDescendantsOfType(Container comp, Class<T> clazz) {
 	}
 
 
-	/**
-	 * Returns the singleton <code>java.awt.Desktop</code> instance, or
-	 * <code>null</code> if it is unsupported on this platform (or the JRE
-	 * is older than 1.6).
-	 *
-	 * @return The desktop, as an {@link Object}.
-	 */
-	private static Object getDesktop() {
-
-		synchronized (LOCK_DESKTOP_CREATION) {
-
-			if (!desktopCreationAttempted) {
-
-				desktopCreationAttempted = true;
-
-				try {
-					Class<?> desktopClazz = Class.forName("java.awt.Desktop");
-					Method m = desktopClazz.
-						getDeclaredMethod("isDesktopSupported");
-
-					boolean supported = (Boolean) m.invoke(null);
-					if (supported) {
-						m = desktopClazz.getDeclaredMethod("getDesktop");
-						desktop = m.invoke(null);
-					}
-
-				} catch (RuntimeException re) {
-					throw re; // Keep FindBugs happy
-				} catch (Exception e) {
-					// Ignore; keeps desktop as null.
-				}
-
-			}
-
-		}
-
-		return desktop;
-
-	}
-
-
 	/**
 	 * Returns an empty border of width 5 on all sides.  Since this is a
 	 * very common border in GUI's, the border returned is a singleton.
@@ -248,13 +197,11 @@ public static Color getErrorTextForeground() {
 	 */
 	public static int getMnemonic(ResourceBundle msg, String key) {
 		int mnemonic = 0;
-		try {
+		if (msg.containsKey(key)) {
 			Object value = msg.getObject(key);
 			if (value instanceof String) {
 				mnemonic = ((String)value).charAt(0);
 			}
-		} catch (MissingResourceException mre) {
-			// Swallow.  TODO: When we drop 1.4/1.5 support, use containsKey().
 		}
 		return mnemonic;
 	}
@@ -302,7 +249,7 @@ public static void makeSpringCompactGrid(Container parent, int rows,
 							"must use SpringLayout.", cce);
 		}
 
-		//Align all cells in each column and make them the same width.
+		// Align all cells in each column and make them the same width.
 		Spring x = Spring.constant(initialX);
 		for (int c = 0; c < cols; c++) {
 			Spring width = Spring.constant(0);
@@ -320,7 +267,7 @@ public static void makeSpringCompactGrid(Container parent, int rows,
 			x = Spring.sum(x, Spring.sum(width, Spring.constant(xPad)));
 		}
 
-		//Align all cells in each row and make them the same height.
+		// Align all cells in each row and make them the same height.
 		Spring y = Spring.constant(initialY);
 		for (int r = 0; r < rows; r++) {
 			Spring height = Spring.constant(0);
@@ -337,7 +284,7 @@ public static void makeSpringCompactGrid(Container parent, int rows,
 			y = Spring.sum(y, Spring.sum(height, Spring.constant(yPad)));
 		}
 
-		//Set the parent's size.
+		// Set the parent's size.
 		SpringLayout.Constraints pCons = layout.getConstraints(parent);
 		pCons.setConstraint(SpringLayout.SOUTH, y);
 		pCons.setConstraint(SpringLayout.EAST, x);