Add a cli interface to choose a configuration (#163)

- [x] add a cli to the webserver to take env variables into account 
- [x] add a cli to the data processing that takes enviromental variable
as a valid source into account
- [x] rework the cli for the reset sql command
- [x] rework the cli for the copying of sql data from one db to another

tests/utils/data_transfer_test.py

@@ -1,6 +1,7 @@
 """Test the transfer functions from mongodb to sql."""
 import random
 import string
+import sys
 from datetime import date
 from typing import Any
 
@@ -8,13 +9,13 @@ import numpy as np
 import pandas as pd
 import pytest
 import sqlalchemy as sa
+from _pytest.monkeypatch import MonkeyPatch
 from pytest_mock import MockerFixture
 from sqlalchemy.engine import Engine
 from sqlalchemy.orm import Session
 
 from aki_prj23_transparenzregister.models.company import CapitalTypeEnum, CurrencyEnum
 from aki_prj23_transparenzregister.utils import data_transfer
-from aki_prj23_transparenzregister.utils.data_transfer import norm_capital
 from aki_prj23_transparenzregister.utils.sql import entities
 
 
@@ -1025,7 +1026,9 @@ def test_add_annual_report_financial_key_error(full_db: Session) -> None:
 @pytest.mark.parametrize("currency", ["€", "EUR"])
 def test_norm_capital_eur(currency: str, capital_type: str) -> None:
     """Tests if eur entries can be converted / normed correctly."""
-    assert norm_capital({"value": 5, "currency": currency, "type": capital_type}) == {
+    assert data_transfer.norm_capital(
+        {"value": 5, "currency": currency, "type": capital_type}
+    ) == {
         "capital_value": 5.0,
         "capital_currency": CurrencyEnum("EUR"),
         "capital_type": CapitalTypeEnum(capital_type),
@@ -1036,7 +1039,7 @@ def test_norm_capital_eur(currency: str, capital_type: str) -> None:
 @pytest.mark.parametrize("currency", ["DM", "DEM"])
 def test_norm_capital_dm(currency: str, capital_type: CapitalTypeEnum) -> None:
     """Tests if dm entries can be converted / normed correctly."""
-    assert norm_capital(
+    assert data_transfer.norm_capital(
         capital={"value": 5, "currency": currency, "type": capital_type}
     ) == {
         "capital_value": 2.56,
@@ -1047,7 +1050,7 @@ def test_norm_capital_dm(currency: str, capital_type: CapitalTypeEnum) -> None:
 
 def test_norm_capital_fail() -> None:
     """Tests if the entry is dropped if it isn't complete."""
-    assert norm_capital({"something": "something"}) == {}  # type: ignore
+    assert data_transfer.norm_capital({"something": "something"}) == {}  # type: ignore
 
 
 @pytest.mark.parametrize(
@@ -1062,3 +1065,30 @@ def test_norm_capital_fail() -> None:
 )
 def test_get_geocodes(zip_code: str | None, results: dict) -> None:
     assert data_transfer.get_geocodes(zip_code) == results
+
+
+def test_transfer_data_cli(monkeypatch: MonkeyPatch) -> None:
+    monkeypatch.setattr(sys, "argv", [sys.argv[0]])
+    with pytest.raises(SystemExit):
+        data_transfer.transfer_data_cli()
+
+
+def test_transfer_data_cli_help(monkeypatch: MonkeyPatch) -> None:
+    monkeypatch.setattr(sys, "argv", [sys.argv[0], "-h"])
+    with pytest.raises(SystemExit):
+        data_transfer.transfer_data_cli()
+
+
+@pytest.mark.parametrize("upper", [True, False])
+def test_transfer_data_cli_env(
+    monkeypatch: MonkeyPatch, upper: bool, mocker: MockerFixture
+) -> None:
+    monkeypatch.setattr(sys, "argv", [sys.argv[0], "ENV" if upper else "env"])
+    mocker.patch(
+        "aki_prj23_transparenzregister.utils.data_transfer.transfer_data", lambda _: _
+    )
+    spy = mocker.spy(data_transfer, "transfer_data")
+
+    # with pytest.raises(KeyError):
+    data_transfer.transfer_data_cli()
+    spy.assert_called_once()

tests/utils/logger_config_test.py

@@ -1,15 +1,21 @@
 """Smoke-test over the logger config."""
+from argparse import ArgumentParser
 from pathlib import Path
 
 import pytest
 
-from aki_prj23_transparenzregister.utils.logger_config import configer_logger
+from aki_prj23_transparenzregister.utils.logger_config import (
+    add_logger_options_to_argparse,
+    configer_logger,
+)
 
 
+@pytest.mark.parametrize("parser", [True, False])
 @pytest.mark.parametrize("path", [None, "test-log.log", ""])
 @pytest.mark.parametrize("upper", [True, False])
-@pytest.mark.parametrize("level", ["info", "debug", "error", "warning"])
+@pytest.mark.parametrize("level", ["info", "debug", "error"])
 def test_configer_logger(
+    parser: bool,
     level: str,
     upper: bool,
     path: Path | str | None,
@@ -17,10 +23,32 @@ def test_configer_logger(
     """Tests the configuration of the logger.
 
     Args:
+        parser: If the arguments should be given via the parser or not.
         level: The log-level to configure.
         upper: If the upper variant of the level should be used.
         path: The path where to save the log.
     """
     if level.upper():
         level = level.upper()
-    configer_logger(level, path)  # type: ignore
+    if parser:
+        args_parser = ArgumentParser()
+        add_logger_options_to_argparse(args_parser)
+        configer_logger(
+            namespace=args_parser.parse_args(
+                [
+                    "--level",
+                    level if level else "",
+                    "--log-path",
+                    str(path) if path else "",
+                ]
+            )
+        )
+    else:
+        configer_logger(level=level, path=path)  # type: ignore
+
+
+def test_add_logger_options_to_argparse() -> None:
+    """A test checking if the ArgumentParser is modified."""
+    args_parser = ArgumentParser()
+
+    add_logger_options_to_argparse(args_parser)

tests/utils/mongo/mongo_test.py

@@ -1,30 +1,12 @@
 """Tests for connecting to the mongodb."""
 from unittest.mock import patch
 
+from aki_prj23_transparenzregister.config.config_template import MongoConnection
 from aki_prj23_transparenzregister.utils.mongo.connector import (
-    MongoConnection,
     MongoConnector,
 )
 
 
-def test_get_conn_string_no_credentials() -> None:
-    """Tests the mongo connection string generation."""
-    conn = MongoConnection("localhost", "", 27017, None, None)
-    assert conn.get_conn_string() == "mongodb://localhost:27017"
-
-
-def test_get_conn_string_no_port_but_credentials() -> None:
-    """Tests the mongo connection string generation."""
-    conn = MongoConnection("localhost", "", None, "admin", "password")
-    assert conn.get_conn_string() == "mongodb+srv://admin:password@localhost"
-
-
-def test_get_conn_simple() -> None:
-    """Tests the mongo connection string generation."""
-    conn = MongoConnection("localhost", "", None, None, None)
-    assert conn.get_conn_string() == "mongodb+srv://localhost"
-
-
 def test_mongo_connector() -> None:
     """Tests the MongoConnector."""
     with patch("pymongo.MongoClient") as mock_mongo_client:

tests/utils/sql/connector_test.py

@@ -1,16 +1,14 @@
 """Tests the sql connector."""
 import os.path
 from collections.abc import Generator
-from typing import Any
 from unittest.mock import Mock, patch
 
 import pytest
-from sqlalchemy.engine import Engine
 
 from aki_prj23_transparenzregister.config.config_providers import JsonFileConfigProvider
 from aki_prj23_transparenzregister.config.config_template import PostgreConnectionString
 from aki_prj23_transparenzregister.utils.sql.connector import (
-    get_pg_engine,
+    get_engine,
     get_session,
     init_db,
 )
@@ -24,7 +22,13 @@ def test_get_engine_pg() -> None:
     ) as mock_create_engine:
         result = "someThing"
         mock_create_engine.return_value = result
-        assert get_pg_engine(conn_args) == result
+        assert get_engine(conn_args) == result
+
+
+def test_get_engine_fail() -> None:
+    """Tests what happens if the wrong type is given to the engine factory."""
+    with pytest.raises(TypeError, match="The type of the configuration is invalid."):
+        get_engine(None)  # type: ignore
 
 
 @pytest.fixture()
@@ -44,29 +48,10 @@ def delete_sqlite_table() -> Generator[str, None, None]:
         os.remove(sqlite_test_path)
 
 
-def test_get_sqlite_init(delete_sqlite_table: str) -> None:
-    """Tests if a sql table file can be initiated."""
-    assert not os.path.exists(delete_sqlite_table)
-    session = get_session(f"sqlite:///{delete_sqlite_table}")
-    init_db(session)
-    session.close()
-    engine = session.bind
-    assert isinstance(engine, Engine)
-    engine.dispose()
-    assert os.path.exists(delete_sqlite_table)
-
-
-@pytest.mark.parametrize("connection", ["faulty-name", 0, 9.2, True])
-def test_get_invalid_connection(connection: Any) -> None:
-    """Tests if an error is thrown on a faulty connections."""
-    with pytest.raises(TypeError):
-        get_session(connection)
-
-
 def test_init_pd_db() -> None:
     """Tests if a pg sql database can be connected and initiated to."""
     with patch(
-        "aki_prj23_transparenzregister.utils.sql.connector.get_pg_engine"
+        "aki_prj23_transparenzregister.utils.sql.connector.get_engine"
     ) as mock_get_engine, patch(
         "aki_prj23_transparenzregister.utils.sql.connector.declarative_base"
     ) as mock_declarative_base:
@@ -77,6 +62,6 @@ def test_init_pd_db() -> None:
         mock_declarative_base.return_value = mock_value
 
         mock_value = Mock(spec=JsonFileConfigProvider)
-        mock_value.get_postgre_connection_string.return_value = ""
+        mock_value.get_sql_connection_string.return_value = ""
 
         init_db(get_session(mock_value))

tests/utils/sql/copy_sql_test.py

@@ -1,13 +1,20 @@
 """Test if the sql db can be copied."""
 import os
+import sys
 from collections.abc import Generator
 
 import pandas as pd
 import pytest
+from _pytest.monkeypatch import MonkeyPatch
 from sqlalchemy.engine import Engine
-from sqlalchemy.orm import Session
+from sqlalchemy.orm import Session, sessionmaker
 
-from aki_prj23_transparenzregister.utils.sql.connector import Base, get_session, init_db
+from aki_prj23_transparenzregister.config.config_template import SQLiteConnectionString
+from aki_prj23_transparenzregister.utils.sql.connector import (
+    Base,
+    get_engine,
+    init_db,
+)
 from aki_prj23_transparenzregister.utils.sql.copy_sql import (
     copy_db_cli,
     transfer_db_function,
@@ -19,7 +26,13 @@ def destination_db() -> Generator[Session, None, None]:
     """Generates a db Session to a sqlite db to copy data to."""
     if os.path.exists("secondary.db"):
         os.remove("secondary.db")
-    db = get_session("sqlite:///secondary.db")
+
+    db = sessionmaker(
+        autocommit=False,
+        autoflush=False,
+        bind=get_engine(SQLiteConnectionString("secondary.db")),
+    )()
+
     init_db(db)
     yield db
     db.close()
@@ -44,13 +57,15 @@ def test_transfer_db(full_db: Session, destination_db: Session) -> None:
         )
 
 
-def test_copy_db_cli_help1() -> None:
+def test_copy_db_cli_help1(monkeypatch: MonkeyPatch) -> None:
     """Tests if the help argument exits the software gracefully."""
-    with pytest.raises(SystemExit):
-        copy_db_cli(["-h"])
+    with monkeypatch.context() as m, pytest.raises(SystemExit):  # noqa: PT012
+        m.setattr(sys, "argv", [sys.argv[0], "-h"])
+        copy_db_cli()
 
 
-def test_copy_db_cli_help2() -> None:
+def test_copy_db_cli_help2(monkeypatch: MonkeyPatch) -> None:
     """Tests if the help argument exits the software gracefully."""
-    with pytest.raises(SystemExit):
-        copy_db_cli(["eskse", "-h", "asdf"])
+    with monkeypatch.context() as m, pytest.raises(SystemExit):  # noqa: PT012
+        m.setattr(sys, "argv", [sys.argv[0], "eskse", "-h", "asdf"])
+        copy_db_cli()