[API-7364] - Add integration tests to CI (#105)

[API-7364] - Tests fixes + CI step for the integration app

Author: viaskal-sift

.circleci/config.yml

@@ -39,8 +39,23 @@ jobs:
           mock-version: 3.0.5
           requests-version: 2.27.1
 
+  run-integration-tests-python3:
+    docker:
+      - image: cimg/python:3.10.2
+    steps:
+      - checkout
+      - run:
+          name: Install the lib and run tests
+          command: | 
+            pip3 install ../project
+            python3 test_integration_app/main.py
+
 workflows:
   build-and-test-wf:
     jobs:
       - build-and-test-python3
       - build-and-test-python2
+      - run-integration-tests-python3:
+          filters:
+            branches:
+              only: master

README.md

@@ -243,3 +243,25 @@ errors from the root dir of the repository:
 
     python -m unittest discover
     python3 -m unittest discover
+
+## Integration testing app
+
+For testing the app with real calls it is possible to run the integration testing app, 
+it makes calls to almost all our public endpoints to make sure the library integrates
+well. At the moment, the app is run on every merge to master
+
+#### How to run it locally
+
+1. Add env variable `ACCOUNT_ID` with the valid account id
+2. Add env variable `API_KEY` with the valid Api Key associated from the account
+3. Run the following under the project root folder
+```
+# uninstall the lib from the local env (if it was installed)
+pip uninstall sift
+
+# install the lib from the local source code
+pip install ../sift-python
+
+# run the app
+python test_integration_app/main.py
+```

test_integration_app/decisions_api/test_decisions_api.py

@@ -10,10 +10,11 @@ class DecisionAPI():
     client = sift.Client(api_key = api_key, account_id = account_id)
     globals.initialize()
     user_id = globals.user_id
+    session_id = globals.session_id
 
     def apply_user_decision(self):
         applyDecisionRequest = {
-            "decision_id"     : "block_user_payment_abuse",
+            "decision_id"     : "integration_app_watch_account_abuse",
             "source"          : "MANUAL_REVIEW",
             "analyst"         : "analyst@example.com",
             "description"     : "User linked to three other payment abusers and ordering high value items"
@@ -32,17 +33,17 @@ def apply_order_decision(self):
 
     def apply_session_decision(self):
         applySessionDecisionRequest = {
-            "decision_id"   : "session_looks_fraud_account_takover",
+            "decision_id"   : "integration_app_watch_account_takeover",
             "source"    : "MANUAL_REVIEW",
             "analyst"   : "analyst@example.com",
             "description"   : "compromised account reported to customer service"
         }
 
-        return self.client.apply_session_decision(self.user_id, "session_id", applySessionDecisionRequest)
+        return self.client.apply_session_decision(self.user_id, self.session_id, applySessionDecisionRequest)
 
     def apply_content_decision(self):
         applyContentDecisionRequest = {
-            "decision_id"    : "content_looks_fraud_content_abuse",
+            "decision_id"    : "integration_app_watch_content_abuse",
             "source"         : "MANUAL_REVIEW",
             "analyst"       : "analyst@example.com",
             "description"    : "fraudulent listing"

test_integration_app/globals.py

@@ -1,4 +1,5 @@
 def initialize(): 
-    global user_id, user_email
+    global user_id, user_email, session_id
     user_id = 'billy_jones_301'
     user_email = 'billjones1@example.com'
+    session_id = 'gigtleqddo84l8cm15qe4il'

test_integration_app/main.py

@@ -1,3 +1,6 @@
+import string
+import random
+
 from events_api import test_events_api
 from decisions_api import test_decisions_api
 from workflows_api import test_workflows_api
@@ -22,7 +25,6 @@ def runAllMethods():
     objPSPMerchant = test_psp_merchant_api.PSPMerchantAPI()
 
     #Events APIs
-
     assert (objUtils.isOK(objEvents.add_item_to_cart()) == True)
     assert (objUtils.isOK(objEvents.add_promotion()) == True)
     assert (objUtils.isOK(objEvents.chargeback()) == True)
@@ -54,48 +56,43 @@ def runAllMethods():
     assert (objUtils.isOK(objEvents.update_password()) == True)
     assert (objUtils.isOK(objEvents.verification()) == True)
     print("Events API Tested")
-    
-    # Decision APIs
 
-    assert (objUtils.isOK(objDecision.apply_user_decision()) == False)
-    assert (objUtils.isOK(objDecision.apply_order_decision()) == False)
-    assert (objUtils.isOK(objDecision.apply_session_decision()) == False)
-    assert (objUtils.isOK(objDecision.apply_content_decision()) == False)
+    # Decision APIs
+    assert (objUtils.isOK(objDecision.apply_user_decision()) == True)
+    assert (objUtils.isOK(objDecision.apply_order_decision()) == True)
+    assert (objUtils.isOK(objDecision.apply_session_decision()) == True)
+    assert (objUtils.isOK(objDecision.apply_content_decision()) == True)
     assert (objUtils.isOK(objDecision.get_user_decisions()) == True)
     assert (objUtils.isOK(objDecision.get_order_decisions()) == True)
     assert (objUtils.isOK(objDecision.get_content_decisions()) == True)
     assert (objUtils.isOK(objDecision.get_session_decisions()) == True)
     assert (objUtils.isOK(objDecision.get_decisions()) == True)
     print("Decision API Tested")
-    
-    # Workflows APIs
 
+    # Workflows APIs
     assert (objUtils.isOK(objWorkflow.synchronous_workflows()) == True)
     print("Workflow API Tested")
-    
-    # Score APIs
 
-    assert (objUtils.isOK(objScore.get_user_score()) == False)
+    # Score APIs
+    assert (objUtils.isOK(objScore.get_user_score()) == True)
     print("Score API Tested")
-    
-    # Verification APIs
 
+    # Verification APIs
     assert (objUtils.isOK(objVerification.send()) == True)
     assert (objUtils.isOK(objVerification.resend()) == True)
     checkResponse = objVerification.check()
     assert (objUtils.isOK(checkResponse) == True)
     assert (checkResponse.body["status"] == 50)
     print("Verification API Tested")
-    
-    # PSP Merchant APIs
 
-    assert (objUtils.isOK(objPSPMerchant.create_merchant()) == True)
-    assert (objUtils.isOK(objPSPMerchant.edit_merchant()) == True)
-    assert (objUtils.isOK(objPSPMerchant.get_a_merchant_profile()) == True)
+    # PSP Merchant APIs
+    merchant_id = 'merchant_id_test_app' + ''.join(random.choices(string.digits, k = 7))
+    assert (objUtils.isOK(objPSPMerchant.create_merchant(merchant_id)) == True)
+    assert (objUtils.isOK(objPSPMerchant.edit_merchant(merchant_id)) == True)
     assert (objUtils.isOK(objPSPMerchant.get_merchant_profiles()) == True)
     assert (objUtils.isOK(objPSPMerchant.get_merchant_profiles(batch_size=10, batch_token=None)) == True)
     print("PSP Merchant API Tested")
-    
-    print("Execution completed")
+
+    print("API Integration tests execution finished")
 
 runAllMethods()

test_integration_app/psp_merchant_api/test_psp_merchant_api.py

@@ -11,10 +11,9 @@ class PSPMerchantAPI():
 
   client = sift.Client(api_key = api_key, account_id = account_id)
 
-  def create_merchant(self):
-    merchant_id = ''.join(random.choices(string.digits, k = 7))    
+  def create_merchant(self, merchant_id):
     merchantProperties={
-      "id": 'merchant_id_' + merchant_id,
+      "id": merchant_id,
       "name": "Wonderful Payments Inc.13",
       "description": "Wonderful Payments payment provider.",
       "address": {
@@ -37,9 +36,9 @@ def create_merchant(self):
     }
     return self.client.create_psp_merchant_profile(merchantProperties)
 
-  def edit_merchant(self):
-    merchantProperties={
-      "id": "merchant_id_01013",
+  def edit_merchant(self, merchant_id):
+    merchantProperties = {
+      "id": merchant_id,
       "name": "Wonderful Payments Inc.13 edit",
       "description": "Wonderful Payments payment provider. edit",
       "address": {
@@ -60,10 +59,10 @@ def edit_merchant(self):
         "score": 10
       }
     }
-    return self.client.update_psp_merchant_profile("merchant_id_01013", merchantProperties)
+    return self.client.update_psp_merchant_profile(merchant_id, merchantProperties)
 
-  def get_a_merchant_profile(self):
-    return self.client.get_a_psp_merchant_profile("merchant_id_01013")
+  def get_a_merchant_profile(self, merchant_id):
+    return self.client.get_a_psp_merchant_profile(merchant_id)
 
   def get_merchant_profiles(self, batch_token = None, batch_size = None):
     return self.client.get_psp_merchant_profiles(batch_token, batch_size)