hledger/uitest.org at f12ff0df3a194b388a428cd9fd344dcde7925481

simonmichael/hledger

Fork 0

mirror of https://github.com/simonmichael/hledger.git synced 2024-09-20 02:37:12 +03:00

Simon Michael f54e645dbf test: ui: outliner tip

2021-07-15 09:57:16 -10:00

12 KiB

Raw Blame History

Human-powered tests for hledger-ui

Human-powered tests for hledger-ui

When you want to check that hledger-ui is working correctly, try some or all of these things. Additions welcome. Expected output, at least the first few lines of it, as copied from an 80x25 terminal, is shown below each step.

This is an org outline. When you're familiar with these tests, you can view it in Emacs org mode with all body text hidden, showing just the test steps and brief expected result - makes it quicker to run through them.

Another source of tests is the tutorial at https://hledger.org/ui.html, which has nice screenshots, but might be less up to date.

hledger-ui -f sample.journal # shows all accounts in list mode

───────────────────── sample.journal account balances (1/8) ──────────────────── assets🏦checking 0 # <- selected assets🏦saving $1 assets:cash $-2 expenses:food $1 expenses:supplies $1 income:gifts $-1 income:salary $-1 liabilities:debts $1

t # switches to tree mode

──────────────────── sample.journal account balances (3/13) ──────────────────── assets $-1 bank $1 checking 0 # <- selected saving $1 cash $-2 expenses $2 food $1 supplies $1 income $-2 gifts $-1 salary $-1 liabilities $1 debts $1

1 # clips accounts to depth 1

─────────────── sample.journal account balances to depth 1 (1/4) ─────────────── assets $-1 # <- selected expenses $2 income $-2 liabilities $1

RIGHT # shows assets & subaccounts' transactions (register ignores depth limit)

─────────────────────────── assets transactions (5/5) ────────────────────────── 2008-01-01 income in:salary $1 $1 2008-06-01 gift in:gifts $1 $2 2008-06-02 save as:ba:saving, as:ba:chec.. 0 $2 2008-06-03 * eat & shop ex:food, ex:supplies $-2 0 2008-12-31 * pay off li:debts $-1 $-1 # <- selected

ESC # reset UI state to initial screen in list mode

/ bank # set a filter, showing only accounts with "bank" in the name

────────────── sample.journal account balances matching bank (1/2) ───────────── assets🏦checking 0 # <- selected assets🏦saving $1

RIGHT # shows assets🏦checking & subaccounts' transactions

───────────── assets🏦checking transactions matching bank (4/4) ──────────── 2008-01-01 income in:salary $1 $1 2008-06-01 gift in:gifts $1 $2 2008-06-02 save as:ba:saving $-1 $1 2008-12-31 * pay off li:debts $-1 0 # <- selected

/ SPACE desc:a # add another filter term, showing only transactions with "a" in the description

───────── assets🏦checking transactions matching bank desc:a (2/2) ───────── 2008-06-02 save as:ba:saving $-1 $-1 2008-12-31 * pay off as:ba:checking $-1 $-2 # <- selected

RIGHT # shows transaction detail

───── Transaction #5 (2 of 2 matching bank desc:a in assets🏦checking) ───── 2008-12-31 * pay off liabilities:debts $1 assets🏦checking $-1

UP # shows previous matched transaction

───── Transaction #3 (1 of 2 matching bank desc:a in assets🏦checking) ───── 2008-06-02 save assets🏦saving $1 assets🏦checking $-1

DOWN # shows next matched transaction

───── Transaction #5 (2 of 2 matching bank desc:a in assets🏦checking) ───── 2008-12-31 * pay off liabilities:debts $1 assets🏦checking $-1

? # shows help dialog over current screen; all content fits unclipped in 80x25, including the last q quit line

┌──────────────────────Help (LEFT/ESC/?/q to close help)──────────────────────┐─ │ Navigation Filtering │ │ UP/DOWN/PUP/PDN/HOME/END/k/j/C-p/C-n / set a filter query │ │ move selection up/down F show future & periodic txns │ │ RIGHT/l/C-f show txns, or txn detail R show real/all postings │ │ LEFT/h/C-b go back Z show nonzero/all amounts │ │ ESC cancel, or reset app state U/P/C show unmarked/pending/cleared │ │ S-DOWN /S-UP shrink/grow period │ │ Accounts screen S-RIGHT/S-LEFT next/previous period │ │ 1234567890-+ set/adjust depth limit T set period to today │ │ t toggle accounts tree/list mode DEL reset filters │ │ H toggle historical balance/change │ │ Other │ │ Register screen a add transaction (hledger add) │ │ t toggle subaccount txns A add transaction (hledger-iadd) │ │ (and accounts tree/list mode) B show amounts/costs │ │ H toggle historical/period total E open editor │ │ I toggle balance assertions │ │ Help V show amounts/market values │ │ ? toggle this help g reload data │ │ p/m/i while help is open: C-l redraw & recenter │ │ show manual in pager/man/info C-z suspend │ │ q quit │ └─────────────────────────────────────────────────────────────────────────────┘ ──── ?:help t:list/tree -+:depth H:end-bals/changes F:forecast a:add q:quit ────

q # q with help dialog open closes it

──── Transaction #5 (1 of 1 matching bank desc:pay in assets🏦checking) ──── 2008-12-31 * pay off liabilities:debts $1 assets🏦checking $-1

q # q elsewhere exits the app, terminal is restored to its previous state

~/src/hledger/hledger-ui/test$ hledger-ui -f sample.journal ~/src/hledger/hledger-ui/test$

hledger-ui -f sample.journal –register checking date:200812 # date query at startup

──── assets🏦checking transactions matching date:200812 in 2008-12 (1/1) ─── 2008-12-31 * pay off li:debts $-1 0 # <- selected

hledger-ui -f sample.journal –register checking date:200812 –change # total is now $-1

──── assets🏦checking transactions matching date:200812 in 2008-12 (1/1) ─── 2008-12-31 * pay off li:debts $-1 $-1

hledger-ui -f bcexample.journal –tree –register assets # wide content is elided as shown

──────────────────────── Assets transactions (518/518) ──────────────────────── 2014-07-26 * .. .. 16.00 GLD, -1515.83 USD ..0 GLD, 17.00 ITOT, 6 more.. 2014-07-31 * .. .. 2550.60 USD, 4.62 VACHR ..0 GLD, 17.00 ITOT, 6 more.. 2014-08-03 * .. .. -2400.00 USD ..0 GLD, 17.00 ITOT, 6 more.. 2014-08-04 * .. .. -4.00 USD ..0 GLD, 17.00 ITOT, 6 more.. 2014-08-08 * .. .. -65.00 USD ..0 GLD, 17.00 ITOT, 6 more.. 2014-08-09 * .. .. -560.82 USD ..0 GLD, 17.00 ITOT, 6 more.. 2014-08-14 * .. .. 2550.60 USD, 4.62 VACHR ..0 GLD, 17.00 ITOT, 6 more.. 2014-08-15 * .. .. -16.00 GLD, 1481.29 USD ..0 GLD, 17.00 ITOT, 6 more..

hledger-ui -f forecast.journal –register a # future and forecasted txns are hidden by default

───────────────────────── a transactions (1/1) ───────────────────────── 2020-01-01 past transaction a $1 $1

hledger-ui -f forecast.journal –register a –forecast # future txn is shown, and sets the start of default forecast period

───────────────────────── a transactions (1/2) ───────────────────────── 2020-01-01 past transaction a $1 $1 3000-01-01 future transac.. a $1000000 $1000001

hledger-ui -f forecast.journal –register a –forecast=2020 # explicit forecast period shows forecasted txns also

───────────────────────── a transactions (6/6) ───────────────────────── 2020-01-01 past transaction a $1 $1 2020-01-01 forecasted tra.. a $1 $2 2020-04-01 forecasted tra.. a $1 $3 2020-07-01 forecasted tra.. a $1 $4 2020-10-01 forecasted tra.. a $1 $5 3000-01-01 future transac.. a $1000000 $1000005

press F at least three times # future & forecasted txns are toggled every time (#1411)

hledger-ui -f forecast.journal –register a –forecast=2020 –watch, press F once

with the above still running, touch forecast.journal, press F again # forecast txns can still be enabled if file modification time changed while disabled (#1204)

───────────────────────── a transactions (6/6) ───────────────────────── 2020-01-01 past transaction a $1 $1 # <- selected 2020-01-01 forecasted tra.. a $1 $2 2020-04-01 forecasted tra.. a $1 $3 2020-07-01 forecasted tra.. a $1 $4 2020-10-01 forecasted tra.. a $1 $5 3000-01-01 future transac.. a $1000000 $1000005

hledger-ui -f 1468.j, 2, RIGHT # in list mode, register of account above depth limit shows only its transactions

───────────────────────────── a transactions (1/1) ───────────────────────────── 2021-01-01 a 1 1

LEFT, DOWN, RIGHT # in list mode, register of account at depth limit also shows subaccounts' transactions (#1468)

──────────────────────────── a:aa transactions (2/2) ─────────────────────────── 2021-01-02 a:aa 10 10 2021-01-03 a:aa:aaa 100 110

12 KiB Raw Blame History Unescape Escape