arcade-mcp/arcade/tests/cli/test_utils.py
Eric Gustin 8508a28f54
Config Refactor (#116)
# PR Description
1. Removes `arcade config` CLI command and it's helper function.
2. Upon `arcade login`, if the user does not have an `arcade.env` file,
then a templated environment file is created for the user.
3. Removed `EngineConfig` and all references to it. Since there is no
longer an `EngineConfig`, this PR refactors the CLI to compute the
engine URL based on the command-line flags that were provided.
4. Renamed `arcade.toml` to `credentials.yaml`. If a user is using
`arcade.toml`, then we will display a deprecation message and then
automatically migrate their `arcade.toml` to `credentials.yaml`. NOTE:
Eventually this auto-migration support should be removed.
5. `arcade.env` is now an optional file
6. Make `arcade show` default to `https://api.arcade-ai.com/v1` instead
of localhost.
-------




## Ensuring engine url is still computed correctly:
I used the following matrix to ensure that the behavior has not changed
after the refactor. This matrix is tested in `test_utils.py`

DEFAULT_HOST = "api.arcade-ai.com"  
DEFAULT_PORT = None  
DEFAULT_FORCE_TLS = False  
DEFAULT_FORCE_NO_TLS = False  


| Command Line Arguments | Host | Port | Force TLS | Force No TLS |
Main's URL | This PR's URL |

|----------------------------------------|-----------------|---------------|-----------|--------------|-----------------------------------|-----------------------------------|
| | DEFAULT_HOST | DEFAULT_PORT | False | False |
https://api.arcade-ai.com/v1 | https://api.arcade-ai.com/v1 |
| --host localhost | localhost | DEFAULT_PORT | False | False |
http://localhost:9099/v1 | http://localhost:9099/v1 |
| -p 9099 | DEFAULT_HOST | 9099 | False | False |
https://api.arcade-ai.com:9099/v1 | https://api.arcade-ai.com:9099/v1 |
| --host localhost -p 9099 | localhost | 9099 | False | False |
http://localhost:9099/v1 | http://localhost:9099/v1 |
| --tls | DEFAULT_HOST | DEFAULT_PORT | True | False |
https://api.arcade-ai.com/v1 | https://api.arcade-ai.com/v1 |
| --host localhost --tls | localhost | DEFAULT_PORT | True | False |
https://localhost:9099/v1 | https://localhost:9099/v1 |
| -p 9099 --tls | DEFAULT_HOST | 9099 | True | False |
https://api.arcade-ai.com:9099/v1 | https://api.arcade-ai.com:9099/v1 |
| --host localhost -p 9099 --tls | localhost | 9099 | True | False |
https://localhost:9099/v1 | https://localhost:9099/v1 |
| --no-tls | DEFAULT_HOST | DEFAULT_PORT | False | True |
http://api.arcade-ai.com/v1 | http://api.arcade-ai.com/v1 |
| --host localhost --no-tls | localhost | DEFAULT_PORT | False | True |
http://localhost:9099/v1 | http://localhost:9099/v1 |
| -p 9099 --no-tls | DEFAULT_HOST | 9099 | False | True |
http://api.arcade-ai.com:9099/v1 | http://api.arcade-ai.com:9099/v1 |
| --host localhost -p 9099 --no-tls | localhost | 9099 | False | True |
http://localhost:9099/v1 | http://localhost:9099/v1 |
| --tls --no-tls | DEFAULT_HOST | DEFAULT_PORT | True | True |
http://api.arcade-ai.com/v1 | http://api.arcade-ai.com/v1 |
| --host localhost --tls --no-tls | localhost | DEFAULT_PORT | True |
True | http://localhost:9099/v1 | http://localhost:9099/v1 |
| -p 9099 --tls --no-tls | DEFAULT_HOST | 9099 | True | True |
http://api.arcade-ai.com:9099/v1 | http://api.arcade-ai.com:9099/v1 |
| --host localhost -p 9099 --tls --no-tls| localhost | 9099 | True |
True | http://localhost:9099/v1 | http://localhost:9099/v1 |
| --host arandomhost.com | arandomhost.com | DEFAULT_PORT | False |
False | https://arandomhost.com/v1 | https://arandomhost.com/v1 |
2024-10-24 11:34:33 -07:00

195 lines
5.8 KiB
Python

import pytest
from arcade.cli.utils import compute_base_url
DEFAULT_HOST = "api.arcade-ai.com"
LOCALHOST = "localhost"
DEFAULT_PORT = None
DEFAULT_FORCE_TLS = False
DEFAULT_FORCE_NO_TLS = False
@pytest.mark.parametrize(
"inputs, expected_output",
[
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": DEFAULT_PORT,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"https://api.arcade-ai.com",
id="default",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": DEFAULT_PORT,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"http://localhost:9099",
id="localhost",
),
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": 9099,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"https://api.arcade-ai.com:9099",
id="custom port",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": 9099,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"http://localhost:9099",
id="localhost with custom port",
),
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": DEFAULT_PORT,
"force_tls": True,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"https://api.arcade-ai.com",
id="force TLS",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": DEFAULT_PORT,
"force_tls": True,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"https://localhost:9099",
id="localhost with force TLS",
),
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": 9099,
"force_tls": True,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"https://api.arcade-ai.com:9099",
id="custom port with force TLS",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": 9099,
"force_tls": True,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"https://localhost:9099",
id="localhost with custom port and force TLS",
),
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": DEFAULT_PORT,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": True,
},
"http://api.arcade-ai.com",
id="force no TLS",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": DEFAULT_PORT,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": True,
},
"http://localhost:9099",
id="localhost with force no TLS",
),
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": 9099,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": True,
},
"http://api.arcade-ai.com:9099",
id="custom port with force no TLS",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": 9099,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": True,
},
"http://localhost:9099",
id="localhost with custom port and force no TLS",
),
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": DEFAULT_PORT,
"force_tls": True,
"force_no_tls": True,
},
"http://api.arcade-ai.com",
id="force TLS and no TLS",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": DEFAULT_PORT,
"force_tls": True,
"force_no_tls": True,
},
"http://localhost:9099",
id="localhost with force TLS and no TLS",
),
pytest.param(
{
"host_input": DEFAULT_HOST,
"port_input": 9099,
"force_tls": True,
"force_no_tls": True,
},
"http://api.arcade-ai.com:9099",
id="custom port with force TLS and no TLS",
),
pytest.param(
{
"host_input": LOCALHOST,
"port_input": 9099,
"force_tls": True,
"force_no_tls": True,
},
"http://localhost:9099",
id="localhost with custom port, force TLS and no TLS",
),
pytest.param(
{
"host_input": "arandomhost.com",
"port_input": DEFAULT_PORT,
"force_tls": DEFAULT_FORCE_TLS,
"force_no_tls": DEFAULT_FORCE_NO_TLS,
},
"https://arandomhost.com",
id="random host",
),
],
)
def test_compute_base_url(inputs: dict, expected_output: str):
base_url = compute_base_url(
inputs["force_tls"],
inputs["force_no_tls"],
inputs["host_input"],
inputs["port_input"],
)
assert base_url == expected_output