Comparar una traza con una línea base golden

Cree una línea base de golden-diff a partir de una traza conocida como correcta, compruebe trazas posteriores con ella en texto o JSON y actualice la línea base cuando un cambio sea intencionado.

Utilice Altifigence CLI 0.1.9 en Linux para registrar una línea base a partir de una traza .altrace conocida como correcta y para comprobar trazas posteriores con ella. Una comprobación termina con 0 cuando todos los pasos están dentro de la tolerancia y con 1 cuando algún paso se desvía.

Preparar dos trazas

golden-diff lee trazas .altrace cuyo encabezado declara "encoding":"bincode". El script siguiente escribe run.altrace, una traza conocida como correcta con un núcleo y cinco eventos, y changed.altrace, la misma traza con un evento MAC_COMPUTE más. Cada línea de evento es core start duration type [api_name].

PROJECT="$(cd "$HOME/alti-projects/demo-project" && pwd -P)"
cd "$PROJECT"

le() { local n=$1 v=$2; while [ "$n" -gt 0 ]; do printf "\\x$(printf %02x $((v & 255)))"; v=$((v >> 8)); n=$((n - 1)); done; }
str() { le 8 "${#1}"; printf '%s' "$1"; }
write_trace() {
  local out="$1" payload line core start dur type api total=0 header
  local -a lines
  mapfile -t lines
  payload="$(mktemp)"
  {
    for line in "${lines[@]}"; do
      read -r core start dur type api <<<"$line"
      (( start + dur > total )) && total=$((start + dur))
    done
    le 8 "$total"
    le 8 "${#lines[@]}"
    for line in "${lines[@]}"; do
      read -r core start dur type api <<<"$line"
      le 4 "$core"; le 8 "$start"; le 8 "$dur"; str "$type"
      if [ -n "$api" ]; then printf '\x01'; str "$api"; else printf '\x00'; fi
    done
  } >"$payload"
  header="{\"altifigence_trace_version\":\"1.0\",\"trace\":{\"cycles\":$total,\"cores\":1,\"clock_mhz\":1000},\"payload\":{\"encoding\":\"bincode\",\"byte_length\":$(wc -c <"$payload")}}"
  { printf 'ALTR\x01\x01\x00\x00'; le 8 "${#header}"; printf '%s' "$header"; cat "$payload"; } >"$out"
  rm -f "$payload"
}

write_trace run.altrace <<'EVENTS'
0 0 100 MAC_COMPUTE
0 100 50 DMA_READ
0 150 5 API_CALL step_1
0 160 100 MAC_COMPUTE
0 260 100 MAC_COMPUTE
EVENTS

write_trace changed.altrace <<'EVENTS'
0 0 100 MAC_COMPUTE
0 100 50 DMA_READ
0 150 5 API_CALL step_1
0 160 100 MAC_COMPUTE
0 260 100 MAC_COMPUTE
0 360 100 MAC_COMPUTE
EVENTS

wc -c < run.altrace
wc -c < changed.altrace

Compruebe que los dos comandos wc impriman los tamaños de los archivos.

376
416

Crear la línea base

alti verification golden-diff emit-profile lee una traza y escribe la línea base en stdout, así que rediríjala a un archivo. Un paso comienza en cada API_CALL, y los eventos anteriores al primer API_CALL pertenecen al paso 0. --tolerance-pct registra en cada fila la desviación permitida, en porcentaje, y el valor predeterminado es 10.

alti verification golden-diff emit-profile --project "$PROJECT" run.altrace > "$PROJECT/reference.jsonl"
grep -v '^#' "$PROJECT/reference.jsonl"

Compruebe que el estado de salida sea 0. El archivo empieza con dos líneas de comentario # y, después, contiene una fila JSON por paso.

{"step":0,"api_name":null,"expect_mac":1,"expect_dma_read":1,"expect_dma_write":0,"expect_barrier":0,"cycle_budget":165,"tolerance_pct":10.0,"abs_tolerance":null}
{"step":1,"api_name":"step_1","expect_mac":2,"expect_dma_read":0,"expect_dma_write":0,"expect_barrier":0,"cycle_budget":232,"tolerance_pct":10.0,"abs_tolerance":null}

Cada fila almacena los recuentos de eventos observados como expect_mac, expect_dma_read, expect_dma_write y expect_barrier. cycle_budget son los ciclos que abarca el paso, aumentados en tolerance_pct y redondeados hacia arriba: el paso 0 abarca 150 ciclos y el paso 1 abarca 210. Las líneas en blanco y las líneas que empiezan con # se omiten cuando se lee el archivo.

Comprobar una traza con la línea base

alti verification golden-diff check toma primero la línea base y, en segundo lugar, la traza. La salida de texto tiene un resumen golden-diff: entre dos líneas de banner formadas por caracteres ═, y después una línea por paso. Los extractos siguientes omiten las líneas de banner.

alti verification golden-diff check --project "$PROJECT" reference.jsonl run.altrace; echo "exit=$?"

  golden-diff: all 2 steps within tolerance
step   0 pass
step   1 pass
exit=0

Compruebe que el estado de salida sea 0. Ejecute los comandos de esta sección sin la opción global --json de alti, de modo que stdout contenga el propio informe. --format json imprime el informe, y --format json-v1 imprime el resultado versionado con procedencia. Ambos usan el mismo estado de salida que el formato de texto.

alti verification golden-diff check --project "$PROJECT" reference.jsonl run.altrace --format json \
  | jq '{summary, step_count, pass_count, total_metrics, exact_matches, tolerance_passes, metric_mismatches, unexpected_observed_steps}'

{
  "summary": "golden-diff: all 2 steps within tolerance",
  "step_count": 2,
  "pass_count": 2,
  "total_metrics": 10,
  "exact_matches": 8,
  "tolerance_passes": 2,
  "metric_mismatches": 0,
  "unexpected_observed_steps": 0
}

alti verification golden-diff check --project "$PROJECT" reference.jsonl run.altrace --format json-v1 \
  | jq '{schema, operation_id, artifact_schema: .artifact.artifact_schema, engine: .provenance.engine}'

{
  "schema": "altifigence.golden-diff.operation-result.v1",
  "operation_id": "altifigence.verification.golden-diff.v1",
  "artifact_schema": "altifigence.golden-diff.report.v1",
  "engine": "alti-verification"
}

Leer una comprobación fallida

El paso 1 de changed.altrace contiene tres eventos MAC_COMPUTE y abarca 310 ciclos, mientras que la línea base espera dos eventos y un presupuesto de 232 ciclos.

alti verification golden-diff check --project "$PROJECT" reference.jsonl changed.altrace; echo "exit=$?"

  golden-diff: 1 / 2 steps PASS — 1 regressed
step   0 pass
step   1 drift on [mac, cycles]
    └─ mac       observed=3 · expected=2 · tol ±10.0%
    └─ cycles    observed=310 · expected=232 · tol ±10.0%
exit=1

Compruebe que el estado de salida sea 1. alti también imprime en stderr una línea de estado que incluye exit=1. Bajo cada paso solo se enumeran las métricas que fallaron. Para leerlas en el informe JSON, seleccione las métricas cuyo pass es false.

alti verification golden-diff check --project "$PROJECT" reference.jsonl changed.altrace --format json \
  | jq -c '.steps[] | select(.is_pass | not) | .metrics[] | select(.pass | not) | {name, observed, expected}'

{"name":"mac","observed":3,"expected":2}
{"name":"cycles","observed":310,"expected":232}

Un paso que figura en la línea base pero falta en la traza imprime step N missing from observed trace. Un paso de la traza que no tiene fila en la línea base se cuenta en unexpected_observed_steps. Ambos hacen que la comprobación termine con 1.

Resolver fallos

Cuando la desviación es el comportamiento previsto, convierta la traza modificada en la nueva línea base y vuelva a comprobar.

alti verification golden-diff emit-profile --project "$PROJECT" changed.altrace > "$PROJECT/reference.jsonl"
alti verification golden-diff check --project "$PROJECT" reference.jsonl changed.altrace; echo "exit=$?"

  golden-diff: all 2 steps within tolerance
step   0 pass
step   1 pass
exit=0

Un archivo que no es una traza hace que emit-profile y check terminen con 1 y con los mensajes siguientes. Pase un archivo que empiece con ALTR, como run.altrace.

printf 'this is not a trace\n' > "$PROJECT/notes.txt"
alti verification golden-diff emit-profile --project "$PROJECT" notes.txt
alti verification golden-diff check --project "$PROJECT" reference.jsonl notes.txt

parse error in 'notes.txt': Invalid magic number — expected 'ALTR', got '[116, 104, 105, 115]'
trace parse error for 'notes.txt': invalid .altrace magic

Una traza cuyo encabezado declara otra codificación de carga útil hace que check termine con 1 y con un mensaje de esta forma. Pase una traza cuyo encabezado declare "encoding":"bincode", como run.altrace.

trace parse error for 'other.altrace': unsupported .altrace payload encoding 'flatbuf'

Una línea base sin filas hace que check termine con 1 y con el mensaje siguiente. Ejecute emit-profile de nuevo para escribir una línea base con una fila por paso.

: > "$PROJECT/empty.jsonl"
alti verification golden-diff check --project "$PROJECT" empty.jsonl run.altrace

empty reference file: empty.jsonl

Un --tolerance-pct negativo o no numérico termina con 2 antes de que se inicie el motor, con este texto en el error. Pase un número de 0 o más, como 5.

tolerance-pct must be a finite non-negative number

alti verification golden-diff emit-profile --project "$PROJECT" run.altrace --tolerance-pct 5 > "$PROJECT/reference.jsonl"

Comandos de motor de la CLI