Refactored Nag Dialogs, Split UnableToAffordExpensesNagDialog into Two Dialogs, Added Unit Tests

MekHQ/src/mekhq/gui/dialog/nagDialogs/EndContractNagDialog.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 - 2024 The MegaMek Team. All Rights Reserved.
+ * Copyright (c) 2021-2024 The MegaMek Team. All Rights Reserved.
  *
  * This file is part of MekHQ.
  *
@@ -21,24 +21,59 @@
 import mekhq.MHQConstants;
 import mekhq.MekHQ;
 import mekhq.campaign.Campaign;
+import mekhq.campaign.mission.Contract;
 import mekhq.gui.baseComponents.AbstractMHQNagDialog;
 
 import javax.swing.*;
-import java.time.temporal.ChronoUnit;
+import java.time.LocalDate;
 
+/**
+ * This class represents a nag dialog displayed on the day a contract ends
+ * It extends the AbstractMHQNagDialog class.
+ */
 public class EndContractNagDialog extends AbstractMHQNagDialog {
-    private static boolean isContractEnded (Campaign campaign) {
-        // we can use 'is date y after x', as once the end date has been passed,
+    static String DIALOG_NAME = "EndContractNagDialog";
+    static String DIALOG_TITLE = "EndContractNagDialog.title";
+    static String DIALOG_BODY = "EndContractNagDialog.text";
+
+    /**
+     * Checks if a contract within a campaign has ended on the current date.
+     *
+     * @param campaign the campaign containing the contracts to be checked
+     * @return {@code true} if a contract within the campaign has ended on the current date,
+     *         {@code false} otherwise
+     */
+    static boolean isContractEnded(Campaign campaign) {
+        LocalDate today = campaign.getLocalDate();
+
+        // we can't use 'is date y after x', as once the end date has been passed,
         // the contract is removed from the list of active contracts
-        return campaign.getActiveContracts().stream()
-                .anyMatch(contract -> ChronoUnit.DAYS.between(campaign.getLocalDate(), contract.getEndingDate()) == 0);
+
+        // there is no reason to use a stream here, as there won't be enough iterations to warrant it
+        for (Contract contract : campaign.getActiveContracts()) {
+            if (contract.getEndingDate().equals(today)) {
+                return true;
+            }
+        }
+
+        return false;
     }
 
+    /**
+     * Creates a new instance of the EndContractNagDialog class.
+     *
+     * @param frame the parent JFrame for the dialog
+     * @param campaign the Campaign associated with the dialog
+     */
     public EndContractNagDialog(final JFrame frame, final Campaign campaign) {
-        super(frame, "EndContractNagDialog", "EndContractNagDialog.title",
-                "EndContractNagDialog.text", campaign, MHQConstants.NAG_CONTRACT_ENDED);
+        super(frame, DIALOG_NAME, DIALOG_TITLE, DIALOG_BODY, campaign, MHQConstants.NAG_CONTRACT_ENDED);
     }
 
+    /**
+     * Checks if there is a nag message to display.
+     *
+     * @return {@code true} if there is a nag message to display, {@code false} otherwise
+     */
     @Override
     protected boolean checkNag() {
         return !MekHQ.getMHQOptions().getNagDialogIgnore(getKey())

MekHQ/src/mekhq/gui/dialog/nagDialogs/UnmaintainedUnitsNagDialog.java

@@ -50,10 +50,10 @@ static boolean checkHanger(Campaign campaign) {
     }
 
     /**
-     * Constructs a new UnmaintainedUnitsNagDialog.
+     * Creates a new instance of the UnmaintainedUnitsNagDialog class.
      *
-     * @param frame    the parent JFrame for the dialog
-     * @param campaign the Campaign object associated with the dialog
+     * @param frame the parent JFrame for the dialog
+     * @param campaign the Campaign associated with the dialog
      */
     //region Constructors
     public UnmaintainedUnitsNagDialog(final JFrame frame, final Campaign campaign) {

MekHQ/unittests/mekhq/gui/dialog/nagDialogs/EndContractNagDialogTest.java

@@ -0,0 +1,99 @@
+package mekhq.gui.dialog.nagDialogs;
+
+import megamek.logging.MMLogger;
+import mekhq.campaign.Campaign;
+import mekhq.campaign.mission.Contract;
+import mekhq.campaign.universe.Systems;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.time.LocalDate;
+import java.util.ArrayList;
+import java.util.List;
+
+import static mekhq.gui.dialog.nagDialogs.EndContractNagDialog.isContractEnded;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+/**
+ * This class is a test class for the EndContractNagDialog class.
+ * It contains test methods for various scenarios related to contract expiration.
+ */
+public class EndContractNagDialogTest {
+    // Mock objects for the tests
+    private Campaign campaign;
+    private LocalDate today;
+    private Contract contract1, contract2;
+
+    /**
+     * Sets up the necessary dependencies and configurations before running the test methods.
+     * Runs once before all tests
+     */
+    @BeforeAll
+    static void setup() {
+        try {
+            Systems.setInstance(Systems.loadDefault());
+        } catch (Exception exception) {
+            MMLogger.create(EndContractNagDialogTest.class).error("", exception);
+        }
+    }
+
+    /**
+     * Test setup for each test, runs before each test.
+     * Initializes the mock objects and sets up the necessary mock behaviors.
+     */
+    @BeforeEach
+    void init() {
+        // Initialize the mock objects
+        campaign = mock(Campaign.class);
+        today = LocalDate.now();
+        contract1 = mock(Contract.class);
+        contract2 = mock(Contract.class);
+
+        // When the Campaign mock calls 'getLocalDate()' return today's date
+        when(campaign.getLocalDate()).thenReturn(today);
+    }
+
+    // In the following tests,
+    // Different combinations of contract end date states to set up desired behaviors in mock objects
+    // Then the isContractEnded() method of EndContractNagDialog class is called,
+    // and its response is checked against expected behavior
+
+    @Test
+    void noActiveContracts() {
+        when(campaign.getActiveContracts()).thenReturn(new ArrayList<>());
+        assertFalse(isContractEnded(campaign));
+    }
+
+    @Test
+    void oneActiveContractEndsTomorrow() {
+        when(campaign.getActiveContracts()).thenReturn(List.of(contract1));
+        when(contract1.getEndingDate()).thenReturn(today.plusDays(1));
+        assertFalse(isContractEnded(campaign));
+    }
+
+    @Test
+    void oneActiveContractEndsToday() {
+        when(campaign.getActiveContracts()).thenReturn(List.of(contract1));
+        when(contract1.getEndingDate()).thenReturn(today);
+        assertTrue(isContractEnded(campaign));
+    }
+
+    @Test
+    void twoActiveContractsOneEndsTomorrowOneEndsToday() {
+        when(campaign.getActiveContracts()).thenReturn(List.of(contract1, contract2));
+        when(contract1.getEndingDate()).thenReturn(today.plusDays(1));
+        when(contract2.getEndingDate()).thenReturn(today);
+        assertTrue(isContractEnded(campaign));
+    }
+
+    @Test
+    void twoActiveContractsBothEndToday() {
+        when(campaign.getActiveContracts()).thenReturn(List.of(contract1, contract2));
+        when(contract1.getEndingDate()).thenReturn(today);
+        assertTrue(isContractEnded(campaign));
+    }
+}

MekHQ/unittests/mekhq/gui/dialog/nagDialogs/InsufficientAstechsNagDialogTest.java

@@ -0,0 +1,65 @@
+package mekhq.gui.dialog.nagDialogs;
+
+import megamek.logging.MMLogger;
+import mekhq.campaign.Campaign;
+import mekhq.campaign.universe.Systems;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+class InsufficientAstechsNagDialogTest {
+    // Mock objects for the tests
+    private Campaign campaign;
+    private InsufficientAstechsNagDialog dialog;
+
+    /**
+     * Sets up the necessary dependencies and configurations before running the test methods.
+     * Runs once before all tests
+     */
+    @BeforeAll
+    static void setup() {
+        try {
+            Systems.setInstance(Systems.loadDefault());
+        } catch (Exception exception) {
+            MMLogger.create(InsufficientAstechsNagDialogTest.class).error("", exception);
+        }
+    }
+
+    /**
+     * Test setup for each test, runs before each test.
+     * Initializes the mock objects and sets up the necessary mock behaviors.
+     */
+    @BeforeEach
+    void init() {
+        campaign = mock(Campaign.class);
+        dialog = new InsufficientAstechsNagDialog(null, campaign);
+    }
+
+    // In the following tests,
+    // Different combinations of unit states to set up desired behaviors in mock objects
+    // Then the checkNag() method of InsufficientAstechsNagDialog class is called,
+    // and its response is checked against expected behavior
+
+    @Test
+    void noAstechsNeeded() {
+        when(campaign.getAstechNeed()).thenReturn(0);
+        assertFalse(dialog.checkNag());
+    }
+
+    @Test
+    void oneAstechNeeded() {
+        when(campaign.getAstechNeed()).thenReturn(1);
+        assertTrue(dialog.checkNag());
+    }
+
+    @Test
+    void negativeAstechsNeeded() {
+        when(campaign.getAstechNeed()).thenReturn(-1);
+        assertFalse(dialog.checkNag());
+    }
+}

MekHQ/unittests/mekhq/gui/dialog/nagDialogs/UnmaintainedUnitsNagDialogTest.java

@@ -41,9 +41,9 @@
  */
 class UnmaintainedUnitsNagDialogTest {
     // Mock objects for the tests
-    Campaign campaign;
-    Hangar hangar;
-    Unit mockUnit1, mockUnit2;
+    private Campaign campaign;
+    private Hangar hangar;
+    private Unit mockUnit1, mockUnit2;
 
     /**
      * Sets up the necessary dependencies and configurations before running the test methods.
@@ -129,14 +129,14 @@ void unmaintainedUnitExistsButSalvageMixed() {
     }
 
     @Test
-    void noUoUnmaintainedUnitExistsUnit1() {
+    void noUnmaintainedUnitExistsNoSalvage() {
         initializeUnits(false, false, false, false);
         assertFalse(checkHanger(campaign));
     }
 
     @Test
-    void noUnmaintainedUnitExistsUnit2() {
-        initializeUnits(false, false, false, false);
+    void noUnmaintainedUnitExistsAllSalvage() {
+        initializeUnits(false, true, false, true);
         assertFalse(checkHanger(campaign));
     }