Add colors to terminal output

Author: lfir

README.md

@@ -7,23 +7,23 @@ It also sets some configuration options useful for development work and system a
 
 Current actions that can be applied (each needs to be confirmed first):
 
-1. Install RPMFusion repositories. 
+1. **Install RPMFusion repositories.** 
 Adds free and nonfree RPMFusion repos and imports their GPG keys.
 
-2. Install additional packages with DNF.
+2. **Install additional packages with DNF.**
 Installs extra packages listed in [dnf-install.cf](https://github.com/lfir/fedora-setup-script/blob/main/src/main/resources/dnf-install.cf), with the
 option to skip selected packages interactively.
 
-3. Remove unnecessary packages.
+3. **Remove unnecessary packages.**
 Removes unwanted packages from [dnf-remove.cf](https://github.com/lfir/fedora-setup-script/blob/main/src/main/resources/dnf-remove.cf) and performs autoremove.
 
-4. Install Flatpak applications.
+4. **Install Flatpak applications.**
 Adds the Flathub remote and installs Flatpaks from [flatpak-install.cf](https://github.com/lfir/fedora-setup-script/blob/main/src/main/resources/flatpak-install.cf).
 
-5. Ensure groups exist and add user.
+5. **Ensure groups exist and add user.**
 Creates and assigns admin-related groups such as _docker_, _libvirt_, and _vboxusers_.
 
-6. Enable and start Cockpit.
+6. **Enable and start Cockpit.**
 Enables and starts the systemd service of the Cockpit web-based management interface.
 
 ### Run commands

src/main/java/cf/maybelambda/fedora/PostInstallUpdater.java

@@ -1,6 +1,7 @@
 package cf.maybelambda.fedora;
 
 import java.io.BufferedReader;
+import java.io.Console;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
@@ -33,8 +34,11 @@ public class PostInstallUpdater {
     private static final String FLATPAK_INSTALL_FILE = "flatpak-install.cf";
     private static final String HELP_FILE = "help.txt";
 
-    private static final String RESET  = "\u001B[0m";
-    private static final String YELLOW = "\u001B[33m";
+    static final String RESET  = "\u001B[0m";
+    static final String YELLOW = "\u001B[33m";
+    static final String GREEN  = "\u001B[32m";
+    private static final String RED    = "\u001B[31m";
+    private static final String BLUE   = "\u001B[34m";
 
     private static boolean dryRun = false;
 
@@ -49,10 +53,10 @@ public static void main(String[] args) {
         List<String> flatpakInstallPackages = ConfigManager.loadPackageNamesFrom(FLATPAK_INSTALL_FILE);
         Scanner scanner = new Scanner(System.in);
 
-        System.out.println("Fedora Post Install Actions\n");
+        System.out.println(color("Fedora Post Install Actions\n", GREEN));
         setDryRun(Arrays.asList(args).contains("--dry-run"));
         if (isDryRun()) {
-            System.out.println("---[Dry Run Mode] Shell Commands will not be executed.---\n");
+            System.out.println(color("---[Dry Run Mode] Shell Commands will not be executed.---\n", RED));
         }
 
         if (confirm(scanner, "Install RPMFusion repos?")) {
@@ -130,7 +134,7 @@ public static void main(String[] args) {
             runCommand(new String[]{"sudo", "systemctl", "enable", "--now", "cockpit.socket"});
         }
 
-        System.out.println("\nAll actions completed. Goodbye.");
+        System.out.println(color("\nAll actions completed. Goodbye.", GREEN));
     }
 
     static boolean isDryRun() {
@@ -152,9 +156,9 @@ static ProcessBuilder createProcessBuilder(String[] cmd) {
     }
 
     static int runCommand(String[] command) {
-        System.out.println("Executing shell command: " + String.join(" ", command));
+        System.out.println("Executing shell command: " + color(String.join(" ", command), BLUE));
         if (isDryRun()) {
-            System.out.println("Dry-run: command not executed.");
+            System.out.println(color("Dry-run: command not executed.", YELLOW));
             return 0;
         }
 
@@ -167,7 +171,7 @@ static int runCommand(String[] command) {
             System.out.println("Command output:");
             String line;
             while ((line = reader.readLine()) != null) {
-                System.out.println(YELLOW + line + RESET);
+                System.out.println(color(line, YELLOW));
             }
             exitCode = process.waitFor();
             System.out.println("Command exited with code: " + exitCode);
@@ -214,4 +218,12 @@ static void printHelp() {
             System.err.println("Error reading help file: " + e.getMessage());
         }
     }
+
+    static String color(String str, String ansiColorCode) {
+        return isANSISupported(System.getenv("TERM"), System.console()) ? ansiColorCode + str + RESET : str;
+    }
+
+    static boolean isANSISupported(String term, Console console) {
+        return console != null && term != null && !"dumb".equals(term);
+    }
 }

src/test/java/cf/maybelambda/fedora/ConfigManagerTests.java

@@ -54,7 +54,7 @@ void readResourceLinesThrowsIOExceptionWhenResourceMissing() {
     }
 
     @Test
-    void loadPackageNamesFromValidFileParsesPackageNamesAndOmitsComments() throws IOException {
+    void loadPackageNamesFromValidFileParsesPackageNamesAndOmitsComments() {
         try (MockedStatic<ConfigManager> updaterMock = Mockito.mockStatic(ConfigManager.class, CALLS_REAL_METHODS)) {
             updaterMock.when(() -> ConfigManager.readResourceLines(any(String.class)))
                     .thenReturn(List.of("# Comment", "nano", "vim", "", "htop"));

src/test/java/cf/maybelambda/fedora/PostInstallUpdaterTests.java

@@ -5,11 +5,16 @@
 import org.mockito.Mockito;
 
 import java.io.ByteArrayInputStream;
+import java.io.Console;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.Scanner;
 
+import static cf.maybelambda.fedora.PostInstallUpdater.GREEN;
+import static cf.maybelambda.fedora.PostInstallUpdater.RESET;
+import static cf.maybelambda.fedora.PostInstallUpdater.YELLOW;
+import static cf.maybelambda.fedora.PostInstallUpdater.isANSISupported;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -141,4 +146,46 @@ void helpOptionDisplaysHelpTextAndExits() {
             filesMock.verify(() -> ConfigManager.readResourceLines(any(String.class)), Mockito.times(2));
         }
     }
+
+    @Test
+    void colorAppliesAnsiWhenisANSISupportedTrue() {
+        try (MockedStatic<PostInstallUpdater> mocked = mockStatic(PostInstallUpdater.class, CALLS_REAL_METHODS)) {
+            mocked.when(() -> isANSISupported(any(), any())).thenReturn(true);
+
+            String result = PostInstallUpdater.color("Hello", YELLOW);
+
+            assertEquals(YELLOW + "Hello" + RESET, result);
+        }
+    }
+
+    @Test
+    void colorReturnsPlainTextWhenisANSISupportedFalse() {
+        try (MockedStatic<PostInstallUpdater> mocked = mockStatic(PostInstallUpdater.class, CALLS_REAL_METHODS)) {
+            mocked.when(() -> isANSISupported(any(), any())).thenReturn(false);
+
+            String result = PostInstallUpdater.color("World", GREEN);
+
+            assertEquals("World", result);
+        }
+    }
+
+    @Test
+    void isANSISupportedReturnsTrueWhenConsolePresentAndTermValid() {
+        assertTrue(isANSISupported("xterm-256color", mock(Console.class)));
+    }
+
+    @Test
+    void isANSISupportedReturnsFalseWhenConsoleNull() {
+        assertFalse(isANSISupported("xterm-256color", null));
+    }
+
+    @Test
+    void isANSISupportedReturnsFalseWhenTermNull() {
+        assertFalse(isANSISupported(null, mock(Console.class)));
+    }
+
+    @Test
+    void isANSISupportedReturnsFalseWhenTermIsDumb() {
+        assertFalse(isANSISupported("dumb", mock(Console.class)));
+    }
 }