Extended unit tests

Author: afonsoc12

Dockerfile

@@ -1,6 +1,6 @@
 ARG DOCKER_IMAGE=python:3.9-alpine \
-    USER=nonroot \
-    GROUP=nonroot \
+    USER=coolio \
+    GROUP=coolio \
     UID=1234 \
     GID=4321
 
@@ -38,7 +38,7 @@ RUN mkdir -p /home $XDG_CONFIG_HOME \
     && chown -R $USER:$GROUP /home $XDG_CONFIG_HOME \
     && rm -rf /tmp/* /var/{cache,log}/* /var/lib/apt/lists/*
 
-USER nonroot
+USER $USER
 WORKDIR /home
 
 COPY --from=install-image --chown=$USER:$GROUP /root/.local /home/.local

firefly_cli/__init__.py

@@ -1,26 +1,26 @@
 import sys
 
 from firefly_cli._version import get_versions
+from firefly_cli.api import FireflyAPI
 from firefly_cli.cli import FireflyPrompt
 from firefly_cli.parser import Parser
+from firefly_cli.transaction import Transaction
 
 __version__ = get_versions()["version"]
+del get_versions
 
 
 def _real_main():
 
     if len(sys.argv) > 1:
         args, ffargs = Parser.entrypoint().parse_known_args()
 
-        try:
-            if args.version:
-                FireflyPrompt().onecmd("version")
-            elif args.help:
-                FireflyPrompt().onecmd("help")
-            else:
-                FireflyPrompt().onecmd(" ".join(ffargs))
-        except Exception:
-            raise
+        if args.version:
+            FireflyPrompt().onecmd("version")
+        elif args.help:
+            FireflyPrompt().onecmd("help")
+        else:
+            FireflyPrompt().onecmd(Parser.safe_string(ffargs))
     else:
         FireflyPrompt().cmdloop()
 
@@ -30,7 +30,6 @@ def main():
         _real_main()
     except KeyboardInterrupt:
         print("\nInterrupted by user")
-    except:
+    except Exception:
         # Silence raising exceptions
         raise
-        # pass

firefly_cli/api.py

@@ -26,15 +26,7 @@ def __init__(self, hostname, auth_token, check_connection=True):
             else hostname[:-1]
         )  # Remove trailing backslash
         self.api_url = self.hostname + "/api/v1/" if hostname else self.hostname
-        self.api_test = self._test_api() if check_connection else False
-
-    def _test_api(self):
-        """Tests API connection."""
-        try:
-            _ = self.get_about_user()
-            return True
-        except:
-            return False
+        self.api_test = self.test_api_connection() if check_connection else False
 
     def _post(self, endpoint, payload):
         """Handles general POST requests."""
@@ -51,22 +43,31 @@ def _post(self, endpoint, payload):
 
         return response
 
-    def _get(self, endpoint, params={}, cache=False):
+    def _get(self, endpoint, params={}, cache=False, request_raw=False, timeout=2):
         """Handles general GET requests."""
 
         with self.rc.cache_disabled() if not cache else nullcontext():
             response = self.rc.get(
                 "{}{}".format(self.api_url, endpoint),
                 params=params,
                 headers=self.headers,
+                timeout=timeout,
             )
 
-        return response.json()
+        return response.json() if not request_raw else response
 
-    def get_budgets(self):
-        """Returns budgets of the user."""
+    def test_api_connection(self):
+        """Tests API connection."""
+        try:
+            _ = self.get_about_user()
+            return True
+        except:
+            return False
 
-        return self._get("budgets")
+    def get_about_user(self):
+        """Returns user information."""
+
+        return self._get("about/user")
 
     def get_accounts(
         self, account_type="asset", cache=False, pagination=False, limit=None
@@ -96,6 +97,11 @@ def get_accounts(
 
         return pages
 
+    def get_budgets(self):
+        """Returns budgets of the user."""
+
+        return self._get("budgets")
+
     def get_autocomplete_accounts(self, limit=20):
         """Returns all user accounts."""
         acc_data = self.get_accounts(
@@ -107,15 +113,8 @@ def get_autocomplete_accounts(self, limit=20):
 
         return account_names
 
-    def get_about_user(self):
-        """Returns user information."""
-
-        return self._get("about/user")
-
     def create_transaction(self, transaction: Transaction):
         """Creates a new transaction.
-        data:
-            pd.DataFrame
 
         `Amount, Description, Source account, Destination account, Category, Budget`
         Example:
@@ -127,18 +126,23 @@ def create_transaction(self, transaction: Transaction):
                 -> `5, Large Mocha, Cash, , , UCO Bank`
         """
 
-        trans_data = transaction.to_dict(remove_none=True, api_safe=True)
+        payload = self.payload_formatter(transaction)
 
-        header = {k: v for k, v in trans_data.items() if k.startswith("header__")}
+        return self._post(endpoint="transactions", payload=payload)
+
+    def payload_formatter(self, transaction):
+        trans_data = transaction.to_dict(remove_none=True, api_safe=True)
+        header = {
+            k.replace("header__", ""): v
+            for k, v in trans_data.items()
+            if k.startswith("header__")
+        }
         body = {
             "transactions": [
                 {k: v for k, v in trans_data.items() if not k.startswith("header__")}
             ]
         }
-
-        payload = {**header, **body}
-
-        return self._post(endpoint="transactions", payload=payload)
+        return {**header, **body}
 
     @staticmethod
     def refresh_api(configs):

firefly_cli/transaction.py

@@ -77,6 +77,10 @@ def to_dict(
 
         d = self.__dict__
 
+        # Remove argparse arguments not related to transaction
+        if "bypass_prompt" in d:
+            del d["bypass_prompt"]
+
         if remove_none:
             d = {k: v for k, v in d.items() if v is not None}
 

requirements.txt

@@ -4,13 +4,22 @@ cattrs==1.10.0
 certifi==2022.6.15
 charset-normalizer==2.0.12
 cmd2==2.4.1
+coverage==6.4.2
 idna==3.3
+iniconfig==1.1.1
+packaging==21.3
+pluggy==1.0.0
+py==1.11.0
+pyparsing==3.0.9
 pyperclip==1.8.2
+pytest==7.1.2
 pyxdg==0.28
 requests==2.28.0
 requests-cache==0.9.4
+requests-mock==1.9.3
 six==1.16.0
 tabulate==0.8.9
+tomli==2.0.1
 url-normalize==1.4.3
 urllib3==1.26.9
 wcwidth==0.2.5

test/__init__.py

@@ -1,3 +1,7 @@
 import os
+from test.utils import ensure_project_root
 
-os.environ["XDG_CONFIG_HOME"] = "../.testout"
+os.environ["FIREFLY_CLI_CONFIG"] = "test/test_data/firefly-cli-test.ini"
+
+# Ensure tests are being run from root
+ensure_project_root()

test/conftest.py

@@ -0,0 +1,38 @@
+import pytest
+from requests_cache import CachedSession
+from requests_mock import Adapter
+
+from firefly_cli import FireflyAPI, FireflyPrompt
+from firefly_cli.configs import load_configs
+
+
+@pytest.fixture
+def api(configs):
+    """Fixture that provides a CachedSession that will make mock requests where it would normally
+    make real requests"""
+    api = FireflyAPI(
+        hostname=configs["firefly-cli"]["url"],
+        auth_token=configs["firefly-cli"]["api_token"],
+        check_connection=False,
+    )
+
+    adapter = Adapter()
+
+    session = CachedSession(backend="memory")
+    session.mount("https://", adapter)
+
+    api.rc = session
+
+    yield api
+
+
+@pytest.fixture
+def prompt(api):
+    prompt = FireflyPrompt()
+    prompt.api = api
+    return prompt
+
+
+@pytest.fixture
+def configs():
+    return load_configs()