Merge pull request #4 from carboneio/2-fix_json_check

Fix json check and add tests

Author: steevepay

CHANGELOG.md

@@ -1,3 +1,5 @@
+### v1.0.3
+  - Fix #2 - render function: check if the json argument is empty
 
 ### v1.0.2
   - Add license and update setup

README.md

@@ -1,5 +1,5 @@
 # Carbone Render Python SDK
-[![Pypi Package](https://img.shields.io/badge/pypi-1.0.2-brightgreen.svg?cacheSeconds=2592000&logo=python&style=flat-square)](https://pypi.org/project/carbone-sdk)
+[![Pypi Package](https://img.shields.io/badge/pypi-1.0.3-brightgreen.svg?cacheSeconds=2592000&logo=python&style=flat-square)](https://pypi.org/project/carbone-sdk)
 [![Documentation](https://img.shields.io/badge/documentation-yes-blue.svg?style=flat-square)](./API-REFERENCE.md)
 
 > Python SDK to use Carbone Render easily.

carbone_sdk/carbone_sdk.py

@@ -80,7 +80,7 @@ def set_api_version(self, api_version = None):
   def render(self, file_or_template_id = None, json_data = None, payload = ""):
     if file_or_template_id is None:
       raise ValueError('Carbone SDK render error: argument is missing: file_or_template_id')
-    if file_or_template_id is None:
+    if json_data is None:
       raise ValueError('Carbone SDK render error: argument is missing: json_data')
     resp = None
     # 1 - if file_or_template_id is a template_id => render from the template_id

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="carbone-sdk",
-    version="1.0.2",
+    version="1.0.3",
     author="CarboneIO",
     author_email="support@carbone.io",
     description="Carbone Render Python SDK to generate reports easily (PDF, docx, xlsx, ods, odt, ...) from a JSON",

tests/test_carbone_sdk.py

@@ -21,6 +21,7 @@ def test_sdk_default_values(self, csdk):
   def test_init_sdk_error_missing_token(self):
     with pytest.raises(Exception) as e:
       c = carbone_sdk.CarboneSDK()
+    assert e.value.args[0] == 'CarboneSDK: "API access token" is missing'
 
   def test_simple_mock_http_request(self, csdk, requests_mock):
     requests_mock.get(csdk._api_url + "/path", text="content")
@@ -36,6 +37,7 @@ def test_set_access_token(self, csdk):
   def test_set_access_token_error_missing_token(self, csdk):
     with pytest.raises(ValueError) as e:
       csdk.set_access_token()
+    assert e.value.args[0] == 'Carbone SDK set_access_token error: argument is missing: api_token'
 
   def test_set_api_version_int(self, csdk):
     new_version = 3
@@ -47,28 +49,35 @@ def test_set_api_version_string(self, csdk):
     csdk.set_api_version(new_version)
     assert csdk._api_headers["carbone-version"] == new_version
 
+  def test_set_api_version_error_missing_version(self, csdk):
+    with pytest.raises(ValueError) as e:
+      csdk.set_api_version()
+    assert e.value.args[0] == 'Carbone SDK set_api_version error: argument is missing: api_version'
+
 class TestRender:
   def test_render_a_report_error_file_missing(self, csdk):
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError) as e:
       csdk.render()
+    assert e.value.args[0] == 'Carbone SDK render error: argument is missing: file_or_template_id'
 
   def test_render_a_report_error_json_data_missing(self, csdk):
-    with pytest.raises(ValueError):
-      csdk.render()
+    with pytest.raises(ValueError) as e:
+      csdk.render("template_id")
+    assert e.value.args[0] == 'Carbone SDK render error: argument is missing: json_data'
 
   def test_render_a_report_error_from_a_non_existing_template_id(self, csdk, requests_mock):
     fake_template_id = "ThisTemplateIdDoesNotExist"
     requests_mock.post(csdk._api_url + "/render/" + fake_template_id , json={'success': False, 'error': 'Error while rendering template Error: 404 Not Found'})
-    with pytest.raises(Exception):
-      # should return the error "Error while rendering template Error: 404 Not Found"
+    with pytest.raises(Exception) as e:
       csdk.render(fake_template_id, {"data": {"firstname": "john", "lastname": "wick"}})
+    assert e.value.args[0] == 'Carbone SDK render error: Error while rendering template Error: 404 Not Found'
 
   def test_render_a_report_error_from_a_directory(self, csdk, requests_mock):
     fake_template_id = "./tests"
     requests_mock.post(csdk._api_url + "/render/" + fake_template_id , json={'success': False, 'error': 'Error while rendering template Error: 404 Not Found'})
-    with pytest.raises(Exception):
-      # should return the error "failled to generate the template id"
+    with pytest.raises(Exception) as e:
       csdk.render(fake_template_id, {"data": {"firstname": "john", "lastname": "wick"}})
+    assert e.value.args[0] == 'Carbone SDK render error: failled to generate the template id'
 
   def test_render_a_report_from_an_existing_template_id(self, csdk, requests_mock):
     template_id = "0545253258577a632a99065f0572720225f5165cc43db9515e9cef0e17b40114"
@@ -154,13 +163,14 @@ def test_add_template_with_payload(self, csdk, requests_mock):
   def test_add_template_error_missing_args(self, csdk):
     with pytest.raises(ValueError) as e:
       csdk.add_template()
+    assert e.value.args[0] == 'CarboneSDK: add_template method: the argument template_file_name is missing'
 
   def test_add_template_error_with_a_non_existing_file(self, csdk):
-    with pytest.raises(FileNotFoundError) as e:
+    with pytest.raises(FileNotFoundError):
       csdk.add_template("ShouldThrowAnError")
 
   def test_add_template_error_with_directory(self, csdk):
-    with pytest.raises(FileNotFoundError) as e:
+    with pytest.raises(IsADirectoryError):
       csdk.add_template("../tests")
 
 
@@ -176,7 +186,8 @@ def test_get_template(self, csdk, requests_mock):
 
   def test_get_template_error_missing_template_id(self, csdk):
     with pytest.raises(ValueError) as e:
-      csdk.add_template()
+      csdk.get_template()
+    assert e.value.args[0] == 'Carbone SDK get_template error: argument is missing: template_id'
 
 class TestDeleteTemplate:
   def test_delete_template(self, csdk, requests_mock):
@@ -196,6 +207,7 @@ def test_delete_template_error_already_deleted(self, csdk, requests_mock):
   def test_delete_template_error_missing_template_id(self, csdk):
     with pytest.raises(ValueError) as e:
       csdk.delete_template()
+    assert e.value.args[0] == 'Carbone SDK delete_template error: argument is missing: template_id'
 
 class TestRenderReport:
   def test_render_report(self, csdk, requests_mock):
@@ -216,10 +228,12 @@ def test_render_report(self, csdk, requests_mock):
   def test_render_report_error_missing_template_id(self, csdk):
     with pytest.raises(ValueError) as e:
       csdk.render_report()
+    assert e.value.args[0] == 'Carbone SDK render_report error: argument is missing: template_id'
 
   def test_render_report_error_missing_json_data(self, csdk):
     with pytest.raises(ValueError) as e:
       csdk.render_report("template_id")
+    assert e.value.args[0] == 'Carbone SDK render_report error: argument is missing: json_data'
 
 class TestGetReport:
   def test_get_report(self, csdk, requests_mock):
@@ -238,6 +252,7 @@ def test_get_report(self, csdk, requests_mock):
   def test_get_report_error_missing_render_id(self, csdk):
     with pytest.raises(ValueError) as e:
       csdk.get_report()
+    assert e.value.args[0] == 'Carbone SDK get_report error: argument is missing: render_id'
 
 class TestGenerateTemplateID:
   def test_generate_template_id_odt_1(self, csdk):
@@ -265,6 +280,11 @@ def test_generate_template_id_html_2_payload_1(self, csdk):
     res = csdk.generate_template_id(filename_html, "This is a long payload with different characters 1 *5 &*9 %$ 3%&@9 @(( 3992288282 29299 9299929")
     assert res == "70799b421cc9cf75d9112273a8e054c141d484eb8d5988bd006fac83e3990707"
 
+  def test_generate_template_id_error(self, csdk):
+    with pytest.raises(ValueError) as e:
+      csdk.generate_template_id()
+    assert e.value.args[0] == 'Carbone SDK generate_template_id error: argument is missing: template_file_name'
+
 class TestGetReportName:
   def test_get_report_name_from_header(self, csdk):
     expected_report_name = "01EEYYHV0ENQE07JCKW8BD2QRP.odt"