RCB-596: Sonar instructions. Copyrights. Test coverage.

Author: seth-mg

.gitignore

@@ -75,3 +75,6 @@ target/
 
 settings.json
 *.orig
+
+# Sonar
+.scannerwork/

DEVELOPER.md

@@ -1,5 +1,37 @@
 ## Developer Information
 
+#### Sonar Scanning
+* Uncomment the `sonar.branch.name` line in `sonar-project.properties` and adjust the value to match your branch name.
+* Install the `coverage` module in to your virtual environment.
+  ```
+  virtualenv -p python3 ~/venvs/python-binding-development
+  source ~/venvs/python-binding-development/bin/activate
+  pip install --upgrade pip
+  pip install coverage
+  ```
+* Generate the coverage data.
+  ```
+  coverage run --source=rosette -m pytest
+  ```
+* Check the results locally
+  ```
+  coverage report
+  ```
+* Generate the XML coverage report
+  ```
+  coverage xml
+  ```
+* Push the results to Sonar
+  ```
+  docker run \
+      --rm \
+      -e SONAR_HOST_URL="${sonar_host}" \
+      -e SONAR_LOGIN="${sonar_token}" \
+      -v "$(pwd):/usr/src" \
+      sonarsource/sonar-scanner-cli
+
+  ```
+
 ### Testing
 To test changes you have made to the binding, you can use a pre-configured Docker environment.  This environment will:
 - Compile the binding within the container.

docs/source/conf.py

@@ -47,7 +47,7 @@
 
 # General information about the project.
 project = ''
-copyright = '2019, Basis Technology'
+copyright = '2022, Basis Technology'
 author = 'Basis Technology'
 
 # The version info for the project you're documenting, acts as replacement for

rosette/__init__.py

@@ -1,6 +1,6 @@
 """
 Python client for the Rosette API.
-Copyright (c) 2014-2019 Basis Technology Corporation.
+Copyright (c) 2014-2022 Basis Technology Corporation.
 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

rosette/api.py

@@ -3,7 +3,7 @@
 """
 Python client for the Rosette API.
 
-Copyright (c) 2014-2019 Basis Technology Corporation.
+Copyright (c) 2014-2022 Basis Technology Corporation.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -599,7 +599,7 @@ def set_pool_size(self, new_pool_size):
         if 'https:' in self.service_url:
             self.session.mount('https://', adapter)
         else:
-            self.session.mount('http://', adapter)
+            self.session.mount('http://', adapter) # NOSONAR
 
     def __adjust_concurrency(self, dict_headers):
         if _CONCURRENCY_HEADER in dict_headers and dict_headers[_CONCURRENCY_HEADER] != self.max_pool_size:
@@ -947,12 +947,12 @@ def name_deduplication(self, parameters):
         return EndpointCaller(self, self.endpoints['NAME_DEDUPLICATION']).call(parameters)
 
     def text_embedding(self, parameters):
-        """
+        """ deprecated
         Create an L{EndpointCaller}  to identify text vectors found in the texts
         to which it is applied and call it.
         @type parameters: L{DocumentParameters} or L{str}
         @return: A python dictionary containing the results of text embedding."""
-        return EndpointCaller(self, self.endpoints['TEXT_EMBEDDING']).call(parameters)
+        return self.semantic_vectors(parameters)
 
     def semantic_vectors(self, parameters):
         """

sonar-project.properties

@@ -0,0 +1,4 @@
+sonar.projectKey=rosette-api-python-binding
+sonar.sources=rosette
+sonar.python.coverage.reportPaths=coverage.xml
+#sonar.branch.name=RCB-596-pool-size

tests/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-Copyright (c) 2014-2019 Basis Technology Corporation.
+Copyright (c) 2014-2022 Basis Technology Corporation.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

tests/test_rosette_api.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-Copyright (c) 2014-2019 Basis Technology Corporation.
+Copyright (c) 2014-2022 Basis Technology Corporation.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -202,6 +202,8 @@ def test_the_max_pool_size(json_response, doc_params):
     result = api.language(doc_params)
     assert result["name"] == "Rosette"
     assert api.get_pool_size() == 5
+    api.set_pool_size(11)
+    assert api.get_pool_size() == 11
     httpretty.disable()
     httpretty.reset()
 
@@ -756,3 +758,57 @@ def test_the_similar_terms_endpoint(api, json_response, doc_params):
     assert result["name"] == "Rosette"
     httpretty.disable()
     httpretty.reset()
+
+
+def test_the_deprecated_endpoints(api, json_response, doc_params):
+    """There are three deprecated endpoints.  Exercise them until they are deleted."""
+
+    # TEXT_EMBEDDING calls SEMANTIC_VECTORS
+    httpretty.enable()
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/semantics/vector",
+                           body=json_response, status=200, content_type="application/json")
+
+    result = api.text_embedding(doc_params)
+    assert result["name"] == "Rosette"
+    httpretty.disable()
+    httpretty.reset()
+
+    # MATCHED_NAME calls NAME_SIMILARITY
+    httpretty.enable()
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
+                           body=json_response, status=200, content_type="application/json")
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/name-similarity",
+                           body=json_response, status=200, content_type="application/json")
+
+    name_similarity_params = NameSimilarityParameters()
+
+    name_similarity_params["name1"] = {
+        "text": "Michael Jackson",
+        "language": "eng",
+        "entityType": "PERSON"}
+
+    name_similarity_params["name2"] = {"text": "迈克尔·杰克逊", "entityType": "PERSON"}
+
+    result = api.matched_name(name_similarity_params)
+    assert result["name"] == "Rosette"
+    httpretty.disable()
+    httpretty.reset()
+
+    # TRANSLATED_NAME calls NAME_TRANSLATION
+    httpretty.enable()
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
+                           body=json_response, status=200, content_type="application/json")
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/name-translation",
+                           body=json_response, status=200, content_type="application/json")
+
+    name_translation_params = NameTranslationParameters()
+    name_translation_params["entityType"] = "PERSON"
+    name_translation_params["targetScript"] = "Latn"
+    name_translation_params["name"] = "some data to translate"
+    name_translation_params["targetLanguage"] = "eng"
+
+    result = api.translated_name(name_translation_params)
+    assert result["name"] == "Rosette"
+
+    httpretty.disable()
+    httpretty.reset()