Skip to content

Commit b0fd9fd

Browse files
xexylxexyl
committed
Improve mkiocccentry_test.sh
Add only required files test. Updated MKIOCCCENTRY_TEST_VERSION to "1.0.14 2025-02-25".
1 parent 484f63f commit b0fd9fd

File tree

3 files changed

+159
-56
lines changed

3 files changed

+159
-56
lines changed

‎CHANGES.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# Major changes to the IOCCC entry toolkit
22

33

4+
## Release 2.3.43 2025-02-25
5+
6+
Improve `mkiocccentry_test.sh` - add only required files test.
7+
8+
Updated `MKIOCCCENTRY_TEST_VERSION` to `"1.0.14 2025-02-25"`.
9+
10+
411
## Release 2.3.42 2025-02-24
512

613
Disable `-g3` in Makefile as use of `-O` option (besides level 0) makes

‎soup/version.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
*
6767
* NOTE: This should match the latest Release string in CHANGES.md
6868
*/
69-
#define MKIOCCCENTRY_REPO_VERSION "2.3.42 2025-02-24" /* special release format: major.minor[.patch] YYYY-MM-DD */
69+
#define MKIOCCCENTRY_REPO_VERSION "2.3.43 2025-02-25" /* special release format: major.minor[.patch] YYYY-MM-DD */
7070

7171

7272
/*

‎test_ioccc/mkiocccentry_test.sh

+151-55
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ MAKE="$(type -P make 2>/dev/null)"
7676
export TXZCHK="./txzchk"
7777
export FNAMCHK="./test_ioccc/fnamchk"
7878

79-
export MKIOCCCENTRY_TEST_VERSION="1.0.13 2025-02-21"
79+
export MKIOCCCENTRY_TEST_VERSION="1.0.14 2025-02-25"
8080
export USAGE="usage: $0 [-h] [-V] [-v level] [-J level] [-t tar] [-T txzchk] [-l ls] [-F fnamchk] [-m make] [-Z topdir]
8181
8282
-h print help and exit
@@ -199,18 +199,18 @@ fi
199199
#
200200
Makefile="test_ioccc/Makefile.test"
201201
workdir="test_ioccc/workdir"
202-
src_dir="test_ioccc/topdir"
203-
src_src_dir="test_ioccc/topdir/topdir"
204-
src_src_src_src_src_dir="test_ioccc/topdir/a/b/c/d/e"
202+
topdir="test_ioccc/topdir"
203+
topdir_topdir="test_ioccc/topdir/topdir"
204+
topdir_topdir_topdir_topdir_topdir="test_ioccc/topdir/a/b/c/d/e"
205205

206206
# clean out test directories first
207-
rm -rf -- "${workdir}" "${src_dir}" "${src_src_dir}" "${src_src_src_src_src_dir}"
207+
rm -rf -- "${workdir}" "${topdir}" "${topdir_topdir}" "${topdir_topdir_topdir_topdir_topdir}"
208208
# be sure the working locations exist
209209
#
210-
mkdir -p -- "${workdir}" "${src_dir}" "${src_src_dir}"
210+
mkdir -p -- "${workdir}" "${topdir}"
211211
status=$?
212212
if [[ ${status} -ne 0 ]]; then
213-
echo "$0: ERROR: error in creating working dirs: mkdir -p -- ${workdir} ${src_dir} ${src_src_dir} ${src_src_src_src_src_dir}" 1>&2
213+
echo "$0: ERROR: error in creating working dirs: mkdir -p -- ${workdir} ${topdir}" 1>&2
214214
exit 9
215215
fi
216216

@@ -222,8 +222,8 @@ if [[ ! -d ${workdir} ]]; then
222222
exit 9
223223
fi
224224
# we also need the source directory
225-
if [[ ! -d ${src_dir} ]]; then
226-
echo "$0: ERROR: src_dir not found: ${src_dir}" 1>&2
225+
if [[ ! -d ${topdir} ]]; then
226+
echo "$0: ERROR: topdir not found: ${topdir}" 1>&2
227227
exit 9
228228
fi
229229

@@ -264,10 +264,11 @@ LONG_FILENAME="fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
264264
workdir_esc="${workdir}"
265265
test "${workdir:0:1}" = "-" && workdir_esc=./"${workdir}"
266266
find "${workdir_esc}" -mindepth 1 -depth -delete
267-
rm -f "${src_dir}"/"${LONG_FILENAME}"
267+
rm -f "${topdir}"/
268268

269269
# Answers as of mkiocccentry version: v0.40 2022-03-15
270-
answers() {
270+
answers()
271+
{
271272
cat <<"EOF"
272273
test
273274
0
@@ -339,23 +340,114 @@ grep -E '^#define MKIOCCCENTRY_ANSWERS_VERSION' soup/version.h | cut -d' ' -f3 |
339340
# shellcheck disable=SC2218
340341
answers >>answers.txt
341342

342-
# fake some required, extra and optional files
343+
# fake a submission that only has the required files
343344
#
344-
test -f "${src_dir}"/Makefile || cat "${Makefile}" >"${src_dir}"/Makefile
345-
test -f "${src_dir}"/remarks.md || cat README.md >"${src_dir}"/remarks.md
346-
test -f "${src_dir}"/extra1 || echo "123" >"${src_dir}"/extra1
347-
test -f "${src_dir}"/extra2 || echo "456" >"${src_dir}"/extra2
348-
test -f "${src_dir}"/try.sh || touch "${src_dir}"/try.sh
349-
test -f "${src_dir}"/try.alt.sh || touch "${src_dir}"/try.alt.sh
350-
test -f "${src_dir}"/prog.alt.c || touch "${src_dir}"/prog.alt.c
351-
345+
test -f "${topdir}"/Makefile || cat "${Makefile}" >"${topdir}"/Makefile
346+
test -f "${topdir}"/remarks.md || cat README.md >"${topdir}"/remarks.md
347+
test -f "${topdir}"/prog.c || echo "int main(){}" >"${topdir}"/prog.c
352348
# delete the work directory for next test
353349
find "${workdir_esc}" -mindepth 1 -depth -delete
354-
rm -f "${src_dir}"/prog.c
355-
:> "${src_dir}"/prog.c
356350
# test empty prog.c, ignoring the warning about it
357-
echo "./mkiocccentry -y -q -W -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${src_dir}"
358-
./mkiocccentry -y -q -W -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${src_dir}"
351+
echo "./mkiocccentry -y -q -W -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${topdir}"
352+
./mkiocccentry -y -q -W -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${topdir}"
353+
status=$?
354+
if [[ ${status} -ne 0 ]]; then
355+
echo "$0: ERROR: mkiocccentry non-zero exit code: $status" 1>&2
356+
exit "${status}"
357+
fi
358+
359+
echo "--"
360+
361+
# Answers as of mkiocccentry version: v0.40 2022-03-15
362+
answers()
363+
{
364+
cat <<"EOF"
365+
test
366+
1
367+
title-for-entry0
368+
abstract for entry #0
369+
5
370+
author0 middle0 thisisaveryverylonglastname0
371+
AU
372+
[email protected]
373+
https://a.host0.example.com/index.html
374+
https://b.host0.example.com/index.html
375+
@[email protected]
376+
@github0
377+
an affiliation for #0 author
378+
379+
author1 middle1a middle1b last1
380+
UK
381+
382+
383+
384+
385+
386+
387+
replaced_author1_handle
388+
EOF
389+
# Avoid triggering an out of date shellcheck bug by using encoded hex characters
390+
printf "Author2 \\xc3\\xa5\\xe2\\x88\\xab\\xc3\\xa7\\xe2\\x88\\x82\\xc2\\xb4\\xc6\\x92\\xc2\\xa9 LAST2\\n"
391+
cat <<"EOF"
392+
US
393+
[email protected]
394+
http://c.host2.example.com/index.html
395+
http://d.host2.example.com/index.html
396+
@[email protected]
397+
@github2
398+
an affiliation for #2 author
399+
400+
author3 middle3 last3
401+
AU
402+
[email protected]
403+
https://e.host0.example.com/index.html
404+
https://f.host0.example.com/index.html
405+
@[email protected]
406+
@github3
407+
an affiliation for #3 author
408+
author3_last3
409+
@#$%^
410+
AU
411+
[email protected]
412+
https://g.host0.example.com/index.html
413+
414+
@[email protected]
415+
@github4
416+
an affiliation for #4 author
417+
418+
ANSWERS_EOF
419+
EOF
420+
}
421+
rm -f answers.txt
422+
# Retrieve the answers version from mkiocccentry.c and write to answers file:
423+
grep -E '^#define MKIOCCCENTRY_ANSWERS_VERSION' soup/version.h | cut -d' ' -f3 | sed 's/"//g' >answers.txt
424+
# Append answers + EOF marker
425+
#
426+
# We disable this shellcheck error because answers already is defined but we
427+
# redefine it as well. The error is ironically erroneous as if one is to move up
428+
# in the file they'll see that answers is actually defined above as well.
429+
#
430+
# SC2218 (error): This function is only defined later. Move the definition up.
431+
# https://www.shellcheck.net/wiki/SC2218
432+
# shellcheck disable=SC2218
433+
answers >>answers.txt
434+
435+
# fake some required, extra and optional files
436+
#
437+
mkdir -p "${topdir_topdir}"
438+
test -f "${topdir}"/Makefile || cat "${Makefile}" >"${topdir}"/Makefile
439+
test -f "${topdir}"/remarks.md || cat README.md >"${topdir}"/remarks.md
440+
test -f "${topdir}"/extra1 || echo "123" >"${topdir}"/extra1
441+
test -f "${topdir}"/extra2 || echo "456" >"${topdir}"/extra2
442+
test -f "${topdir}"/try.sh || touch "${topdir}"/try.sh
443+
test -f "${topdir}"/try.alt.sh || touch "${topdir}"/try.alt.sh
444+
test -f "${topdir}"/prog.alt.c || touch "${topdir}"/prog.alt.c
445+
446+
rm -f "${topdir}"/prog.c
447+
:> "${topdir}"/prog.c
448+
# test empty prog.c, ignoring the warning about it
449+
echo "./mkiocccentry -y -q -W -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${topdir}"
450+
./mkiocccentry -y -q -W -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${topdir}"
359451
status=$?
360452
if [[ ${status} -ne 0 ]]; then
361453
echo "$0: ERROR: mkiocccentry non-zero exit code: $status" 1>&2
@@ -366,18 +458,19 @@ echo "--"
366458

367459
# Form 'submissions' that are unlikely to win the IOCCC :-)
368460
#
369-
test -f "${src_dir}"/prog.c || {
370-
cat >"${src_dir}"/prog.c <<"EOF"
461+
test -f "${topdir}"/prog.c || {
462+
cat >"${topdir}"/prog.c <<"EOF"
371463
#include <stdio.h>
372464
int main(void) { puts("Hello, World!"); }
373465
EOF
374466
}
375467

376468
# Answers as of mkiocccentry version: v0.40 2022-03-15
377-
answers() {
469+
answers()
470+
{
378471
cat <<"EOF"
379472
test
380-
1
473+
2
381474
title-for-entry0
382475
abstract for entry #0
383476
5
@@ -447,8 +540,8 @@ answers >>answers.txt
447540

448541
# run the test, looking for an exit
449542
#
450-
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${src_dir}"
451-
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${src_dir}"
543+
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${topdir}"
544+
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${topdir}"
452545
status=$?
453546
if [[ ${status} -ne 0 ]]; then
454547
echo "$0: ERROR: mkiocccentry non-zero exit code: $status" 1>&2
@@ -458,10 +551,11 @@ fi
458551
echo "--"
459552

460553
# Answers as of mkiocccentry version: v0.40 2022-03-15
461-
answers() {
554+
answers()
555+
{
462556
cat <<"EOF"
463557
12345678-1234-4321-abcd-1234567890ab
464-
2
558+
3
465559
title-for-entry0
466560
abstract for entry #0
467561
5
@@ -531,13 +625,13 @@ answers >>answers.txt
531625

532626
# fake a couple more files
533627
#
534-
test -f "${src_dir}"/foo || cat LICENSE >"${src_dir}"/foo
535-
test -f "${src_dir}"/bar || cat CODE_OF_CONDUCT.md >"${src_dir}"/bar
628+
test -f "${topdir}"/foo || cat LICENSE >"${topdir}"/foo
629+
test -f "${topdir}"/bar || cat CODE_OF_CONDUCT.md >"${topdir}"/bar
536630

537631
# run the test, looking for an exit
538632
#
539-
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${src_dir}"
540-
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${src_dir}"
633+
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${topdir}"
634+
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${topdir}"
541635
status=$?
542636
if [[ ${status} -ne 0 ]]; then
543637
echo "$0: ERROR: mkiocccentry non-zero exit code: $status" 1>&2
@@ -547,10 +641,11 @@ fi
547641
echo "--"
548642

549643
# Answers as of mkiocccentry version: v0.40 2022-03-15
550-
answers() {
644+
answers()
645+
{
551646
cat <<"EOF"
552647
test
553-
2
648+
4
554649
title-for-entry0
555650
abstract for entry #0
556651
5
@@ -619,19 +714,18 @@ grep -E '^#define MKIOCCCENTRY_ANSWERS_VERSION' soup/version.h | cut -d' ' -f3 |
619714
# shellcheck disable=SC2218
620715
answers >>answers.txt
621716

622-
623717
#
624718
# this next test must FAIL as it has a filename that is too long
625719
#
626720

627721
# fake a filename that's too long
628722
#
629-
test -f "${src_dir}/$LONG_FILENAME" || touch "${src_dir}/$LONG_FILENAME"
723+
test -f "${topdir}/$LONG_FILENAME" || touch "${topdir}/$LONG_FILENAME"
630724

631725
# run the test, looking for an exit
632726
#
633-
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${src_dir}"
634-
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${src_dir}"
727+
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${topdir}"
728+
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${topdir}"
635729
status=$?
636730
if [[ ${status} -ne 4 ]]; then
637731
echo "$0: ERROR: mkiocccentry exit code not 4: $status" 1>&2
@@ -644,10 +738,11 @@ fi
644738
echo "--"
645739

646740
# Answers as of mkiocccentry version: v0.40 2022-03-15
647-
answers() {
741+
answers()
742+
{
648743
cat <<"EOF"
649744
test
650-
3
745+
5
651746
title-for-entry0
652747
abstract for entry #0
653748
5
@@ -717,15 +812,15 @@ grep -E '^#define MKIOCCCENTRY_ANSWERS_VERSION' soup/version.h | cut -d' ' -f3 |
717812
answers >>answers.txt
718813

719814
# remove long filename
720-
rm -f "${src_dir}"/"${LONG_FILENAME}"
815+
rm -f "${topdir}"/"${LONG_FILENAME}"
721816
# make a file in the subdirectory
722817
#
723-
test -f "${src_src_dir}/foo" || touch "${src_src_dir}/foo"
818+
test -f "${topdir_topdir}/foo" || touch "${topdir_topdir}/foo"
724819

725820
# run the test, looking for an exit
726821
#
727-
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${src_dir}"
728-
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${src_dir}"
822+
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${topdir}"
823+
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${topdir}"
729824
status=$?
730825
if [[ ${status} -ne 0 ]]; then
731826
echo "$0: ERROR: mkiocccentry non-zero exit code: $status" 1>&2
@@ -735,10 +830,11 @@ fi
735830
echo "--"
736831

737832
# Answers as of mkiocccentry version: v0.40 2022-03-15
738-
answers() {
833+
answers()
834+
{
739835
cat <<"EOF"
740836
test
741-
4
837+
6
742838
title-for-entry0
743839
abstract for entry #0
744840
5
@@ -809,19 +905,19 @@ answers >>answers.txt
809905

810906
# be sure the working location exist
811907
#
812-
mkdir -p -- "${src_src_src_src_src_dir}"
908+
mkdir -p -- "${topdir_topdir_topdir_topdir_topdir}"
813909
status=$?
814910
if [[ ${status} -ne 0 ]]; then
815-
echo "$0: ERROR: error in creating working dirs: mkdir -p -- ${src_src_src_src_src_dir}" 1>&2
911+
echo "$0: ERROR: error in creating working dirs: mkdir -p -- ${topdir_topdir_topdir_topdir_topdir}" 1>&2
816912
exit 9
817913
fi
818914

819-
test -f "${src_src_src_src_src_dir}/foo" || touch "${src_src_src_src_src_dir}/foo"
915+
test -f "${topdir_topdir_topdir_topdir_topdir}/foo" || touch "${topdir_topdir_topdir_topdir_topdir}/foo"
820916

821917
# run the test, looking for an exit
822918
#
823-
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${src_dir}"
824-
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${src_dir}"
919+
echo "./mkiocccentry -y -q -i answers.txt -m $MAKE -F $FNAMCHK -t $TAR -T $TXZCHK -e -l $LS -v $V_FLAG -J $J_FLAG -- ${workdir} ${topdir}"
920+
./mkiocccentry -y -q -i answers.txt -m "$MAKE" -F "$FNAMCHK" -t "$TAR" -T "$TXZCHK" -e -l "$LS" -v "$V_FLAG" -J "$J_FLAG" -- "${workdir}" "${topdir}"
825921
status=$?
826922
if [[ ${status} -ne 4 ]]; then
827923
echo "$0: ERROR: mkiocccentry zero exit code not 4: $status" 1>&2

0 commit comments

Comments
 (0)