Skip to content

Added the ability to validate the "run_was_for_test_purposes" HDF5 File Attribute #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bieryAtFnal merged 2 commits into from
Nov 19, 2025
Merged

Added the ability to validate the "run_was_for_test_purposes" HDF5 File Attribute #134

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3738daf
Added the ability to pass in the expected value of the run_was_for_te…
Nov 17, 2025
e0521e3
Moved the printout of the HDF5 filename from check_file_attributes to…
Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions src/integrationtest/data_file_checks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ def __init__(self, filename):
def sanity_check(datafile):
"Very basic sanity checks on file"
passed=True
base_filename = os.path.basename(datafile.h5file.filename)
print("") # Clear potential dot from pytest

# execute unit tests for local function(s)
Expand All @@ -52,10 +53,16 @@ def sanity_check(datafile):
print(f"\N{POLICE CARS REVOLVING LIGHT} More than one TriggerRecordHeader in record {event} \N{POLICE CARS REVOLVING LIGHT}")
passed=False
if passed:
print("\N{WHITE HEAVY CHECK MARK} Sanity-check passed")
print(f"\N{WHITE HEAVY CHECK MARK} Sanity-check passed for file {base_filename}")
else:
print(f"\N{POLICE CARS REVOLVING LIGHT} One or more sanity-checks failed for file {base_filename} \N{POLICE CARS REVOLVING LIGHT}")
return passed

def check_file_attributes(datafile):
# 17-Nov-2025, KAB: added the 'was_test_run' function argument to allow us
# to validate the run_was_for_test_purposes Attribute value. Valid values
# are the strings "true" and "false", which is easiest given that the values
# in the HDF5 Attribute are lower-case strings.
def check_file_attributes(datafile, was_test_run="true"):
"Checking that the expected Attributes exist within the data file"
passed=True
base_filename = os.path.basename(datafile.h5file.filename)
Expand All @@ -76,7 +83,7 @@ def check_file_attributes(datafile):
filename_value = int(re.sub('run','',re.sub('_','',match_obj.group(0))))
if attr_value != filename_value:
passed=False
print(f"\N{POLICE CARS REVOLVING LIGHT} The value in Attribute '{expected_attr_name}' ({attr_value}) does not match the value in the filename ({base_filename}) \N{POLICE CARS REVOLVING LIGHT}")
print(f"\N{POLICE CARS REVOLVING LIGHT} The value in HDF5 File Attribute '{expected_attr_name}' ({attr_value}) does not match the value in the filename ({base_filename}) \N{POLICE CARS REVOLVING LIGHT}")
elif expected_attr_name == "file_index":
# value from the Attribute
attr_value = datafile.h5file.attrs.get(expected_attr_name)
Expand All @@ -87,7 +94,7 @@ def check_file_attributes(datafile):
filename_value = int(re.sub('_','',match_obj.group(0)))
if attr_value != filename_value:
passed=False
print(f"\N{POLICE CARS REVOLVING LIGHT} The value in Attribute '{expected_attr_name}' ({attr_value}) does not match the value in the filename ({base_filename}) \N{POLICE CARS REVOLVING LIGHT}")
print(f"\N{POLICE CARS REVOLVING LIGHT} The value in HDF5 File Attribute '{expected_attr_name}' ({attr_value}) does not match the value in the filename ({base_filename}) \N{POLICE CARS REVOLVING LIGHT}")
elif expected_attr_name == "creation_timestamp":
attr_value = datafile.h5file.attrs.get(expected_attr_name)
date_obj = datetime.datetime.fromtimestamp((int(attr_value)/1000)-1, datetime.timezone.utc)
Expand All @@ -101,10 +108,16 @@ def check_file_attributes(datafile):
pattern_exact = f".*{date_string}.*"
if not re.match(pattern_exact, base_filename) and not re.match(pattern_low, base_filename) and not re.match(pattern_high, base_filename):
passed=False
print(f"\N{POLICE CARS REVOLVING LIGHT} The value in Attribute '{expected_attr_name}' ({date_string}) does not match the value in the filename ({base_filename}) \N{POLICE CARS REVOLVING LIGHT}")
print(f"\N{POLICE CARS REVOLVING LIGHT} The value in HDF5 File Attribute '{expected_attr_name}' ({date_string}) does not match the value in the filename ({base_filename}) \N{POLICE CARS REVOLVING LIGHT}")
print(f"\N{POLICE CARS REVOLVING LIGHT} Debug information: pattern_low={pattern_low} pattern_high={pattern_high} pattern_exact={pattern_exact} \N{POLICE CARS REVOLVING LIGHT}")
elif expected_attr_name == "run_was_for_test_purposes":
# value from the Attribute
attr_value = datafile.h5file.attrs.get(expected_attr_name)
if attr_value != was_test_run:
passed=False
print(f"\N{POLICE CARS REVOLVING LIGHT} The value in HDF5 File Attribute '{expected_attr_name}' ({attr_value}) does not match the expected value ({was_test_run}) \N{POLICE CARS REVOLVING LIGHT}")
if passed:
print(f"\N{WHITE HEAVY CHECK MARK} All Attribute tests passed for file {base_filename}")
print(f"\N{WHITE HEAVY CHECK MARK} All Attribute tests passed")
return passed

def check_event_count(datafile, expected_value, tolerance):
Expand Down