rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-12-21 14:35:47 +02:00
Code Issues Releases Activity

tests: Migrate create_slide.list.sh into cargo xtask function. (#2957)

Browse Source 
The new xtask function makes the helper code
- more readable
- more reliable due to better error checking
- be in the same place as other helper functions
- and more aligned to the skillset relevant for contributing in this
repository.

The shell script grew and was not readable for everyone anymore without
deeper knowledge.

mitigates #2941 in a more reliable way but does still not fully fix the
root cause
This commit is contained in:
michael-kerscher
2025-10-29 18:15:21 +01:00
committed by GitHub
parent a5e68972c2
commit d1899de233
6 changed files with 134 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
tests/src/slides/create-slide.list.sh
View File

@@ -1,80 +0,0 @@
#!/bin/bash
# This script (re)creates the slides.list.ts file based on the given book html directory.
# It is used to regenerate the list of slides that are tested in the slide-size.test.ts file.
# Takes either TEST_BOOK_DIR environment variable or first parameter as override.
set -e
BASEDIR="$(dirname "$0")"
if [[ -n "$1" ]]; then
# take directory from command line
TEST_BOOK_DIR="$1"
fi
# check if TEST_BOOK_DIR is empty (not set by environment nor parameter)
if [[ -z "${TEST_BOOK_DIR}" ]]; then
echo "Usage: $0 <book_html_dir>"
exit 1
fi
# check if this is the correct root directory by checking if it contains the index.html
if [[ ! -f "${TEST_BOOK_DIR}/index.html" ]]; then
echo "Could not find index.html in ${TEST_BOOK_DIR}. Please check if the correct directory is used (e.g. book/html). You might need to (re)create the directory with mdbook build."
exit 1
fi
# These special pages should never be tested for slide size.
EXCLUDE_FILES=(
"exercise.html"
"solution.html"
"toc.html"
"print.html"
"404.html"
"glossary.html"
"index.html"
"course-structure.html"
)
CANDIDATE_SLIDES=""
if [[ -n "${CI}" ]]; then
echo "CI environment detected, checking only changed slides."
# Find changed markdown files in src/ and map them to their html output.
# GITHUB_BASE_REF is available in PRs. Default to 'main' for other CI contexts.
CANDIDATE_SLIDES=$(git diff --name-only "origin/${GITHUB_BASE_REF:-main}"... \
| grep '^src/.*\.md$' \
| sed 's|^src/||; s|\.md$|.html|' \
|| true)
else
# TODO: Limit the amount of files to check: Figure out what a good local diff base is.
echo "Local environment, checking all slides."
# Find all .html files recursively.
CANDIDATE_SLIDES=$(find "${TEST_BOOK_DIR}" -name "*.html" -printf "%P\n")
fi
SLIDES=""
if [[ -n "${CANDIDATE_SLIDES}" ]]; then
# From the candidate slides, filter out:
# - Files that are just redirects.
# - Files that are in the EXCLUDE_FILES list.
# - Files that do not exist in the TEST_BOOK_DIR (by using ls)
pushd "${TEST_BOOK_DIR}" > /dev/null
EXCLUDE_PATTERN=$(IFS="|" ; echo "${EXCLUDE_FILES[*]}")
SLIDES=$(echo "${CANDIDATE_SLIDES}" | grep -v -E "${EXCLUDE_PATTERN}" \
| xargs ls 2>/dev/null \
| xargs -r grep -L "Redirecting to...") || true
popd > /dev/null
fi
if [[ -n "${CI}" ]]; then
echo "The following slides will be checked:"
echo "${SLIDES}"
fi
OUTPUT="${BASEDIR}/slides.list.ts"
# create a ts module that can be imported in the tests
echo "export const slides = [" > ${OUTPUT};
for SLIDE in ${SLIDES}; do
echo " \"${SLIDE}\"," >> ${OUTPUT};
done;
echo "];" >> ${OUTPUT};

2
tests/src/slides/slides.list.ts
View File

@@ -1,5 +1,5 @@
// to enable local testing for slide size checks please (re)generate this file by executing:
// $ ./tests/src/slides/create-slide.list.sh book/html
// $ cargo xtask create-slide-list --dir book/html/
//
// This file is on purpose not pre-filled in the repository to avoid
// a) manual maintenance of slide list