feat(time): wire up harvest -> toggl converter

Author: thekaveman

compiler_admin/commands/time/convert.py

@@ -1,7 +1,23 @@
 from argparse import Namespace
 
+import pandas as pd
+
 from compiler_admin import RESULT_SUCCESS
+from compiler_admin.services.toggl import INPUT_COLUMNS, convert_to_harvest
+
+
+def _get_source_converter(source):
+    columns = pd.read_csv(source, nrows=0).columns.tolist()
+
+    if set(INPUT_COLUMNS) < set(columns):
+        return convert_to_harvest
+    else:
+        raise NotImplementedError("A converter for the given source data does not exist.")
 
 
 def convert(args: Namespace, *extras):
+    converter = _get_source_converter(args.input)
+
+    converter(args.input, args.output, args.client)
+
     return RESULT_SUCCESS

compiler_admin/main.py

@@ -52,7 +52,14 @@ def main(argv=None):
     time_cmd.set_defaults(func=time)
     time_subcmds = time_cmd.add_subparsers("subcommand", help="The time command to run.")
 
-    add_sub_cmd(time_subcmds, "convert", help="Convert a time report from one format into another.")
+    time_convert = add_sub_cmd(time_subcmds, "convert", help="Convert a time report from one format into another.")
+    time_convert.add_argument(
+        "--input", default=sys.stdin, help="The path to the source data for conversion. Defaults to stdin."
+    )
+    time_convert.add_argument(
+        "--output", default=sys.stdout, help="The path to the file where converted data should be written. Defaults to stdout."
+    )
+    time_convert.add_argument("--client", default=None, help="The name of the client to use in converted data.")
 
     user_cmd = add_sub_cmd(cmd_parsers, "user", help="Work with users in the Compiler org.")
     user_cmd.set_defaults(func=user)

tests/commands/time/__init__.py

@@ -0,0 +1,30 @@
+from argparse import Namespace
+import pytest
+
+from compiler_admin import RESULT_SUCCESS
+from compiler_admin.commands.time.convert import _get_source_converter, convert_to_harvest, convert, __name__ as MODULE
+
+
+@pytest.fixture
+def mock_get_source_converter(mocker):
+    return mocker.patch(f"{MODULE}._get_source_converter")
+
+
+def test_get_source_converter_match(toggl_file):
+    result = _get_source_converter(toggl_file)
+
+    assert result == convert_to_harvest
+
+
+def test_get_source_converter_mismatch(harvest_file):
+    with pytest.raises(NotImplementedError, match="A converter for the given source data does not exist."):
+        _get_source_converter(harvest_file)
+
+
+def test_convert(mock_get_source_converter):
+    args = Namespace(input="input", output="output", client="client")
+    res = convert(args)
+
+    assert res == RESULT_SUCCESS
+    mock_get_source_converter.assert_called_once_with(args.input)
+    mock_get_source_converter.return_value.assert_called_once_with(args.input, args.output, args.client)

tests/commands/time/test_convert.py

@@ -82,6 +82,12 @@ def mock_commands_signout(mock_module_name):
     return mock_module_name("signout")
 
 
+@pytest.fixture
+def mock_commands_time(mock_module_name):
+    """Fixture returns a function that patches the time command function in a given module."""
+    return mock_module_name("time")
+
+
 @pytest.fixture
 def mock_commands_user(mock_module_name):
     """Fixture returns a function that patches the user command function in a given module."""
@@ -167,3 +173,13 @@ def _mock_NamedTemporaryFile(module, readlines=[""], **kwargs):
         return patched
 
     return _mock_NamedTemporaryFile
+
+
+@pytest.fixture
+def harvest_file():
+    return "notebooks/data/harvest-sample.csv"
+
+
+@pytest.fixture
+def toggl_file():
+    return "notebooks/data/toggl-sample.csv"

tests/commands/user/__init__.py

@@ -24,24 +24,14 @@ def mock_google_user_info(mocker):
     return mocker.patch(f"{MODULE}.google_user_info")
 
 
-@pytest.fixture
-def source_data():
-    return "notebooks/data/toggl-sample.csv"
-
-
-@pytest.fixture
-def sample_transformed_data():
-    return "notebooks/data/harvest-sample.csv"
-
-
-def test_convert_to_harvest_mocked(source_data, mock_files, mock_google_user_info):
+def test_convert_to_harvest_mocked(toggl_file, mock_files, mock_google_user_info):
     mock_google_user_info.return_value = {}
 
-    convert_to_harvest(source_data)
+    convert_to_harvest(toggl_file)
 
     mock_files.read_csv.assert_called_once()
     call_args = mock_files.read_csv.call_args
-    assert (source_data,) in call_args
+    assert (toggl_file,) in call_args
     assert call_args.kwargs["usecols"] == INPUT_COLUMNS
     assert call_args.kwargs["parse_dates"] == ["Start date"]
     assert call_args.kwargs["cache_dates"] is True
@@ -52,20 +42,20 @@ def test_convert_to_harvest_mocked(source_data, mock_files, mock_google_user_inf
     assert call_args.kwargs["columns"] == OUTPUT_COLUMNS
 
 
-def test_convert_to_harvest_sample(source_data, sample_transformed_data, mock_google_user_info):
+def test_convert_to_harvest_sample(toggl_file, harvest_file, mock_google_user_info):
     mock_google_user_info.return_value = {}
     output = None
 
     with StringIO() as output_data:
-        convert_to_harvest(source_data, output_data)
+        convert_to_harvest(toggl_file, output_data)
         output = output_data.getvalue()
 
     assert output
     assert isinstance(output, str)
     assert ",".join(OUTPUT_COLUMNS) in output
 
     order = ["Date", "First Name", "Hours"]
-    sample_output_df = pd.read_csv(sample_transformed_data).sort_values(order)
+    sample_output_df = pd.read_csv(harvest_file).sort_values(order)
     output_df = pd.read_csv(StringIO(output)).sort_values(order)
 
     assert set(output_df.columns.to_list()) < set(sample_output_df.columns.to_list())

tests/conftest.py

@@ -1,5 +1,6 @@
 from argparse import Namespace
 import subprocess
+import sys
 
 import pytest
 
@@ -18,6 +19,11 @@ def mock_commands_init(mock_commands_init):
     return mock_commands_init(MODULE)
 
 
+@pytest.fixture
+def mock_commands_time(mock_commands_time):
+    return mock_commands_time(MODULE)
+
+
 @pytest.fixture
 def mock_commands_user(mock_commands_user):
     return mock_commands_user(MODULE)
@@ -65,6 +71,73 @@ def test_main_init_no_username(mock_commands_init):
         assert mock_commands_init.call_count == 0
 
 
+def test_main_time_convert_default(mock_commands_time):
+    main(argv=["time", "convert"])
+
+    mock_commands_time.assert_called_once()
+    call_args = mock_commands_time.call_args.args
+    assert (
+        Namespace(
+            func=mock_commands_time, command="time", subcommand="convert", client=None, input=sys.stdin, output=sys.stdout
+        )
+        in call_args
+    )
+
+
+def test_main_time_convert_client(mock_commands_time):
+    main(argv=["time", "convert", "--client", "client123"])
+
+    mock_commands_time.assert_called_once()
+    call_args = mock_commands_time.call_args.args
+    assert (
+        Namespace(
+            func=mock_commands_time,
+            command="time",
+            subcommand="convert",
+            client="client123",
+            input=sys.stdin,
+            output=sys.stdout,
+        )
+        in call_args
+    )
+
+
+def test_main_time_convert_input(mock_commands_time):
+    main(argv=["time", "convert", "--input", "file.csv"])
+
+    mock_commands_time.assert_called_once()
+    call_args = mock_commands_time.call_args.args
+    assert (
+        Namespace(
+            func=mock_commands_time,
+            command="time",
+            subcommand="convert",
+            client=None,
+            input="file.csv",
+            output=sys.stdout,
+        )
+        in call_args
+    )
+
+
+def test_main_time_convert_output(mock_commands_time):
+    main(argv=["time", "convert", "--output", "file.csv"])
+
+    mock_commands_time.assert_called_once()
+    call_args = mock_commands_time.call_args.args
+    assert (
+        Namespace(
+            func=mock_commands_time,
+            command="time",
+            subcommand="convert",
+            client=None,
+            input=sys.stdin,
+            output="file.csv",
+        )
+        in call_args
+    )
+
+
 def test_main_user_create(mock_commands_user):
     main(argv=["user", "create", "username"])