Merge pull request #1558 from grvvy/ci_sgpio_debug

ci: improve sgpio-debug test reliability and error messaging
This commit is contained in:
Jacob Graves
2025-09-04 15:23:45 -06:00
committed by GitHub
2 changed files with 48 additions and 18 deletions

4
Jenkinsfile vendored
View File

@@ -33,7 +33,9 @@ pipeline {
sh 'python3 ci-scripts/test-transfer.py rx'
}
sh 'hubs all off'
sh 'python3 ci-scripts/test-sgpio-debug.py'
retry(3) {
sh 'python3 ci-scripts/test-sgpio-debug.py'
}
sh 'hubs all reset'
}
}

View File

@@ -4,12 +4,12 @@ import sys
import subprocess
from pathlib import Path
FILENAME = "/tmp/rx_100kB_" + str(os.getpid())
FILENAME = f"/tmp/rx_100kB_{str(os.getpid())}"
def program_device():
# build new firmware with SGPIO_DEBUG mode enabled
print("Programming device..")
print("Programming device...")
fw_dir = os.getcwd() + "/firmware/hackrf_usb/build"
del_dir = subprocess.run(["rm", "-rf", "firmware/hackrf_usb/build"])
mk_dir = subprocess.run(["mkdir", "firmware/hackrf_usb/build"])
@@ -22,36 +22,64 @@ def program_device():
def capture():
print("Capturing data..")
rx_100kB = subprocess.run(["host/build/hackrf-tools/src/hackrf_transfer",
"-r", FILENAME, "-d", "RunningFromRAM",
"-n", "50000", "-s", "20000000"],
capture_output=True, encoding="UTF-8")
print(rx_100kB.stdout)
print(rx_100kB.stderr)
print("Wrote data to file: " + FILENAME)
shortfall_count = -1
capture_tries = 0
while shortfall_count != 0:
print("Capturing data...")
rx_100kB = subprocess.run(["host/build/hackrf-tools/src/hackrf_transfer",
"-r", FILENAME, "-d", "RunningFromRAM",
"-n", "50000", "-s", "20000000"],
capture_output=True, encoding="UTF-8")
print(rx_100kB.stdout)
print(rx_100kB.stderr)
print(f"Wrote capture data to file: {FILENAME}")
debug_state_proc = subprocess.run(["host/build/hackrf-tools/src/hackrf_debug", "--state"],
capture_output=True, encoding="UTF-8")
print(debug_state_proc.stdout)
print(debug_state_proc.stderr)
capture_tries += 1
debug_state = debug_state_proc.stdout.split("\n")
shortfalls_line = [s for s in debug_state if s.startswith("Number of shortfalls")]
shortfall_count = [int(c) for c in shortfalls_line[0].split() if c.isdigit()][0]
if capture_tries == 10:
print("Unable to transmit data with 0 shortfalls. " \
"This is not indicative of a device failure. " \
"Likely an issue with the testing infrastructure.")
sys.exit(1)
def check():
def check_bytes():
print(f"Checking length of {FILENAME}")
rx_data = Path(FILENAME).read_bytes()
# file should be 100k bytes when using 50k samples
if len(rx_data) != 100000:
print("SGPIO debug test failed.")
if len(rx_data) != 100000: # file should be 100k bytes when using 50k samples
print(f"ERROR: Only {str(len(rx_data))} bytes found in file, expected 100k.")
sys.exit(1)
else:
print("Correct file size found.")
# check that each byte = prev_byte + 1 except at wraparound bounds
print("Checking bytes...")
for i in range(1, len(rx_data)):
if rx_data[i-1] != rx_data[i] - 1:
if not (rx_data[i] == 0 and rx_data[i-1] == 255):
print("SGPIO debug test failed.")
print(f"ERROR: Incorrect data value found at location {str(i)} in {FILENAME}:")
# print up to 5 values starting from at most 1 value before error occurence
j = -1
while j < 4:
if i + j < len(rx_data) and i + j > -1:
print(f"{str(i+j)} : {str(rx_data[i+j])}")
j = j + 1
sys.exit(1)
print("SGPIO debug test passed.")
print("Successfully validated all bytes in file.\nSGPIO debug test passed.")
def main():
program_device()
capture()
check()
check_bytes()
if __name__ == "__main__":