Add DijkstrasAlgorithmTest

Author: Jegors Čemisovs

algorithm/build.gradle

@@ -46,7 +46,7 @@ publishing {
                     fromResolutionOf('runtimeClasspath')
                 }
                 usage('java-runtime') {
-                    fromResolutionResult()
+                    fromResolutionResult(null)
                 }
             }
         }
@@ -65,6 +65,9 @@ dependencies {
     // Required for spock-reports
     testImplementation 'org.slf4j:slf4j-api:2.0.1'
     testRuntimeClasspath 'org.slf4j:slf4j-simple:2.0.1'
+
+    // JUnit 5 Parameterized Tests
+    testImplementation 'org.junit.jupiter:junit-jupiter-params:5.8.1'
 }
 
 test {

algorithm/src/test/groovy/lv/id/jc/algorithm/graph/DijkstrasAlgorithmSpec.groovy

@@ -4,8 +4,12 @@ import spock.lang.*
 
 @Title("Dijkstra's Algorithm")
 @See("https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm")
-@Narrative("Dijkstra's algorithm is an algorithm for finding the fastest paths between nodes in a graph")
+@Narrative("""
+Dijkstra's algorithm is an algorithm for finding 
+the fastest paths between nodes in a graph
+""")
 class DijkstrasAlgorithmSpec extends Specification {
+
     @Subject
     def algorithm = new DijkstrasAlgorithm()
 
@@ -19,19 +23,17 @@ class DijkstrasAlgorithmSpec extends Specification {
 
         when:
         def path = algorithm.findPath(graph, source, target)
+        def time = graph.getDistance(path)
 
         then:
-        path == fastest
-
-        and:
-        graph.getDistance(path) == time as double
+        path == fastestPath
+        time == fastestTime
 
         where:
-        source | target || time | fastest
-        'A'    | 'A'    || 0    | ['A']
-        'B'    | 'B'    || 0    | ['B']
-        'C'    | 'C'    || 0    | ['C']
-        'A'    | 'B'    || 5    | ['A', 'C', 'B']
+        source | target || fastestPath     | fastestTime
+        'A'    | 'A'    || ['A']           | 0
+        'B'    | 'A'    || ['B', 'A']      | 3
+        'A'    | 'B'    || ['A', 'C', 'B'] | 5
     }
 
     def 'should find a route for a medium graph'() {

algorithm/src/test/java/lv/id/jc/algorithm/graph/DijkstrasAlgorithmTest.java

@@ -0,0 +1,56 @@
+package lv.id.jc.algorithm.graph;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.*;
+import java.util.stream.Stream;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+// Java 8 + JUnit 5 + Parameterized Test
+class DijkstrasAlgorithmTest {
+
+    // Subject under test
+    SearchAlgorithm<String> algorithm = new DijkstrasAlgorithm<>();
+
+    // Sample data
+    private static Stream<Arguments> providePathTime() {
+        return Stream.of(
+                Arguments.of("A", "A", Collections.singletonList("A"), 0),
+                Arguments.of("B", "A", Arrays.asList("B", "A"), 3),
+                Arguments.of("A", "B", Arrays.asList("A", "C", "B"), 5)
+        );
+    }
+
+    @ParameterizedTest
+    @MethodSource("providePathTime")
+    @DisplayName("should find a route for a simple graph")
+    void testRouteForSimpleGraph(String source, String target, List<String> fastestPath, double fastestTime) {
+        // given
+        Map<String, Number> fromA = new HashMap<>();
+        fromA.put("B", 7);
+        fromA.put("C", 2);
+        Map<String, Number> fromB = new HashMap<>();
+        fromB.put("A", 3);
+        fromB.put("C", 5);
+        Map<String, Number> fromC = new HashMap<>();
+        fromC.put("A", 1);
+        fromC.put("B", 3);
+        Map<String, Map<String, Number>> nodes = new HashMap<>();
+        nodes.put("A", fromA);
+        nodes.put("B", fromB);
+        nodes.put("C", fromC);
+        Graph<String> graph = Graph.of(nodes);
+
+        // when
+        List<String> path = algorithm.findPath(graph, source, target);
+        double time = graph.getDistance(path);
+
+        // then
+        assertEquals(fastestPath, path);
+        assertEquals(fastestTime, time);
+    }
+}

algorithm/src/test/java/lv/id/jc/algorithm/graph/SearchAlgorithmsTest.java

@@ -67,6 +67,7 @@ void tearDown() {
     void testFindPathAA() {
         // Java 8
 
+        // given
         String source = "A";
         String target = "A";
 
@@ -76,9 +77,11 @@ void testFindPathAA() {
         List<String> fastest = new ArrayList<>();
         fastest.add("A");
 
+        // when
         List<String> routeOne = bfsAlgorithm.findPath(graph, source, target);
         List<String> routeTwo = dijkstras.findPath(graph, source, target);
 
+        // then
         assertEquals(shortest, routeOne);
         assertEquals(fastest, routeTwo);
 

docs/spock-reports/aggregated_report.json

@@ -1 +1 @@
-{"lv.id.jc.algorithm.graph.SearchAlgorithmsSpec":{"executedFeatures":["should find a route for a complex graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":1,"totalFeatures":1,"passed":1,"successRate":1.0,"time":46},"title":"Comparison of two algorithms","narrative":""},"lv.id.jc.algorithm.graph.BreadthFirstSearchSpec":{"executedFeatures":["should find a route for complex graph","should find a route for simple graph","should return an empty path if can't find a route","should thrown NPE path for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":4,"totalFeatures":4,"passed":4,"successRate":1.0,"time":16},"title":"Breadth First Search Algorithm","narrative":"Breadth First Search algorithm for finding the shortest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.DijkstrasAlgorithmSpec":{"executedFeatures":["should find a route for a complex graph","should find a route for a medium graph","should find a route for a simple graph","should return an empty path if can't find a route","should thrown NPE for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":45},"title":"Dijkstra's Algorithm","narrative":"Dijkstra's algorithm is an algorithm for finding the fastest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.GraphSpec":{"executedFeatures":["should be zero distance for an empty path","should be zero distance for any one node path","should calculate distance for a path","should return edges for a given node","should throw NPE for incorrect path"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":47},"title":"Generic Graph","narrative":"A generic implementation of Graph structure"}}
+{"lv.id.jc.algorithm.graph.SearchAlgorithmsSpec":{"executedFeatures":["should find a route for a complex graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":1,"totalFeatures":1,"passed":1,"successRate":1.0,"time":46},"title":"Comparison of two algorithms","narrative":""},"lv.id.jc.algorithm.graph.BreadthFirstSearchSpec":{"executedFeatures":["should find a route for complex graph","should find a route for simple graph","should return an empty path if can't find a route","should thrown NPE path for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":4,"totalFeatures":4,"passed":4,"successRate":1.0,"time":16},"title":"Breadth First Search Algorithm","narrative":"Breadth First Search algorithm for finding the shortest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.DijkstrasAlgorithmSpec":{"executedFeatures":["should find a route for a complex graph","should find a route for a medium graph","should find a route for a simple graph","should return an empty path if can't find a route","should thrown NPE for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":45},"title":"Dijkstra's Algorithm","narrative":"Dijkstra's algorithm is an algorithm for finding the fastest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.GraphSpec":{"executedFeatures":["should be zero distance for an empty path","should be zero distance for any one node path","should calculate distance for a path","should return edges for a given node","should throw NPE for incorrect path"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":47},"title":"Generic Graph","narrative":"A generic implementation of Graph structure"},"lv.id.jc.algorithm.graph.DijkstrasAlgorithmSpec":{"executedFeatures":["should find a route for a complex graph","should find a route for a medium graph","should find a route for a simple graph","should return an empty path if can't find a route","should thrown NPE for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":46},"title":"Dijkstra's Algorithm","narrative":"Dijkstra's algorithm is an algorithm for finding the fastest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.DijkstrasAlgorithmSpec":{"executedFeatures":["should find a route for a complex graph","should find a route for a medium graph","should find a route for a simple graph","should return an empty path if can't find a route","should thrown NPE for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":1,"totalFeatures":5,"passed":1,"successRate":1.0,"time":29},"title":"Dijkstra's Algorithm","narrative":"Dijkstra's algorithm is an algorithm for finding the fastest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.DijkstrasAlgorithmSpec":{"executedFeatures":["should find a route for a complex graph","should find a route for a medium graph","should find a route for a simple graph","should return an empty path if can't find a route","should thrown NPE for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":1,"totalFeatures":5,"passed":1,"successRate":1.0,"time":32},"title":"Dijkstra's Algorithm","narrative":"Dijkstra's algorithm is an algorithm for finding the fastest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.BreadthFirstSearchSpec":{"executedFeatures":["should find a route for complex graph","should find a route for simple graph","should return an empty path if can't find a route","should thrown an exception for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":4,"totalFeatures":4,"passed":4,"successRate":1.0,"time":37},"title":"Breadth First Search Algorithm","narrative":"Breadth First Search algorithm for finding the shortest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.DijkstrasAlgorithmSpec":{"executedFeatures":["should find a route for a complex graph","should find a route for a medium graph","should find a route for a simple graph","should return an empty path if can't find a route","should thrown NPE for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":15},"title":"Dijkstra's Algorithm","narrative":"Dijkstra's algorithm is an algorithm for finding the fastest paths between nodes in a graph"},"lv.id.jc.algorithm.graph.GraphSpec":{"executedFeatures":["should be zero distance for an empty path","should be zero distance for any one node path","should calculate distance for a path","should return edges for a given node","should throw NPE for incorrect path"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":32},"title":"Generic Graph","narrative":"A generic implementation of Graph structure"},"lv.id.jc.algorithm.graph.SearchAlgorithmsSpec":{"executedFeatures":["should find a route for a complex graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":1,"totalFeatures":1,"passed":1,"successRate":1.0,"time":5},"title":"Comparison of two algorithms","narrative":""},"lv.id.jc.algorithm.graph.DijkstrasAlgorithmSpec":{"executedFeatures":["should find a route for a complex graph","should find a route for a medium graph","should find a route for a simple graph","should return an empty path if can't find a route","should thrown NPE for an empty graph"],"ignoredFeatures":[],"stats":{"failures":0,"errors":0,"skipped":0,"totalRuns":5,"totalFeatures":5,"passed":5,"successRate":1.0,"time":44},"title":"Dijkstra's Algorithm","narrative":"Dijkstra's algorithm is an algorithm for finding \nthe fastest paths between nodes in a graph"}}

docs/spock-reports/index.html

@@ -84,7 +84,7 @@ <h2>Specification run results</h2>
 </div>
 <div class='summary-report'>
 <h3>Specifications summary:</h3>
-<div class='date-test-ran'>Created on Tue Jan 11 09:12:51 EET 2022 by jegors.cemisovs</div>
+<div class='date-test-ran'>Created on Sun Oct 16 13:46:14 EEST 2022 by jegors</div>
 <table class='summary-table'>
 <thead>
 <tr>
@@ -111,7 +111,7 @@ <h3>Specifications summary:</h3>
 <td>0</td>
 <td>0</td>
 <td>100.0%</td>
-<td>0.154 seconds</td>
+<td>0.118 seconds</td>
 </tr>
 </tbody>
 </table>
@@ -142,7 +142,7 @@ <h3>Specifications:</h3>
 <td>0</td>
 <td>0</td>
 <td>100.0%</td>
-<td>0.016 seconds</td>
+<td>0.037 seconds</td>
 </tr>
 <tr>
 <td>
@@ -155,7 +155,7 @@ <h3>Specifications:</h3>
 <td>0</td>
 <td>0</td>
 <td>100.0%</td>
-<td>0.045 seconds</td>
+<td>0.044 seconds</td>
 </tr>
 <tr>
 <td>
@@ -168,7 +168,7 @@ <h3>Specifications:</h3>
 <td>0</td>
 <td>0</td>
 <td>100.0%</td>
-<td>0.047 seconds</td>
+<td>0.032 seconds</td>
 </tr>
 <tr>
 <td>
@@ -181,7 +181,7 @@ <h3>Specifications:</h3>
 <td>0</td>
 <td>0</td>
 <td>100.0%</td>
-<td>0.046 seconds</td>
+<td>0.005 seconds</td>
 </tr>
 </tbody>
 </table>