fix(messaging): return a specific error template if API response' code or description are missing

Author: KaiSchwarz-cnic

hexonet/apiconnector/responseparser.py

@@ -39,9 +39,6 @@ def parse(raw):
             r['PROPERTY'][prop].append(value)
         else:
             r[attr.upper()] = value
-
-    if 'DESCRIPTION' not in r:
-        r['DESCRIPTION'] = ""
     return r
 
 

hexonet/apiconnector/responsetemplate.py

@@ -39,6 +39,10 @@ def __init__(self, response=""):
             #: Holds the response as hash
             self.__hash = RP.parse(self.__raw)
 
+        if ('CODE' not in self.__hash) or ('DESCRIPTION' not in self.__hash):
+            self.__raw = '[RESPONSE]\r\nCODE=423\r\nDESCRIPTION=Invalid API response. Contact Support\r\nEOF\r\n'
+            self.__hash = RP.parse(self.__raw)
+
     def getCode(self):
         """
         Returns the API response code as integer

hexonet/apiconnector/responsetemplatemanager.py

@@ -33,6 +33,7 @@ def __new__(self):
             "error": rtm.generateTemplate("421", "Command failed due to server error. Client should try again"),
             "expired": rtm.generateTemplate("530", "SESSION NOT FOUND"),
             "httperror": rtm.generateTemplate("421", "Command failed due to HTTP communication error"),
+            "invalid": rtm.generateTemplate("423", "Invalid API response. Contact Support"),
             "unauthorized": rtm.generateTemplate("530", "Unauthorized"),
         }
         return rtm

tests/test_apiclient.py

@@ -4,10 +4,11 @@
 import pytest
 import platform
 
+rtm = RTM()
+
 
 def test_apiclientmethods():
     cl = AC()
-    rtm = RTM.getInstance()
     rtm.addTemplate(
         'login200',
         '[RESPONSE]\r\nPROPERTY[SESSION][0]=h8JLZZHdF2WgWWXlwbKWzEG3XrzoW4y' +

tests/test_response.py

@@ -4,7 +4,7 @@
 
 
 def test_responsemethods():
-    rtm = RTM.getInstance()
+    rtm = RTM()
     rtm.addTemplate(
         'listP0',
         '[RESPONSE]\r\nPROPERTY[TOTAL][0]=2701\r\nPROPERTY[FIRST][0]=0\r\nP' +

tests/test_responseparser.py

@@ -4,16 +4,12 @@
 
 
 def test_rpmethods():
-    rtm = RTM.getInstance()
+    rtm = RTM()
     rtm.addTemplate(
         'OK',
         rtm.generateTemplate('200', 'Command completed successfully')
     )
 
-    # #.parse()
-    plain = re.sub(r'/\r\nDESCRIPTION=/', '', rtm.generateTemplate('421', ''))
-    assert RP.parse(plain)["DESCRIPTION"] is ""
-
     # #.serialize()
     # [w/ PROPERTY]
     r = rtm.getTemplate('OK').getHash()

tests/test_responsetemplate.py

@@ -2,6 +2,11 @@
 
 
 def test_responsetemplatemethods():
+    # check invalid api response
+    tpl = ResponseTemplate("[RESPONSE]\r\nqueuetime=0\r\nEOF\r\n")
+    assert tpl.getCode() == 423
+    assert tpl.getDescription() == "Invalid API response. Contact Support"
+
     descr = "Empty API response. Probably unreachable API end point"
     # check instance [raw empty string]
     tpl = ResponseTemplate()

tests/test_responsetemplatemanager.py

@@ -4,13 +4,13 @@
 
 def test_rtmmethods():
     # #.getTemplate()
-    rtm = RTM.getInstance()
+    rtm = RTM()
     tpl = rtm.getTemplate('IwontExist')
     assert tpl.getCode() == 500
     assert tpl.getDescription() == 'Response Template not found'
 
     # #.getTemplates()
-    defaultones = sorted(['404', '500', 'error', 'httperror', 'empty', 'unauthorized', 'expired'])
+    defaultones = sorted(['404', '500', 'error', 'httperror', 'invalid', 'empty', 'unauthorized', 'expired'])
     availableones = sorted(rtm.getTemplates().keys())
     assert defaultones == availableones