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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
|
from pathlib import Path
import pytest
import yaml
from pyfdb import FDB, ControlAction, ControlIdentifier
from pyfdb._internal import _ControlAction, _ControlIdentifier
from pyfdb.pyfdb_type import UserInputMapper
def test_control_action_values():
assert ControlAction.NONE.value == _ControlAction.NONE.value
assert ControlAction.DISABLE.value == _ControlAction.DISABLE.value
assert ControlAction.ENABLE.value == _ControlAction.ENABLE.value
def test_control_identifier_values():
assert _ControlIdentifier.NONE.value == ControlIdentifier.NONE.value
assert _ControlIdentifier.LIST.value == ControlIdentifier.LIST
assert _ControlIdentifier.RETRIEVE.value == ControlIdentifier.RETRIEVE
assert _ControlIdentifier.ARCHIVE.value == ControlIdentifier.ARCHIVE
assert _ControlIdentifier.WIPE.value == ControlIdentifier.WIPE
assert _ControlIdentifier.UNIQUEROOT.value == ControlIdentifier.UNIQUEROOT
def test_control_identifier_string():
assert str(ControlIdentifier.NONE) == "NONE"
assert str(ControlIdentifier.LIST) == "LIST"
assert str(ControlIdentifier.RETRIEVE) == "RETRIEVE"
assert str(ControlIdentifier.ARCHIVE) == "ARCHIVE"
assert str(ControlIdentifier.WIPE) == "WIPE"
assert str(ControlIdentifier.UNIQUEROOT) == "UNIQUEROOT"
assert str(ControlIdentifier.NONE | ControlIdentifier.LIST) == "LIST"
assert str(ControlIdentifier.LIST | ControlIdentifier.RETRIEVE) == "LIST|RETRIEVE"
assert str(ControlIdentifier.RETRIEVE | ControlIdentifier.NONE) == "RETRIEVE"
assert (
str(ControlIdentifier.RETRIEVE | ControlIdentifier.NONE | ControlIdentifier.LIST)
== "LIST|RETRIEVE"
)
def test_control_action_string():
assert str(ControlAction.NONE) == "NONE"
assert str(ControlAction.ENABLE) == "ENABLE"
assert str(ControlAction.DISABLE) == "DISABLE"
def test_control_lock_retrieve(read_only_fdb_setup, function_tmp):
fdb = FDB(read_only_fdb_setup)
print("Retrieve without lock")
data_handle = fdb.retrieve(
{
"type": "an",
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"levtype": "sfc",
"step": "0",
"param": "167/165/166",
"time": "1800",
}
)
assert data_handle
data_handle.open()
assert data_handle.read(4) == b"GRIB"
data_handle.close()
assert not (
function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "retrieve.lock"
).exists()
print("Locking database for retrieve")
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
control_iterator = fdb.control(
selection,
ControlAction.DISABLE,
[ControlIdentifier.RETRIEVE],
)
assert control_iterator
elements = []
for el in control_iterator:
print(el)
elements.append(el)
assert len(elements) == 1
assert (function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "retrieve.lock").exists()
print("Retrieve with lock")
# Needed because reuse of databases in the retrieve path is using a cached db
# object which contains the first (non-locked) status of the db.
# This can be removed as soon as https://jira.ecmwf.int/browse/FDB-613 is fixed.
fdb = FDB(read_only_fdb_setup)
data_handle = fdb.retrieve(
{
"type": "an",
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"levtype": "sfc",
"step": "0",
"param": "167/165/166",
"time": "1800",
},
)
assert data_handle
data_handle.open()
assert data_handle.read(4) == b""
data_handle.close()
def test_control_lock_list(read_only_fdb_setup, function_tmp):
fdb = FDB(read_only_fdb_setup)
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
print("List without lock")
list_iterator = fdb.list(selection)
elements = list(list_iterator)
assert len(elements) == 3
print("Locking database for listing")
control_iterator = fdb.control(selection, ControlAction.DISABLE, [ControlIdentifier.LIST])
assert control_iterator
elements = []
for el in control_iterator:
print(el)
elements.append(el)
assert len(elements) == 1
assert (function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "list.lock").exists()
print("List with lock. Expecting 0 elements.")
list_iterator = fdb.list(selection)
elements = list(list_iterator)
assert len(elements) == 0
print("Unlocking database for listing")
control_iterator = fdb.control(selection, ControlAction.ENABLE, [ControlIdentifier.LIST])
assert control_iterator
elements = list(control_iterator)
assert len(elements) > 0
# Correct behaviour is to "not see the data after locking"
assert not (function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "list.lock").exists()
list_iterator = fdb.list(selection)
elements = list(list_iterator)
assert len(elements) == 3
def test_control_lock_archive(read_only_fdb_setup, build_grib_messages, function_tmp):
fdb = FDB(read_only_fdb_setup)
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
print("Lock the database for archiving")
control_iterator = fdb.control(selection, ControlAction.DISABLE, [ControlIdentifier.ARCHIVE])
elements = []
for el in control_iterator:
print(el)
elements.append(el)
assert len(elements) == 1
assert (function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "archive.lock").exists()
print("Try archiving")
with pytest.raises(Exception, match=" matched for archived is LOCKED against archiving"):
fdb.archive(build_grib_messages.read_bytes())
fdb.flush()
print("Unlock the database for archiving")
control_iterator = fdb.control(selection, ControlAction.ENABLE, [ControlIdentifier.ARCHIVE])
assert control_iterator
elements = []
for el in control_iterator:
print(el)
elements.append(el)
assert len(elements) == 1
assert not (
function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "archive.lock"
).exists()
print("Try archiving")
fdb.archive(build_grib_messages.read_bytes())
fdb.flush()
print("Success")
def test_control_lock_archive_status(
read_only_fdb_setup, build_grib_messages, function_tmp, test_logger
):
fdb = FDB(read_only_fdb_setup)
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
test_logger.info("Lock the database for archiving")
control_iterator = fdb.control(selection, ControlAction.DISABLE, [ControlIdentifier.ARCHIVE])
assert control_iterator
elements = []
for el in control_iterator:
test_logger.debug(el)
elements.append(el)
assert len(elements) == 1
test_logger.debug("--------- OUTPUT STATUS -----------")
status_iterator = fdb.status(selection)
elements = list(status_iterator)
for el in elements:
test_logger.debug(el)
assert (function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "archive.lock").exists()
test_logger.info("Try archiving")
with pytest.raises(Exception, match=" matched for archived is LOCKED against archiving"):
fdb.archive(build_grib_messages.read_bytes())
fdb.flush()
test_logger.info("Unlock the database for archiving")
control_iterator = fdb.control(selection, ControlAction.ENABLE, [ControlIdentifier.ARCHIVE])
assert control_iterator
elements = []
for el in control_iterator:
test_logger.debug(el)
elements.append(el)
assert len(elements) == 1
assert not (
function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "archive.lock"
).exists()
test_logger.info("Try archiving")
fdb.archive(build_grib_messages.read_bytes())
fdb.flush()
test_logger.info("Success")
def test_control_lock_wipe(read_only_fdb_setup, function_tmp, build_grib_messages):
fdb = FDB(read_only_fdb_setup)
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
print("Archive same data as the FDB was setup with in the Fixture")
fdb.archive(build_grib_messages.read_bytes())
fdb.flush()
print("Lock the database for wiping")
control_iterator = fdb.control(selection, ControlAction.DISABLE, [ControlIdentifier.WIPE])
assert control_iterator
elements = []
for el in control_iterator:
print(el)
elements.append(el)
assert len(elements) == 1
assert (function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "wipe.lock").exists()
print("Try Wipe")
wipe_iterator = fdb.wipe(selection, doit=True)
elements = []
with pytest.raises(RuntimeError):
for el in wipe_iterator:
elements.append(el)
assert len(elements) == 0
print("Unlock the database for wiping")
control_iterator = fdb.control(selection, ControlAction.ENABLE, [ControlIdentifier.WIPE])
assert control_iterator
elements = []
for el in control_iterator:
print(el)
elements.append(el)
assert len(elements) > 0
assert not (function_tmp / "db_store" / "ea:0001:oper:20200101:1800:g" / "wipe.lock").exists()
print("Try Wipe")
fdb.wipe(selection, doit=True)
fdb.flush()
print("Success")
def test_enabled_per_default(read_only_fdb_setup):
fdb = FDB(read_only_fdb_setup)
assert fdb.enabled(ControlIdentifier.NONE) is True
assert fdb.enabled(ControlIdentifier.LIST) is True
assert fdb.enabled(ControlIdentifier.RETRIEVE) is True
assert fdb.enabled(ControlIdentifier.ARCHIVE) is True
assert fdb.enabled(ControlIdentifier.WIPE) is True
assert fdb.enabled(ControlIdentifier.UNIQUEROOT) is True
def test_disabled_writable(read_only_fdb_setup):
fdb_config_path = read_only_fdb_setup
assert fdb_config_path
fdb_config = yaml.safe_load(fdb_config_path.read_text())
fdb_config["writable"] = False
fdb = FDB(yaml.dump(fdb_config))
assert fdb.enabled(ControlIdentifier.NONE) is True
assert fdb.enabled(ControlIdentifier.LIST) is True
assert fdb.enabled(ControlIdentifier.RETRIEVE) is True
assert fdb.enabled(ControlIdentifier.ARCHIVE) is False
assert fdb.enabled(ControlIdentifier.WIPE) is False
assert fdb.enabled(ControlIdentifier.UNIQUEROOT) is True
def test_disabled_visitable(read_only_fdb_setup):
fdb_config = yaml.safe_load(read_only_fdb_setup.read_text())
fdb_config["visitable"] = False
fdb = FDB(yaml.dump(fdb_config))
assert fdb.enabled(ControlIdentifier.NONE) is True
assert fdb.enabled(ControlIdentifier.LIST) is False
assert fdb.enabled(ControlIdentifier.RETRIEVE) is False
assert fdb.enabled(ControlIdentifier.ARCHIVE) is True
assert fdb.enabled(ControlIdentifier.WIPE) is True
assert fdb.enabled(ControlIdentifier.UNIQUEROOT) is True
def test_disabled_visitable_writeable(read_only_fdb_setup):
fdb_config = yaml.safe_load(read_only_fdb_setup.read_text())
fdb_config["visitable"] = False
fdb_config["writable"] = False
fdb = FDB(yaml.dump(fdb_config))
assert fdb.enabled(ControlIdentifier.NONE) is True
assert fdb.enabled(ControlIdentifier.LIST) is False
assert fdb.enabled(ControlIdentifier.RETRIEVE) is False
assert fdb.enabled(ControlIdentifier.ARCHIVE) is False
assert fdb.enabled(ControlIdentifier.WIPE) is False
assert fdb.enabled(ControlIdentifier.UNIQUEROOT) is True
def test_needs_flush(empty_fdb_setup, test_data_path):
fdb = FDB(empty_fdb_setup)
filename: Path = test_data_path / "x138-300.grib"
fdb.archive(filename.read_bytes())
assert fdb.dirty() is True
fdb.flush()
assert fdb.dirty() is False
def test_control_element_key(read_only_fdb_setup):
fdb = FDB(read_only_fdb_setup)
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
print("List without lock")
list_iterator = fdb.list(selection)
elements = list(list_iterator)
assert len(elements) == 3
print("Locking database for listing")
control_iterator = fdb.control(selection, ControlAction.DISABLE, [ControlIdentifier.LIST])
assert control_iterator
elements = []
for el in control_iterator:
print(el)
elements.append(el.key())
assert len(elements) == 1
print(f"Element key: {elements[0]}")
print(f"Element key type: {type(elements[0])}")
assert elements[0] == UserInputMapper.map_selection_to_internal(selection)
def test_control_element_control_identifiers(read_only_fdb_setup):
fdb = FDB(read_only_fdb_setup)
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
print("List without lock")
list_iterator = fdb.list(selection)
elements = list(list_iterator)
assert len(elements) == 3
control_identifier_list = [
ControlIdentifier.LIST,
ControlIdentifier.RETRIEVE,
ControlIdentifier.ARCHIVE,
ControlIdentifier.WIPE,
ControlIdentifier.UNIQUEROOT,
]
print("Locking database for all control actions")
control_iterator = fdb.control(
selection, ControlAction.DISABLE, control_identifiers=control_identifier_list
)
assert control_iterator
elements = []
for el in control_iterator:
print(el)
elements.append(el.controlIdentifiers())
assert len(elements) == 1
assert len(elements[0]) == 5 # There should be 5 control identifiers for the first database
assert elements[0] == control_identifier_list
print(f"Element control identifiers: {elements[0]}")
print(f"Element control identifiers type: {type(elements[0])}")
print("Unlocking database for all control actions")
control_iterator = fdb.control(
selection, ControlAction.ENABLE, control_identifiers=control_identifier_list
)
assert control_iterator
elements = [el.controlIdentifiers() for el in control_iterator]
assert len(elements) == 1
assert len(elements[0]) == 0
print(f"Element control identifiers: {elements[0]}")
print(f"Element control identifiers type: {type(elements[0])}")
def test_status_element_eq_control_element(read_only_fdb_setup):
fdb = FDB(read_only_fdb_setup)
selection = {
"class": "ea",
"domain": "g",
"expver": "0001",
"stream": "oper",
"date": "20200101",
"time": "1800",
}
print("List without lock")
list_iterator = fdb.list(selection)
elements = list(list_iterator)
assert len(elements) == 3
control_identifier_list = [
ControlIdentifier.LIST,
ControlIdentifier.RETRIEVE,
ControlIdentifier.ARCHIVE,
ControlIdentifier.WIPE,
ControlIdentifier.UNIQUEROOT,
]
print("Locking all databases for all control actions")
# Control results for all databases
control_iterator = fdb.control(
{}, ControlAction.DISABLE, control_identifiers=control_identifier_list
)
assert control_iterator
control_elements = list(control_iterator)
# Status for all databases
status_iterator = fdb.status({})
assert status_iterator
status_elements = list(status_iterator)
assert control_elements == status_elements
for i in range(len(control_elements)):
print(f"Control Element: \n {control_elements[i]}")
print(f"Status Element: \n {status_elements[i]}")
# Check (cross-verify) that consecutive elements are different
for i in range(len(control_elements) - 1):
assert control_elements[i + 1] != status_elements[i]
|