Merge pull request #23 from OP-TED/feature/add-xpath-api

Feature: Add API for XPath parsing and processing (TEDEFO-2401)

Author: bertrand-lorentz

.gitignore

@@ -1,4 +1,5 @@
 /target/
+.antlr
 .settings
 .project
 .classpath

README.md

@@ -39,6 +39,13 @@ Execute the following on the root folder of this project:
 
     mvn clean install
 
+## Testing
+
+Unit tests are available under `src/test/java/`.
+
+After running the unit tests with `mvn test`, you can generate a coverage report with `mvn jacoco:report`.
+The report is available under `target/site/jacoco/`, in HTML, CSV, and XML format.
+
 
 [^1]: _Copyright 2022 European Union_  
 _Licensed under the EUPL, Version 1.2 or – as soon they will be approved by the European Commission –

pom.xml

@@ -55,6 +55,7 @@
     <maven.compiler.target>${java.version}</maven.compiler.target>
 
     <!-- Versions - Third-party libraries -->
+    <version.antlr4>4.9.3</version.antlr4>
     <version.commons-collections>3.2.2</version.commons-collections>
     <version.commons-io>2.11.0</version.commons-io>
     <version.commons-lang3>3.12.0</version.commons-lang3>
@@ -72,9 +73,11 @@
     <version.slf4j>2.0.3</version.slf4j>
 
     <!-- Versions - Plugins -->
+    <version.build-helper.plugin>3.3.0</version.build-helper.plugin>
     <version.compiler.plugin>3.10.1</version.compiler.plugin>
     <version.gpg.plugin>1.5</version.gpg.plugin>
     <version.install.plugin>2.5.2</version.install.plugin>
+    <version.jacoco.plugin>0.8.10</version.jacoco.plugin>
     <version.javadoc.plugin>3.4.0</version.javadoc.plugin>
     <version.source.plugin>3.2.1</version.source.plugin>
     <version.jar.plugin>3.3.0</version.jar.plugin>
@@ -211,6 +214,11 @@
         <artifactId>jsr305</artifactId>
         <version>${version.jsr305}</version>
       </dependency>
+      <dependency>
+        <groupId>org.antlr</groupId>
+        <artifactId>antlr4-runtime</artifactId>
+        <version>${version.antlr4}</version>
+      </dependency>
       <dependency>
         <groupId>org.jooq</groupId>
         <artifactId>jool</artifactId>
@@ -338,6 +346,10 @@
       <artifactId>jsr305</artifactId>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.antlr</groupId>
+      <artifactId>antlr4-runtime</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.jooq</groupId>
       <artifactId>jool</artifactId>
@@ -367,6 +379,16 @@
             <createChecksum>true</createChecksum>
           </configuration>
         </plugin>
+        <plugin>
+          <groupId>org.antlr</groupId>
+          <artifactId>antlr4-maven-plugin</artifactId>
+          <version>${version.antlr4}</version>
+        </plugin>
+        <plugin>
+          <groupId>org.codehaus.mojo</groupId>
+          <artifactId>build-helper-maven-plugin</artifactId>
+          <version>${version.build-helper.plugin}</version>
+        </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-jar-plugin</artifactId>
@@ -387,13 +409,76 @@
           <artifactId>maven-gpg-plugin</artifactId>
           <version>${version.gpg.plugin}</version>
         </plugin>
+        <plugin>
+          <groupId>org.jacoco</groupId>
+          <artifactId>jacoco-maven-plugin</artifactId>
+          <version>${version.jacoco.plugin}</version>
+        </plugin>
         <plugin>
           <groupId>org.sonatype.plugins</groupId>
           <artifactId>nexus-staging-maven-plugin</artifactId>
           <version>${version.nexus-staging.plugin}</version>
         </plugin>
       </plugins>
     </pluginManagement>
+
+    <plugins>
+      <plugin>
+        <groupId>org.antlr</groupId>
+        <artifactId>antlr4-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>antlr</id>
+            <goals>
+              <goal>antlr4</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>add-source</id>
+            <phase>generate-sources</phase>
+            <goals>
+              <goal>add-source</goal>
+            </goals>
+            <configuration>
+              <sources>
+                <source>${project.build.directory}/generated-sources/antlr4/</source>
+              </sources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
+      <plugin>
+        <groupId>org.jacoco</groupId>
+        <artifactId>jacoco-maven-plugin</artifactId>
+        <configuration>
+          <excludes>
+            <exclude>**/XPath20*.class</exclude>
+          </excludes>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>prepare-agent</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>report</id>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>report</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
   </build>
 
   <profiles>