"""Test Commodity API endpoints.""" import base64 import pytest import requests from openbb_core.env import Env from openbb_core.provider.utils.helpers import get_querystring # pylint: disable=redefined-outer-name @pytest.fixture(scope="session") def headers(): """Get the headers for the API request.""" userpass = f"{Env().API_USERNAME}:{Env().API_PASSWORD}" userpass_bytes = userpass.encode("ascii") base64_bytes = base64.b64encode(userpass_bytes) return {"Authorization": f"Basic {base64_bytes.decode('ascii')}"} @pytest.mark.parametrize( "params", [ ( { "commodity": "all", "start_date": None, "end_date": None, "frequency": None, "transform": None, "aggregation_method": None, "provider": "fred", } ), ], ) @pytest.mark.integration def test_commodity_price_spot(params, headers): """Test the commodity spot prices endpoint.""" params = {p: v for p, v in params.items() if v} query_str = get_querystring(params, []) url = f"http://0.0.0.0:8000/api/v1/commodity/price/spot?{query_str}" result = requests.get(url, headers=headers, timeout=10) assert isinstance(result, requests.Response) assert result.status_code == 200 @pytest.mark.parametrize( "params", [ ( { "category": "balance_sheet", "table": "stocks", "start_date": None, "end_date": None, "provider": "eia", "use_cache": True, } ), ( { "category": "weekly_estimates", "table": "crude_production", "start_date": "2020-01-01", "end_date": "2023-12-31", "provider": "eia", "use_cache": True, } ), ], ) @pytest.mark.integration def test_commodity_petroleum_status_report(params, headers): """Test the Petroleum Status Report endpoint.""" params = {p: v for p, v in params.items() if v} query_str = get_querystring(params, []) url = f"http://0.0.0.0:8000/api/v1/commodity/petroleum_status_report?{query_str}" result = requests.get(url, headers=headers, timeout=10) assert isinstance(result, requests.Response) assert result.status_code == 200 @pytest.mark.parametrize( "params", [ ( { "table": "01", "symbol": None, "start_date": "2024-09-01", "end_date": "2024-10-01", "provider": "eia", "frequency": "month", } ), ], ) @pytest.mark.integration def test_commodity_short_term_energy_outlook(params, headers): """Test the Short Term Energy Outlook endpoint.""" params = {p: v for p, v in params.items() if v} query_str = get_querystring(params, []) url = f"http://0.0.0.0:8000/api/v1/commodity/short_term_energy_outlook?{query_str}" result = requests.get(url, headers=headers, timeout=10) assert isinstance(result, requests.Response) assert result.status_code == 200 @pytest.mark.parametrize( "params", [ ( { "commodity": "sugar", "year": 2025, "month": 5, "provider": "government_us", } ), ], ) @pytest.mark.integration def test_commodity_psd_report(params, headers): """Test the Commodity PSD Report endpoint.""" params = {p: v for p, v in params.items() if v} query_str = get_querystring(params, []) url = f"http://0.0.0.0:8000/api/v1/commodity/psd_report?{query_str}" result = requests.get(url, headers=headers, timeout=10) assert isinstance(result, requests.Response) assert result.status_code == 200 @pytest.mark.parametrize( "params", [ ( { "urls": "https://esmis.nal.usda.gov/sites/default/release-files/cj82k728n/vx023b997/z890tr81b/wwcb1825.pdf" + ",https://esmis.nal.usda.gov/sites/default/release-files/cj82k728n/w6635s43r/x059dz29h/wwcb1924.pdf", "provider": "government_us", } ), ], ) @pytest.mark.integration def test_commodity_weather_bulletins_download(params, headers): """Test the Commodity Weather Bulletin Download endpoint.""" params = {p: v for p, v in params.items() if v} urls = params.pop("urls", "") query_str = get_querystring(params, []) url = f"http://0.0.0.0:8000/api/v1/commodity/weather_bulletins_download?{query_str}" result = requests.post(url, headers=headers, json=urls, timeout=30) assert isinstance(result, requests.Response) assert result.status_code == 200 @pytest.mark.parametrize( "params", [ ( { "year": 2025, "month": 5, "week": 2, "provider": "government_us", } ), ], ) @pytest.mark.integration def test_commodity_weather_bulletins(params, headers): """Test the Commodity Weather Bulletins endpoint.""" params = {p: v for p, v in params.items() if v} query_str = get_querystring(params, []) url = f"http://0.0.0.0:8000/api/v1/commodity/weather_bulletins?{query_str}" result = requests.get(url, headers=headers, timeout=10) assert isinstance(result, requests.Response) assert result.status_code == 200 @pytest.mark.parametrize( "params", [ ( { "provider": "government_us", } ), ( { "provider": "government_us", "report_id": "coffee_summary", "commodity": None, "country": None, "attribute": None, "start_year": None, "end_year": None, "aggregate_regions": False, } ), ( { "report_id": "world_crop_production_summary", # ignored if commodity is set "commodity": "corn", "country": "united_states,argentina", "attribute": "exports", "start_year": 2025, "end_year": 2025, "provider": "government_us", "aggregate_regions": False, } ), ], ) @pytest.mark.integration def test_commodity_psd_data(params, headers): """Test the Commodity PSD Data endpoint.""" params = {p: v for p, v in params.items() if v} query_str = get_querystring(params, []) url = f"http://0.0.0.0:8000/api/v1/commodity/psd_data?{query_str}" result = requests.get(url, headers=headers, timeout=10) assert isinstance(result, requests.Response) assert result.status_code == 200