Merge branch 'zacharysabourin/master/26' into 'master'

feat: Add Jacoco and Sonar dependencies

Closes #26

See merge request !34

README.md

@@ -14,27 +14,35 @@ TODO!!
 
 ## Configuration
 
-To import MaxMind data for usage with this microservice, CSV and binary database versions of MaxMind's GeoLite2 data must be retrieved. This can be done using the script `./bin/maxmind.sh <location>`, with location being the path to where the data MaxMind data should be stored. This will retrieve, extract, and clean up unneeded MaxMind files for use with the microservice. Note that this script uses Unix based commands, and will not work in windows environments unless run through a Unix terminal emulator (like WSL). This requires a license key for MaxMind to be set into your local environment. This can be done by copying the `./config/.env.sample` into the project root as `.env` and updating the value of the variable to be your license key.  
-
-Once the environment variable is available, the import can be run through `make install`. By default, this script installs the maxmind assets in the current project directory under the gitignored `./maxmind` folder. The stack can also be started instead, using `make headless-docker` which starts the API, binding it to port 8080.
+To import MaxMind data for usage with this microservice, CSV and binary database versions of MaxMind's GeoLite2 data must be retrieved. This can be done using the script `./bin/maxmind.sh <location>`, with location being the path to where the data MaxMind data should be stored.. This will retrieve, extract, and clean up unneeded MaxMind files for use with the microservice. Note that this script uses Unix based commands, and will not work in windows environments unless run through a Unix terminal emulator (like WSL). This requires a license key for MaxMind to be set into your local environment. This can be done by copying the `./config/.env.sample` into the project root as `.env` and updating the value of the variable to be your license key.  
 
+Once the environment variable is available, the import can be run through `make setup`. By default, this script installs the maxmind assets in the current project directory under the gitignored `./maxmind` folder. The stack can also be started instead, using `make compile-start` which starts the API, binding it to port 8080.
 
 ## Build
 
-* Development 
+### Development
+
+```bash
+make dev-start
+```
+
+### Build docker container
+
+```bash
+make compile-start
+```
 
-    $ mvn compile quarkus:dev
-   
-* Build docker container
+### Testing
 
-    make headless-docker
-    
-See https://quarkus.io for more information.
+```bash
+mvn test -Declipse.maxmind.root=${PWD}/maxmind
+```
 
+See [https://quarkus.io] for more information.
 
-## Copyright 
+## Copyright
 
-Copyright (c) 2022 Eclipse Foundation and others.
-This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-v20.html,
+Copyright (c) 2022, 2023 Eclipse Foundation and others.
+This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at [http://www.eclipse.org/legal/epl-v20.html],
 
 SPDX-License-Identifier: EPL-2.0

pom.xml

@@ -17,6 +17,12 @@
 		<maven.compiler.target>11</maven.compiler.target>
 		<compiler-plugin.version>3.8.1</compiler-plugin.version>
 		<auto-value.version>1.8.2</auto-value.version>
+		<sonar.sources>src/main</sonar.sources>
+		<sonar.tests>src/test</sonar.tests>
+		<sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
+		<sonar.dynamicAnalysis>reuseReports</sonar.dynamicAnalysis>
+		<sonar.coverage.jacoco.xmlReportPaths>${project.basedir}/target/jacoco-report/jacoco.xml</sonar.coverage.jacoco.xmlReportPaths>
+		<sonar.junit.reportPath>${project.build.directory}/surefire-reports</sonar.junit.reportPath>
 	</properties>
 	<repositories>
 		<repository>
@@ -108,6 +114,11 @@
 			<version>${eclipse-api-version}</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>io.quarkus</groupId>
+			<artifactId>quarkus-jacoco</artifactId>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 
 

src/test/resources/application.properties

+quarkus.jacoco.includes=**/geoip/**/*
\ No newline at end of file