Add test for end of custom level

Author: Arun Prasaad

.cascade

@@ -8,6 +8,8 @@ strict_mode = true
 # Don't create getter methods unless they're actually needed
 avoid_unnecessary_getters = true
 # Method ordering: helper methods after their callers
+# Test names should be propositional (e.g., "returns_true_when_condition_met")
+propositional_test_names = true
 helper_methods_after_caller = true
 
 [editing]
@@ -16,6 +18,8 @@ helper_methods_after_caller = true
 make_minimal_changes = true
 # Code formatting
 no_trailing_spaces = true
+# Avoid comments that state the obvious or repeat the code
+avoid_superfluous_comments = true
 
 [communication]
 # Be direct and to the point

src/main/java/ihm/SokobanWindow.java

@@ -1,16 +1,15 @@
 package ihm;
 
-import java.awt.Dimension;
+import java.awt.*;
 
-import java.awt.Image;
 import java.awt.event.KeyEvent;
 import java.awt.event.KeyListener;
 import java.awt.image.BufferedImage;
 import java.util.ArrayList;
 import java.util.List;
-import javax.swing.ImageIcon;
-import javax.swing.JFrame;
-import javax.swing.JOptionPane;
+import javax.swing.*;
+
+import com.google.common.annotations.VisibleForTesting;
 import logic.Controller;
 import logic.Direction;
 import logic.GameAction;
@@ -20,6 +19,7 @@
 public class SokobanWindow extends JFrame implements KeyListener{
 
     public static final int IMAGE_SIZE = 32;
+    private final JButton okButton;
 
     public Controller getController() {
         return controller;
@@ -49,6 +49,7 @@ public SokobanWindow(Controller controller) {
         this.pack();
         this.setLocationRelativeTo( null );
         this.setVisible( true );
+        okButton = new JButton("OK");
     }
 
     @Override
@@ -98,16 +99,36 @@ else if (input == GameAction.STOP) {
         }
     }
 
-    private void handleEndOfLevel() {
+     private void handleEndOfLevel() {
         if (controller.isOnCustomLevel()) {
-            JOptionPane.showMessageDialog(this, "Congratulations, you've completed the level!");
-            exitGame();
+
+            JDialog dialog = new JDialog(this, "Level Complete!", true);
+            okButton.addActionListener(_ -> dialog.dispose());
+
+            JOptionPane.showOptionDialog(
+                dialog,
+                "Congratulations! You've completed the level!",
+                "Level Complete!",
+                JOptionPane.DEFAULT_OPTION,
+                JOptionPane.INFORMATION_MESSAGE,
+                null,
+                new Object[]{okButton},
+                okButton
+            );
+
+            dispose();
+            new HomeWindow();
         }
         else {
             handleNextLevel();
         }
     }
 
+    @VisibleForTesting
+    void clickOkButton() {
+        okButton.doClick();
+    }
+
     private void handleNextLevel() {
         Object[] options = {"Next level", "Quit"};
         Image image = new BufferedImage(1, 1, BufferedImage.TYPE_INT_ARGB);

src/test/java/ihm/SokobanWindowTest.java

@@ -8,6 +8,8 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
+
+import java.awt.*;
 import java.util.stream.Stream;
 
 import javax.swing.*;
@@ -16,6 +18,8 @@
 
 import static org.assertj.core.api.BDDAssertions.then;
 
+import java.util.Arrays;
+
 @NullMarked
 class SokobanWindowTest {
 
@@ -32,7 +36,11 @@ void setUp() {
 
     @AfterEach
     void tearDown() {
-        window.dispose();
+
+        // Clean up windows
+        Arrays.stream(java.awt.Window.getWindows())
+                .filter(java.awt.Window::isDisplayable)
+                .forEach(java.awt.Window::dispose);
     }
 
     /**
@@ -247,4 +255,35 @@ void handles_restart_action() {
         then(controller.getWorker().getColumn()).isNotEqualTo(columnAfterMove);
         then(controller.getWorker().getColumn()).isEqualTo(initialColumn);
     }
+
+    @Test
+    void completing_a_custom_level_disposes_window_and_shows_home_window() {
+        // given - create a test window with the simplified level that only needs one push
+        window = createTestWindow("src/test/resources/levels/test_level_end.txt");
+
+        // Simulate the user clicking OK to close the level completion dialog.
+        // This has to be done before the move to push the box to the target
+        // because the dialog will wait for user input
+        Timer timer = new Timer(10, _ -> window.clickOkButton());
+        timer.setRepeats(false);
+        SwingUtilities.invokeLater(timer::start);
+
+        // When:
+        // Single move to push the box to the target
+        KeyEvent rightKey = new KeyEvent(window,
+                KeyEvent.KEY_PRESSED,
+                System.currentTimeMillis(),
+                0,
+                KeyEvent.VK_RIGHT,
+                KeyEvent.CHAR_UNDEFINED);
+        window.keyPressed(rightKey);
+
+        then(window.isShowing())
+                .as("Window is disposed after level completion and OK click")
+                .isFalse();
+
+        then(Window.getWindows())
+                .as("Contains a visible HomeWindow")
+                .anyMatch(w -> w instanceof HomeWindow && w.isShowing());
+    }
 }

src/test/resources/levels/test_level_end.txt

@@ -0,0 +1,7 @@
+MMMMMMM
+M#####M
+M#####M
+M#GCT#M
+M#####M
+M#####M
+MMMMMMM