Handle links inside proc parameters in syntax doc test

Author: FlorentinD

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

@@ -166,6 +166,8 @@ private Consumer<StructuralNode> assertTableValues(
                     .getCells()
                     .get(0)) // Get the first column in the row --> corresponds to the return column names
                 .map(Cell::getText)
+                // remove any potential links in the names
+                .map(name -> name.replaceAll("<a.*\">|<\\/a>", ""))
                 // as java identifier cannot contain white spaces, remove anything after the first space such as footnote:
                 .map(name -> name.split("\\s+")[0])
                 .collect(Collectors.toList());
@@ -176,7 +178,7 @@ private Consumer<StructuralNode> assertTableValues(
         };
     }
 
-    private Iterable<String> extractDocResultFields(String syntaxCode) {
+    private static Iterable<String> extractDocResultFields(String syntaxCode) {
         var yield = syntaxCode.substring(syntaxCode.indexOf(YIELD_KEYWORD) + YIELD_KEYWORD.length()).trim();
         return Arrays.stream(yield.split(YIELD_FIELD_SEPARATOR))
             .map(yieldField -> yieldField.split(YIELD_NAME_DATA_TYPE_SEPARATOR)[0].trim())

doc-test-tools/src/test/java/org/neo4j/gds/doc/syntax/ProcedureSyntaxAutoCheckerTest.java

@@ -23,11 +23,14 @@
 import org.asciidoctor.OptionsBuilder;
 import org.asciidoctor.SafeMode;
 import org.assertj.core.api.SoftAssertions;
+import org.assertj.core.api.junit.jupiter.InjectSoftAssertions;
 import org.assertj.core.api.junit.jupiter.SoftAssertionsExtension;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
 import java.io.File;
 import java.net.URISyntaxException;
@@ -48,6 +51,9 @@ class ProcedureSyntaxAutoCheckerTest {
 
     private static final String newLine = System.lineSeparator();
 
+    @InjectSoftAssertions
+    private SoftAssertions softAssertions;
+
     @BeforeEach
     void setUp() {
         // By default we are forced to use relative path which we don't want.
@@ -57,18 +63,19 @@ void setUp() {
 
     }
 
-    @Test
-    void correctSyntaxSectionTest(SoftAssertions softAssertions) throws URISyntaxException {
+    @ParameterizedTest(name = "{0}")
+    @ValueSource(strings = {"include-with-syntax.adoc", "include-with-syntax-parameter-with-link.adoc"})
+    void correctSyntaxSectionTest(String positiveResource) throws URISyntaxException {
         try (var asciidoctor = createAsciidoctor(softAssertions)) {
-            var file = Paths.get(getClass().getClassLoader().getResource("include-with-syntax.adoc").toURI()).toFile();
+            var file = Paths.get(getClass().getClassLoader().getResource(positiveResource).toURI()).toFile();
             assertTrue(file.exists() && file.canRead());
 
             asciidoctor.convertFile(file, options);
         }
     }
 
     @Test
-    void shouldFailOnMissingResultsTable(SoftAssertions softAssertions) throws URISyntaxException {
+    void shouldFailOnMissingResultsTable() throws URISyntaxException {
         try (var asciidoctor = createAsciidoctor(softAssertions)) {
             var file = Paths
                 .get(getClass()
@@ -85,7 +92,7 @@ void shouldFailOnMissingResultsTable(SoftAssertions softAssertions) throws URISy
     }
 
     @Test
-    void shouldFailOnMoreThanOneResultsTable(SoftAssertions softAssertions) throws URISyntaxException {
+    void shouldFailOnMoreThanOneResultsTable() throws URISyntaxException {
         try (var asciidoctor = createAsciidoctor(softAssertions)) {
             var file = Paths
                 .get(getClass()
@@ -102,7 +109,7 @@ void shouldFailOnMoreThanOneResultsTable(SoftAssertions softAssertions) throws U
     }
 
     @Test
-    void shouldFailOnMissingCodeBlock(SoftAssertions softAssertions) throws URISyntaxException {
+    void shouldFailOnMissingCodeBlock() throws URISyntaxException {
         try (var asciidoctor = createAsciidoctor(softAssertions)) {
             var file = Paths
                 .get(getClass().getClassLoader().getResource("invalid-include-with-syntax-no-code-block.adoc").toURI())
@@ -116,7 +123,7 @@ void shouldFailOnMissingCodeBlock(SoftAssertions softAssertions) throws URISynta
     }
 
     @Test
-    void shouldFailOnMoreThanOneCodeBlock(SoftAssertions softAssertions) throws URISyntaxException {
+    void shouldFailOnMoreThanOneCodeBlock() throws URISyntaxException {
         try (var asciidoctor = createAsciidoctor(softAssertions)) {
             var file = Paths
                 .get(getClass()

doc-test-tools/src/test/resources/include-with-syntax-parameter-with-link.adoc

@@ -0,0 +1,42 @@
+[.include-with-stream]
+======
+.Run Louvain in stream mode on a named graph.
+[source, cypher, role=noplay]
+----
+CALL gds.louvain.stream(
+  graphName: String,
+  configuration: Map
+)
+YIELD
+  nodeId: Integer,
+  communityId: Integer,
+  intermediateCommunityIds: List of Integer
+----
+
+.Parameters
+[opts="header"]
+|===
+| Name
+| graphName footnote:vital[choose the name wisely]
+| <<configuration-table, configuration>>
+|===
+
+// This table is only here to make sure we will really pick the `.Results` one
+[[configuration-table]]
+.Algorithm specific configuration
+[opts="header",cols="1,1,1m,1,4"]
+|===
+| Name                       | Type     | Default | Optional | Description
+| relationshipWeightProperty | String   | null    | yes      | Relationship Weight.
+| seedProperty               | String   | n/a     | yes      | Seed Property.
+|===
+
+.Results
+[opts="header",cols="1,1,6"]
+|===
+| Name                      | Type      | Description
+| nodeId                    | Integer   | Node ID.
+| communityId               | Integer   | The community ID of the final level.
+| intermediateCommunityIds  | List of Integer | Community IDs for each level. `Null` if `includeIntermediateCommunities` is set to false.
+|===
+======