Merge pull request #382 from marklogic/feature/upgrade-sonar

Upgraded Sonar

Author: rjrudin

CONTRIBUTING.md

@@ -56,18 +56,18 @@ To configure the SonarQube service, perform the following steps:
 7. Click on "Use the global setting" and then "Create project".
 8. On the "Analysis Method" page, click on "Locally".
 9. In the "Provide a token" panel, click on "Generate". Copy the token.
-10. Add `systemProp.sonar.token=your token pasted here` to `gradle-local.properties` in the root of your project, creating
+10. Add `systemProp.sonar.login=your token pasted here` to `gradle-local.properties` in the root of your project, creating
 that file if it does not exist yet.
 
 To run SonarQube, run the following Gradle tasks using Java 17, which will run all the tests with code coverage and 
 then generate a quality report with SonarQube:
 
     ./gradlew test sonar
 
-If you do not add `systemProp.sonar.token` to your `gradle-local.properties` file, you can specify the token via the
+If you do not add `systemProp.sonar.login` to your `gradle-local.properties` file, you can specify the token via the
 following:
 
-    ./gradlew test sonar -Dsonar.token=paste your token here
+    ./gradlew test sonar -Dsonar.login=paste your token here
 
 When that completes, you will see a line like this near the end of the logging:
 
@@ -193,12 +193,16 @@ You will need the connector jar available, so run `./gradlew clean shadowJar` if
 You can then run a test Python program in this repository via the following (again, change the master address as 
 needed); note that you run this outside of PySpark, and `spark-submit` is available after having installed PySpark:
 
-    spark-submit --master spark://NYWHYC3G0W:7077 --jars marklogic-spark-connector/build/libs/marklogic-spark-connector-2.5-SNAPSHOT.jar src/test/python/test_program.py
+    spark-submit --master spark://NYWHYC3G0W:7077 --jars marklogic-spark-connector/build/libs/marklogic-spark-connector-2.5-SNAPSHOT.jar marklogic-spark-connector/src/test/python/test_program.py
 
 You can also test a Java program. To do so, first move the `com.marklogic.spark.TestProgram` class from `src/test/java`
-to `src/main/java`. Then run `./gradlew clean shadowJar` to rebuild the connector jar. Then run the following:
+to `src/main/java`. Then run the following:
 
-    spark-submit --master spark://NYWHYC3G0W:7077 --class com.marklogic.spark.TestProgram marklogic-spark-connector/build/libs/marklogic-spark-connector-2.5-SNAPSHOT.jar
+```
+./gradlew clean shadowJar
+cd marklogic-spark-connector
+spark-submit --master spark://NYWHYC3G0W:7077 --class com.marklogic.spark.TestProgram build/libs/marklogic-spark-connector-2.5-SNAPSHOT.jar
+```
 
 Be sure to move `TestProgram` back to `src/test/java` when you are done. 
 

build.gradle

@@ -1,6 +1,6 @@
 plugins {
   id "java-library"
-  id "org.sonarqube" version "5.1.0.4882"
+  id "org.sonarqube" version "6.0.1.5171"
 }
 
 sonar {

docker-compose.yaml

@@ -30,7 +30,7 @@ services:
 
   # Copied from https://docs.sonarsource.com/sonarqube/latest/setup-and-upgrade/install-the-server/#example-docker-compose-configuration .
   sonarqube:
-    image: sonarqube:10.6.0-community
+    image: sonarqube:lts-community
     depends_on:
       - postgres
     environment:

marklogic-spark-connector/src/main/java/com/marklogic/spark/writer/file/FileUtil.java

@@ -8,7 +8,7 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 
-abstract class FileUtil {
+public interface FileUtil {
 
     static String makePathFromDocumentURI(String documentURI) {
         // Mostly copied from MLCP.
@@ -25,7 +25,4 @@ static String makePathFromDocumentURI(String documentURI) {
             return documentURI;
         }
     }
-
-    private FileUtil() {
-    }
 }

marklogic-spark-langchain4j/src/main/java/com/marklogic/spark/langchain4j/DocumentSplitterFactory.java

@@ -14,9 +14,9 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public abstract class DocumentSplitterFactory {
+public interface DocumentSplitterFactory {
 
-    public static DocumentSplitter makeDocumentSplitter(Context context) {
+    static DocumentSplitter makeDocumentSplitter(Context context) {
         if (context.hasOption(Options.WRITE_SPLITTER_CUSTOM_CLASS)) {
             return makeCustomSplitter(context);
         }
@@ -99,7 +99,4 @@ private static String massageLangchain4jError(Context context, String message) {
         }
         return message;
     }
-
-    private DocumentSplitterFactory() {
-    }
 }

marklogic-spark-langchain4j/src/main/java/com/marklogic/spark/langchain4j/DocumentTextSplitterFactory.java

@@ -13,9 +13,9 @@
 import java.util.Arrays;
 import java.util.Optional;
 
-public abstract class DocumentTextSplitterFactory {
+public interface DocumentTextSplitterFactory {
 
-    public static Optional<DocumentTextSplitter> makeSplitter(Context context) {
+    static Optional<DocumentTextSplitter> makeSplitter(Context context) {
         if (context.hasOption(Options.WRITE_SPLITTER_XPATH)) {
             return Optional.of(makeXmlSplitter(context));
         } else if (context.getProperties().containsKey(Options.WRITE_SPLITTER_JSON_POINTERS)) {
@@ -95,7 +95,4 @@ private static ChunkAssembler makeChunkAssembler(Context context) {
             .build()
         );
     }
-
-    private DocumentTextSplitterFactory() {
-    }
 }

marklogic-spark-langchain4j/src/main/java/com/marklogic/spark/langchain4j/EmbeddingAdderFactory.java

@@ -16,9 +16,9 @@
 import java.util.Optional;
 import java.util.function.Function;
 
-public abstract class EmbeddingAdderFactory {
+public interface EmbeddingAdderFactory {
 
-    public static Optional<EmbeddingAdder> makeEmbedder(Context context, DocumentTextSplitter splitter) {
+    static Optional<EmbeddingAdder> makeEmbedder(Context context, DocumentTextSplitter splitter) {
         Optional<EmbeddingModel> embeddingModel = makeEmbeddingModel(context);
         if (embeddingModel.isPresent()) {
             EmbeddingGenerator embeddingGenerator = makeEmbeddingGenerator(context, embeddingModel.get());
@@ -119,7 +119,4 @@ private static Map<String, String> makeEmbedderOptions(Context context) {
             .forEach(key -> options.put(key.substring(Options.WRITE_EMBEDDER_MODEL_FUNCTION_OPTION_PREFIX.length()), context.getProperties().get(key)));
         return options;
     }
-
-    private EmbeddingAdderFactory() {
-    }
 }

marklogic-spark-langchain4j/src/main/java/com/marklogic/spark/langchain4j/NamespaceContextFactory.java

@@ -10,9 +10,9 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public abstract class NamespaceContextFactory {
+public interface NamespaceContextFactory {
 
-    public static NamespaceContext makeNamespaceContext(Map<String, String> properties) {
+    static NamespaceContext makeNamespaceContext(Map<String, String> properties) {
         Map<String, String> prefixesToNamespaces = new HashMap<>();
         properties.keySet().stream()
             .filter(key -> key.startsWith(Options.XPATH_NAMESPACE_PREFIX))
@@ -23,7 +23,4 @@ public static NamespaceContext makeNamespaceContext(Map<String, String> properti
             });
         return new XPathNamespaceContext(prefixesToNamespaces);
     }
-
-    private NamespaceContextFactory() {
-    }
 }