Added unit/integration tests for 6 code examples (#114)

* added tests

* fixed linter errors and updated tests

Author: RomanBachaloSigmaSoftware

app/eSignature/examples/eg008_create_template.py

@@ -18,7 +18,11 @@ def get_args():
         return {
             "account_id": session["ds_account_id"],
             "base_path": session["ds_base_path"],
-            "access_token": session["ds_access_token"]
+            "access_token": session["ds_access_token"],
+            "template_args": {
+                "doc_file": path.join(demo_docs_path, doc_file),
+                "template_name": template_name
+            }
         }
 
     @classmethod
@@ -44,7 +48,7 @@ def worker(cls, args):
 
             # Template not found -- so create it
             # 2. create the template
-            template_req_object = cls.make_template_req()
+            template_req_object = cls.make_template_req(args["template_args"])
             res = templates_api.create_template(account_id=args["account_id"], envelope_template=template_req_object)
             template_id = res.template_id
             results_template_name = res.name
@@ -58,15 +62,15 @@ def worker(cls, args):
         }
 
     @classmethod
-    def make_template_req(cls):
+    def make_template_req(cls, args):
         """Creates template req object"""
 
         # document 1 (pdf)
         #
         # The template has two recipient roles.
         # recipient 1 - signer
         # recipient 2 - cc
-        with open(path.join(demo_docs_path, doc_file), "rb") as file:
+        with open(args["doc_file"], "rb") as file:
             content_bytes = file.read()
         base64_file_content = base64.b64encode(content_bytes).decode("ascii")
 
@@ -191,7 +195,7 @@ def make_template_req(cls):
             documents=[document], email_subject="Please sign this document",
             recipients=Recipients(signers=[signer], carbon_copies=[cc]),
             description="Example template created via the API",
-            name=template_name,
+            name=args["template_name"],
             shared="false",
             status="created"
         )

app/eSignature/examples/eg016_set_tab_values.py

@@ -23,6 +23,7 @@ def get_args():
             "signer_name": signer_name,
             "signer_client_id": signer_client_id,
             "ds_return_url": url_for("ds.ds_return", _external=True),
+            "doc_file": path.join(demo_docs_path, DS_CONFIG["doc_salary_docx"])
         }
         args = {
             "account_id": session["ds_account_id"],
@@ -87,7 +88,7 @@ def make_envelope(cls, args):
         #
         # The envelope has one recipient:
         # recipient 1 - signer
-        with open(path.join(demo_docs_path, DS_CONFIG["doc_salary_docx"]), "rb") as file:
+        with open(args["doc_file"], "rb") as file:
             content_bytes = file.read()
         base64_file_content = base64.b64encode(content_bytes).decode("ascii")
 

app/eSignature/examples/eg031_bulk_send.py

@@ -30,6 +30,7 @@ def get_args():
             "account_id": session["ds_account_id"],  # Represents your {ACCOUNT_ID}
             "base_path": session["ds_base_path"],
             "access_token": session["ds_access_token"],  # Represents your {ACCESS_TOKEN}
+            "doc_pdf": path.join(demo_docs_path, DS_CONFIG["doc_pdf"]),
             "signers": [
                 {
                     "signer_name": signer_name_1,
@@ -78,7 +79,7 @@ def worker(cls, args):
         # Create an envelope
         # Step 4-1 start
         envelope_api = EnvelopesApi(api_client)
-        envelope_definition = cls.make_draft_envelope()
+        envelope_definition = cls.make_draft_envelope(args["doc_pdf"])
         envelope = envelope_api.create_envelope(account_id=args["account_id"], envelope_definition=envelope_definition)
         envelope_id = envelope.envelope_id
         # Step 4-1 end
@@ -158,13 +159,13 @@ def create_bulk_sending_list(cls, args):
 
     # Step 4-2 start
     @classmethod
-    def make_draft_envelope(cls):
+    def make_draft_envelope(cls, doc_pdf):
         """
             Creates the envelope
         """
 
         # Open the example file
-        with open(path.join(demo_docs_path, DS_CONFIG["doc_pdf"]), "rb") as file:
+        with open(doc_pdf, "rb") as file:
             content_bytes = file.read()
         base64_file_content = base64.b64encode(content_bytes).decode("ascii")
 

app/rooms/examples/eg006_create_external_form_fill_session.py

@@ -85,10 +85,10 @@ def worker(args):
         # Step 1. Create an API client with headers
         api_client = create_rooms_api_client(access_token=args["access_token"])
 
-        request_body=ExternalFormFillSessionForCreate(
+        request_body = ExternalFormFillSessionForCreate(
             room_id=args['room_id'],
             form_id=args['form_id'],
-            x_frame_allowed_url = args['x_frame_allowed_url']
+            x_frame_allowed_url=args['x_frame_allowed_url']
         )
 
         # Step 2. Create an external form fill session

app/tests/click_tests.py

@@ -0,0 +1,60 @@
+import datetime
+import unittest
+
+from app.click.examples.eg001_create_clickwrap import Eg001CreateClickwrapController
+from app.click.examples.eg002_activate_clickwrap import Eg002ActivateClickwrapController
+from .test_helper import TestHelper, CONFIG, ApiType
+
+
+class ClickTesting(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        results = TestHelper.authenticate([ApiType.CLICK.value])
+
+        cls.access_token = results["access_token"]
+        cls.account_id = results["account_id"]
+        cls.base_path = results["base_path"]
+
+    def test_create_clickwrap_worker(self):
+        args = {
+            "account_id": self.account_id,
+            "access_token": self.access_token,
+            "clickwrap_name": f"{CONFIG['clickwrap_name']}_{int(datetime.datetime.utcnow().timestamp())}"
+        }
+
+        results = Eg001CreateClickwrapController.worker(args)
+
+        self.assertIsNotNone(results)
+        self.assertIsNotNone(results.clickwrap_id)
+
+    def test_activate_clickwrap_worker(self):
+        args = {
+            "account_id": self.account_id,
+            "base_path": self.base_path,
+            "access_token": self.access_token
+        }
+        results = Eg002ActivateClickwrapController.get_inactive_clickwraps(args)
+        clickwrap = results.clickwraps[0]
+
+        clickwrap_args = f"{{\"clickwrap_id\": \"{clickwrap.clickwrap_id}\",\"version_number\": \"{clickwrap.version_number}\"}}"
+        args["clickwrap"] = clickwrap_args
+
+        results = Eg002ActivateClickwrapController.worker(args)
+
+        self.assertIsNotNone(results)
+        self.assertEqual(results.status, "active")
+
+    def test_activate_clickwrap_get_inactive_clickwraps(self):
+        args = {
+            "account_id": self.account_id,
+            "base_path": self.base_path,
+            "access_token": self.access_token
+        }
+
+        results = Eg002ActivateClickwrapController.get_inactive_clickwraps(args)
+
+        self.assertIsNotNone(results)
+
+
+if __name__ == '__main__':
+    unittest.main()