aboutsummaryrefslogtreecommitdiffstats
path: root/tests/unit/test_commands_transaction.py
blob: 28882d313a6a78fe52dd4900a660ccc6d85d7574 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
import unittest
from unittest.mock import MagicMock
from firefly_cli.commands import transaction as tx
from firefly_cli.context import Context

def make_ctx():
    client = MagicMock()
    resolver = MagicMock()
    return Context(client=client, resolver=resolver, human=False), client, resolver

class TestTxAdd(unittest.TestCase):
    def test_infers_withdrawal_from_asset_to_expense(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {
            "Checking": {"id": "1", "name": "Checking", "type": "asset"},
            "Groceries": {"id": "2", "name": "Groceries", "type": "expense"},
        }[n]
        client.request.return_value = {"data": {"id": "55", "type": "transactions",
                                                "attributes": {}}}
        args = MagicMock(amount="42.50", source="Checking", dest="Groceries",
                         desc="food", date="2026-06-30", category=None,
                         tags=None, type=None, dry_run=False, skip_dupes=False)
        rc = tx.cmd_add(args, ctx)
        self.assertEqual(rc, 0)
        method, path = client.request.call_args[0][:2]
        body = client.request.call_args[1]["body"]
        split = body["transactions"][0]
        self.assertEqual((method, path), ("POST", "/api/v1/transactions"))
        self.assertEqual(split["type"], "withdrawal")
        self.assertEqual(split["source_id"], "1")
        self.assertEqual(split["destination_id"], "2")
        self.assertEqual(split["amount"], "42.50")

    def test_infers_deposit_revenue_to_asset(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {
            "Salary": {"id": "7", "name": "Salary", "type": "revenue"},
            "Checking": {"id": "1", "name": "Checking", "type": "asset"},
        }[n]
        client.request.return_value = {"data": {"id": "1", "attributes": {}}}
        args = MagicMock(amount="1000", source="Salary", dest="Checking",
                         desc="pay", date=None, category=None, tags=None,
                         type=None, dry_run=False, skip_dupes=False)
        tx.cmd_add(args, ctx)
        self.assertEqual(client.request.call_args[1]["body"]["transactions"][0]["type"],
                         "deposit")

    def test_explicit_type_overrides_inference(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {"id": "1", "type": "asset", "name": n}
        client.request.return_value = {"data": {"id": "1", "attributes": {}}}
        args = MagicMock(amount="5", source="A", dest="B", desc=None, date=None,
                         category=None, tags="food,fun", type="transfer",
                         dry_run=False, skip_dupes=False)
        tx.cmd_add(args, ctx)
        split = client.request.call_args[1]["body"]["transactions"][0]
        self.assertEqual(split["type"], "transfer")
        self.assertEqual(split["tags"], ["food", "fun"])

    def test_category_passed_raw_not_resolved(self):
        # Category name goes straight to Firefly (auto-creates); resolver untouched.
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {"id": "1", "type": "asset", "name": n}
        client.request.return_value = {"data": {"id": "1", "attributes": {}}}
        args = MagicMock(amount="5", source="A", dest="B", desc=None, date=None,
                         category="Brand New Cat", tags=None, type="withdrawal",
                         dry_run=False, skip_dupes=False)
        tx.cmd_add(args, ctx)
        split = client.request.call_args[1]["body"]["transactions"][0]
        self.assertEqual(split["category_name"], "Brand New Cat")

    def test_dry_run_resolves_but_does_not_post(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {"id": "1", "type": "asset", "name": n}
        args = MagicMock(amount="5", source="A", dest="B", desc="x", date="2026-06-01",
                         category=None, tags=None, type="withdrawal", dry_run=True, skip_dupes=False)
        rc = tx.cmd_add(args, ctx)
        self.assertEqual(rc, 0)
        client.request.assert_not_called()  # accounts resolved, nothing written
        self.assertEqual(resolver.account.call_count, 2)

    def test_dry_run_missing_account_is_hard_error(self):
        from firefly_cli.errors import ResolutionError
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = ResolutionError('No account named "B"')
        args = MagicMock(amount="5", source="A", dest="B", desc=None, date=None,
                         category=None, tags=None, type="withdrawal", dry_run=True, skip_dupes=False)
        with self.assertRaises(ResolutionError):
            tx.cmd_add(args, ctx)
        client.request.assert_not_called()
        resolver.category.assert_not_called()

    def test_skip_dupes_skips_when_match_exists(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {
            "A": {"id": "1", "name": "A", "type": "asset"},
            "B": {"id": "2", "name": "B", "type": "expense"},
        }[n]
        # search finds an existing tx -> skip, no POST
        client.request.return_value = {"data": [
            {"id": "441", "attributes": {}}]}
        args = MagicMock(amount="9.99", source="A", dest="B", desc="x",
                         date="2026-06-10", category=None, tags=None,
                         type=None, dry_run=False, skip_dupes=True)
        rc = tx.cmd_add(args, ctx)
        self.assertEqual(rc, 0)
        # exactly one call, the GET search; no POST
        self.assertEqual(client.request.call_count, 1)
        method, path = client.request.call_args[0][:2]
        self.assertEqual(method, "GET")
        q = client.request.call_args[1]["params"]["query"]
        self.assertIn("amount_is:9.99", q)
        self.assertIn("date_on:2026-06-10", q)
        self.assertIn("source_account_is:", q)
        self.assertIn("destination_account_is:", q)

    def test_skip_dupes_writes_when_no_match(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {
            "A": {"id": "1", "name": "A", "type": "asset"},
            "B": {"id": "2", "name": "B", "type": "expense"},
        }[n]
        # first call = search (empty), second = POST
        client.request.side_effect = [
            {"data": []},
            {"data": {"id": "99", "attributes": {}}},
        ]
        args = MagicMock(amount="9.99", source="A", dest="B", desc="x",
                         date="2026-06-10", category=None, tags=None,
                         type=None, dry_run=False, skip_dupes=True)
        rc = tx.cmd_add(args, ctx)
        self.assertEqual(rc, 0)
        self.assertEqual(client.request.call_count, 2)
        self.assertEqual(client.request.call_args[0][:2],
                         ("POST", "/api/v1/transactions"))

    def test_transfer_prints_direction_hint_to_stderr(self):
        import io
        from contextlib import redirect_stderr
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {
            "BBVA": {"id": "3", "name": "BBVA", "type": "asset"},
            "Medio": {"id": "4", "name": "Medio", "type": "asset"},
        }[n]
        client.request.return_value = {"data": {"id": "1", "attributes": {}}}
        args = MagicMock(amount="100", source="BBVA", dest="Medio", desc=None,
                         date=None, category=None, tags=None, type=None,
                         dry_run=False, skip_dupes=False)
        buf = io.StringIO()
        with redirect_stderr(buf):
            tx.cmd_add(args, ctx)
        self.assertIn("transfer: BBVA → Medio, 100", buf.getvalue())

    def test_transfer_hint_shown_in_dry_run(self):
        import io
        from contextlib import redirect_stderr
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {"id": "1", "type": "asset", "name": n}
        args = MagicMock(amount="5", source="A", dest="B", desc=None, date=None,
                         category=None, tags=None, type="transfer",
                         dry_run=True, skip_dupes=False)
        buf = io.StringIO()
        with redirect_stderr(buf):
            tx.cmd_add(args, ctx)
        self.assertIn("transfer: A → B, 5", buf.getvalue())
        client.request.assert_not_called()

    def test_withdrawal_no_direction_hint(self):
        import io
        from contextlib import redirect_stderr
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {
            "Checking": {"id": "1", "name": "Checking", "type": "asset"},
            "Groceries": {"id": "2", "name": "Groceries", "type": "expense"},
        }[n]
        client.request.return_value = {"data": {"id": "1", "attributes": {}}}
        args = MagicMock(amount="5", source="Checking", dest="Groceries", desc=None,
                         date=None, category=None, tags=None, type=None,
                         dry_run=False, skip_dupes=False)
        buf = io.StringIO()
        with redirect_stderr(buf):
            tx.cmd_add(args, ctx)
        self.assertNotIn("transfer:", buf.getvalue())

    def test_dry_run_beats_skip_dupes_no_search(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {"id": "1", "type": "asset", "name": n}
        args = MagicMock(amount="5", source="A", dest="B", desc=None, date="2026-06-01",
                         category=None, tags=None, type="withdrawal",
                         dry_run=True, skip_dupes=True)
        rc = tx.cmd_add(args, ctx)
        self.assertEqual(rc, 0)
        client.request.assert_not_called()  # dry-run wins: no search, no write

class TestTxEdit(unittest.TestCase):
    def test_edit_sends_only_provided_fields(self):
        ctx, client, resolver = make_ctx()
        client.request.return_value = {"data": {"id": "9", "attributes": {}}}
        args = MagicMock(id="9", amount="12.00", date=None, desc="fixed",
                         source=None, dest=None, category=None, tags=None, type=None)
        rc = tx.cmd_edit(args, ctx)
        self.assertEqual(rc, 0)
        method, path = client.request.call_args[0][:2]
        split = client.request.call_args[1]["body"]["transactions"][0]
        self.assertEqual((method, path), ("PUT", "/api/v1/transactions/9"))
        self.assertEqual(split, {"amount": "12.00", "description": "fixed"})
        resolver.account.assert_not_called()

    def test_edit_resolves_accounts_when_given(self):
        ctx, client, resolver = make_ctx()
        resolver.account.side_effect = lambda n: {
            "BBVA": {"id": "3", "name": "BBVA", "type": "asset"},
            "Medio": {"id": "4", "name": "Medio", "type": "asset"},
        }[n]
        client.request.return_value = {"data": {"id": "9", "attributes": {}}}
        args = MagicMock(id="9", amount=None, date=None, desc=None,
                         source="BBVA", dest="Medio", category=None, tags=None, type=None)
        tx.cmd_edit(args, ctx)
        split = client.request.call_args[1]["body"]["transactions"][0]
        self.assertEqual(split, {"source_id": "3", "destination_id": "4"})

    def test_edit_category_raw_and_tags_split(self):
        ctx, client, resolver = make_ctx()
        client.request.return_value = {"data": {"id": "9", "attributes": {}}}
        args = MagicMock(id="9", amount=None, date=None, desc=None, source=None,
                         dest=None, category="Cat", tags="a, b", type="transfer")
        tx.cmd_edit(args, ctx)
        split = client.request.call_args[1]["body"]["transactions"][0]
        self.assertEqual(split,
                         {"category_name": "Cat", "tags": ["a", "b"], "type": "transfer"})
        resolver.category.assert_not_called()

    def test_edit_with_no_fields_errors(self):
        from firefly_cli.errors import FireflyError
        ctx, client, _ = make_ctx()
        args = MagicMock(id="9", amount=None, date=None, desc=None, source=None,
                         dest=None, category=None, tags=None, type=None)
        with self.assertRaises(FireflyError):
            tx.cmd_edit(args, ctx)
        client.request.assert_not_called()


class TestTxDelete(unittest.TestCase):
    def test_delete_requires_yes(self):
        from firefly_cli.errors import FireflyError
        ctx, client, _ = make_ctx()
        args = MagicMock(id="9", yes=False)
        with self.assertRaises(FireflyError):
            tx.cmd_delete(args, ctx)
        client.request.assert_not_called()

    def test_delete_with_yes(self):
        ctx, client, _ = make_ctx()
        client.request.return_value = {}
        args = MagicMock(id="9", yes=True)
        rc = tx.cmd_delete(args, ctx)
        self.assertEqual(rc, 0)
        method, path = client.request.call_args[0][:2]
        self.assertEqual((method, path), ("DELETE", "/api/v1/transactions/9"))


class TestTxList(unittest.TestCase):
    def test_list_passes_date_params(self):
        ctx, client, _ = make_ctx()
        client.request.return_value = {"data": []}
        args = MagicMock(since="2026-06-01", until="2026-06-30",
                         account=None, limit=10, all=False, flat=False)
        tx.cmd_list(args, ctx)
        params = client.request.call_args[1]["params"]
        self.assertEqual(params["start"], "2026-06-01")
        self.assertEqual(params["end"], "2026-06-30")
        self.assertEqual(params["limit"], 10)

    def test_list_warns_when_truncated(self):
        import io
        from contextlib import redirect_stderr
        ctx, client, _ = make_ctx()
        client.request.return_value = {
            "data": [{"id": str(i)} for i in range(20)],
            "meta": {"pagination": {"total": 90, "count": 20,
                                    "current_page": 1, "total_pages": 5}},
        }
        args = MagicMock(since=None, until=None, account=None, limit=20, all=False, flat=False)
        buf = io.StringIO()
        with redirect_stderr(buf):
            tx.cmd_list(args, ctx)
        self.assertIn("showing 20 of 90", buf.getvalue())
        self.assertEqual(client.request.call_count, 1)

    def test_list_no_warn_when_complete(self):
        import io
        from contextlib import redirect_stderr
        ctx, client, _ = make_ctx()
        client.request.return_value = {
            "data": [{"id": "1"}],
            "meta": {"pagination": {"total": 1, "count": 1,
                                    "current_page": 1, "total_pages": 1}},
        }
        args = MagicMock(since=None, until=None, account=None, limit=20, all=False, flat=False)
        buf = io.StringIO()
        with redirect_stderr(buf):
            tx.cmd_list(args, ctx)
        self.assertEqual(buf.getvalue(), "")

    def test_list_flat_explodes_splits_json(self):
        import io, json
        from contextlib import redirect_stdout
        ctx, client, _ = make_ctx()
        client.request.return_value = {
            "data": [{"id": "7", "type": "transactions", "attributes": {
                "transactions": [{"amount": "5", "source_name": "A"}]}}],
            "meta": {"pagination": {"total": 1, "count": 1, "total_pages": 1}},
        }
        args = MagicMock(since=None, until=None, account=None, limit=20,
                         all=False, flat=True)
        buf = io.StringIO()
        with redirect_stdout(buf):
            tx.cmd_list(args, ctx)
        out = json.loads(buf.getvalue())
        self.assertEqual(out, [{"amount": "5", "source_name": "A", "id": "7"}])

    def test_list_flat_skipped_for_human(self):
        # --human path must keep nested rows so the table renderer explodes them.
        import io
        from contextlib import redirect_stdout
        ctx, client, _ = make_ctx()
        ctx = Context(client=client, resolver=ctx.resolver, human=True)
        client.request.return_value = {
            "data": [{"id": "7", "attributes": {
                "transactions": [{"amount": "5", "source_name": "A",
                                  "destination_name": "B", "type": "withdrawal"}]}}],
            "meta": {"pagination": {"total": 1, "count": 1, "total_pages": 1}},
        }
        args = MagicMock(since=None, until=None, account=None, limit=20,
                         all=False, flat=True)
        buf = io.StringIO()
        with redirect_stdout(buf):
            tx.cmd_list(args, ctx)
        # human table shows the exploded split value; not raw JSON
        self.assertIn("5", buf.getvalue())

    def test_list_all_paginates(self):
        ctx, client, _ = make_ctx()
        def page(method, path, params=None, body=None):
            p = params["page"]
            return {
                "data": [{"id": f"{p}-{i}"} for i in range(2)],
                "meta": {"pagination": {"total": 4, "count": 2,
                                        "current_page": p, "total_pages": 2}},
            }
        client.request.side_effect = page
        args = MagicMock(since=None, until=None, account=None, limit=2, all=True, flat=False)
        rc = tx.cmd_list(args, ctx)
        self.assertEqual(rc, 0)
        self.assertEqual(client.request.call_count, 2)