Merge pull request #193 from rosette-api/no-jira-suppress-logger-exception-code-smells-in-examples

seth-mg · web-flow · commit 1808ba0b8ac4 · 2022-10-31T16:58:56.000-05:00
NO-JIRA:  Suppress log-or-rethrow, exception sub-type and use-logger …
diff --git a/CI.Jenkinsfile b/CI.Jenkinsfile
@@ -9,6 +9,11 @@ node ("docker-light") {
         }
         stage("Maven Build") {
             withSonarQubeEnv {
+                mySonarOpts="-Dsonar.login=${env.SONAR_AUTH_TOKEN} -Dsonar.host.url=${env.SONAR_HOST_URL}"
+                 if ("${env.CHANGE_BRANCH}") {
+                     mySonarOpts="$mySonarOpts -Dsonar.pullrequest.key=${env.CHANGE_ID} -Dsonar.pullrequest.base=${env.CHANGE_TARGET} -Dsonar.pullrequest.branch=${env.CHANGE_BRANCH}"
+                }
+                echo("Sonar Options are: $mySonarOpts")
                 sh "docker run --rm \
                        --pull always \
                        --volume ${sourceDir}:/source \
@@ -17,9 +22,7 @@ node ("docker-light") {
                        bash -c \"apt-get update && \
                              apt-get install -y git && \
                              pushd /source && \
-                             /opt/maven-basis/bin/mvn --batch-mode clean install sonar:sonar \
-                                  -Dsonar.login=${env.SONAR_AUTH_TOKEN} \
-                                  -Dsonar.host.url=${env.SONAR_HOST_URL}\""
+                             /opt/maven-basis/bin/mvn --batch-mode clean install sonar:sonar $mySonarOpts\""
             }
         }
         slack(true)
diff --git a/examples/src/main/java/com/basistech/rosette/examples/AddressSimilarityExample.java b/examples/src/main/java/com/basistech/rosette/examples/AddressSimilarityExample.java
@@ -29,6 +29,7 @@
 /**
  * Example which demonstrates address similarity
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class AddressSimilarityExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/CategoriesExample.java b/examples/src/main/java/com/basistech/rosette/examples/CategoriesExample.java
@@ -30,6 +30,7 @@
  * Gets QAG categories (http://www.iab.net/QAGInitiative/overview/taxonomy) of a web page document
  * located at http://www.basistech.com/about
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class CategoriesExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/EntitiesExample.java b/examples/src/main/java/com/basistech/rosette/examples/EntitiesExample.java
@@ -27,6 +27,7 @@
 /**
  * Example which demonstrates the entity extraction api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class EntitiesExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/ExampleBase.java b/examples/src/main/java/com/basistech/rosette/examples/ExampleBase.java
@@ -25,6 +25,7 @@
 /**
  * Provides examples on how to use the {@link com.basistech.rosette.api.HttpRosetteAPI HttpRosetteAPI}
  */
+@SuppressWarnings("java:S106")
 public abstract class ExampleBase {
     private static final String KEY_PROP_NAME = "rosette.api.key";
     private static final String URL_PROP_NAME = "rosette.api.altUrl";
diff --git a/examples/src/main/java/com/basistech/rosette/examples/InfoExample.java b/examples/src/main/java/com/basistech/rosette/examples/InfoExample.java
@@ -23,6 +23,7 @@
 /**
  * Example which demonstrates the top level info api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class InfoExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/LanguageExample.java b/examples/src/main/java/com/basistech/rosette/examples/LanguageExample.java
@@ -27,6 +27,7 @@
 /**
  * Example which demonstrates the language detection api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class LanguageExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/LanguageMultilingualExample.java b/examples/src/main/java/com/basistech/rosette/examples/LanguageMultilingualExample.java
@@ -27,6 +27,7 @@
 /**
  * Example which demonstrates the language detection api with the multilingual option.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class LanguageMultilingualExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/MorphologyCompleteExample.java b/examples/src/main/java/com/basistech/rosette/examples/MorphologyCompleteExample.java
@@ -28,6 +28,7 @@
 /**
  * Example which demonstrates the complete morphology api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class MorphologyCompleteExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/MorphologyCompoundComponentsExample.java b/examples/src/main/java/com/basistech/rosette/examples/MorphologyCompoundComponentsExample.java
@@ -29,6 +29,7 @@
 /**
  * Example which demonstrates the decompounding api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class MorphologyCompoundComponentsExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/MorphologyHanReadingsExample.java b/examples/src/main/java/com/basistech/rosette/examples/MorphologyHanReadingsExample.java
@@ -28,6 +28,7 @@
 /**
  * Example which demonstrates the han readings api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class MorphologyHanReadingsExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/MorphologyLemmasExample.java b/examples/src/main/java/com/basistech/rosette/examples/MorphologyLemmasExample.java
@@ -28,6 +28,7 @@
 /**
  * Example which demonstrates the lemmas api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class MorphologyLemmasExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/MorphologyPartsOfSpeechExample.java b/examples/src/main/java/com/basistech/rosette/examples/MorphologyPartsOfSpeechExample.java
@@ -28,6 +28,7 @@
 /**
  * Example which demonstrates the part-of-speech api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class MorphologyPartsOfSpeechExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/NameDeduplicationExample.java b/examples/src/main/java/com/basistech/rosette/examples/NameDeduplicationExample.java
@@ -30,6 +30,7 @@
 /**
  * Example which demonstrates name deduplication.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class NameDeduplicationExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/NameSimilarityExample.java b/examples/src/main/java/com/basistech/rosette/examples/NameSimilarityExample.java
@@ -29,6 +29,7 @@
 /**
  * Example which demonstrates name similarity.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class NameSimilarityExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/NameTranslationExample.java b/examples/src/main/java/com/basistech/rosette/examples/NameTranslationExample.java
@@ -27,6 +27,7 @@
 /**
  * Example which demonstrates the name translation api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class NameTranslationExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/PingExample.java b/examples/src/main/java/com/basistech/rosette/examples/PingExample.java
@@ -23,6 +23,7 @@
 /**
  * Example which demonstrates the ping api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class PingExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/RelationshipsExample.java b/examples/src/main/java/com/basistech/rosette/examples/RelationshipsExample.java
@@ -27,6 +27,7 @@
 /**
  * Example which demonstrates the relationships extraction api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class RelationshipsExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/SemanticVectorsExample.java b/examples/src/main/java/com/basistech/rosette/examples/SemanticVectorsExample.java
@@ -27,6 +27,7 @@
 /**
  * Example which demonstrates semantic-vectors.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class SemanticVectorsExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/SentencesExample.java b/examples/src/main/java/com/basistech/rosette/examples/SentencesExample.java
@@ -26,6 +26,7 @@
 /**
  * Example which demonstrates the sentence detection api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class SentencesExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/SentimentExample.java b/examples/src/main/java/com/basistech/rosette/examples/SentimentExample.java
@@ -32,6 +32,7 @@
 /**
  * Example which demonstrates the sentiment api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class SentimentExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/SimilarTermsExample.java b/examples/src/main/java/com/basistech/rosette/examples/SimilarTermsExample.java
@@ -30,6 +30,7 @@
 /**
  * Example which demonstrates the similar terms api
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class SimilarTermsExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/SyntaxDependenciesExample.java b/examples/src/main/java/com/basistech/rosette/examples/SyntaxDependenciesExample.java
@@ -26,6 +26,7 @@
 /**
  * Example which demonstrates the syntax dependencies endpoint of the Rosette api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class SyntaxDependenciesExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/examples/src/main/java/com/basistech/rosette/examples/TokensExample.java b/examples/src/main/java/com/basistech/rosette/examples/TokensExample.java
@@ -26,6 +26,7 @@
 /**
  * Example which demonstrates the tokens api.
  */
+@SuppressWarnings({"java:S1166", "java:S2221", "java:S106"})
 public final class TokensExample extends ExampleBase {
     public static void main(String[] args) {
         try {
diff --git a/json/src/test/java/com/basistech/rosette/apimodel/DocumentRequestTest.java b/json/src/test/java/com/basistech/rosette/apimodel/DocumentRequestTest.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2022 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basistech.rosette.apimodel;
+
+import org.junit.jupiter.api.Test;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class DocumentRequestTest {
+
+    @Test
+    void getContentString() {
+        String content = "expected";
+        DocumentRequest<EntitiesOptions> request = DocumentRequest.<EntitiesOptions>builder()
+                .content(content)
+                .build();
+        assertEquals(content, request.getContent());
+        assertEquals(content, request.getRawContent());
+        assertNull(request.getContentBytes());
+    }
+
+    @Test
+    void getContentBytes() {
+        String json = "{\"content\": \"My JSON content.\", \"language\": \"eng\"}";
+        byte[] content = json.getBytes(StandardCharsets.UTF_8);
+        DocumentRequest<EntitiesOptions> request = DocumentRequest.<EntitiesOptions>builder()
+                .content(content, "application/json")
+                .build();
+
+        var actualRawContentInputStream = (ByteArrayInputStream) request.getRawContent();
+        var actualRawContent = actualRawContentInputStream.readAllBytes();
+
+        assertArrayEquals(content, actualRawContent);
+        assertNull(request.getContent());
+    }
+
+    @Test
+    void getContentInputStream() {
+        InputStream content = new ByteArrayInputStream("expected".getBytes(StandardCharsets.UTF_8));
+        DocumentRequest<EntitiesOptions> request = DocumentRequest.<EntitiesOptions>builder()
+                .content(content, "text/plain")
+                .build();
+        assertEquals(content, request.getContentBytes());
+        assertNull(request.getContent());
+        assertEquals(content, request.getRawContent());
+    }
+}
diff --git a/json/src/test/java/com/basistech/rosette/apimodel/EntitiesOptionsTest.java b/json/src/test/java/com/basistech/rosette/apimodel/EntitiesOptionsTest.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2022 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basistech.rosette.apimodel;
+
+import org.junit.jupiter.api.Test;
+
+import static com.basistech.rosette.apimodel.EntitiesOptions.DEFAULT;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class EntitiesOptionsTest {
+
+    @Test
+    void builderDefaults() {
+        var entitiesOptions = DEFAULT;
+        assertNotNull(entitiesOptions);
+
+        assertFalse(entitiesOptions.getCalculateConfidence());
+        assertFalse(entitiesOptions.getCalculateSalience());
+        assertTrue(entitiesOptions.getLinkEntities());
+        assertEquals("statistical", entitiesOptions.getModelType());
+        assertFalse(entitiesOptions.getEnableStructuredRegion());
+    }
+}
diff --git a/json/src/test/java/com/basistech/rosette/apimodel/SentimentOptionsTest.java b/json/src/test/java/com/basistech/rosette/apimodel/SentimentOptionsTest.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2022 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basistech.rosette.apimodel;
+
+import org.junit.jupiter.api.Test;
+
+import static com.basistech.rosette.apimodel.SentimentOptions.DEFAULT;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+class SentimentOptionsTest {
+
+    @Test
+    void builderDefaults() {
+        var sentimentOptions = DEFAULT;
+        assertNotNull(sentimentOptions);
+
+        assertFalse(sentimentOptions.getCalculateEntityConfidence());
+        assertFalse(sentimentOptions.getCalculateEntitySalience());
+    }
+}
