Fixtestrunningbug (#25)

* Fix minor test bug

* Add unittests

.vscode/launch.json

@@ -10,7 +10,7 @@
             "request": "launch",
             "program": "src/docsismodem/retriever.py",
             "console": "integratedTerminal",
-            "justMyCode": true
+            "justMyCode": false
         }
     ]
 }

.vscode/settings.json

@@ -1,10 +1,13 @@
 {
     "python.linting.enabled": true,
     "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter"
+        "editor.defaultFormatter": "ms-python.python"
     },
     "python.formatting.provider": "none",
-    "python.testing.pytestArgs": [],
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+
 }

setup.cfg

@@ -34,7 +34,7 @@ install_requires =
     python-dateutil==2.8.2
     python-logging-loki==0.3.1
     pytz==2022.7
-    requests==2.28.1
+    requests==2.31.0
     selenium==4.7.2
     rfc3339==6.2
     schedule==1.1.0
@@ -48,4 +48,8 @@ install_requires =
 dev =
     build==1.0.3
     flake8==6.1.0
-    pytest==7.4.2
+    pytest==7.4.2
+    responses==0.23.3
+    flake8-pytest-style==1.7.2
+    flask==2.0.0
+    werkzeug==2.0.0

src/docsismodem/exceptions.py

@@ -0,0 +1,9 @@
+class ModemConnectionError(Exception):
+    def __init__(self, message="An error occurred loging into the modem."):
+        self.message = message
+        super().__init__(self.message)
+
+class ModemCredentialsError(Exception):
+    def __init__(self, message="An error occurred loging into the modem."):
+        self.message = message
+        super().__init__(self.message)

src/docsismodem/modems/technicolor_xb7.py

@@ -1,3 +1,4 @@
+from docsismodem.exceptions import ModemConnectionError, ModemCredentialsError
 from .observablemodem import ObservableModem
 from bs4 import BeautifulSoup
 from datetime import datetime
@@ -90,8 +91,22 @@ def login(self):
             'password': self.config['Modem']['Password']
         }
         loginUrl = "/check.jst"
-
-        self.session.post(self.baseUrl + loginUrl, data=modemAuthentication)
+
+        try:
+            response = self.session.post(self.baseUrl + loginUrl, data=modemAuthentication)
+            if response.status_code == 200:
+                # 200 indicates a login failure
+                msg = "Invalid login credentials"
+                logging.error(msg)
+                raise ModemCredentialsError(msg)
+        except requests.ConnectionError as e:
+            msg = 'Could not connect to modem.'
+            logging.error(msg)
+            raise ModemConnectionError(msg)
+        except requests.exceptions.Timeout:
+            msg = 'Connection to modem timed out.'
+            logging.error(msg)
+            raise ModemConnectionError(msg)
 
     def collectStatus(self):
         self.logger.info("Getting modem status")

tests/mocks.py → tests/test_mocks.py

@@ -3,15 +3,17 @@
         'Bucket': 'testBucket',
         'Org': 'org',
         'Host': 'localhost',
-        'Port': '443',
-        'UseTls': True,
+        'Port': '5000',
+        'UseTls': False,
         'Token': 'token'
     },
     'General': {
         'HostTimezone': 'Pacific/Los_Angeles'
     },
     'Modem': {
-        'Host': '10.0.0.1',
-        'LogTimezone': 'Pacific/Los_Angeles'
+        'Host': 'localhost:5000',
+        'LogTimezone': 'Pacific/Los_Angeles',
+        'Username': 'admin',
+        'Password': 'password'
     }
 }

tests/test_motorolamb8600m.py

@@ -3,7 +3,7 @@
 from docsismodem.modems.observablemodem import ObservableModem
 from docsismodem.modems.observablemodemfactory import ObservableModemFactory
 
-from tests.mocks import config
+from tests.test_mocks import config
 
 class TestMotorolaMB8600:
 

tests/test_netgearcm2000.py

@@ -3,7 +3,7 @@
 from docsismodem.modems.observablemodem import ObservableModem
 from docsismodem.modems.observablemodemfactory import ObservableModemFactory
 
-from tests.mocks import config
+from tests.test_mocks import config
 
 class TestNetgear2000:
 

tests/test_technicolorxb7.py

@@ -1,9 +1,13 @@
 import logging
+
+import pytest
+import responses
+from docsismodem.exceptions import ModemConnectionError, ModemCredentialsError
 from docsismodem.modems.observablemodem import ObservableModem
 from docsismodem.modems.observablemodemfactory import ObservableModemFactory
 from docsismodem.modems.technicolor_xb7 import TechnicolorXB7
 
-from tests.mocks import config
+from tests.test_mocks import config
 
 class TestTechnicolorXB7:
 
@@ -13,3 +17,23 @@ def test_init(self):
         assert isinstance(instance, ObservableModem)
         assert type(instance) is TechnicolorXB7
 
+    @responses.activate
+    def test_succcessful_login(self):
+
+        responses.add(responses.POST, 'http://localhost:5000/check.jst', json={}, status=302)
+
+        instance = ObservableModemFactory.get("TechnicolorXB7", config, logging.getLogger(None))
+        instance.login()
+
+    @responses.activate
+    def test_invalid_login(self):
+        responses.add(responses.POST, 'http://localhost:5000/check.jst', json={}, status=200)
+
+        instance = ObservableModemFactory.get("TechnicolorXB7", config, logging.getLogger(None))
+        with pytest.raises(ModemCredentialsError):
+            instance.login()
+
+    def test_login_unreachable_modem(self):
+        instance = ObservableModemFactory.get("TechnicolorXB7", config, logging.getLogger(None))
+        with pytest.raises(ModemConnectionError):
+            instance.login()

tests/test_touchstonetg3492upcch.py

@@ -3,7 +3,7 @@
 from docsismodem.modems.observablemodemfactory import ObservableModemFactory
 from docsismodem.modems.touchstone_tg3492_upc_ch import TouchstoneTG3492UPCCH
 
-from tests.mocks import config
+from tests.test_mocks import config
 
 class TestTouchstoneTG3492UPCCH: