A couple more tests

Author: ConsoleCatzirl

mips_api/__init__.py

@@ -616,7 +616,7 @@ def process_balance(bal_dict, coa_dict):
     # check for success
     if "executionResult" not in bal_dict:
         LOG.error(f"No execution result found: '{bal_dict}'")
-        raise KeyError("No 'executionResult' found")
+        raise KeyError("No 'executionResult' key found")
 
     result = bal_dict["executionResult"]
     if result != "SUCCESS":
@@ -629,7 +629,8 @@ def process_balance(bal_dict, coa_dict):
     _detail = []
     for k, v in bal_dict["extraInformation"].items():
         if k != "Level1":
-            LOG.info(f"Unexpected key (not 'Level1'): {k}")
+            LOG.error(f"Unexpected key (not 'Level1'): {k}")
+            raise KeyError("No 'Level1' key found")
         else:
             _detail = v
 
@@ -669,6 +670,7 @@ def process_balance(bal_dict, coa_dict):
         name = None
         if k not in coa_dict:
             LOG.error(f"Key {k} not found in chart of accounts")
+            LOG.debug(f"List of keys: {coa_dict.keys()}")
             name = k
         else:
             name = coa_dict[k]
@@ -755,39 +757,46 @@ def lambda_handler(event, context):
         show_no_program = _param_show_no_program_bool(params)
         show_other = _param_show_other_bool(params)
 
-        # Process the chart of accounts from MIP, it's used in all cases
-        raw_chart = chart_cache(
-            mip_org,
-            ssm_secrets,
-            s3_bucket,
-            s3_chart_path,
-            hide_inactive,
-        )
-        LOG.debug(f"Raw chart data: {raw_chart}")
-        coa_chart = process_chart(
-            raw_chart,
-            omit_codes_list,
-            priority_codes,
-            hide_inactive,
-            code_other,
-            show_other,
-            code_no_program,
-            show_no_program,
-        )
-
         # parse the path and return appropriate data
         if "path" in event:
             event_path = event["path"]
 
             if event_path == api_routes["ApiTrialBalances"]:
+                raw_chart = chart_cache(
+                    mip_org,
+                    ssm_secrets,
+                    s3_bucket,
+                    s3_chart_path,
+                    False,
+                )
+                LOG.debug(f"Raw chart data: {raw_chart}")
+
                 # Process current balances
                 raw_bal = balance_cache(
                     mip_org, ssm_secrets, s3_bucket, s3_balance_path
                 )
-                bal_csv = format_balance(raw_bal, coa_chart)
+                bal_csv = format_balance(raw_bal, raw_chart)
 
                 return _build_return_text(200, bal_csv)
             else:
+                raw_chart = chart_cache(
+                    mip_org,
+                    ssm_secrets,
+                    s3_bucket,
+                    s3_chart_path,
+                    hide_inactive,
+                )
+                LOG.debug(f"Raw chart data: {raw_chart}")
+                coa_chart = process_chart(
+                    raw_chart,
+                    omit_codes_list,
+                    priority_codes,
+                    hide_inactive,
+                    code_other,
+                    show_other,
+                    code_no_program,
+                    show_no_program,
+                )
 
                 if event_path == api_routes["ApiChartOfAccounts"]:
                     # conditionally filter the output

tests/unit/test_handler.py

@@ -149,6 +149,17 @@
     ]
 }
 
+mock_balance_empty = {}
+
+mock_balance_invalid1 = {
+    "executionResult": "INVALID",
+}
+
+mock_balance_invalid2 = {
+    "executionResult": "SUCCESS",
+    "extraInformation": {"foo": "bar"},
+}
+
 mock_balance_success = {
     "executionResult": "SUCCESS",
     "extraInformation": {
@@ -163,7 +174,7 @@
                 "DBDETAIL_SUM_POSTEDAMT": mock_balance_start,
                 "DBDETAIL_SUM_SEGMENT_N0": "",
                 "DBDETAIL_SUM_SEGMENT_N1": "",
-                "DBDETAIL_SUM_SEGMENT_N2": "123456",
+                "DBDETAIL_SUM_SEGMENT_N2": "12345600",
                 "DBDETAIL_SUM_SEGMENT_N3": "",
                 "DBDETAIL_SUM_SEGMENT_N4": "",
                 "DBDETAIL_SUM_SEGMENT_N5": "",
@@ -180,7 +191,7 @@
                 "DBDETAIL_SUM_POSTEDAMT": mock_balance_activity,
                 "DBDETAIL_SUM_SEGMENT_N0": "",
                 "DBDETAIL_SUM_SEGMENT_N1": "",
-                "DBDETAIL_SUM_SEGMENT_N2": "123456",
+                "DBDETAIL_SUM_SEGMENT_N2": "12345600",
                 "DBDETAIL_SUM_SEGMENT_N3": "",
                 "DBDETAIL_SUM_SEGMENT_N4": "",
                 "DBDETAIL_SUM_SEGMENT_N5": "",
@@ -197,7 +208,7 @@
                 "DBDETAIL_SUM_POSTEDAMT": mock_balance_end,
                 "DBDETAIL_SUM_SEGMENT_N0": "",
                 "DBDETAIL_SUM_SEGMENT_N1": "",
-                "DBDETAIL_SUM_SEGMENT_N2": "123456",
+                "DBDETAIL_SUM_SEGMENT_N2": "12345600",
                 "DBDETAIL_SUM_SEGMENT_N3": "",
                 "DBDETAIL_SUM_SEGMENT_N4": "",
                 "DBDETAIL_SUM_SEGMENT_N5": "",
@@ -345,7 +356,7 @@
         "EndBalance",
     ],
     [
-        "123456",
+        "12345600",
         "Program Part A",
         expected_start_date,
         expected_end_date,
@@ -356,7 +367,7 @@
 ]
 
 expected_balance_csv = f"""AccountNumber,AccountName,PeriodStart,PeriodEnd,StartBalance,Activity,EndBalance\r
-123456,Program Part A,{expected_start_date},{expected_end_date},{mock_balance_start},{mock_balance_activity},{mock_balance_end}\r
+12345600,Program Part A,{expected_start_date},{expected_end_date},{mock_balance_start},{mock_balance_activity},{mock_balance_end}\r
 """
 
 # mock query-string parameters
@@ -509,21 +520,18 @@ def test_bad_secrets(mocker):
 
 def test_requests(mocker, requests_mock):
     """
-    Test getting chart of accounts from upstream API
+    Test _chart_requests and _balance_requests
 
     Relies on `requests-mock.Mocker` fixture to inject mock `requests` responses.
     Because requests-mock creates a requests transport adapter, responses are
-    global and not thread-safe. Run tests sequentially to maintain control of
-    response order.
+    global (across all tests). Run all related assertions sequentially to maintain
+    control of the response order.
     """
 
     # inject mock responses into `requests`
     login_mock = requests_mock.post(mips_api._mip_url_login, json=mock_token)
     segment_mock = requests_mock.get(mips_api._mip_url_coa_segments, json=mock_segments)
     account_mock = requests_mock.get(mips_api._mip_url_coa_accounts, json=mock_accounts)
-    balance_mock = requests_mock.post(
-        mips_api._mip_url_current_balance, json=mock_balance_success
-    )
     logout_mock = requests_mock.post(mips_api._mip_url_logout)
 
     # also mock today's date
@@ -547,13 +555,14 @@ def test_requests(mocker, requests_mock):
     assert logout_mock.call_count == 1
 
     # get current balance from mip
+    balance_mock = requests_mock.post(
+        mips_api._mip_url_current_balance, json=mock_balance_success
+    )
     balance_dict = mips_api._balance_requests(mock_org_name, mock_secrets)
     assert balance_mock.call_count == 1
     assert balance_dict == mock_balance_success
 
-    # begin a second test with an alternate requests response
-
-    # inject new mock response with an Exception
+    # inject new mock response with an Exception for coa segments
     requests_mock.get(mips_api._mip_url_coa_segments, exc=Exception)
 
     # assert logout is called when an exception is raised
@@ -587,6 +596,40 @@ def test_cache_write(mocker):
         mips_api._s3_cache_write(expected_coa_dict_raw, mock_s3_bucket, mock_s3_chart)
 
 
+@pytest.mark.parametrize(
+    "api_response,cache_response",
+    [
+        (mock_balance_success, None),
+        (None, mock_balance_success),
+        (mock_balance_success, mock_balance_success),
+    ],
+)
+def test_balance_cache(mocker, api_response, cache_response):
+    """Test balance_cache() with no upstream response"""
+    mocker.patch(
+        "mips_api._balance_requests",
+        autospec=True,
+        return_value=api_response,
+    )
+    mocker.patch(
+        "mips_api._s3_cache_read",
+        autospec=True,
+        return_value=cache_response,
+    )
+    mocker.patch(
+        "mips_api._s3_cache_write",
+        autospec=True,
+    )
+
+    found_dict = mips_api.balance_cache(
+        mock_org_name,
+        mock_secrets,
+        mock_s3_bucket,
+        mock_s3_chart,
+    )
+    assert found_dict == mock_balance_success
+
+
 @pytest.mark.parametrize(
     "chart_response,cache_response",
     [
@@ -724,6 +767,24 @@ def test_process_chart(
     assert processed_chart == expected_dict
 
 
+@pytest.mark.parametrize(
+    "bal_dict, coa_dict, fail",
+    [
+        (mock_balance_empty, expected_coa_dict_full, True),
+        (mock_balance_invalid1, expected_coa_dict_full, True),
+        (mock_balance_invalid2, expected_coa_dict_full, True),
+        (mock_balance_success, expected_coa_dict_full, False),
+    ],
+)
+def test_process_balance(bal_dict, coa_dict, fail):
+    if fail:
+        with pytest.raises(Exception):
+            mips_api.process_balance(bal_dict, coa_dict)
+    else:
+        found_rows = mips_api.process_balance(bal_dict, coa_dict)
+        assert found_rows == expected_balance_rows
+
+
 @pytest.mark.parametrize(
     "params,expected_bool",
     [
@@ -820,7 +881,7 @@ def test_lambda_handler_no_env(invalid_event):
     assert ret["statusCode"] == 500
 
 
-def _test_with_env(mocker, event, code, body=None, error=None, use_json=True):
+def _test_with_env(mocker, event, code, body=None, error=None, text=None):
     """Keep lambda_handler tests DRY"""
 
     # mock environment variables
@@ -860,17 +921,18 @@ def _test_with_env(mocker, event, code, body=None, error=None, use_json=True):
     ret = mips_api.lambda_handler(event, None)
     assert ret["statusCode"] == code
 
-    if use_json:
+    if text is not None:
+        assert ret["body"] == text
+
+    else:
         json_body = json.loads(ret["body"])
 
+        if body is not None:
+            assert json_body == body
+
         if error is not None:
             assert json_body["error"] == error
 
-        elif body is not None:
-            assert json_body == body
-    else:
-        assert ret["body"] == body
-
 
 def test_lambda_handler_invalid_path(invalid_event, mocker):
     """Test event with no path"""
@@ -904,9 +966,7 @@ def test_lambda_handler_accounts_priority(accounts_priority_event, mocker):
 def test_lambda_handler_balance(balances_event, mocker):
     """Test tag-list event"""
 
-    _test_with_env(
-        mocker, balances_event, 200, body=expected_balance_csv, use_json=False
-    )
+    _test_with_env(mocker, balances_event, 200, text=expected_balance_csv)
 
 
 def test_lambda_handler_tags(tags_event, mocker):