def test_fix_wrong_run_descriptions():
v3fixpath = os.path.join(fixturepath, 'db_files', 'version3')
dbname_old = os.path.join(v3fixpath,
'some_runs_without_run_description.db')
if not os.path.exists(dbname_old):
pytest.skip("No db-file fixtures found. You can generate test db-files"
" using the scripts in the legacy_DB_generation folder")
def make_ps(n):
ps = ParamSpec(f'p{n}',
label=f'Parameter {n}',
unit=f'unit {n}',
paramtype='numeric')
return ps
paramspecs = [make_ps(n) for n in range(6)]
paramspecs[2]._inferred_from = ['p0']
paramspecs[3]._inferred_from = ['p1', 'p0']
paramspecs[4]._depends_on = ['p2', 'p3']
paramspecs[5]._inferred_from = ['p0']
with temporarily_copied_DB(dbname_old, debug=False, version=3) as conn:
assert get_user_version(conn) == 3
expected_description = v0.RunDescriber(
v0.InterDependencies(*paramspecs))
empty_description = v0.RunDescriber(v0.InterDependencies())
fix_wrong_run_descriptions(conn, [1, 2, 3, 4])
for run_id in [1, 2, 3]:
desc_str = get_run_description(conn, run_id)
desc = serial.from_json_to_native(desc_str)
assert desc == expected_description
desc_str = get_run_description(conn, run_id=4)
desc = serial.from_json_to_native(desc_str)
assert desc == empty_description
def v1_to_v0(new: current.RunDescriber) -> v0.RunDescriber:
"""
Convert a v1 RunDescriber to a v0 RunDescriber
"""
if new.version != 1:
raise ValueError(f'Cannot convert {new} to version 0, {new} is not '
'a version 1 RunDescriber.')
new_idps = new.interdeps
old_idps = new_to_old(new_idps)
return v0.RunDescriber(interdeps=old_idps)
def fix_wrong_run_descriptions(conn: ConnectionPlus,
run_ids: Sequence[int]) -> None:
"""
NB: This is a FIX function. Do not use it unless your database has been
diagnosed with the problem that this function fixes.
Overwrite faulty run_descriptions by using information from the layouts and
dependencies tables. If a correct description is found for a run, that
run is left untouched.
Args:
conn: The connection to the database
run_ids: The runs to (potentially) fix
"""
user_version = get_user_version(conn)
if not user_version == 3:
raise RuntimeError('Database of wrong version. Will not apply fix. '
'Expected version 3, found version {user_version}')
log.info('[*] Fixing run descriptions...')
for run_id in run_ids:
trusted_paramspecs = _get_parameters(conn, run_id)
trusted_desc = v0.RunDescriber(
v0.InterDependencies(*trusted_paramspecs))
actual_desc_str = select_one_where(conn, "runs",
"run_description",
"run_id", run_id)
trusted_json = serial.to_json_as_version(trusted_desc, 0)
if actual_desc_str == trusted_json:
log.info(f'[+] Run id: {run_id} had an OK description')
else:
log.info(f'[-] Run id: {run_id} had a broken description. '
f'Description found: {actual_desc_str}')
update_run_description(conn, run_id, trusted_json)
log.info(f' Run id: {run_id} has been updated.')