Repository Public
1import Foundation2import Testing3import SheetCore4import SheetUI5import FinanceModels6import AnalysisKit7@testable import FinanceStudio89@MainActor @Suite struct CashFlowTests {10 @Test func listsAllRootsWithTheSignChangeWarning() throws {11 let s = makeSession([["Flows"], ["-1600"], ["10000"], ["-10000"]])12 let r = try run(CashFlowTool.descriptor, session: s) { v in v.set("data", range: "A1:A4"); v.set("flows", column: 0); v.set("rate", number: 0.10) }13 #expect(close(r.number("IRR, root 1 of 2"), 0.25, 1e-8) && close(r.number("IRR, root 2 of 2"), 4.0, 1e-8))14 #expect(r.number("Sign changes of the flows") == 2)15 #expect(r.warnings.count == 1 && r.warnings[0].contains("not unique"))16 #expect(close(r.number("Net present value (NPV)"), CashFlowAnalysis.npv(rate: 0.10, cashFlows: [-1600, 10000, -10000])))17 #expect(r.metric("IRR") == nil) // shown as "2 roots", not as one number18 }1920 @Test func conventionalFlowsMatchTheEngine() throws {21 let flows = [-100000.0, 28000, 32000, 36000, 30000, 24000, 18000]22 let s = makeSession([["Year", "A"]] + flows.enumerated().map { ["\($0.offset)", "\($0.element)"] })23 let r = try run(CashFlowTool.descriptor, session: s) { v in24 v.set("data", range: "A1:B8"); v.set("flows", column: 1); v.set("rate", number: 0.08); v.set("finance", number: 0.07); v.set("reinvest", number: 0.09)25 }26 let irr = try CashFlowAnalysis.irr(cashFlows: flows)27 #expect(close(r.number("Internal rate of return (IRR)"), irr.irr ?? .nan) && irr.allRoots.count == 1 && r.warnings.isEmpty)28 #expect(close(r.number("Modified IRR (MIRR)"), try CashFlowAnalysis.mirr(cashFlows: flows, financeRate: 0.07, reinvestRate: 0.09)))29 #expect(close(r.number("Payback (periods)"), CapitalBudgeting.payback(cashFlows: flows) ?? .nan))30 #expect(close(r.number("Discounted payback (periods)"), CapitalBudgeting.discountedPayback(cashFlows: flows, rate: 0.08) ?? .nan))31 #expect(close(r.number("Profitability index"), CapitalBudgeting.profitabilityIndex(cashFlows: flows, rate: 0.08) ?? .nan))32 }3334 @Test func xirrUsesTheDatesOfTheRange() throws {35 // Excel XIRR documentation example: 0.37336253536 let s = makeSession([["Date", "Amount"], ["2008-01-01", "-10000"], ["2008-03-01", "2750"], ["2008-10-30", "4250"], ["2009-02-15", "3250"], ["2009-04-01", "2750"]])37 #expect(s.workbook.sheets[0].value(1, 0).isNumber) // dates were parsed as serials38 let r = try run(CashFlowTool.descriptor, session: s) { v in v.set("data", range: "A1:B6"); v.set("flows", column: 1); v.set("dates", column: 0); v.set("rate", number: 0.09) }39 #expect(abs((r.number("XIRR (annual)") ?? 0) - 0.373362535) < 1e-8)40 #expect(abs((r.number("XNPV at 9.00% a year") ?? 0) - 2086.647602) < 1e-5) // Excel XNPV documentation example41 }4243 @Test func noRootIsReported() throws {44 let s = makeSession([["F"], ["100"], ["50"], ["25"]])45 let r = try run(CashFlowTool.descriptor, session: s) { v in v.set("data", range: "A1:A4"); v.set("flows", column: 0) }46 #expect(r.warnings.first?.contains("never change sign") == true)47 }4849 @Test func capitalBudgetingMatchesTheEngine() throws {50 let a = [-100000.0, 28000, 32000, 36000, 30000], b = [-100000.0, 8000, 16000, 50000, 70000]51 let s = makeSession([["Year", "A", "B"]] + (0..<5).map { ["\($0)", "\(a[$0])", "\(b[$0])"] })52 let r = try run(CapitalBudgetingTool.descriptor, session: s) { v in v.set("data", range: "A1:C6"); v.set("projects", columns: [1, 2]); v.set("rate", number: 0.08) }53 let c = CapitalBudgeting.compare([Project(name: "A", cashFlows: a), Project(name: "B", cashFlows: b)], rate: 0.08)54 #expect(close(r.number("Net present value (NPV)", column: 1), c.projects[0].npv) && close(r.number("Net present value (NPV)", column: 2), c.projects[1].npv))55 #expect(close(r.number("Equivalent annual annuity", column: 2), c.projects[1].equivalentAnnualAnnuity ?? .nan))56 #expect(r.number("NPV rank", column: 1) == Double(c.projects[0].npvRank))57 #expect(!c.crossoverRates.isEmpty && close(r.number("Crossover rate 1"), c.crossoverRates[0]))58 }59}6061@MainActor @Suite struct DCFTests {62 func assumptions(capm: Bool = false, exit: Bool = false, midYear: Bool = false) -> DCFAssumptions {63 let rate: DiscountRateSource = capm ? .wacc(WACCInputs(riskFreeRate: 0.0325, beta: 1.1, equityRiskPremium: 0.055, preTaxCostOfDebt: 0.055, taxRate: 0.265,64 equityValue: 4000, debtValue: 1000)) : .fixed(0.085)65 return DCFAssumptions(baseRevenue: 1250, revenueGrowth: [0.09, 0.08, 0.07, 0.06, 0.05], ebitMargin: Array(repeating: 0.17, count: 5),66 depreciationPercentOfRevenue: Array(repeating: 0.04, count: 5), capexPercentOfRevenue: Array(repeating: 0.05, count: 5),67 nwcPercentOfRevenue: 0.10, taxRate: 0.265, discountRate: rate, terminal: exit ? .exitMultiple(9) : .gordonGrowth(0.025),68 midYearConvention: midYear, debt: 600, cash: 150, dilutedShares: 100)69 }7071 @Test func formMapsToTheEngineAssumptions() throws {72 let s = makeSession()73 let r = try run(DCFTool.descriptor, session: s)74 let d = try DCFModel.value(assumptions())75 #expect(close(r.metric("Enterprise value"), d.enterpriseValue) && close(r.metric("Value per share"), d.valuePerShare))76 #expect(close(r.number("Implied exit multiple (TV / EBITDA)"), d.impliedExitMultiple))77 #expect(throws: ToolError.self) { try run(DCFTool.descriptor, session: s) { $0.set("growth", text: "5, 4") } } // 2 values for 5 years78 let c = try run(DCFTool.descriptor, session: s) { v in v.set("rateMode", choice: "capm"); v.set("terminal", choice: "exit"); v.set("midYear", bool: true) }79 let dc = try DCFModel.value(assumptions(capm: true, exit: true, midYear: true))80 #expect(close(c.metric("Equity value"), dc.equityValue) && close(c.number("Cost of equity (CAPM)"), dc.costOfEquity ?? .nan))81 }8283 @Test func sensitivityUsesADataTableOnAPrivateModel() throws {84 for a in [assumptions(), assumptions(capm: true), assumptions(exit: true, midYear: true)] {85 let s = try DCFSensitivity.compute(a)86 let base = try DCFModel.value(a).valuePerShare87 let i = try #require(s.rates.firstIndex { abs($0 - a.discountRate.rate) < 1e-9 }), j = try #require(s.parameters.firstIndex { abs($0 - s.baseParameter) < 1e-9 })88 #expect(close(s.values[i][j].numberValue, base, 1e-6)) // rates are rounded to 1e-6 for display89 // every cell equals the engine's own valuation at those parameters90 var b = a91 b.discountRate = .fixed(s.rates[0])92 b.terminal = s.isGrowth ? .gordonGrowth(s.parameters[4]) : .exitMultiple(s.parameters[4])93 #expect(close(s.values[0][4].numberValue, try DCFModel.value(b).valuePerShare, 1e-9))94 }95 }9697 @Test(arguments: [false, true]) func insertedSheetIsLiveAndMatchesTheEngine(_ capm: Bool) throws {98 let s = makeSession([["keep"]])99 let before = snapshot(s.workbook)100 let a = assumptions(capm: capm)101 let sens = try DCFSensitivity.compute(a)102 let ins = try s.perform("Insert DCF Model") { try DCFInsertion.insert(engine: $0, at: 1, assumptions: a, sensitivity: sens, sheetName: "DCF", locale: en) }103 let sh = s.workbook.sheets[ins.sheet]104 let d = try DCFModel.value(a)105 func cell(_ name: String) throws -> Double {106 let c = try #require(ins.cells[name])107 return sh.value(c.row, c.col).numberValue ?? .nan108 }109 try #expect(close(try cell("enterpriseValue"), d.enterpriseValue, 1e-9) && close(try cell("equityValue"), d.equityValue, 1e-9))110 try #expect(close(try cell("valuePerShare"), d.valuePerShare, 1e-9) && close(try cell("terminalValue"), d.terminalValue, 1e-9))111 let ev = try #require(ins.cells["enterpriseValue"])112 #expect(sh.cell(ev.row, ev.col)?.formula != nil)113 #expect(s.workbook.styles[sh.styleID(ev.row, ev.col)].bold)114 // inputs are styled as assumptions; calculations are not115 let tax = try #require(ins.cells["taxRate"])116 #expect(ModelStyle.isInput(s.workbook.styles[sh.styleID(tax.row, tax.col)]) && sh.cell(tax.row, tax.col)?.formula == nil)117 #expect(!ModelStyle.isInput(s.workbook.styles[sh.styleID(ev.row, ev.col)]))118 // defined names resolve to the cells119 #expect(ins.definedNames.contains("DCF_WACC") && ins.definedNames.contains("DCF_ValuePerShare") && ins.definedNames.contains("DCF_TerminalGrowth"))120 #expect(close(s.engine.evaluate("=DCF_EnterpriseValue", sheet: 0).scalar.numberValue, d.enterpriseValue, 1e-9))121 #expect(close(s.engine.evaluate("=DCF_WACC", sheet: 0).scalar.numberValue, d.discountRate, 1e-12))122 // live: editing an input revalues the company exactly as the engine does123 s.perform("Edit") { $0.set(sheet: ins.sheet, row: tax.row, col: tax.col, .value(.number(0.30))) }124 var a2 = a; a2.taxRate = 0.30125 #expect(close(try cell("valuePerShare"), try DCFModel.value(a2).valuePerShare, 1e-9))126 #expect(abs(try cell("valuePerShare") - d.valuePerShare) > 0.01)127 s.undo()128 // a second model gets distinct names129 let second = try s.perform("Insert DCF Model") { try DCFInsertion.insert(engine: $0, at: 2, assumptions: a, sensitivity: nil, sheetName: "DCF", locale: en) }130 #expect(second.definedNames.contains("DCF_WACC_2") && s.workbook.sheets[second.sheet].name == "DCF 2")131 s.undo()132 // one undo removes the sheet and its names133 s.undo()134 #expect(snapshot(s.workbook) == before && s.workbook.sheets.count == 1 && s.workbook.definedName("DCF_WACC") == nil)135 }136137 @Test func actionInsertsTheModelThroughTheSession() throws {138 let s = makeSession()139 let r = try run(DCFTool.descriptor, session: s)140 let message = try #require(try r.action("insert-model")?.perform(s))141 #expect(message.contains("DCF") && s.workbook.sheets.count == 2 && s.sheetIndex == 1)142 #expect(s.engine.undoLabel == "Insert DCF Model")143 s.undo()144 #expect(s.workbook.sheets.count == 1 && !s.engine.canUndo)145 }146}147