Always run cleanup query in doc tests

Author: soerenreichardt

doc-test-tools/src/main/java/org/neo4j/gds/doc/DocExampleQueryParser.java

@@ -61,6 +61,7 @@ public ParseResult parseAndCollect() {
         return new ParseResult(
             queryProcessor.getBeforeEachQueries(),
             queryProcessor.getBeforeAllQueries(),
+            queryProcessor.getAfterAllQueries(),
             queryProcessor.getQueryExampleGroups()
         );
     }
@@ -76,6 +77,7 @@ private List<File> adocFiles() {
     public record ParseResult(
             List<DocQuery> beforeEachQueries,
             List<DocQuery> beforeAllQueries,
-            List<QueryExampleGroup> queryExampleGroups) {
-    }
+            List<QueryExample> afterAllQueries,
+            List<QueryExampleGroup> queryExampleGroups
+    ) {}
 }

doc-test-tools/src/main/java/org/neo4j/gds/doc/DocumentationTestToolsConstants.java

@@ -36,6 +36,7 @@ final class DocumentationTestToolsConstants {
     static final String CODE_BLOCK_CONTEXT = ":listing";
     static final String TABLE_CONTEXT = ":table";
     static final String SETUP_QUERY_ROLE = "setup-query";
+    static final String CLEANUP_QUERY_ROLE = "cleanup-query";
     static final String GRAPH_PROJECT_QUERY_ROLE = "graph-project-query";
     static final String QUERY_EXAMPLE_ROLE = "query-example";
     static final String TEST_TYPE_NO_RESULT = "no-result";

doc-test-tools/src/main/java/org/neo4j/gds/doc/QueryCollectingTreeProcessor.java

@@ -36,6 +36,7 @@
 import java.util.UUID;
 import java.util.stream.Collectors;
 
+import static org.neo4j.gds.doc.DocumentationTestToolsConstants.CLEANUP_QUERY_ROLE;
 import static org.neo4j.gds.doc.DocumentationTestToolsConstants.CODE_BLOCK_CONTEXT;
 import static org.neo4j.gds.doc.DocumentationTestToolsConstants.GRAPH_PROJECT_QUERY_ROLE;
 import static org.neo4j.gds.doc.DocumentationTestToolsConstants.QUERY_EXAMPLE_ROLE;
@@ -70,6 +71,8 @@ public class QueryCollectingTreeProcessor extends Treeprocessor {
 
     private final List<DocQuery> beforeEachQueries = new ArrayList<>();
 
+    private final List<QueryExample> afterAllQueries = new ArrayList<>();
+
     /**
      * "Group encounter order" is preserved if we use a LinkedHashMap, and while that is not strictly necessary, I think
      * it is a nice touch. Not sure if JUnit UI reflects it, TBD.
@@ -86,6 +89,7 @@ public Document process(Document document) {
         collectBeforeAllQueries(document);
         collectBeforeEachQueries(document);
         collectQueryExamples(document);
+        collectAfterAllExampleQueries(document);
 
         return document;
     }
@@ -98,6 +102,10 @@ public List<DocQuery> getBeforeEachQueries() {
         return beforeEachQueries;
     }
 
+    public List<QueryExample> getAfterAllQueries() {
+        return afterAllQueries;
+    }
+
     /**
      * Do grouping into QueryExampleGroups
      */
@@ -111,16 +119,24 @@ public List<QueryExampleGroup> getQueryExampleGroups() {
     }
 
     private void collectBeforeAllQueries(StructuralNode document) {
-        var queries = CollectSetupQueries(document, SETUP_QUERY_ROLE);
+        var queries = collectSetupQueries(document, SETUP_QUERY_ROLE);
         beforeAllQueries.addAll(queries);
     }
 
     private void collectBeforeEachQueries(StructuralNode document) {
-        var queries = CollectSetupQueries(document, GRAPH_PROJECT_QUERY_ROLE);
+        var queries = collectSetupQueries(document, GRAPH_PROJECT_QUERY_ROLE);
         beforeEachQueries.addAll(queries);
     }
 
-    private static List<DocQuery> CollectSetupQueries(StructuralNode node, String setupQueryType) {
+    private void collectAfterAllExampleQueries(StructuralNode document) {
+        var examples = document.findBy(Map.of(ROLE_SELECTOR, CLEANUP_QUERY_ROLE));
+        for (StructuralNode example : examples) {
+            var queryExample = convertToQueryExample(example);
+            afterAllQueries.add(queryExample);
+        }
+    }
+
+    private static List<DocQuery> collectSetupQueries(StructuralNode node, String setupQueryType) {
         var nodes = node.findBy(Map.of(ROLE_SELECTOR, setupQueryType));
 
         return nodes.stream()

doc/modules/ROOT/pages/installation/aura-graph-analytics-serverless.adoc

@@ -620,7 +620,7 @@ RETURN communityCount, modularity
 
 Finally, drop the projected graph, which will also delete the GDS Session.
 
-[role=query-example]
+[role=cleanup-query]
 --
 .Drop the graph 'myGraph':
 [source, cypher]