Fix NPE when a line references an unknown substation (#48)

Author: jonenst

geo-data-server/src/main/java/org/gridsuite/geodata/server/GeoDataService.java

@@ -240,13 +240,32 @@ boolean emptyOrEquals(String emptyable, String s) {
         return emptyable.isEmpty() || s.equals(emptyable);
     }
 
+    /**
+     * returns the line gps coordinates in the network order with the substations
+     * coordinates added at each extremity.
+     *
+     * returns null when the substations at the end of the line are missing.
+     */
     private LineGeoData getLineGeoDataWithEndSubstations(Map<String, LineGeoData> linesGeoDataDb, Map<String, SubstationGeoData> substationGeoDataDb, Line line) {
         LineGeoData geoData = linesGeoDataDb.get(line.getId());
         Substation sub1 = line.getTerminal1().getVoltageLevel().getSubstation();
         Substation sub2 = line.getTerminal2().getVoltageLevel().getSubstation();
-        Coordinate substation1Coordinate = substationGeoDataDb.get(sub1.getId()).getCoordinate();
-        Coordinate substation2Coordinate = substationGeoDataDb.get(sub2.getId()).getCoordinate();
+        SubstationGeoData substation1GeoData = substationGeoDataDb.get(sub1.getId());
+        SubstationGeoData substation2GeoData = substationGeoDataDb.get(sub2.getId());
+
+        // TODO: we return null here even if we have line data
+        // because the method is called "withEndSubstations"...
+        // We could refactor this in separate methods if we ever have a
+        // need to return the line in the network order without the substations
+        if (substation1GeoData == null || substation2GeoData == null) {
+            LOGGER.error("line {} has substations with unknown gps positions({}={}, {}={})", line.getId(),
+                    sub1.getId(), substation1GeoData,
+                    sub2.getId(), substation2GeoData);
+            return null;
+        }
 
+        Coordinate substation1Coordinate = substation1GeoData.getCoordinate();
+        Coordinate substation2Coordinate = substation2GeoData.getCoordinate();
         if (geoData == null || geoData.getCoordinates().isEmpty() || (geoData.getSubstationStart().isEmpty() && geoData.getSubstationEnd().isEmpty())) {
             return new LineGeoData(line.getId(), sub1.getNullableCountry(), sub2.getNullableCountry(), sub1.getId(), sub2.getId(),
                 List.of(substation1Coordinate, substation2Coordinate));
@@ -303,7 +322,8 @@ List<LineGeoData> getLines(Network network, Set<Country> countries) {
             lines.stream().flatMap(line -> line.getTerminals().stream().map(term -> term.getVoltageLevel().getSubstation().getNullableCountry()).filter(Objects::nonNull))
             .collect(Collectors.toSet());
         Map<String, SubstationGeoData> substationGeoDataDb = getSubstationMap(network, countryAndNextTo);
-        List<LineGeoData> lineGeoData = lines.stream().map(line -> getLineGeoDataWithEndSubstations(linesGeoDataDb, substationGeoDataDb, line)).collect(Collectors.toList());
+        List<LineGeoData> lineGeoData = lines.stream().map(line -> getLineGeoDataWithEndSubstations(linesGeoDataDb, substationGeoDataDb, line))
+                .filter(Objects::nonNull).collect(Collectors.toList());
         LOGGER.info("{} lines read from DB in {} ms", linesGeoDataDb.size(),  stopWatch.getTime(TimeUnit.MILLISECONDS));
 
         return lineGeoData;

geo-data-server/src/test/java/org/gridsuite/geodata/server/GeoDataServiceTest.java

@@ -150,6 +150,65 @@ public void test() {
         assertEquals(1, substationsGeoData2.stream().filter(s -> s.getId().equals("P5")).collect(Collectors.toList()).get(0).getCoordinate().getLon(), 0);
     }
 
+    @Test
+    public void testNonExisting() {
+        Network network = EurostagTutorialExample1Factory.create();
+        Substation notexistsub1 = network.newSubstation()
+                .setId("NOTEXISTSUB1")
+                .setCountry(Country.FR)
+                .setTso("RTE")
+                .add();
+        VoltageLevel notexistvl1 = notexistsub1.newVoltageLevel()
+                .setId("NOTEXISTVL1")
+                .setNominalV(380)
+                .setTopologyKind(TopologyKind.BUS_BREAKER)
+                .add();
+        Bus notexistbus1 = notexistvl1.getBusBreakerView().newBus()
+                .setId("NOTEXISTBUS1")
+                .add();
+
+        Substation notexistsub2 = network.newSubstation()
+                .setId("NOTEXISTSUB2")
+                .setCountry(Country.FR)
+                .setTso("RTE")
+                .add();
+        VoltageLevel notexistvl2 = notexistsub2.newVoltageLevel()
+                .setId("NOTEXISTVL2")
+                .setNominalV(380)
+                .setTopologyKind(TopologyKind.BUS_BREAKER)
+                .add();
+        Bus notexistbus2 = notexistvl2.getBusBreakerView().newBus()
+                .setId("NOTEXISTBUS2")
+                .add();
+
+        Line notexistline = network.newLine()
+                .setId("NOTEXISTLINE1")
+                .setVoltageLevel1(notexistvl1.getId())
+                .setBus1(notexistbus1.getId())
+                .setConnectableBus1(notexistbus1.getId())
+                .setVoltageLevel2(notexistvl2.getId())
+                .setBus2(notexistbus2.getId())
+                .setConnectableBus2(notexistbus2.getId())
+                .setR(3.0)
+                .setX(33.0)
+                .setG1(0.0)
+                .setB1(386E-6 / 2)
+                .setG2(0.0)
+                .setB2(386E-6 / 2)
+                .add();
+        List<SubstationGeoData> substationsGeoData = geoDataService.getSubstations(network, new HashSet<>(Collections.singletonList(Country.FR)));
+        assertFalse("Must not contain nulls", substationsGeoData.stream().anyMatch(Objects::isNull));
+        assertFalse("Must not contain unknown substation " + notexistsub1.getId(),
+                substationsGeoData.stream().anyMatch(s -> notexistsub1.getId().equals(s.getId())));
+        assertFalse("Must not contain unknown substation " + notexistsub2.getId(),
+                substationsGeoData.stream().anyMatch(s -> notexistsub2.getId().equals(s.getId())));
+
+        List<LineGeoData> linesGeoData = geoDataService.getLines(network, new HashSet<>(Collections.singletonList(Country.FR)));
+        assertFalse("Must not contain nulls", linesGeoData.stream().anyMatch(Objects::isNull));
+        assertFalse("Must not contain unknown lines " + notexistline.getId(),
+                linesGeoData.stream().anyMatch(s -> notexistline.getId().equals(s.getId())));
+    }
+
     private Network createGeoDataNetwork() {
         Network network = EurostagTutorialExample1Factory.create();