mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-08 10:22:09 +00:00
72a46fbfbf
* Allow to set variables and do loops * Fix mypy errors * improve code * mypy * pylint * accepts Openbb date keywords like 1MONTHAGO,LASTFRIDAY,3YEARSFROMNOW,NEXTTUESDAY * warn fix * add documentation for script foreach and vars creation * refactor controller as per James request * black linting * add another warning * Editing some routine enhancements (#5063) * move routine to new file * Move to relativedelta and add some tests * Fix mocking * Get match_and_return_openbb_keyword_date to 100% cov * start testing parse script * remove rogue prints --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * big improvement in routines tests * mypy lint * ruff lint * lint * typo * test relative time * cover edge case of home at end of script * fix edge case for going to home at start * explain better slicing * foreach tests added * lint * allow foreach loops to have different var names that is iterating * foreach more powerful * warning when var in foreach is not used * fail script when varname that iterates foreach loop is never defined * black * lint again * ruff * improve another edge case * fix test and fix a description * fix nft test and routine test * why mutual fund test failing --------- Co-authored-by: James Maslek <jmaslek11@gmail.com>
547 lines
14 KiB
Python
547 lines
14 KiB
Python
from typing import List
|
|
|
|
import pytest
|
|
from freezegun import freeze_time
|
|
|
|
from openbb_terminal.routine_functions import (
|
|
match_and_return_openbb_keyword_date,
|
|
parse_openbb_script,
|
|
)
|
|
|
|
|
|
def cleanup_script(script: str) -> List[str]:
|
|
raw_lines = [x for x in script.split("\n") if ("#" not in x) and x]
|
|
raw_lines = [raw_line.strip("\n") for raw_line in raw_lines if raw_line.strip("\n")]
|
|
return raw_lines
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_days_ago():
|
|
assert match_and_return_openbb_keyword_date("$1DAYSAGO") == "2023-05-16"
|
|
assert match_and_return_openbb_keyword_date("$10DAYSAGO") == "2023-05-07"
|
|
assert match_and_return_openbb_keyword_date("$-5DAYSAGO") == ""
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_months_ago():
|
|
assert match_and_return_openbb_keyword_date("$1MONTHSAGO") == "2023-04-17"
|
|
assert match_and_return_openbb_keyword_date("$10MONTHSAGO") == "2022-07-17"
|
|
assert match_and_return_openbb_keyword_date("$-5MONTHSAGO") == ""
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_years_ago():
|
|
assert match_and_return_openbb_keyword_date("$1YEARSAGO") == "2022-05-17"
|
|
assert match_and_return_openbb_keyword_date("$10YEARSAGO") == "2013-05-17"
|
|
assert match_and_return_openbb_keyword_date("$-5YEARSAGO") == ""
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_days_from_now():
|
|
assert match_and_return_openbb_keyword_date("$1DAYSFROMNOW") == "2023-05-18"
|
|
assert match_and_return_openbb_keyword_date("$10DAYSFROMNOW") == "2023-05-27"
|
|
assert match_and_return_openbb_keyword_date("$-5DAYSFROMNOW") == ""
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_months_from_now():
|
|
assert match_and_return_openbb_keyword_date("$1MONTHSFROMNOW") == "2023-06-17"
|
|
assert match_and_return_openbb_keyword_date("$10MONTHSFROMNOW") == "2024-03-17"
|
|
assert match_and_return_openbb_keyword_date("$-5MONTHSFROMNOW") == ""
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_years_from_now():
|
|
assert match_and_return_openbb_keyword_date("$1YEARSFROMNOW") == "2024-05-17"
|
|
assert match_and_return_openbb_keyword_date("$10YEARSFROMNOW") == "2033-05-17"
|
|
assert match_and_return_openbb_keyword_date("$-5YEARSFROMNOW") == ""
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_others():
|
|
assert match_and_return_openbb_keyword_date("$LASTMONDAY") == "2023-05-15"
|
|
assert match_and_return_openbb_keyword_date("$LASTFRIDAY") == "2023-05-12"
|
|
assert match_and_return_openbb_keyword_date("$NEXTFRIDAY") == "2023-05-19"
|
|
assert match_and_return_openbb_keyword_date("$LASTJANUARY") == "2023-01-01"
|
|
assert match_and_return_openbb_keyword_date("$NEXTMARCH") == "2024-03-01"
|
|
assert match_and_return_openbb_keyword_date("$LASTDECEMBER") == "2022-12-01"
|
|
assert match_and_return_openbb_keyword_date("$NEXTTUESDAY") == "2023-05-23"
|
|
assert match_and_return_openbb_keyword_date("$NEXTSEPTEMBER") == "2023-09-01"
|
|
|
|
|
|
@freeze_time("2023-05-17")
|
|
def test_parse_openbb_script():
|
|
raw_lines = [
|
|
"stocks",
|
|
"foreach $$VAR in PLTR,BB",
|
|
" load $$VAR --start $LASTJANUARY",
|
|
" candle",
|
|
"END",
|
|
]
|
|
test_out = parse_openbb_script(raw_lines)
|
|
assert test_out[1].split("/")[1:] == [
|
|
"stocks",
|
|
"load PLTR --start 2023-01-01",
|
|
"candle",
|
|
"load BB --start 2023-01-01",
|
|
"candle",
|
|
]
|
|
|
|
raw_lines2 = [
|
|
"$DATE = 2022-01-01",
|
|
"$DATES = 2022-01-01,2023-01-01",
|
|
"stocks",
|
|
"load $ARGV[0]",
|
|
"ta/ema/..",
|
|
"foreach $$VAR in $ARGV[1:]",
|
|
" load $$VAR --start $DATE[0]",
|
|
" candle",
|
|
"end",
|
|
"ca/set $ARGV[2:]/historical/..",
|
|
"FOREACH $$VAR in $ARGV",
|
|
"load $$VAR --start $DATES[0] --end $DATES[1]",
|
|
"candle",
|
|
" end",
|
|
"foreach $$VAR in $ARGV[1:3]",
|
|
" load $$VAR --start 2022-01-01",
|
|
" candle",
|
|
"END",
|
|
"foreach $$VAR in PLTR,BB",
|
|
" load $$VAR --start 2022-01-01",
|
|
" candle",
|
|
"END",
|
|
]
|
|
test_out2 = parse_openbb_script(raw_lines2, None)
|
|
assert (
|
|
test_out2[0]
|
|
== "[red]Variable $ARGV not given for current routine script.[/red]"
|
|
)
|
|
|
|
|
|
@freeze_time("2023-06-04")
|
|
@pytest.mark.parametrize(
|
|
"routine, input_args, expected_error, expected_queue",
|
|
[
|
|
(
|
|
"""
|
|
# This is a comment that will be ignored
|
|
stocks/load aapl/candle
|
|
/
|
|
""",
|
|
None,
|
|
"",
|
|
"/stocks/load aapl/candle/home",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01
|
|
|
|
stocks/load AAPL --start $DATE
|
|
""",
|
|
None,
|
|
"",
|
|
"/stocks/load AAPL --start 2022-01-01",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01
|
|
|
|
stocks/load AAPL --start $DATE[0]
|
|
""",
|
|
None,
|
|
"",
|
|
"/stocks/load AAPL --start 2022-01-01",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01,2024-01-01
|
|
|
|
stocks/load AAPL --start $DATE[0]
|
|
""",
|
|
None,
|
|
"",
|
|
"/stocks/load AAPL --start 2022-01-01",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01,2024-01-01
|
|
|
|
stocks/load AAPL --start $DATE[0] --end $DATE[1]
|
|
""",
|
|
None,
|
|
"",
|
|
"/stocks/load AAPL --start 2022-01-01 --end 2024-01-01",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01
|
|
|
|
stocks/load AAPL --start $DATE[1]
|
|
""",
|
|
None,
|
|
"[red]Variable $DATE only has 1 elements and there was an attempt to access it with index 1.[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01,2023-01-01
|
|
|
|
stocks/load AAPL --start $DATE[2]
|
|
""",
|
|
None,
|
|
"[red]Variable $DATE only has 2 elements and there was an attempt to access it with index 2.[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks/load AAPL --start $DATE[1]
|
|
# Set variable
|
|
$DATE = 2022-01-01,2023-01-01
|
|
""",
|
|
None,
|
|
"",
|
|
"/stocks/load AAPL --start 2023-01-01",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01,2023-01-01
|
|
|
|
stocks/load AAPL --start $DATE[5]
|
|
""",
|
|
None,
|
|
"[red]Variable $DATE only has 2 elements and there was an attempt to access it with index 5.[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01
|
|
|
|
stocks/load AAPL --start $DATE[5]
|
|
""",
|
|
None,
|
|
"[red]Variable $DATE only has 1 elements and there was an attempt to access it with index 5.[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01
|
|
|
|
stocks/load AAPL --start $DATE[-2]
|
|
""",
|
|
None,
|
|
"[red]Negative index on $DATE is not allowed[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
$DATE = 2022-01-01,2024-01-01
|
|
|
|
stocks/load AAPL --start $DATE[-1]
|
|
""",
|
|
None,
|
|
"[red]Negative index on $DATE is not allowed[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set variable
|
|
DATE = 2022-01-01,2024-01-01
|
|
|
|
stocks/load AAPL --start $DATE[0]
|
|
""",
|
|
None,
|
|
"[red]Variable $DATE not given for current routine script.[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks/load $ARGV[3]
|
|
""",
|
|
"TSLA,MSFT".split(","),
|
|
"[red]Variable $ARGV only has 2 elements and there was an attempt to access it with index 3.[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks/load $ARGV[-1]
|
|
""",
|
|
"TSLA,MSFT".split(","),
|
|
"[red]Negative index on $ARGV is not allowed[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks/load $ARGV[a]
|
|
""",
|
|
"TSLA,MSFT".split(","),
|
|
"[red]Index 'a' is not a value[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks/load $ARGV[0]/candle --start $1MONTHSAGO
|
|
""",
|
|
"TSLA,MSFT".split(","),
|
|
"",
|
|
"/stocks/load TSLA/candle --start 2023-05-04",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# cool beans this is a comment that should be ignored
|
|
|
|
stocks/ca/set $ARGV[1:]/historical
|
|
..
|
|
""",
|
|
"TSLA,MSFT,AAPL,NVDA".split(","),
|
|
"",
|
|
"/stocks/ca/set MSFT,AAPL,NVDA/historical/..",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# cool beans this is a comment that should be ignored
|
|
|
|
stocks/ca/set $ARGV/historical
|
|
/
|
|
""",
|
|
"TSLA,MSFT,AAPL,NVDA".split(","),
|
|
"",
|
|
"/stocks/ca/set TSLA,MSFT,AAPL,NVDA/historical/home",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
/stocks/ca/set $ARGV[1:3]/historical
|
|
""",
|
|
"TSLA,MSFT,AAPL,NVDA".split(","),
|
|
"",
|
|
"/stocks/ca/set MSFT,AAPL/historical",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
/
|
|
stocks/ca/set $ARGV[1:3]/historical
|
|
""",
|
|
"TSLA,MSFT,AAPL,NVDA".split(","),
|
|
"",
|
|
"/home/stocks/ca/set MSFT,AAPL/historical",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
|
|
# Set list of fixed variables
|
|
$DATES = 2022-01-01,2023-01-01
|
|
|
|
# Charts from all ARGV elements from position 1 onwards
|
|
stocks
|
|
foreach $$VAR in $ARGV[1:]
|
|
load $$VAR --start $DATES[0] --end $DATES[1]/dps/psi/..
|
|
end
|
|
""",
|
|
"TSLA,MSFT,NVDA".split(","),
|
|
"",
|
|
"/stocks/load MSFT --start 2022-01-01 --end 2023-01-01/dps/psi/../"
|
|
"load NVDA --start 2022-01-01 --end 2023-01-01/dps/psi/..",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set list of fixed variables
|
|
$DATE = 2022-01-01
|
|
|
|
# Charts from all ARGV elements from position 1 onwards
|
|
stocks
|
|
FOREACH $$VAR in $ARGV
|
|
load $$VAR --start $DATE[0]/ins/stats/..
|
|
end
|
|
""",
|
|
"TSLA,MSFT".split(","),
|
|
"",
|
|
"/stocks/load TSLA --start 2022-01-01/ins/stats/../load MSFT --start 2022-01-01/ins/stats/..",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Set list of fixed variables
|
|
$DATE = 2022-01-01
|
|
|
|
# Charts from all ARGV elements from position 1 onwards
|
|
stocks
|
|
# Charts elements in positions 1 and 3 of ARGV
|
|
foreach $$VAR in $ARGV[1:3]
|
|
load $$VAR --start $DATE
|
|
ba
|
|
regions
|
|
..
|
|
END
|
|
""",
|
|
"TSLA,MSFT,AAPL,PLTR".split(","),
|
|
"",
|
|
"/stocks/load MSFT --start 2022-01-01/ba/regions/../load AAPL --start 2022-01-01/ba/regions/..",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
|
|
# Charts for PLTR and BB
|
|
foreach $$VAR in PLTR,BB
|
|
load $$VAR --start $LASTJANUARY
|
|
candle
|
|
END
|
|
|
|
home
|
|
""",
|
|
"",
|
|
"",
|
|
"/stocks/load PLTR --start 2023-01-01/candle/load BB --start 2023-01-01/candle/home",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
# Charts for PLTR and BB
|
|
foreach $$SOMETHING in PLTR,BB
|
|
load $$SOMETHING --start $LASTJANUARY
|
|
candle
|
|
END
|
|
""",
|
|
"",
|
|
"",
|
|
"/stocks/load PLTR --start 2023-01-01/candle/load BB --start 2023-01-01/candle",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
# forgetting the end on purpose
|
|
foreach $$X in PLTR,BB
|
|
load $$X --start $LASTJANUARY
|
|
""",
|
|
"",
|
|
"[red]The script has a foreach loop that doesn't terminate. "
|
|
"Add the keyword 'end' to explicitly terminate loop[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
# pretending I forgot the header
|
|
load $$X --start $LASTJANUARY
|
|
end
|
|
""",
|
|
"",
|
|
"[red]The script has a foreach loop that terminates before it gets started. "
|
|
"Add the keyword 'foreach' to explicitly start loop[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
foreach $$X in PLTR,BB
|
|
end
|
|
""",
|
|
"",
|
|
"",
|
|
"/stocks",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
foreach $$D in 2022-01-01,2023-01-01
|
|
load AAPL --start $$D
|
|
end
|
|
""",
|
|
"",
|
|
"",
|
|
"/stocks/load AAPL --start 2022-01-01/load AAPL --start 2023-01-01",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
foreach $$UNUSED in 1,2
|
|
load AAPL
|
|
end
|
|
""",
|
|
"",
|
|
"",
|
|
"/stocks/load AAPL/load AAPL",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
stocks
|
|
foreach $$UNUSED in 1,2
|
|
load $$TYPO
|
|
end
|
|
""",
|
|
"",
|
|
"[red]The script has a foreach loop that iterates through "
|
|
"1,2 with variable $$UNUSED but another var name is being "
|
|
"utilized instead[/red]",
|
|
"",
|
|
),
|
|
#############################
|
|
(
|
|
"""
|
|
# Defining variables
|
|
$TICKERS = AAPL,TSLA,MSFT
|
|
$DATES = 2020-01-01,2021-01-01
|
|
|
|
stocks/load $TICKERS[0] --start $DATES[1]/candle
|
|
|
|
foreach $$VAR in $TICKERS
|
|
load $$VAR/fa/income
|
|
..
|
|
dps/psi/..
|
|
end
|
|
|
|
load $ARGV[0]/ta/ema -l 50,100,200
|
|
""",
|
|
"NVDA",
|
|
"",
|
|
"/stocks/load AAPL --start 2021-01-01/candle/load AAPL/fa/income/../dps/psi/"
|
|
"../load TSLA/fa/income/../dps/psi/../load MSFT/fa/income/../dps/psi/../"
|
|
"load NVDA/ta/ema -l 50,100,200",
|
|
),
|
|
],
|
|
)
|
|
def test_openbb_routines(routine, input_args, expected_error, expected_queue):
|
|
err, queue = parse_openbb_script(routine.split("\n"), input_args)
|
|
|
|
assert err == expected_error
|
|
assert queue == expected_queue
|