Fix K-spanning tree docTests

Co-authored-by: Jonatan Jäderberg <jonatan.jaderberg@gmail.com>

Author: IoannisPanagiotas

alpha/alpha-proc/src/test/java/org/neo4j/gds/spanningtree/KSpanningTreeWriteProcTest.java

@@ -30,6 +30,7 @@
 import org.neo4j.gds.extension.Neo4jGraph;
 
 import java.util.HashMap;
+import java.util.HashSet;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -83,16 +84,20 @@ void testMax() {
             assertThat(row.getNumber("computeMillis").longValue() >= 0).isTrue();
         });
 
-        final HashMap<String, Long> communities = new HashMap<>();
+        final HashMap<String, Integer> communities = new HashMap<>();
+        final HashSet<Integer> distinctCommunities = new HashSet<>();
 
         runQueryWithRowConsumer("MATCH (n) WHERE n.partition IS NOT NULL RETURN n.name as name, n.partition as p", row -> {
             final String name = row.getString("name");
-            final long p = row.getNumber("p").longValue();
+            final int p = row.getNumber("p").intValue();
             communities.put(name, p);
+            distinctCommunities.add(p);
+
         });
 
         assertThat(communities).matches(c -> c.get("a").equals(c.get("b")) ^ c.get("c").equals(c.get("d")));
         assertThat(communities.get("a")).isNotEqualTo(communities.get("c"));
+        assertThat(distinctCommunities.size()).isEqualTo(3);
     }
 
     @Test
@@ -113,14 +118,15 @@ void testMin() {
         });
 
         final HashMap<String, Integer> communities = new HashMap<>();
-
+        final HashSet<Integer> distinctCommunities = new HashSet<>();
         runQueryWithRowConsumer("MATCH (n) WHERE n.partition IS NOT NULL RETURN n.name as name, n.partition as p", row -> {
             final String name = row.getString("name");
             final int p = row.getNumber("p").intValue();
             communities.put(name, p);
+            distinctCommunities.add(p);
         });
 
         assertThat(communities).matches(c -> c.get("a").equals(c.get("d")) ^ c.get("b").equals(c.get("c")));
-        assertThat(communities.get("a")).isNotEqualTo(communities.get("b"));
+        assertThat(distinctCommunities.size()).isEqualTo(3);
     }
 }

doc-test/src/test/java/org/neo4j/gds/doc/KSpanningTreeDocTest.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.doc;
+
+import org.neo4j.gds.catalog.GraphProjectProc;
+import org.neo4j.gds.functions.AsNodeFunc;
+import org.neo4j.gds.spanningtree.KSpanningWriteTreeProc;
+
+import java.util.List;
+
+class KSpanningTreeDocTest extends SingleFileDocTestBase {
+
+    @Override
+    protected List<Class<?>> functions() {
+        return List.of(AsNodeFunc.class);
+    }
+
+    @Override
+    protected List<Class<?>> procedures() {
+        return List.of(
+            KSpanningWriteTreeProc.class,
+            GraphProjectProc.class
+        );
+    }
+
+    @Override
+    protected String adocFile() {
+        return "pages/alpha-algorithms/k-minimum-weight-spanning-tree.adoc";
+    }
+
+}

doc/modules/ROOT/pages/alpha-algorithms/k-minimum-weight-spanning-tree.adoc

@@ -62,7 +62,7 @@ YIELD effectiveNodeCount: Integer,
 image::mst.png[]
 
 .The following will create the sample graph depicted in the figure:
-[source, cypher, role=noplay]
+[source, cypher, role=noplay setup-query]
 ----
 CREATE (a:Place {id: 'A'}),
        (b:Place {id: 'B'}),
@@ -81,7 +81,7 @@ CREATE (a:Place {id: 'A'}),
 ----
 
 .The following will project and store a named graph:
-[source, cypher, role=noplay]
+[source, cypher, role=noplay graph-project-query]
 ----
 CALL gds.graph.project(
   'graph',
@@ -98,46 +98,57 @@ CALL gds.graph.project(
 [[algorithms-minimum-weight-spanning-tree-k]]
 == K-Spanning tree examples
 
+=== Minimum K-Spanning Tree example
+
 In our sample graph we have 5 nodes.
-When we ran MST above, we got a 5-minimum spanning tree returned, that covered all five nodes.
 By setting the `k=3`, we define that we want to get returned a 3-minimum spanning tree that covers 3 nodes and has 2 relationships.
 
 .The following will run the k-minimum spanning tree algorithm and write back results:
+[role=query-example, no-result=true, group=write-example]
+--
 [source, cypher, role=noplay]
 ----
 MATCH (n:Place{id: 'D'})
 CALL gds.alpha.kSpanningTree.write('graph', {
   k: 3,
   sourceNode: id(n),
   relationshipWeightProperty: 'cost',
-  writeProperty:'kminst'
+  writeProperty:'kmin'
 })
 YIELD preProcessingMillis, computeMillis, writeMillis, effectiveNodeCount
 RETURN preProcessingMillis,computeMillis,writeMillis, effectiveNodeCount;
 ----
+--
 
-.Find nodes that belong to our k-spanning tree result:
+[role=query-example, group=write-example]
+--
+.The following will find the nodes that belong to our k-spanning tree result:
 [source, cypher, role=noplay]
 ----
-MATCH (n:Place)
-WITH n.id AS Place, n.kminst AS Partition, count(*) AS count
-WHERE count = 3
-RETURN Place, Partition
+MATCH (n)
+WITH n.kmin AS p, count(n) AS c
+WHERE c = 3
+MATCH (n)
+WHERE n.kmin = p
+RETURN n.id As Place, p as Partition
+
 ----
 
 .Results
 [opts="header",cols="1,1"]
 |===
 | Place | Partition
-| A     | 1
-| B     | 1
-| C     | 1
-| D     | 3
-| E     | 4
+| "A"     | 1
+| "B"     | 1
+| "C"     | 1
 |===
-
+--
 Nodes A, B, and C are the result 3-minimum spanning tree of our graph.
 
+=== Maximum K-Spanning Tree example
+
+[role=query-example,no-result=true, group=max-example]
+--
 .The following will run the k-maximum spanning tree algorithm and write back results:
 [source, cypher, role=noplay]
 ----
@@ -146,31 +157,33 @@ CALL gds.alpha.kSpanningTree.write('graph', {
   k: 3,
   sourceNode: id(n),
   relationshipWeightProperty: 'cost',
-  writeProperty:'kmaxst',
-  objective: 'maximum',
+  writeProperty:'kmax',
+  objective: 'maximum'
 })
 YIELD preProcessingMillis, computeMillis, writeMillis, effectiveNodeCount
 RETURN preProcessingMillis,computeMillis,writeMillis, effectiveNodeCount;
 ----
+--
 
+[role=query-example, group=max-example]
+--
 .Find nodes that belong to our k-spanning tree result:
 [source, cypher, role=noplay]
 ----
-MATCH (n:Place)
-WITH n.id AS Place, n.kmaxst AS Partition, count(*) AS count
-WHERE count = 3
-RETURN Place, Partition
+MATCH (n)
+WITH n.kmax AS p, count(n) AS c
+WHERE c = 3
+MATCH (n)
+WHERE n.kmax = p
+RETURN n.id As Place, p as Partition
 ----
-
 .Results
 [opts="header",cols="1,1"]
 |===
 | Place | Partition
-| A     | 0
-| B     | 1
-| C     | 3
-| D     | 3
-| E     | 3
+| "C"     | 3
+| "D"     | 3
+| "E"     | 3
 |===
-
+--
 Nodes C, D, and E are the result 3-maximum spanning tree of our graph.