tests: add cram wrapper parallel_cram.sh that runs cram tests in parallel #1667
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| #!/bin/bash | ||
| # Default values | ||
| QUIET=0 | ||
| VERBOSE=0 | ||
| KEEP_TMPDIR=0 | ||
| SHELL_PATH="/bin/bash" | ||
| SHELL_OPTS="" | ||
| INDENT=2 | ||
|
Comment on lines
+4
to
+8
There was a problem hiding this comment. This is hardcoding things that should be left at defaults, either cram's builtins or our project-level defaults from |
||
| TEST_DIR="tests" | ||
| PRIORITY_PATTERNS="merge|tree" # Slow tests that should start first | ||
| # Get default number of processors | ||
| NCPU=$(getconf _NPROCESSORS_ONLN 2>/dev/null || echo 4) | ||
| PARALLEL_JOBS=$NCPU # Default to CPU count if not specified | ||
|
|
||
| # Function to show usage | ||
| usage() { | ||
| cat << EOF | ||
| Usage: $(basename "$0") [OPTIONS] [TESTS...] | ||
| Wrapper script to run cram tests in parallel. | ||
| Options: | ||
| -h, --help show this help message and exit | ||
| -q, --quiet don't print diffs | ||
| -v, --verbose show filenames and test status | ||
| -j, --jobs=N number of tests to run in parallel (default: number of CPUs) | ||
| --keep-tmpdir keep temporary directories | ||
| --shell=PATH shell to use for running tests (default: /bin/bash) | ||
| --shell-opts=OPTS arguments to invoke shell with | ||
| --indent=NUM number of spaces to use for indentation (default: 2) | ||
| EOF | ||
| exit 1 | ||
| } | ||
|
|
||
| # Parse command line arguments | ||
| while [[ $# -gt 0 ]]; do | ||
| case $1 in | ||
| -h|--help) | ||
| usage | ||
| ;; | ||
| -q|--quiet) | ||
| QUIET=1 | ||
| shift | ||
| ;; | ||
| -v|--verbose) | ||
| VERBOSE=1 | ||
| shift | ||
| ;; | ||
| -j|--jobs=*) | ||
| if [[ "$1" == *"="* ]]; then | ||
| PARALLEL_JOBS="${1#*=}" | ||
| else | ||
| shift | ||
| PARALLEL_JOBS="$1" | ||
| fi | ||
| if ! [[ "$PARALLEL_JOBS" =~ ^[0-9]+$ ]]; then | ||
| echo "Error: -j/--jobs requires a numeric argument" | ||
| exit 1 | ||
| fi | ||
| if [ "$PARALLEL_JOBS" -lt 1 ]; then | ||
| echo "Error: Number of jobs must be at least 1" | ||
| exit 1 | ||
| fi | ||
| shift | ||
| ;; | ||
| -j*) # Handle -j4 format | ||
| PARALLEL_JOBS="${1#-j}" | ||
| if ! [[ "$PARALLEL_JOBS" =~ ^[0-9]+$ ]]; then | ||
| echo "Error: -j requires a numeric argument" | ||
| exit 1 | ||
| fi | ||
| if [ "$PARALLEL_JOBS" -lt 1 ]; then | ||
| echo "Error: Number of jobs must be at least 1" | ||
| exit 1 | ||
| fi | ||
| shift | ||
| ;; | ||
| --keep-tmpdir) | ||
| KEEP_TMPDIR=1 | ||
| shift | ||
| ;; | ||
| --shell=*) | ||
| SHELL_PATH="${1#*=}" | ||
| shift | ||
| ;; | ||
| --shell-opts=*) | ||
| SHELL_OPTS="${1#*=}" | ||
| shift | ||
| ;; | ||
| --indent=*) | ||
| INDENT="${1#*=}" | ||
| shift | ||
| ;; | ||
|
Comment on lines
+80
to
+91
There was a problem hiding this comment. These don't take the common |
||
| -*) | ||
| echo "Unknown option: $1" | ||
| usage | ||
| ;; | ||
| *) | ||
| TEST_DIR="$1" | ||
| shift | ||
| ;; | ||
|
Comment on lines
+96
to
+99
There was a problem hiding this comment. If more than one positional is given, only the last will be used. e.g. you can't do |
||
| esac | ||
| done | ||
|
|
||
| # Validate test directory | ||
| if [ ! -d "$TEST_DIR" ]; then | ||
| echo "Error: Directory $TEST_DIR does not exist" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Build cram command with options | ||
| CRAM_CMD="cram" | ||
| [ $QUIET -eq 1 ] && CRAM_CMD="$CRAM_CMD -q" | ||
| [ $VERBOSE -eq 1 ] && CRAM_CMD="$CRAM_CMD -v" | ||
| [ $KEEP_TMPDIR -eq 1 ] && CRAM_CMD="$CRAM_CMD --keep-tmpdir" | ||
| [ -n "$SHELL_PATH" ] && CRAM_CMD="$CRAM_CMD --shell=$SHELL_PATH" | ||
| [ -n "$SHELL_OPTS" ] && CRAM_CMD="$CRAM_CMD --shell-opts=$SHELL_OPTS" | ||
| [ -n "$INDENT" ] && CRAM_CMD="$CRAM_CMD --indent=$INDENT" | ||
|
Comment on lines
+109
to
+116
There was a problem hiding this comment. Instead of a string, this should build up an array and then be used as |
||
|
|
||
| # Find all .t files and order with priority files first | ||
| TEST_FILES=$(find "$TEST_DIR" -name "*.t" | sort) | ||
| PRIORITY_FILES=$(echo "$TEST_FILES" | grep -E "$PRIORITY_PATTERNS" || true) | ||
| OTHER_FILES=$(echo "$TEST_FILES" | grep -vE "$PRIORITY_PATTERNS" || true) | ||
| ALL_FILES=$(echo -e "${PRIORITY_FILES}\n${OTHER_FILES}") | ||
|
|
||
| # Create a lock directory for synchronized output | ||
| LOCK_DIR="/tmp/cram_lock_$$" | ||
| mkdir "$LOCK_DIR" | ||
|
Comment on lines
+125
to
+126
There was a problem hiding this comment. This should be a |
||
| trap 'rm -rf "$LOCK_DIR"' EXIT | ||
|
|
||
| # Create files to store temporary directories and test results | ||
| TMPDIR_FILE="$LOCK_DIR/tmpdirs" | ||
| RESULTS_FILE="$LOCK_DIR/results" | ||
| touch "$TMPDIR_FILE" "$RESULTS_FILE" | ||
|
|
||
| # Export variables for subshell | ||
| export CRAM_CMD LOCK_DIR TMPDIR_FILE RESULTS_FILE KEEP_TMPDIR | ||
|
|
||
| # Run tests in parallel with specified number of jobs | ||
| echo "$ALL_FILES" | xargs -P "$PARALLEL_JOBS" -I {} sh -c ' | ||
| file="$1" | ||
| lock_dir="$LOCK_DIR" | ||
| output=$($CRAM_CMD "$file" 2>&1) | ||
| status=$? | ||
|
|
||
| while ! mkdir "$lock_dir/lock" 2>/dev/null; do | ||
| sleep 0.05 | ||
| done | ||
|
|
||
| # Record test status | ||
| echo "$status" >> "$RESULTS_FILE" | ||
|
|
||
| if [ $status -eq 0 ]; then | ||
| printf "." | ||
| else | ||
| echo "$output" | grep -v "^# Ran " | ||
| fi | ||
|
|
||
| # If --keep-tmpdir is enabled, capture the temporary directory | ||
| if [ $KEEP_TMPDIR -eq 1 ]; then | ||
| echo "$output" | grep "Kept temporary directory:" >> "$TMPDIR_FILE" | ||
| fi | ||
|
|
||
| rm -rf "$lock_dir/lock" | ||
| ' - {} | ||
|
Comment on lines
+137
to
+163
There was a problem hiding this comment. FWIW, this reimplements a bit of functionality in |
||
| echo | ||
|
|
||
| # Display captured temporary directories if --keep-tmpdir was used | ||
| if [ $KEEP_TMPDIR -eq 1 ]; then | ||
| sort -u "$TMPDIR_FILE" | while read -r line; do | ||
| echo "$line" | ||
| done | ||
| fi | ||
|
|
||
| # Check if any tests failed, i.e. non-zero exit status | ||
| # Count the number of failed tests | ||
| # Count the number of passed tests | ||
| failed_tests=$(grep -c -v "^0$" "$RESULTS_FILE") | ||
| passed_tests=$(grep -c "^0$" "$RESULTS_FILE") | ||
|
|
||
| # Print summary of test results | ||
| echo "Passed $passed_tests, failed $failed_tests tests" | ||
| if [ "$failed_tests" -gt 0 ]; then | ||
| exit 1 | ||
| fi | ||
|
|
||
| exit 0 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,7 @@ | ||
| export AUGUR="${AUGUR:-$TESTDIR/../../../../bin/augur}" | ||
| set -o pipefail | ||
|
|
||
| # IQ-Tree writes to the input file directory, so we need to copy the data | ||
| # to allow running tests in parallel. | ||
| # This also avoids the data directory being polluted with output files. | ||
| cp -r "$TESTDIR/../data" "$TMP" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No
set -euo pipefail, which is a red flag to me.