VDYP-168 Validate FIPStart input data

vdyp-fip/src/main/java/ca/bc/gov/nrs/vdyp/fip/FipStart.java

@@ -275,6 +275,22 @@ private void checkPolygon(FipPolygon polygon) throws ProcessingException {
 					polygon.getPolygonIdentifier(), Layer.PRIMARY, primaryLayer.getSiteIndex(), 0.5f
 			);
 		}
+
+		// TODO fill in "FR" should be a map of species to volume proportions for the
+		// primary layer, see fip_chk.for:237
+
+		for (var layer : polygon.getLayers().values()) {
+			var percentTotal = layer.getSpecies().values().stream()//
+					.map(FipSpecies::getPercentGenus)//
+					.reduce(0.0f, (x, y) -> x + y);
+			if (Math.abs(percentTotal - 100f) > 0.01f) {
+				throw validationError(
+						"Polygon %s has %s layer where species entries have a percentage total that does not sum to 100%%.",
+						polygon.getPolygonIdentifier(), Layer.PRIMARY
+				);
+			}
+		}
+
 	}
 
 	private static <E extends Throwable> void throwIfPresent(Optional<E> opt) throws E {

vdyp-fip/src/test/java/ca/bc/gov/nrs/vdyp/fip/FipStartTest.java

@@ -317,6 +317,172 @@ public void testPolygonWithModeFipYoung() throws Exception {
 
 	}
 
+	@Test
+	public void testOneSpeciesLessThan100Percent() throws Exception {
+
+		var polygonId = polygonId("Test Polygon", 2023);
+		var layer = Layer.PRIMARY;
+
+		testWith(
+				Arrays.asList(getTestPolygon(polygonId, valid())), //
+				Arrays.asList(layerMap(getTestPrimaryLayer(polygonId, valid()))), //
+				Arrays.asList(Collections.singletonList(getTestSpecies(polygonId, layer, x -> {
+					x.setPercentGenus(99f);
+				}))), //
+				app -> {
+
+					var ex = assertThrows(ProcessingException.class, () -> app.process());
+
+					assertThat(
+							ex,
+							hasProperty(
+									"message",
+									is(
+											"Polygon " + polygonId
+													+ " has PRIMARY layer where species entries have a percentage total that does not sum to 100%."
+									)
+							)
+					);
+				}
+		);
+
+	}
+
+	@Test
+	public void testOneSpeciesMoreThan100Percent() throws Exception {
+
+		var polygonId = polygonId("Test Polygon", 2023);
+		var layer = Layer.PRIMARY;
+
+		testWith(
+				Arrays.asList(getTestPolygon(polygonId, valid())), //
+				Arrays.asList(layerMap(getTestPrimaryLayer(polygonId, valid()))), //
+				Arrays.asList(Collections.singletonList(getTestSpecies(polygonId, layer, x -> {
+					x.setPercentGenus(101f);
+				}))), //
+				app -> {
+
+					var ex = assertThrows(ProcessingException.class, () -> app.process());
+
+					assertThat(
+							ex,
+							hasProperty(
+									"message",
+									is(
+											"Polygon " + polygonId
+													+ " has PRIMARY layer where species entries have a percentage total that does not sum to 100%."
+									)
+							)
+					);
+				}
+		);
+
+	}
+
+	@Test
+	public void testTwoSpeciesSumTo100Percent() throws Exception {
+
+		var polygonId = polygonId("Test Polygon", 2023);
+		var layer = Layer.PRIMARY;
+
+		testWith(
+				Arrays.asList(getTestPolygon(polygonId, valid())), //
+				Arrays.asList(layerMap(getTestPrimaryLayer(polygonId, valid()))), //
+				Arrays.asList(
+						Arrays.asList(
+								//
+								getTestSpecies(polygonId, layer, "B", x -> {
+									x.setPercentGenus(75f);
+								}), getTestSpecies(polygonId, layer, "P", x -> {
+									x.setPercentGenus(25f);
+								})
+						)
+				), //
+				app -> {
+
+					assertDoesNotThrow(() -> app.process());
+
+				}
+		);
+
+	}
+
+	@Test
+	public void testTwoSpeciesSumToLessThan100Percent() throws Exception {
+
+		var polygonId = polygonId("Test Polygon", 2023);
+		var layer = Layer.PRIMARY;
+
+		testWith(
+				Arrays.asList(getTestPolygon(polygonId, valid())), //
+				Arrays.asList(layerMap(getTestPrimaryLayer(polygonId, valid()))), //
+				Arrays.asList(
+						Arrays.asList(
+								//
+								getTestSpecies(polygonId, layer, "B", x -> {
+									x.setPercentGenus(75 - 1f);
+								}), getTestSpecies(polygonId, layer, "P", x -> {
+									x.setPercentGenus(25f);
+								})
+						)
+				), //
+				app -> {
+
+					var ex = assertThrows(ProcessingException.class, () -> app.process());
+
+					assertThat(
+							ex,
+							hasProperty(
+									"message",
+									is(
+											"Polygon " + polygonId
+													+ " has PRIMARY layer where species entries have a percentage total that does not sum to 100%."
+									)
+							)
+					);
+				}
+		);
+
+	}
+
+	@Test
+	public void testTwoSpeciesSumToMoreThan100Percent() throws Exception {
+
+		var polygonId = polygonId("Test Polygon", 2023);
+		var layer = Layer.PRIMARY;
+
+		testWith(
+				Arrays.asList(getTestPolygon(polygonId, valid())), //
+				Arrays.asList(layerMap(getTestPrimaryLayer(polygonId, valid()))), //
+				Arrays.asList(
+						Arrays.asList(
+								//
+								getTestSpecies(polygonId, layer, "B", x -> {
+									x.setPercentGenus(75 + 1f);
+								}), getTestSpecies(polygonId, layer, "P", x -> {
+									x.setPercentGenus(25f);
+								})
+						)
+				), //
+				app -> {
+
+					var ex = assertThrows(ProcessingException.class, () -> app.process());
+
+					assertThat(
+							ex,
+							hasProperty(
+									"message",
+									is(
+											"Polygon " + polygonId
+													+ " has PRIMARY layer where species entries have a percentage total that does not sum to 100%."
+									)
+							)
+					);
+				}
+		);
+
+	}
+
 	private static <T> MockStreamingParser<T>
 			mockStream(IMocksControl control, Map<String, Object> controlMap, String key, String name)
 					throws IOException {
@@ -474,10 +640,14 @@ FipLayer getTestVeteranLayer(String polygonId, Consumer<FipLayer> mutator) {
 	};
 
 	FipSpecies getTestSpecies(String polygonId, Layer layer, Consumer<FipSpecies> mutator) {
+		return getTestSpecies(polygonId, layer, "B", mutator);
+	};
+
+	FipSpecies getTestSpecies(String polygonId, Layer layer, String genusId, Consumer<FipSpecies> mutator) {
 		var result = new FipSpecies(
 				polygonId, // polygonIdentifier
 				layer, // layer
-				"B", // genus
+				genusId, // genus
 				100.0f, // percentGenus
 				Collections.emptyMap() // speciesPercent
 		);