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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
|
import logging
import pytest
from gql import __version__
from gql.cli import (
get_execute_args,
get_introspection_args,
get_parser,
get_transport,
get_transport_args,
main,
)
@pytest.fixture
def parser():
return get_parser()
def test_cli_parser(parser):
# Simple call with https server
# gql-cli https://your_server.com
args = parser.parse_args(["https://your_server.com"])
assert args.server == "https://your_server.com"
assert args.headers is None
assert args.loglevel is None
assert args.operation_name is None
assert args.variables is None
# Call with variable values parameters
# gql-cli https://your_server.com --variables KEY1:value1 KEY2:value2
args = parser.parse_args(
["https://your_server.com", "--variables", "KEY1:value1", "KEY2:value2"]
)
assert args.server == "https://your_server.com"
assert args.variables == ["KEY1:value1", "KEY2:value2"]
# Call with headers values parameters
# gql-cli https://your_server.com --headers HEADER1:value1 HEADER2:value2
args = parser.parse_args(
["https://your_server.com", "--headers", "HEADER1:value1", "HEADER2:value2"]
)
assert args.server == "https://your_server.com"
assert args.headers == ["HEADER1:value1", "HEADER2:value2"]
# Call with header value with a space in value
# gql-cli https://your_server.com --headers Authorization:"Bearer blahblah"
args = parser.parse_args(
["https://your_server.com", "--headers", "Authorization:Bearer blahblah"]
)
assert args.server == "https://your_server.com"
assert args.headers == ["Authorization:Bearer blahblah"]
# Check loglevel flags
# gql-cli https://your_server.com --debug
args = parser.parse_args(["https://your_server.com", "--debug"])
assert args.loglevel == logging.DEBUG
# gql-cli https://your_server.com --verbose
args = parser.parse_args(["https://your_server.com", "--verbose"])
assert args.loglevel == logging.INFO
# Check operation_name
# gql-cli https://your_server.com --operation-name my_operation
args = parser.parse_args(
["https://your_server.com", "--operation-name", "my_operation"]
)
assert args.operation_name == "my_operation"
# Check execute_timeout
# gql-cli https://your_server.com --execute-timeout 1
args = parser.parse_args(["https://your_server.com", "--execute-timeout", "1"])
assert args.execute_timeout == 1
# gql-cli https://your_server.com --execute-timeout=none
args = parser.parse_args(["https://your_server.com", "--execute-timeout", "none"])
assert args.execute_timeout is None
# gql-cli https://your_server.com --execute-timeout=-1
with pytest.raises(SystemExit):
args = parser.parse_args(["https://your_server.com", "--execute-timeout", "-1"])
# gql-cli https://your_server.com --execute-timeout=invalid
with pytest.raises(SystemExit):
args = parser.parse_args(
["https://your_server.com", "--execute-timeout", "invalid"]
)
def test_cli_parse_headers(parser):
args = parser.parse_args(
[
"https://your_server.com",
"--headers",
"Token1:1234",
"Token2:5678",
"TokenWithSpace:abc def",
"TokenWithColon:abc:def",
]
)
transport_args = get_transport_args(args)
expected_headers = {
"Token1": "1234",
"Token2": "5678",
"TokenWithSpace": "abc def",
"TokenWithColon": "abc:def",
}
assert transport_args == {"headers": expected_headers}
def test_cli_parse_headers_invalid_header(parser):
args = parser.parse_args(
["https://your_server.com", "--headers", "TokenWithoutColon"]
)
with pytest.raises(ValueError):
get_transport_args(args)
def test_cli_parse_operation_name(parser):
args = parser.parse_args(["https://your_server.com", "--operation-name", "myop"])
execute_args = get_execute_args(args)
assert execute_args == {"operation_name": "myop"}
@pytest.mark.parametrize(
"param",
[
{"args": ["key:abcdef"], "d": {"key": "abcdef"}},
{"args": ['key:"abcdef"'], "d": {"key": "abcdef"}},
{"args": ["key:1234"], "d": {"key": 1234}},
{"args": ["key1:1234", "key2:5678"], "d": {"key1": 1234, "key2": 5678}},
{"args": ["key1:null"], "d": {"key1": None}},
{"args": ["key1:true"], "d": {"key1": True}},
{"args": ["key1:false"], "d": {"key1": False}},
{
"args": ["key1:null", "key2:abcd", "key3:5"],
"d": {"key1": None, "key2": "abcd", "key3": 5},
},
],
)
def test_cli_parse_variable_value(parser, param):
args = parser.parse_args(["https://your_server.com", "--variables", *param["args"]])
execute_args = get_execute_args(args)
expected_variable_values = param["d"]
assert execute_args == {"variable_values": expected_variable_values}
@pytest.mark.parametrize("param", ["nocolon", 'key:"'])
def test_cli_parse_variable_value_invalid_param(parser, param):
args = parser.parse_args(["https://your_server.com", "--variables", param])
with pytest.raises(ValueError):
get_execute_args(args)
@pytest.mark.aiohttp
@pytest.mark.parametrize(
"url",
["http://your_server.com", "https://your_server.com"],
)
def test_cli_get_transport_aiohttp(parser, url):
from gql.transport.aiohttp import AIOHTTPTransport
args = parser.parse_args([url])
transport = get_transport(args)
assert isinstance(transport, AIOHTTPTransport)
@pytest.mark.httpx
@pytest.mark.parametrize(
"url",
["http://your_server.com", "https://your_server.com"],
)
def test_cli_get_transport_httpx(parser, url):
from gql.transport.httpx import HTTPXAsyncTransport
args = parser.parse_args([url, "--transport", "httpx"])
transport = get_transport(args)
assert isinstance(transport, HTTPXAsyncTransport)
@pytest.mark.websockets
@pytest.mark.parametrize(
"url",
["ws://your_server.com", "wss://your_server.com"],
)
def test_cli_get_transport_websockets(parser, url):
from gql.transport.websockets import WebsocketsTransport
args = parser.parse_args([url])
transport = get_transport(args)
assert isinstance(transport, WebsocketsTransport)
@pytest.mark.websockets
@pytest.mark.parametrize(
"url",
["ws://your_server.com", "wss://your_server.com"],
)
def test_cli_get_transport_phoenix(parser, url):
from gql.transport.phoenix_channel_websockets import (
PhoenixChannelWebsocketsTransport,
)
args = parser.parse_args([url, "--transport", "phoenix"])
transport = get_transport(args)
assert isinstance(transport, PhoenixChannelWebsocketsTransport)
@pytest.mark.websockets
@pytest.mark.botocore
@pytest.mark.parametrize(
"url",
[
"wss://XXXXXX.appsync-api.eu-west-3.amazonaws.com/graphql",
"wss://noregion.amazonaws.com/graphql",
],
)
def test_cli_get_transport_appsync_websockets_iam(parser, url):
args = parser.parse_args([url, "--transport", "appsync_websockets"])
transport = get_transport(args)
# In the tests, the AWS Appsync credentials are not set
# So the transport is None
assert transport is None
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.botocore
@pytest.mark.parametrize(
"url",
["wss://XXXXXX.appsync-api.eu-west-3.amazonaws.com/graphql"],
)
async def test_cli_main_appsync_websockets_iam(parser, url):
args = parser.parse_args([url, "--transport", "appsync_websockets"])
exit_code = await main(args)
# In the tests, the AWS Appsync credentials are not set
# So the transport is None and the main returns
# an exit_code of 1
assert exit_code == 1
@pytest.mark.websockets
@pytest.mark.parametrize(
"url",
["wss://XXXXXX.appsync-api.eu-west-3.amazonaws.com/graphql"],
)
def test_cli_get_transport_appsync_websockets_api_key(parser, url):
from gql.transport.appsync_auth import AppSyncApiKeyAuthentication
from gql.transport.appsync_websockets import AppSyncWebsocketsTransport
args = parser.parse_args(
[url, "--transport", "appsync_websockets", "--api-key", "test-api-key"]
)
transport = get_transport(args)
assert isinstance(transport, AppSyncWebsocketsTransport)
assert isinstance(transport.auth, AppSyncApiKeyAuthentication)
assert transport.auth.api_key == "test-api-key"
@pytest.mark.websockets
@pytest.mark.parametrize(
"url",
["wss://XXXXXX.appsync-api.eu-west-3.amazonaws.com/graphql"],
)
def test_cli_get_transport_appsync_websockets_jwt(parser, url):
from gql.transport.appsync_auth import AppSyncJWTAuthentication
from gql.transport.appsync_websockets import AppSyncWebsocketsTransport
args = parser.parse_args(
[url, "--transport", "appsync_websockets", "--jwt", "test-jwt"]
)
transport = get_transport(args)
assert isinstance(transport, AppSyncWebsocketsTransport)
assert isinstance(transport.auth, AppSyncJWTAuthentication)
assert transport.auth.jwt == "test-jwt"
@pytest.mark.aiohttp
@pytest.mark.botocore
@pytest.mark.parametrize(
"url",
["https://XXXXXX.appsync-api.eu-west-3.amazonaws.com/graphql"],
)
def test_cli_get_transport_appsync_http_iam(parser, url):
from gql.transport.aiohttp import AIOHTTPTransport
args = parser.parse_args([url, "--transport", "appsync_http"])
transport = get_transport(args)
assert isinstance(transport, AIOHTTPTransport)
@pytest.mark.aiohttp
@pytest.mark.parametrize(
"url",
["https://XXXXXX.appsync-api.eu-west-3.amazonaws.com/graphql"],
)
def test_cli_get_transport_appsync_http_api_key(parser, url):
from gql.transport.aiohttp import AIOHTTPTransport
from gql.transport.appsync_auth import AppSyncApiKeyAuthentication
args = parser.parse_args(
[url, "--transport", "appsync_http", "--api-key", "test-api-key"]
)
transport = get_transport(args)
assert isinstance(transport, AIOHTTPTransport)
assert isinstance(transport.auth, AppSyncApiKeyAuthentication)
assert transport.auth.api_key == "test-api-key"
@pytest.mark.aiohttp
@pytest.mark.parametrize(
"url",
["https://XXXXXX.appsync-api.eu-west-3.amazonaws.com/graphql"],
)
def test_cli_get_transport_appsync_http_jwt(parser, url):
from gql.transport.aiohttp import AIOHTTPTransport
from gql.transport.appsync_auth import AppSyncJWTAuthentication
args = parser.parse_args([url, "--transport", "appsync_http", "--jwt", "test-jwt"])
transport = get_transport(args)
assert isinstance(transport, AIOHTTPTransport)
assert isinstance(transport.auth, AppSyncJWTAuthentication)
assert transport.auth.jwt == "test-jwt"
def test_cli_get_transport_no_protocol(parser):
args = parser.parse_args(["your_server.com"])
with pytest.raises(ValueError):
get_transport(args)
@pytest.mark.script_launch_mode("subprocess")
def test_cli_ep_version(script_runner):
ret = script_runner.run(["gql-cli", "--version"])
assert ret.success
assert ret.stdout == f"v{__version__}\n"
assert ret.stderr == ""
def test_cli_parse_schema_download(parser):
args = parser.parse_args(
[
"https://your_server.com",
"--schema-download",
"descriptions:false",
"input_value_deprecation:true",
"specified_by_url:True",
"schema_description:true",
"directive_is_repeatable:true",
"--print-schema",
]
)
introspection_args = get_introspection_args(args)
expected_args = {
"descriptions": False,
"input_value_deprecation": True,
"specified_by_url": True,
"schema_description": True,
"directive_is_repeatable": True,
}
assert introspection_args == expected_args
@pytest.mark.parametrize(
"invalid_args",
[
["https://your_server.com", "--schema-download", "ArgWithoutColon"],
["https://your_server.com", "--schema-download", "blahblah:true"],
["https://your_server.com", "--schema-download", "descriptions:invalid_bool"],
],
)
def test_cli_parse_schema_download_invalid_arg(parser, invalid_args):
args = parser.parse_args(invalid_args)
with pytest.raises(ValueError):
get_introspection_args(args)
|