0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a CI check for missing images in WML macros

Browse source 
This detects image errors such as issue #8432.

Example output:

    data/multiplayer/scenarios/2p_Aethermaw.cfg:134: missing image: units/undead/shadow-s-attack-1.png
    data/multiplayer/scenarios/2p_Aethermaw.cfg:135: missing image: units/undead/shadow-n-attack-2.png
    data/multiplayer/scenarios/2p_Aethermaw.cfg:147: missing image: units/undead/shadow-n-3.png
    data/multiplayer/scenarios/2p_Aethermaw.cfg:149: missing image: units/undead/shadow-s-attack-4.png
    data/multiplayer/scenarios/2p_Aethermaw.cfg:196: missing image: units/human-loyalists/spearman-attack-se-10.png
    data/multiplayer/scenarios/2p_Aethermaw.cfg:197: missing image: units/human-loyalists/spearman-attack-s-6.png
    data/multiplayer/scenarios/2p_Aethermaw.cfg:198: missing image: units/human-loyalists/spearman-attack-se-9.png
    data/multiplayer/scenarios/2p_Aethermaw.cfg:203: missing image: units/human-loyalists/general-idle-5.png
This commit is contained in:
P. J. McDermott 2024-03-19 07:56:23 -04:00 • committed by Pentarctagon
parent 98492e1797
commit 2993757315
2 changed files with 71 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.github/workflows/ci-main.yml vendored
View file

@ -31,6 +31,9 @@ jobs:
- name: Whitespace and WML indentation check
if: success() || failure()
run: ./utils/CI/fix_whitespace.sh; git status; git diff --exit-code
- name: WML missing images check
if: success() || failure()
run: utils/CI/check_wml_images.sh
- name: Run luacheck
if: success() || failure()
run: luacheck .

68
utils/CI/check_wml_images.sh Executable file
View file

@ -0,0 +1,68 @@
#!/bin/sh
#
# Find missing images referenced by WML (as in issue #8432)
#
# Requires sort with -s option (stable sort, disable further byte-by-byte
# comparison of lines that collate equally by specified sort key), e.g. from
# GNU coreutils
#
# Example output:
# data/multiplayer/scenarios/2p_Aethermaw.cfg:134: missing image: units/undead/shadow-s-attack-1.png
# data/multiplayer/scenarios/2p_Aethermaw.cfg:135: missing image: units/undead/shadow-n-attack-2.png
# data/multiplayer/scenarios/2p_Aethermaw.cfg:147: missing image: units/undead/shadow-n-3.png
# data/multiplayer/scenarios/2p_Aethermaw.cfg:149: missing image: units/undead/shadow-s-attack-4.png
# data/multiplayer/scenarios/2p_Aethermaw.cfg:196: missing image: units/human-loyalists/spearman-attack-se-10.png
# data/multiplayer/scenarios/2p_Aethermaw.cfg:197: missing image: units/human-loyalists/spearman-attack-s-6.png
# data/multiplayer/scenarios/2p_Aethermaw.cfg:198: missing image: units/human-loyalists/spearman-attack-se-9.png
# data/multiplayer/scenarios/2p_Aethermaw.cfg:203: missing image: units/human-loyalists/general-idle-5.png
set -eu
# Parsing WML with a regular expression isn't ideal, but it's easy and it works.
# Note that this only matches images specified with "PLACE_IMAGE" and
# "PLACE_IMAGE_SUBMERGED" macros, not "[item]" "image=" images.
IMG_RE='
^ ; Beginning of line
[^#]* ; Zero or more characters other than hash (do not match
; commented-out images)
[{] ; Open curly brace
PLACE_IMAGE ; "PLACE_IMAGE" macro name
[^ \t]* ; Optional non-whitespace characters (e.g. "_SUBMERGED")
[ \t]+ ; One or more spaces or tabs after macro name
[(]? ; One optional open parenthesis
"? ; One optional double quote around image file name
([^{}$ \t~")]+) ; Capture image file name (one or more characters other
; than curly braces, dollar, space, tab, tilde, double
; quote, or close parenthesis)
[ \t~")}] ; One space, tab, tilde, double quote, close
; parenthesis, or close curly brace after the file name
.* ; Any character(s)
$ ; End of line
'
# Somewhat simulate Perl's "/x" modifier ("Extend your pattern's legibility by
# permitting whitespace and comments"):
IMG_RE="$(printf '%s' "${IMG_RE}" | sed '
s|^[ \t]*||; # Strip leading whitespace
s|;.*$||; # Strip comments (use ";" since "#" is used in the RE)
s|[ \t]*$||; # Strip trailing whitespace
' | tr -d '\n')" # Remove all newlines
# In `! { COMMANDS | grep -- '.'; }` below, `grep -- '.'` returns a successful
# exit status if `COMMANDS` produce output, and `!` inverts it into an error
# status. A less clever/obscure solution would be `es=true` before the loop,
# `es=false` inside the loop after all the `continue`s, and `${es}` at the end;
# but that won't work because all commands in pipelines run in subshells that
# can't affect variables in the parent shell.
! { git grep -EIn -- "${IMG_RE}" data/ | while IFS=':' read -r wml ln img; do
img="$(printf '%s' "${img}" | sed -E "s|${IMG_RE}|\\1|")"
[ -e "data/core/images/${img}" ] && continue
[ -e "${img}" ] && continue
case "${wml}" in
data/campaigns/*)
sfx="${wml#data/campaigns/*/}"
[ -e "${wml%/${sfx}}/images/${img}" ] && continue
;;
esac
printf '%s:%d: missing image: %s\n' "${wml}" "${ln}" "${img}"
done | sort -t ':' -k 2n,2n | sort -t ':' -k 1,1 -s | grep -- '.'; }