hledger/Tests.hs

module Tests
where
import qualified Data.Map as Map
import Text.ParserCombinators.Parsec

import Options
import Models
import Parse
import Utils

-- utils

assertEqual' e a = assertEqual "" e a

parse' p ts = parse p "" ts

assertParseEqual :: (Show a, Eq a) => a -> (Either ParseError a) -> Assertion
assertParseEqual expected parsed =
    case parsed of
      Left e -> parseError e
      Right v -> assertEqual " " expected v

-- find tests with template haskell
--
-- {-# OPTIONS_GHC -fno-warn-unused-imports -no-recomp -fth #-}
-- {- ghc --make Unit.hs -main-is Unit.runTests -o unit -}
-- runTests :: IO ()
-- runTests = $(mkChecks props)

-- mkChecks []        = undefined
-- mkChecks [name]    = mkCheck name
-- mkChecks (name:ns) = [| $(mkCheck name) >> $(mkChecks ns) |]

-- mkCheck name = [| putStr (name ++ ": ") >> quickCheck $(varE (mkName name)) |]

-- {- | looks in Tests.hs for functions like prop_foo and returns
--   the list.  Requires that Tests.hs be valid Haskell98. -}
-- props :: [String]
-- props = unsafePerformIO $
--   do h <- openFile "Tests.hs" ReadMode
--      s <- hGetContents h
--      case parseModule s of
--        (ParseOk (HsModule _ _ _ _ ds)) -> return (map declName (filter isProp ds))
--        (ParseFailed loc s')            -> error (s' ++ " " ++ show loc)

-- {- | checks if function binding name starts with @prop_@ indicating
--  that it is a quickcheck property -}
-- isProp :: HsDecl -> Bool
-- isProp d@(HsFunBind _) = "prop_" `isPrefixOf` (declName d)
-- isProp _ = False

-- {- | takes an HsDecl and returns the name of the declaration -}
-- declName :: HsDecl -> String
-- declName (HsFunBind (HsMatch _ (HsIdent name) _ _ _:_)) = name
-- declName _                                              = undefined


-- test data

transaction1_str  = "  expenses:food:dining  $10.00\n"

transaction1 = LedgerTransaction "expenses:food:dining" (dollars 10) ""

entry1_str = "\
\2007/01/28 coopportunity\n\
\  expenses:food:groceries                 $47.18\n\
\  assets:checking\n\
\\n" --"

entry1 =
    (LedgerEntry "2007/01/28" False "" "coopportunity" ""
               [LedgerTransaction "expenses:food:groceries" (Amount (getcurrency "$") 47.18 2) "", 
                LedgerTransaction "assets:checking" (Amount (getcurrency "$") (-47.18) 2) ""] "")

entry2_str = "\
\2007/01/27 * joes diner\n\
\  expenses:food:dining                    $10.00\n\
\  expenses:gifts                          $10.00\n\
\  assets:checking                        $-20.00\n\
\\n" --"

entry3_str = "\
\2007/01/01 * opening balance\n\
\    assets:cash                                $4.82\n\
\    equity:opening balances\n\
\\n\
\2007/01/01 * opening balance\n\
\    assets:cash                                $4.82\n\
\    equity:opening balances\n\
\\n\
\2007/01/28 coopportunity\n\
\  expenses:food:groceries                 $47.18\n\
\  assets:checking\n\
\\n" --"

periodic_entry1_str = "\
\~ monthly from 2007/2/2\n\
\  assets:saving            $200.00\n\
\  assets:checking\n\
\\n" --"

periodic_entry2_str = "\
\~ monthly from 2007/2/2\n\
\  assets:saving            $200.00         ;auto savings\n\
\  assets:checking\n\
\\n" --"

periodic_entry3_str = "\
\~ monthly from 2007/01/01\n\
\    assets:cash                                $4.82\n\
\    equity:opening balances\n\
\\n\
\~ monthly from 2007/01/01\n\
\    assets:cash                                $4.82\n\
\    equity:opening balances\n\
\\n" --"

ledger1_str = "\
\\n\
\2007/01/27 * joes diner\n\
\  expenses:food:dining                    $10.00\n\
\  expenses:gifts                          $10.00\n\
\  assets:checking                        $-20.00\n\
\\n\
\\n\
\2007/01/28 coopportunity\n\
\  expenses:food:groceries                 $47.18\n\
\  assets:checking                        $-47.18\n\
\\n\
\" --"

ledger2_str = "\
\;comment\n\
\2007/01/27 * joes diner\n\
\  expenses:food:dining                    $10.00\n\
\  assets:checking                        $-47.18\n\
\\n" --"

ledger3_str = "\
\2007/01/27 * joes diner\n\
\  expenses:food:dining                    $10.00\n\
\;intra-entry comment\n\
\  assets:checking                        $-47.18\n\
\\n" --"

ledger4_str = "\
\!include \"somefile\"\n\
\2007/01/27 * joes diner\n\
\  expenses:food:dining                    $10.00\n\
\  assets:checking                        $-47.18\n\
\\n" --"

ledger5_str = ""

ledger6_str = "\
\~ monthly from 2007/1/21\n\
\    expenses:entertainment  $16.23        ;netflix\n\
\    assets:checking\n\
\\n\
\; 2007/01/01 * opening balance\n\
\;     assets:saving                            $200.04\n\
\;     equity:opening balances                         \n\
\\n" --"

ledger7_str = "\
\2007/01/01 * opening balance\n\
\    assets:cash                                $4.82\n\
\    equity:opening balances                         \n\
\\n\
\2007/01/01 * opening balance\n\
\    income:interest                                $-4.82\n\
\    equity:opening balances                         \n\
\\n\
\2007/01/02 * ayres suites\n\
\    expenses:vacation                        $179.92\n\
\    assets:checking                                 \n\
\\n\
\2007/01/02 * auto transfer to savings\n\
\    assets:saving                            $200.00\n\
\    assets:checking                                 \n\
\\n\
\2007/01/03 * poquito mas\n\
\    expenses:food:dining                       $4.82\n\
\    assets:cash                                     \n\
\\n\
\2007/01/03 * verizon\n\
\    expenses:phone                            $95.11\n\
\    assets:checking                                 \n\
\\n\
\2007/01/03 * discover\n\
\    liabilities:credit cards:discover         $80.00\n\
\    assets:checking                                 \n\
\\n\
\2007/01/04 * blue cross\n\
\    expenses:health:insurance                 $90.00\n\
\    assets:checking                                 \n\
\\n\
\2007/01/05 * village market liquor\n\
\    expenses:food:dining                       $6.48\n\
\    assets:checking                                 \n\
\\n" --"

ledger7 = LedgerFile
          [] 
          [] 
          [
           LedgerEntry {
                  edate="2007/01/01", estatus=False, ecode="*", edescription="opening balance", ecomment="",
                  etransactions=[
                                LedgerTransaction {taccount="assets:cash", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=4.82, precision=2},
                                                   tcomment=""},
                                LedgerTransaction {taccount="equity:opening balances", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=(-4.82), precision=2},
                                                   tcomment=""}
                               ],
                  epreceding_comment_lines=""
                 }
          ,
           LedgerEntry {
                  edate="2007/02/01", estatus=False, ecode="*", edescription="ayres suites", ecomment="",
                  etransactions=[
                                LedgerTransaction {taccount="expenses:vacation", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=179.92, precision=2},
                                                   tcomment=""},
                                LedgerTransaction {taccount="assets:checking", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=(-179.92), precision=2},
                                                   tcomment=""}
                               ],
                  epreceding_comment_lines=""
                 }
          ,
           LedgerEntry {
                  edate="2007/01/02", estatus=False, ecode="*", edescription="auto transfer to savings", ecomment="",
                  etransactions=[
                                LedgerTransaction {taccount="assets:saving", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=200, precision=2},
                                                   tcomment=""},
                                LedgerTransaction {taccount="assets:checking", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=(-200), precision=2},
                                                   tcomment=""}
                               ],
                  epreceding_comment_lines=""
                 }
          ,
           LedgerEntry {
                  edate="2007/01/03", estatus=False, ecode="*", edescription="poquito mas", ecomment="",
                  etransactions=[
                                LedgerTransaction {taccount="expenses:food:dining", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=4.82, precision=2},
                                                   tcomment=""},
                                LedgerTransaction {taccount="assets:cash", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=(-4.82), precision=2},
                                                   tcomment=""}
                               ],
                  epreceding_comment_lines=""
                 }
          ,
           LedgerEntry {
                  edate="2007/01/03", estatus=False, ecode="*", edescription="verizon", ecomment="",
                  etransactions=[
                                LedgerTransaction {taccount="expenses:phone", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=95.11, precision=2},
                                                   tcomment=""},
                                LedgerTransaction {taccount="assets:checking", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=(-95.11), precision=2},
                                                   tcomment=""}
                               ],
                  epreceding_comment_lines=""
                 }
          ,
           LedgerEntry {
                  edate="2007/01/03", estatus=False, ecode="*", edescription="discover", ecomment="",
                  etransactions=[
                                LedgerTransaction {taccount="liabilities:credit cards:discover", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=80, precision=2},
                                                   tcomment=""},
                                LedgerTransaction {taccount="assets:checking", 
                                                   tamount=Amount {currency=(getcurrency "$"), quantity=(-80), precision=2},
                                                   tcomment=""}
                               ],
                  epreceding_comment_lines=""
                 }
          ]
          ""

l7 = cacheLedger (argpats [] []) ledger7

timelogentry1_str  = "i 2007/03/11 16:19:00 hledger\n"
timelogentry1 = TimeLogEntry 'i' "2007/03/11 16:19:00" "hledger"

timelogentry2_str  = "o 2007/03/11 16:30:00\n"
timelogentry2 = TimeLogEntry 'o' "2007/03/11 16:30:00" ""

timelog1_str = concat [
                timelogentry1_str,
                timelogentry2_str
               ]
timelog1 = TimeLog [
            timelogentry1,
            timelogentry2
           ]

-- tests

quickcheck = mapM quickCheck ([
        ] :: [Bool])

hunit = runTestTT $ "hunit" ~: test ([
        "" ~: punctuatethousands "" @?= ""
        ,"" ~: punctuatethousands "1234567.8901" @?= "1,234,567.8901"
        ,"" ~: punctuatethousands "-100" @?= "-100"
        ,"" ~: test_ledgertransaction
        ,"" ~: test_ledgerentry
        ,"" ~: test_autofillEntry
        ,"" ~: test_timelogentry
        ,"" ~: test_timelog
        ,"" ~: test_expandAccountNames
        ,"" ~: test_ledgerAccountNames
        ,"" ~: test_cacheLedger
        ,"" ~: test_showLedgerAccounts
        ,"" ~: test_Amount
        ,"" ~: test_ledgeramount
        ] :: [Test])

test_ledgeramount :: Assertion
test_ledgeramount = do
  assertParseEqual (Amount (getcurrency "$") 47.18 2)
                   (parse' ledgeramount " $47.18")
  assertParseEqual (Amount (getcurrency "$") 1 0) 
                   (parse' ledgeramount " $1.")

test_Amount = do
  -- precision subtleties
  let a1 = Amount (getcurrency "$") 1.23 1
  let a2 = Amount (getcurrency "$") (-1.23) 2
  let a3 = Amount (getcurrency "$") (-1.23) 3
  assertEqual "1" (Amount (getcurrency "$") 0 1) (a1 + a2)
  assertEqual "2" (Amount (getcurrency "$") 0 1) (a1 + a3)
  assertEqual "3" (Amount (getcurrency "$") (-2.46) 2) (a2 + a3)
  assertEqual "4" (Amount (getcurrency "$") (-2.46) 3) (a3 + a3)
  -- sum adds 0, with Amount fromIntegral's default precision of 2
  assertEqual "5" (Amount (getcurrency "$") 0 1) (sum [a1,a2])
  assertEqual "6" (Amount (getcurrency "$") (-2.46) 2) (sum [a2,a3])
  assertEqual "7" (Amount (getcurrency "$") (-2.46) 2) (sum [a3,a3])
               
test_ledgertransaction =
    assertParseEqual transaction1 (parse' ledgertransaction transaction1_str)      

test_ledgerentry =
    assertParseEqual entry1 (parse' ledgerentry entry1_str)

test_autofillEntry = 
    assertEqual'
    (Amount (getcurrency "$") (-47.18) 2)
    (tamount $ last $ etransactions $ autofillEntry entry1)

test_timelogentry = do
    assertParseEqual timelogentry1 (parse' timelogentry timelogentry1_str)
    assertParseEqual timelogentry2 (parse' timelogentry timelogentry2_str)

test_timelog =
    assertParseEqual timelog1 (parse' timelog timelog1_str)

test_expandAccountNames =
    assertEqual'
    ["assets","assets:cash","assets:checking","expenses","expenses:vacation"]
    (expandAccountNames ["assets:cash","assets:checking","expenses:vacation"])

test_ledgerAccountNames =
    assertEqual'
    ["assets","assets:cash","assets:checking","assets:saving","equity","equity:opening balances",
    "expenses","expenses:food","expenses:food:dining","expenses:phone","expenses:vacation",
     "liabilities","liabilities:credit cards","liabilities:credit cards:discover"]
    (rawLedgerAccountNames ledger7)

test_cacheLedger =
    assertEqual' 15 (length $ Map.keys $ accounts $ cacheLedger (argpats [] []) ledger7)

test_showLedgerAccounts = 
    assertEqual' 4 (length $ lines $ showLedgerAccounts l7 1)