ibflex 1.4.1

A library and a CLI for reading Interactive Brokers Flex reports and comparing to Ledger-cli transactions
Documentation 
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

/*!

 * Test the Compare method.
 */

// use std::env;

// use ibflex::{compare::CompareParams, download::DownloadParams};

// #[tokio::test]
// async fn test_download_w_params() {
//     let params = DownloadParams::new(Some(12345_u32), &Some("12345".to_string()));
//     let actual = ibflex::download::download(params).await;

//     // println!("got {:?}", actual);

//     assert_ne!(String::default(), actual);
//     assert!(actual.contains("xml"));
// }
//env::set_var("token", "123");

use assert_cmd::Command;
use rstest::fixture;

#[fixture]
fn app_cmd() -> Command {
    Command::cargo_bin("ibflex").unwrap()
}

/**

 * Tests comparison.
 * Requires a default .toml configuration file.
 */
#[rstest::rstest]
fn test_comparison_actual_date(mut app_cmd: Command) {
    // prepare
    let assert = app_cmd
        .args([
            "cmp",
            "--flex-report-path",
            "tests/report_1.xml",
            "--symbols-path",
            "tests/symbols.csv",
            "--ledger-journal-file",
            "tests/journal.ledger",
        ])
        .assert();

    // Assertions
    let expected = r#"Using tests/report_1.xml
Skipped: 2022-11-25/2022-11-25 DGS     ARCA Commission Adjustments 0.33225725 USD, Refund (DGS, 10, 2022-10-26)
Skipped: 2022-11-30/2022-11-30          Deposits/Withdrawals    1500 EUR, CASH RECEIPTS / ELECTRONIC FUND TRANSFERS
Skipped: 2022-12-05/2022-12-05          Broker Interest Received    2.77 AUD, AUD CREDIT INT FOR NOV-2022
New: 2022-12-14/2022-12-15 TCBT_AS Dividend    6.05 EUR, TCBT(NL0009690247) CASH DIVIDEND EUR 0.05 PER SHARE (Ordinary Dividend)
New: 2022-12-14/2022-12-15 TCBT_AS WhTax      -0.91 EUR, TCBT(NL0009690247) CASH DIVIDEND EUR 0.05 PER SHARE - NL TAX
Complete.
"#;

    /* These should be recognized from the ledger:
    New: 2022-12-15/2022-12-15 TRET_AS Dividend    38.4 EUR, TRET(NL0009690239) CASH DIVIDEND EUR 0.30 PER SHARE (Ordinary Dividend)
    New: 2022-12-15/2022-12-15 TRET_AS WhTax   -5.77 EUR, TRET(NL0009690239) CASH DIVIDEND EUR 0.30 PER SHARE - NL TAX
     */

    assert.success().stdout(expected);
}

#[rstest::rstest]
fn test_comparison_w_effective_dates(mut app_cmd: Command) {
    let assert = app_cmd
        .args(vec![
            "cmp",
            "--effective",
            "--flex-report-path",
            "tests/tax_adj_report.xml",
            "--symbols-path",
            "tests/symbols.csv",
            "--ledger-journal-file",
            "tests/tax_adj_journal.ledger",
        ])
        .assert();

    let expected = r#"Using tests/tax_adj_report.xml
New: 2023-01-24/2022-04-01 BBN     WhTax       0.66 USD, BBN(US09248X1000) CASH DIVIDEND USD 0.1229 PER SHARE - US TAX
New: 2023-01-24/2022-04-01 BBN     WhTax      -0.53 USD, BBN(US09248X1000) CASH DIVIDEND USD 0.1229 PER SHARE - US TAX
New: 2023-01-24/2022-04-30 BBN     WhTax       0.66 USD, BBN(US09248X1000) CASH DIVIDEND USD 0.1229 PER SHARE - US TAX
New: 2023-01-24/2022-04-30 BBN     WhTax      -0.53 USD, BBN(US09248X1000) CASH DIVIDEND USD 0.1229 PER SHARE - US TAX
Complete.
"#;

    /* These should be recognized:
    New: 2023-01-24/2022-12-01 BBN     WhTax    0.66 USD, BBN(US09248X1000) CASH DIVIDEND USD 0.1229 PER SHARE - US TAX
    New: 2023-01-24/2022-12-01 BBN     WhTax   -0.53 USD, BBN(US09248X1000) CASH DIVIDEND USD 0.1229 PER SHARE - US TAX
     */

    assert.success().stdout(expected);
}

#[rstest::rstest]
fn test_start_date_parameter(mut app_cmd: Command) {
    let assert = app_cmd
        .args(vec![
            "cmp",
            "--flex-report-path",
            "tests/report_1.xml",
            "--symbols-path",
            "tests/symbols.csv",
            "--ledger-journal-file",
            "tests/journal.ledger",
        ])
        .assert();

    assert.success();
}

#[rstest::rstest]
fn test_tcf(mut app_cmd: Command) {
    let assert = app_cmd
        .args(vec![
            "cmp",
            "--flex-report-path",
            "tests/tcf.xml",
            "--symbols-path",
            "tests/symbols.csv",
            "--ledger-journal-file",
            "tests/tcf.ledger",
        ])
        .assert();

    assert.success();
}

// #[rstest::rstest]
#[allow(dead_code)]
fn test_in_lieu() {
    let assert = Command::cargo_bin("ibflex").unwrap()
        .args(vec![
            "cmp",
            "--flex-report-path", "tests/in-lieu.xml",
            "--symbols-path", "tests/symbols.csv",
            "--ledger-journal-file", "tests/in-lieu.ledger",
        ])
        .assert();

    let expected = r#"
Using tests/in-lieu.xml
New: 2023-03-15/2023-03-16 EXXW    PaymentInLieu    3.74 EUR, EXXW(DE000A0H0744) PAYMENT IN LIEU OF DIVIDEND (Mixed Income)
Complete.
"#;
    assert.success().stdout(expected);
}