feat: cross check run list from trains and DSTs

Differences in these runlists is a recurring issue; let's add it to the
procedure.

Author: c-dilks

bin/qtl

@@ -18,6 +18,7 @@ usage() {
       physics       Generate and analyze physics QA timelines (Step 2)
       error         Scan for errors in Slurm logs (for Step 1)
       reheat        Reproduce a data file, e.g., to rerun postprocessing
+      xtrain        Cross check run list from trains and DSTs
 
   OPTIONS: Each command has its own set of options; run a command with no
            additional options to see usage for that command.
@@ -41,6 +42,7 @@ case $cmd in
   ph*) exec $TIMELINESRC/bin/qtl-physics "$@" ;;
   er*) exec $TIMELINESRC/bin/qtl-error "$@" ;;
   re*) exec $TIMELINESRC/bin/qtl-reheat "$@" ;;
+  xt*) exec $TIMELINESRC/bin/qtl-xtrain "$@" ;;
   -v|--version)
     echo $(mvn -q help:evaluate -Dexpression=project.version -DforceStdout -f $TIMELINESRC/pom.xml || echo "UNKNOWN")
     exit 0

bin/qtl-xtrain

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'set'
+
+unless ARGV.length == 2
+  puts """
+  Verify that a directory of a train's skim files has the same list of
+  run numbers as a directory of DST-file run directories.
+
+  USAGE: #{$0} [TRAIN_DIR] [DST_DIR]"""
+  exit 2
+end
+train_dir, dst_dir = ARGV
+
+# function to get a set of run numbers from one of the argument dirs
+def get_runnums(path, type)
+  runnums = Set.new
+  raise "path '#{path}' does not exist" unless Dir.exist? path
+
+  # get list of files/directories within
+  files = []
+  case type
+  when :train
+    files = Dir.glob File.join(path, '*.hipo')
+  when :dst
+    files = Dir.glob File.join(path, '*/')
+  else
+    raise 'bad type'
+  end
+
+  # extract their run numbers
+  files.each do |file|
+    nums = File.basename(file).scan(/\d+/).map &:to_i
+    raise "failed to get runnum from '#{file}'" unless nums.length == 1
+    runnums << nums[0]
+  end
+  runnums
+end
+
+# compare runnum sets
+train_runs = get_runnums train_dir, :train
+dst_runs   = get_runnums dst_dir,   :dst
+only_in_trains = train_runs - dst_runs
+only_in_dsts   = dst_runs   - train_runs
+
+# return results
+code = 0
+unless only_in_trains.empty?
+  $stderr.puts "ERROR: there are runs with skim files, but no corresponding DST-file directories:"
+  $stderr.puts only_in_trains
+  code = 1
+end
+unless only_in_dsts.empty?
+  $stderr.puts "ERROR: there are runs with DST-file directories, but no corresponding skim files:"
+  $stderr.puts only_in_dsts
+  code = 1
+end
+exit code

doc/qa.md

@@ -49,6 +49,12 @@ If you are performing a manual QA as part of a cross check, skip to the next sec
     - use the scripts in the [`prescaler/` directory](/qadb/prescaler)
 </details>
 
+<details>
+<summary>- [ ] cross check run list from trains and from DSTs</summary>
+
+- FIXME
+</details>
+
 <details>
 <summary>- [ ] make sure all data are cached</summary>