Merge pull request #357 from code-dot-org/molly/neighborhood-tracker-updates

Neighborhood Validation Updates

Author: molly-moen

org-code-javabuilder/neighborhood/src/main/java/org/code/neighborhood/Painter.java

@@ -143,12 +143,16 @@ public void takePaint() {
 
   /** @return True if there is paint in the square where the painter is standing. */
   public boolean isOnPaint() {
-    return this.grid.getSquare(this.xLocation, this.yLocation).hasColor();
+    boolean isOnPaint = this.grid.getSquare(this.xLocation, this.yLocation).hasColor();
+    this.sendBooleanMessage(NeighborhoodSignalKey.IS_ON_PAINT, isOnPaint);
+    return isOnPaint;
   }
 
   /** @return True if there is a paint bucket in the square where the painter is standing. */
   public boolean isOnBucket() {
-    return this.grid.getSquare(this.xLocation, this.yLocation).containsPaint();
+    boolean isOnBucket = this.grid.getSquare(this.xLocation, this.yLocation).containsPaint();
+    this.sendBooleanMessage(NeighborhoodSignalKey.IS_ON_BUCKET, isOnBucket);
+    return isOnBucket;
   }
 
   /** @return True if the painter's personal bucket has paint in it. */
@@ -161,12 +165,14 @@ public boolean hasPaint() {
 
   /** @return True if there is no barrier one square ahead in the requested direction. */
   public boolean canMove(String direction) {
-    return this.isValidMovement(Direction.fromString(direction));
+    boolean canMove = this.isValidMovement(Direction.fromString(direction));
+    this.sendBooleanMessage(NeighborhoodSignalKey.CAN_MOVE, canMove);
+    return canMove;
   }
 
   /** @return True if there is no barrier one square ahead in the current direction. */
   public boolean canMove() {
-    return this.isValidMovement(this.direction);
+    return this.canMove(this.direction.toString());
   }
 
   /** @return the color of the square where the painter is standing. */
@@ -297,6 +303,13 @@ private void sendOutputMessage(NeighborhoodSignalKey signalKey, HashMap<String,
     this.outputAdapter.sendMessage(new NeighborhoodSignalMessage(signalKey, details));
   }
 
+  private void sendBooleanMessage(NeighborhoodSignalKey signalKey, boolean result) {
+    HashMap<String, String> details = this.getSignalDetails();
+    String resultString = String.valueOf(result);
+    details.put(BOOLEAN_RESULT, resultString);
+    this.sendOutputMessage(signalKey, details);
+  }
+
   private void sendInitializationMessage() {
     HashMap<String, String> initDetails = this.getSignalDetails();
     initDetails.put(DIRECTION, this.direction.getDirectionString());

org-code-javabuilder/neighborhood/src/main/java/org/code/neighborhood/support/NeighborhoodSignalKey.java

@@ -20,5 +20,11 @@ public enum NeighborhoodSignalKey {
   // Hide all paint buckets
   HIDE_BUCKETS,
   // Show all paint buckets
-  SHOW_BUCKETS
+  SHOW_BUCKETS,
+  // isOnBucket was called (used for validation only)
+  IS_ON_BUCKET,
+  // isOnPaint was called (used for validation only)
+  IS_ON_PAINT,
+  // canMove was called (used for validation only)
+  CAN_MOVE
 }

org-code-javabuilder/protocol/src/main/java/org/code/protocol/ClientMessageDetailKeys.java

@@ -41,4 +41,6 @@ public class ClientMessageDetailKeys {
   public static final String DIRECTION = "direction";
   public static final String COLOR = "color";
   public static final String PAINT = "paint";
+  // Used to report the result of calling a boolean method
+  public static final String BOOLEAN_RESULT = "booleanResult";
 }

org-code-javabuilder/validation/src/main/java/org/code/validation/NeighborhoodActionType.java

@@ -11,5 +11,8 @@ public enum NeighborhoodActionType {
   SHOW_PAINTER,
   TURN_LEFT,
   HIDE_BUCKETS,
-  SHOW_BUCKETS
+  SHOW_BUCKETS,
+  CAN_MOVE,
+  IS_ON_BUCKET,
+  IS_ON_PAINT
 }

org-code-javabuilder/validation/src/main/java/org/code/validation/Position.java

@@ -1,13 +1,15 @@
 package org.code.validation;
 
-/** User-facing class representing an (x, y) position. */
+/** User-facing class representing an (x, y) position and a direction. */
 public class Position {
   private final int x;
   private final int y;
+  private final String direction;
 
-  public Position(int x, int y) {
+  public Position(int x, int y, String direction) {
     this.x = x;
     this.y = y;
+    this.direction = direction;
   }
 
   public int getX() {
@@ -17,4 +19,8 @@ public int getX() {
   public int getY() {
     return this.y;
   }
+
+  public String getDirection() {
+    return this.direction;
+  }
 }

org-code-javabuilder/validation/src/main/java/org/code/validation/support/NeighborhoodActionTypeMapper.java

@@ -35,6 +35,12 @@ public static NeighborhoodActionType convertNeighborhoodKeyToActionType(
         return NeighborhoodActionType.HIDE_BUCKETS;
       case SHOW_BUCKETS:
         return NeighborhoodActionType.SHOW_BUCKETS;
+      case CAN_MOVE:
+        return NeighborhoodActionType.CAN_MOVE;
+      case IS_ON_BUCKET:
+        return NeighborhoodActionType.IS_ON_BUCKET;
+      case IS_ON_PAINT:
+        return NeighborhoodActionType.IS_ON_PAINT;
       default:
         return null;
     }

org-code-javabuilder/validation/src/main/java/org/code/validation/support/NeighborhoodTracker.java

@@ -50,7 +50,9 @@ public void trackEvent(ClientMessage message) {
       final int x = message.getDetail().getInt(X);
       final int y = message.getDetail().getInt(Y);
       final int paint = message.getDetail().getInt(PAINT);
-      final PainterTracker painterTracker = new PainterTracker(id, new Position(x, y), paint);
+      final String direction = message.getDetail().getString(DIRECTION);
+      final PainterTracker painterTracker =
+          new PainterTracker(id, new Position(x, y, direction), paint);
       this.painterTrackers.put(id, painterTracker);
       return;
     }

org-code-javabuilder/validation/src/main/java/org/code/validation/support/PainterTracker.java

@@ -39,16 +39,16 @@ public void trackEvent(PainterEvent event) {
           final int currentY = this.currentPosition.getY();
           switch (Direction.fromString(directionString)) {
             case NORTH:
-              this.currentPosition = new Position(currentX, currentY - 1);
+              this.currentPosition = new Position(currentX, currentY - 1, directionString);
               break;
             case EAST:
-              this.currentPosition = new Position(currentX + 1, currentY);
+              this.currentPosition = new Position(currentX + 1, currentY, directionString);
               break;
             case SOUTH:
-              this.currentPosition = new Position(currentX, currentY + 1);
+              this.currentPosition = new Position(currentX, currentY + 1, directionString);
               break;
             case WEST:
-              this.currentPosition = new Position(currentX - 1, currentY);
+              this.currentPosition = new Position(currentX - 1, currentY, directionString);
               break;
           }
         }

org-code-javabuilder/validation/src/test/java/org/code/validation/NeighborhoodLogTest.java

@@ -79,7 +79,8 @@ public void finalOutputContainsPaintReturnsCorrectlyForInvalidOutput() {
   }
 
   private PainterLog createPainterLog(List<PainterEvent> events) {
-    return new PainterLog("sampleId", new Position(0, 0), new Position(5, 5), 0, 5, events);
+    return new PainterLog(
+        "sampleId", new Position(0, 0, "east"), new Position(5, 5, "east"), 0, 5, events);
   }
 
   private String[][] getSampleFinalOutput() {

org-code-javabuilder/validation/src/test/java/org/code/validation/PainterLogTest.java

@@ -24,7 +24,13 @@ public void setUp() {
     sampleEvents.add(new PainterEvent(NeighborhoodActionType.PAINT, null));
     sampleEvents.add(new PainterEvent(NeighborhoodActionType.TAKE_PAINT, null));
     unitUnderTest =
-        new PainterLog("sampleId", new Position(0, 0), new Position(5, 5), 0, 5, sampleEvents);
+        new PainterLog(
+            "sampleId",
+            new Position(0, 0, "east"),
+            new Position(5, 5, "north"),
+            0,
+            5,
+            sampleEvents);
   }
 
   @Test