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 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
|
from datetime import datetime, timezone
from pathlib import Path
from pickle import dumps, loads
import pytest
from scitrack import get_text_hexdigest
from cogent3 import get_app, open_data_store
from cogent3.app.composable import NotCompleted
from cogent3.app.data_store import (
APPEND,
OVERWRITE,
READONLY,
DataMemberABC,
DataStoreDirectory,
)
from cogent3.app.sqlite_data_store import (
_LOG_TABLE,
_RESULT_TABLE,
DataStoreSqlite,
has_valid_schema,
open_sqlite_db_rw,
)
from cogent3.util.table import Table
@pytest.fixture(scope="function")
def tmp_dir(tmpdir_factory):
return tmpdir_factory.mktemp("sqldb")
@pytest.fixture(scope="function")
def db_dir(tmp_dir):
db_dir = tmp_dir / "data.sqlitedb"
return db_dir
@pytest.fixture(scope="function")
def ro_dir_dstore(DATA_DIR):
return DataStoreDirectory(DATA_DIR, suffix="fasta")
@pytest.fixture(scope="function")
def sql_dstore(ro_dir_dstore, db_dir):
# we now need to write these out to a path
sql_dstore = DataStoreSqlite(db_dir, mode=OVERWRITE)
for m in ro_dir_dstore:
sql_dstore.write(data=m.read(), unique_id=m.unique_id)
return sql_dstore
@pytest.fixture(scope="function")
def ro_sql_dstore(sql_dstore):
# we now need to write these out to a path
sql_dstore = DataStoreSqlite(source=sql_dstore.source, mode=READONLY)
return sql_dstore
@pytest.fixture(scope="function")
def completed_objects(ro_dir_dstore):
return {f"{Path(m.unique_id).stem}": m.read() for m in ro_dir_dstore}
@pytest.fixture(scope="function")
def nc_objects():
return {
f"id_{i}": NotCompleted("ERROR", "location", "message", source=f"id_{i}")
for i in range(3)
}
@pytest.fixture(scope="function")
def log_data():
path = Path(__file__).parent.parent / "data" / "scitrack.log"
return path.read_text()
@pytest.fixture(scope="function")
def full_dstore_directory(db_dir, nc_objects, completed_objects, log_data):
dstore = DataStoreDirectory(db_dir, suffix="fasta", mode=OVERWRITE)
for id, data in nc_objects.items():
dstore.write_not_completed(unique_id=id, data=data.to_json())
for id, data in completed_objects.items():
dstore.write(unique_id=id, data=data)
dstore.write_log(unique_id="scitrack.log", data=log_data)
return dstore
@pytest.fixture(scope="function")
def full_dstore_sqlite(db_dir, nc_objects, completed_objects, log_data):
dstore = DataStoreSqlite(db_dir, mode=OVERWRITE)
for id, data in nc_objects.items():
dstore.write_not_completed(unique_id=id, data=data.to_json())
for id, data in completed_objects.items():
dstore.write(unique_id=id, data=data)
dstore.write_log(unique_id="scitrack.log", data=log_data)
return dstore
@pytest.fixture(scope="function")
def dstore_on_disk(full_dstore_sqlite):
path = full_dstore_sqlite.source
full_dstore_sqlite.close()
return path
def test_invalid_sqlite(full_dstore_sqlite):
query = "CREATE TABLE newtable (log_id INTEGER PRIMARY KEY)"
full_dstore_sqlite.db.execute(query)
assert not has_valid_schema(full_dstore_sqlite.db)
def test_open_existing(dstore_on_disk):
ro = DataStoreSqlite(dstore_on_disk, mode=READONLY)
assert len(ro) > 0
assert len(ro.completed) > 0
assert len(ro.not_completed) > 0
assert len(ro.logs) > 0
for attr in ("summary_logs", "summary_not_completed", "describe"):
assert isinstance(getattr(ro, attr), Table)
def test_open_to_append(dstore_on_disk):
ro = DataStoreSqlite(dstore_on_disk, mode=APPEND)
def test_open_to_write(dstore_on_disk):
ro = DataStoreSqlite(dstore_on_disk, mode=OVERWRITE)
def test_db_creation():
db = DataStoreSqlite(":memory:", mode=OVERWRITE)
db = db.db
result = db.execute("SELECT name FROM sqlite_master WHERE type='table'").fetchall()
assert len(result) == 3
created_names = {r["name"] for r in result}
assert created_names == {
_LOG_TABLE,
_RESULT_TABLE,
"state",
}
rows = db.execute(f"Select * from {_LOG_TABLE}").fetchall()
assert len(rows) == 0
def test_db_init_log():
dstore = DataStoreSqlite(":memory:", mode=OVERWRITE)
dstore._init_log()
rows = dstore.db.execute(f"Select * from {_LOG_TABLE}").fetchall()
assert len(rows) == 1
assert rows[0]["date"].date() == datetime.now(tz=timezone.utc).date()
def test_open_sqlite_db_rw():
db = open_sqlite_db_rw(":memory:")
# should make tables for results, log and state
result = db.execute("SELECT name FROM sqlite_master WHERE type='table'").fetchall()
assert len(result) == 3
created_names = {r["name"] for r in result}
assert created_names == {
_LOG_TABLE,
_RESULT_TABLE,
"state",
}
def test_rw_sql_dstore_mem(completed_objects):
"""in memory dstore"""
db = DataStoreSqlite(":memory:", mode=OVERWRITE)
for unique_id, obj in completed_objects.items():
db.write(data=obj, unique_id=unique_id)
expect = len(completed_objects)
query = f"SELECT count(*) as c FROM {_RESULT_TABLE} WHERE is_completed=?"
got = db.db.execute(query, (1,)).fetchone()["c"]
assert got == expect, f"Failed for {_RESULT_TABLE} number of rows"
assert len(db.completed) == expect
def test_not_completed(nc_objects):
db = DataStoreSqlite(":memory:", mode=OVERWRITE)
for unique_id, obj in nc_objects.items():
db.write_not_completed(data=obj.to_json(), unique_id=unique_id)
expect = len(nc_objects)
query = f"SELECT count(*) as c FROM {_RESULT_TABLE} WHERE is_completed=?"
got = db.db.execute(query, (0,)).fetchone()["c"]
assert got == expect, f"Failed for {_RESULT_TABLE} number of rows"
assert len(db.not_completed) == expect
def test_logdata(log_data):
db = DataStoreSqlite(":memory:", mode=OVERWRITE)
db.write_log(data=log_data, unique_id="scitrack.log")
query = f"select count(*) as c from {_LOG_TABLE}"
got = db.db.execute(query).fetchone()["c"]
assert got == 1
def test_drop_not_completed(nc_objects):
db = DataStoreSqlite(":memory:", mode=OVERWRITE)
for unique_id, obj in nc_objects.items():
db.write_not_completed(data=obj.to_json(), unique_id=unique_id)
expect = len(nc_objects)
assert len(db.not_completed) == expect
db.drop_not_completed()
assert len(db.not_completed) == 0
def test_contains(sql_dstore):
"""correctly identify when a data store contains a member"""
assert "brca1.fasta" in sql_dstore
def test_limit_datastore(full_dstore_sqlite): # new
assert len(full_dstore_sqlite) == len(full_dstore_sqlite.completed) + len(
full_dstore_sqlite.not_completed
)
full_dstore_sqlite._limit = len(full_dstore_sqlite.completed) // 2
full_dstore_sqlite._completed = []
full_dstore_sqlite._not_completed = []
assert (
len(full_dstore_sqlite.completed)
== len(full_dstore_sqlite.not_completed)
== full_dstore_sqlite._limit
)
assert len(full_dstore_sqlite) == len(full_dstore_sqlite.completed) + len(
full_dstore_sqlite.not_completed
)
full_dstore_sqlite.drop_not_completed()
assert len(full_dstore_sqlite) == len(full_dstore_sqlite.completed)
assert len(full_dstore_sqlite.not_completed) == 0
full_dstore_sqlite._limit = len(full_dstore_sqlite.completed) // 2
full_dstore_sqlite._completed = []
full_dstore_sqlite._not_completed = []
assert (
len(full_dstore_sqlite)
== len(full_dstore_sqlite.completed)
== full_dstore_sqlite._limit
)
assert len(full_dstore_sqlite.not_completed) == 0
def test_iter(sql_dstore):
"""DataStore objects allow iteration over members"""
members = list(sql_dstore)
assert members == sql_dstore.members
def test_members(sql_dstore):
for m in sql_dstore:
assert isinstance(m, DataMemberABC)
assert len(sql_dstore) == len(sql_dstore.completed) + len(sql_dstore.not_completed)
def test_len(sql_dstore, ro_dir_dstore):
"""DataStore returns correct len"""
expect = len(list(ro_dir_dstore.source.glob("*.fasta")))
assert expect == len(sql_dstore) == len(sql_dstore.members)
def test_md5_sum(sql_dstore):
for m in sql_dstore.members:
data = m.read()
md5 = sql_dstore.md5(m.unique_id)
assert md5 == get_text_hexdigest(data)
def test_iterall(sql_dstore, ro_dir_dstore):
expect = {fn.name for fn in ro_dir_dstore.source.glob("*.fasta")}
got = {Path(m.unique_id).name for m in sql_dstore}
assert expect == got
def test_read(full_dstore_sqlite):
"""correctly read content"""
c = full_dstore_sqlite.completed[0]
nc = full_dstore_sqlite.not_completed[0]
log = full_dstore_sqlite.logs[0]
for r in (c, nc, log):
assert isinstance(r.read(), str)
def test_write_success_replaces_not_completed(full_dstore_sqlite):
"""correctly write content"""
new_id = full_dstore_sqlite.not_completed[0].unique_id
data = full_dstore_sqlite.completed[0].read()
num = len(full_dstore_sqlite)
full_dstore_sqlite.write(unique_id=new_id, data=data)
assert len(full_dstore_sqlite) == num
def test_read_log(sql_dstore, log_data):
"""correctly read content"""
sql_dstore.write_log(unique_id="brca1.fasta", data=log_data)
got = sql_dstore.read(f"{_LOG_TABLE}/brca1.fasta")
assert got == log_data
@pytest.mark.parametrize("binary", (False, True))
def test_write_text_binary(sql_dstore, ro_dir_dstore, binary):
"""correctly write content whether text or binary data"""
db = DataStoreSqlite(":memory:", mode=OVERWRITE)
expect = Path(ro_dir_dstore.source / "brca1.fasta").read_text()
if binary:
expect = dumps(expect)
identifier = "brca1.fasta"
m = db.write(unique_id=identifier, data=expect)
got = m.read()
assert got == expect
def test_write_if_member_exists(sql_dstore, ro_dir_dstore):
"""correctly write content"""
expect = Path(ro_dir_dstore.source / "brca1.fasta").read_text()
identifier = "brca1.fasta"
len_dstore = len(sql_dstore)
m = sql_dstore.write(unique_id=identifier, data=expect)
# new, because previously added new member while updating the old one
assert len_dstore == len(sql_dstore)
# got = sql_dstore.read(identifier)
got = m.read()
assert got == expect
sql_dstore._mode = OVERWRITE
identifier = "brca1.fasta"
m = sql_dstore.write(unique_id=identifier, data=expect)
assert len_dstore == len(
sql_dstore
) # new, because previously added new member while updating the old one
# got = sql_dstore.read(identifier)
got = m.read()
assert got == expect
def test_summary_logs(full_dstore_sqlite):
# log summary has a row per log file and a column for each property
got = full_dstore_sqlite.summary_logs
assert got.shape == (1, 6)
assert isinstance(got, Table)
def test_no_not_completed_subdir(full_dstore_sqlite):
expect = f"{len(full_dstore_sqlite.completed)+len(full_dstore_sqlite.not_completed)}x member"
assert str(full_dstore_sqlite).startswith(expect)
# first remove not_completed directory
full_dstore_sqlite.drop_not_completed()
# test repr work without not_completed directory
expect = f"{len(full_dstore_sqlite.completed)}x member"
assert str(full_dstore_sqlite).startswith(expect)
expect = f"{len(full_dstore_sqlite)}x member"
assert str(full_dstore_sqlite).startswith(expect)
assert len(full_dstore_sqlite) == len(full_dstore_sqlite.completed)
def test_describe(full_dstore_sqlite):
got = full_dstore_sqlite.describe
assert got.shape >= (3, 2)
assert isinstance(got, Table)
def test_pickleable_roundtrip(ro_sql_dstore):
"""pickling of data stores should be reversible"""
re_dstore = loads(dumps(ro_sql_dstore))
expect = str(ro_sql_dstore)
got = str(re_dstore)
assert got == expect
assert re_dstore[0].read() == ro_sql_dstore[0].read()
def test_pickleable_member_roundtrip(ro_sql_dstore):
"""pickling of data store members should be reversible"""
re_member = loads(dumps(ro_sql_dstore[0]))
data = re_member.read()
assert len(data) > 0
def test_getitem(full_dstore_sqlite):
with pytest.raises(IndexError):
_ = full_dstore_sqlite[len(full_dstore_sqlite)]
last = full_dstore_sqlite[-1]
first = full_dstore_sqlite[0]
assert last.unique_id != first.unique_id
def test_empty_data_store(db_dir):
dstore = DataStoreSqlite(db_dir, mode=OVERWRITE)
assert 0 == len(dstore)
def test_no_logs(db_dir):
dstore = DataStoreSqlite(db_dir, mode=OVERWRITE)
assert len(dstore.logs) == 0
def test_limit_datastore(full_dstore_sqlite):
assert len(full_dstore_sqlite) == len(full_dstore_sqlite.completed) + len(
full_dstore_sqlite.not_completed
)
full_dstore_sqlite._limit = len(full_dstore_sqlite.completed)
full_dstore_sqlite.drop_not_completed()
assert len(full_dstore_sqlite) == full_dstore_sqlite._limit
assert len(full_dstore_sqlite) == len(full_dstore_sqlite.completed)
def test_validate(full_dstore_sqlite):
r = full_dstore_sqlite.validate()
assert r.shape == (4, 2)
def test_no_not_completed(sql_dstore):
assert len(sql_dstore.not_completed) == 0
def test_write_read_only_datastore(ro_sql_dstore):
with pytest.raises(IOError):
ro_sql_dstore.write(unique_id="brca1.fasta", data="test data")
def test_new_write_read(full_dstore_sqlite):
"""correctly write content"""
identifier = "test1.fasta"
data = "test data"
m = full_dstore_sqlite.write(unique_id=identifier, data=data)
got = full_dstore_sqlite.read(m.unique_id)
assert got == data
def test_summary_logs(full_dstore_sqlite):
# log summary has a row per log file and a column for each property
got = full_dstore_sqlite.summary_logs
assert got.shape == (1, 6)
assert isinstance(got, Table)
def test_read_unknown_table(full_dstore_sqlite):
with pytest.raises(ValueError):
full_dstore_sqlite.read("unknown_table/id")
def test_limit_on_writable(ro_dir_dstore, db_dir):
with pytest.raises(ValueError):
_ = DataStoreSqlite(db_dir, mode=OVERWRITE, limit=3)
@pytest.mark.parametrize("table_name", ("", _RESULT_TABLE))
def test_new_write_id_includes_table(full_dstore_sqlite, table_name):
"""correctly handles table name if included in unique id"""
identifier = "test1.fasta"
if table_name:
identifier = str(Path(table_name) / identifier)
data = "test data"
m = full_dstore_sqlite.write(unique_id=identifier, data=data)
got = full_dstore_sqlite.read(m.unique_id)
assert got == data
def test_summary_logs(full_dstore_sqlite):
# log summary has a row per log file and a column for each property
got = full_dstore_sqlite.summary_logs
assert got.shape == (1, 6)
assert isinstance(got, Table)
def test_set_record_type(full_dstore_sqlite):
from cogent3 import make_table
from cogent3.util.misc import get_object_provenance
assert full_dstore_sqlite.record_type is None
t = make_table(data={"a": [0, 2]})
full_dstore_sqlite.record_type = t
assert full_dstore_sqlite.record_type == get_object_provenance(t)
def test_is_locked(full_dstore_sqlite):
assert full_dstore_sqlite.locked
def test_lock_unlock(full_dstore_sqlite):
full_dstore_sqlite.unlock()
assert not full_dstore_sqlite.locked
full_dstore_sqlite.lock()
assert full_dstore_sqlite.locked
full_dstore_sqlite.unlock()
assert not full_dstore_sqlite.locked
def test_lock_firsttime(full_dstore_sqlite):
full_dstore_sqlite.db.execute("DELETE FROM state WHERE state_id=1")
full_dstore_sqlite.lock()
assert full_dstore_sqlite.locked
full_dstore_sqlite.unlock()
assert not full_dstore_sqlite.locked
def test_db_without_logs(ro_sql_dstore):
assert len(ro_sql_dstore.logs) == 0
@pytest.fixture(scope="function")
def md5_none(full_dstore_sqlite):
"""create a data store with empty md5 fields"""
full_dstore_sqlite.db.execute(
"UPDATE results SET md5=? WHERE record_id LIKE '%'", (None,)
)
return full_dstore_sqlite
def test_md5_none(md5_none):
m = md5_none[0]
assert m.md5 is None
def test_md5_missing(md5_none):
md5_none.md5("unknown")
def test_validate_missing_md5(md5_none):
t = md5_none.validate()
assert t["Num md5sum missing", "Value"] == 9
for c in ("correct", "incorrect"):
assert t[f"Num md5sum {c}", "Value"] == 0
def test_open_data_store_sqlitedb_err():
# cannot create an in-mmemory db to read only
with pytest.raises(NotImplementedError):
open_data_store(":memory:", mode="r")
def _make_appendable_dstore(path, suffix):
return open_data_store(path, suffix=suffix, mode="a")
def _make_and_run_proc(out_path, suffix, members):
out_dstore = _make_appendable_dstore(out_path, suffix)
loader = get_app("load_unaligned", moltype="dna", format="fasta")
mlength = get_app("sample.min_length", 400)
if suffix:
writer = get_app("write_seqs", out_dstore, format="fasta")
else:
writer = get_app("write_db", out_dstore)
app = loader + mlength + writer
return app.apply_to(members, cleanup=True)
@pytest.mark.parametrize(
"name,suffix", (("appended", "fa"), ("appended.sqlitedb", None))
)
def test_append_makes_logs(tmp_dir, ro_dir_dstore, name, suffix):
# do half the records in the first call
num = len(ro_dir_dstore.completed) // 2
# make a path for writeable dstore
out_path = tmp_dir / name
got1 = _make_and_run_proc(out_path, suffix, ro_dir_dstore[:num])
assert len(got1.logs) == 1
# creating a separate instance should result in a
# new log file
got2 = _make_and_run_proc(out_path, suffix, ro_dir_dstore[num:])
assert len(got2.logs) == 2
# should be a row for each log
summary = got2.summary_logs
assert summary.shape[0] == 2
def test_summary_not_completed(nc_objects):
dstore = open_data_store(":memory:", mode="w")
writer = get_app("write_db", dstore)
for nc in nc_objects.values():
writer(nc)
# relying on the fact that all nc_objects have same origin
# and message, so those columns can be readily interrogated
summary = dstore.summary_not_completed
vals = summary.to_list(columns=["origin", "message", "num"])
assert len(vals) == 1
assert vals[0] == ["location", "'message'", 3]
|