Add more RGBFIX tests

Rangi42 · Rangi42 · commit 85d3b5df58bd · 2025-09-30T18:20:53.000-04:00
diff --git a/src/fix/main.cpp b/src/fix/main.cpp
@@ -92,14 +92,10 @@ static Usage usage = {
 // clang-format on
 
 static void parseByte(uint16_t &output, char name) {
-	if (musl_optarg[0] == '\0') {
-		fatal("Argument to option '-%c' may not be empty", name);
-	}
-
 	if (std::optional<uint64_t> value = parseWholeNumber(musl_optarg); !value) {
-		fatal("Expected number as argument to option '-%c', got \"%s\"", name, musl_optarg);
-	} else if (value > 0xFF) {
-		fatal("Argument to option '-%c' is larger than 255: %" PRIu64, name, *value);
+		fatal("Invalid argument for option '-%c'", name);
+	} else if (*value > 0xFF) {
+		fatal("Argument for option '-%c' must be between 0 and 0xFF", name);
 	} else {
 		output = *value;
 	}
@@ -117,9 +113,11 @@ static void initLogo() {
 		if (strcmp(options.logoFilename, "-")) {
 			logoFile = fopen(options.logoFilename, "rb");
 		} else {
+			// LCOV_EXCL_START
 			options.logoFilename = "<stdin>";
 			(void)setmode(STDIN_FILENO, O_BINARY);
 			logoFile = stdin;
+			// LCOV_EXCL_STOP
 		}
 		if (!logoFile) {
 			// LCOV_EXCL_START
diff --git a/test/fix/bad-custom-logo.1bpp b/test/fix/bad-custom-logo.1bpp
diff --git a/test/fix/bad-custom-logo.err b/test/fix/bad-custom-logo.err
@@ -0,0 +1 @@
+FATAL: "bad-custom-logo.1bpp" is not 48 bytes
diff --git a/test/fix/bad-custom-logo.flags b/test/fix/bad-custom-logo.flags
@@ -0,0 +1 @@
+-L ./bad-custom-logo.1bpp
diff --git a/test/fix/deprecated-overwrite.bin b/test/fix/deprecated-overwrite.bin
diff --git a/test/fix/deprecated-overwrite.err b/test/fix/deprecated-overwrite.err
@@ -0,0 +1 @@
+warning: '-O' is deprecated; use '-Wno-overwrite' instead [-Wobsolete]
diff --git a/test/fix/deprecated-overwrite.flags b/test/fix/deprecated-overwrite.flags
@@ -0,0 +1 @@
+-O -v
diff --git a/test/fix/deprecated-overwrite.gb b/test/fix/deprecated-overwrite.gb
diff --git a/test/fix/disable-warnings.bin b/test/fix/disable-warnings.bin
diff --git a/test/fix/disable-warnings.flags b/test/fix/disable-warnings.flags
@@ -0,0 +1,2 @@
+-w -m mbc3+ram -r 0
+The "-w" suppresses "-Wmbc" and "-Woverwrite" warnings
diff --git a/test/fix/disable-warnings.gb b/test/fix/disable-warnings.gb
diff --git a/test/fix/invalid-color.err b/test/fix/invalid-color.err
@@ -0,0 +1 @@
+FATAL: Invalid argument for option '--color'
diff --git a/test/fix/invalid-color.flags b/test/fix/invalid-color.flags
@@ -0,0 +1 @@
+--color=chartreuse
diff --git a/test/fix/invalid-numeric-arg.err b/test/fix/invalid-numeric-arg.err
@@ -0,0 +1 @@
+FATAL: Invalid argument for option '-r'
diff --git a/test/fix/invalid-numeric-arg.flags b/test/fix/invalid-numeric-arg.flags
@@ -0,0 +1 @@
+-r invalid
diff --git a/test/fix/invalid-numeric-range.err b/test/fix/invalid-numeric-range.err
@@ -0,0 +1 @@
+FATAL: Argument for option '-r' must be between 0 and 0xFF
diff --git a/test/fix/invalid-numeric-range.flags b/test/fix/invalid-numeric-range.flags
@@ -0,0 +1 @@
+-r 999
diff --git a/test/fix/multiple-to-one.err b/test/fix/multiple-to-one.err
@@ -0,0 +1,17 @@
+FATAL: If '-o' is set then only a single input file may be specified
+Usage: rgbfix [-hjOsVvw] [-C | -c] [-f <fix_spec>] [-i <game_id>]
+              [-k <licensee>] [-L <logo_file>] [-l <licensee_byte>]
+              [-m <mbc_type>] [-n <rom_version>] [-p <pad_value>]
+              [-r <ram_size>] [-t <title_str>] [-W warning] <file> ...
+
+Useful options:
+    -m, --mbc-type <value>   set the MBC type byte to this value; "-m help"
+                             or "-m list" prints the accepted values
+    -p, --pad-value <value>  pad to the next valid size using this value
+    -r, --ram-size <code>    set the cart RAM size byte to this value
+    -o, --output <path>      set the output file
+    -V, --version            print RGBFIX version and exit
+    -v, --validate           fix the header logo and both checksums ("-f lhg")
+    -W, --warning <warning>  enable or disable warnings
+
+For more help, use "man rgbfix" or go to https://rgbds.gbdev.io/docs/
diff --git a/test/fix/no-exist.err b/test/fix/no-exist.err
@@ -0,0 +1,2 @@
+error: Failed to open "no-exist" for reading+writing: No such file or directory
+Fixing "no-exist" failed with 1 error
diff --git a/test/fix/no-input.err b/test/fix/no-input.err
@@ -0,0 +1,17 @@
+FATAL: No input file specified (pass "-" to read from standard input)
+Usage: rgbfix [-hjOsVvw] [-C | -c] [-f <fix_spec>] [-i <game_id>]
+              [-k <licensee>] [-L <logo_file>] [-l <licensee_byte>]
+              [-m <mbc_type>] [-n <rom_version>] [-p <pad_value>]
+              [-r <ram_size>] [-t <title_str>] [-W warning] <file> ...
+
+Useful options:
+    -m, --mbc-type <value>   set the MBC type byte to this value; "-m help"
+                             or "-m list" prints the accepted values
+    -p, --pad-value <value>  pad to the next valid size using this value
+    -r, --ram-size <code>    set the cart RAM size byte to this value
+    -o, --output <path>      set the output file
+    -V, --version            print RGBFIX version and exit
+    -v, --validate           fix the header logo and both checksums ("-f lhg")
+    -W, --warning <warning>  enable or disable warnings
+
+For more help, use "man rgbfix" or go to https://rgbds.gbdev.io/docs/
diff --git a/test/fix/noexist.err b/test/fix/noexist.err
diff --git a/test/fix/ramful-mbc-2-kb.err b/test/fix/ramful-mbc-2-kb.err
@@ -0,0 +1 @@
+warning: RAM size 1 (2 KiB) was specified for MBC "MBC1+RAM" [-Wmbc]
diff --git a/test/fix/ramful-mbc-2-kb.flags b/test/fix/ramful-mbc-2-kb.flags
@@ -0,0 +1 @@
+-m mbc1+ram -r 1
diff --git a/test/fix/ramful-mbc-2-kb.gb b/test/fix/ramful-mbc-2-kb.gb
diff --git a/test/fix/rom-ram-not-2-kb.err b/test/fix/rom-ram-not-2-kb.err
@@ -0,0 +1,2 @@
+warning: MBC "rom+ram" is under-specified and poorly supported [-Wmbc]
+warning: MBC "ROM+RAM" should have 2 KiB of RAM ("-r 1") [-Wmbc]
diff --git a/test/fix/rom-ram-not-2-kb.flags b/test/fix/rom-ram-not-2-kb.flags
@@ -0,0 +1 @@
+-m rom+ram -r 2
diff --git a/test/fix/rom-ram-not-2-kb.gb b/test/fix/rom-ram-not-2-kb.gb
diff --git a/test/fix/test.sh b/test/fix/test.sh
@@ -12,6 +12,16 @@ cd "$tmpdir" || exit
 # shellcheck disable=SC2064
 trap "cd; rm -rf ${tmpdir@Q}" EXIT
 
+if which cygpath &>/dev/null; then
+	# MinGW needs the Windows path substituted but with forward slash separators;
+	# Cygwin has `cygpath` but just needs the original path substituted.
+	subst1="$(printf '%s\n' "$src" | sed 's:[][\/.^$*]:\\&:g')"
+	subst2="$(printf '%s\n' "$(cygpath -w "$src")" | sed -e 's:\\:/:g' -e 's:[][\/.^$*]:\\&:g')"
+	src_subst="$src/\\|$subst1/\\|$subst2/"
+else
+	src_subst="$src/"
+fi
+
 tests=0
 failed=0
 rc=0
@@ -83,9 +93,9 @@ runTest () {
 		else
 			desired_errname=/dev/null
 		fi
-		sed "s/$subst/<filename>/g" out.out | tryDiff "$desired_outname" - "$1.out${variant}"
+		sed -e "s/$subst/<filename>/g" -e "s#$src_subst##g" out.out | tryDiff "$desired_outname" - "$1.out${variant}"
 		(( our_rc = our_rc || $? ))
-		sed "s/$subst/<filename>/g" out.err | tryDiff "$desired_errname" - "$1.err${variant}"
+		sed -e "s/$subst/<filename>/g" -e "s#$src_subst##g" out.err | tryDiff "$desired_errname" - "$1.err${variant}"
 		(( our_rc = our_rc || $? ))
 
 		if [[ -r "$2/$1.gb" ]]; then
@@ -101,13 +111,32 @@ runTest () {
 	done
 }
 
+runSpecialTest () {
+	name="$1"
+	shift
+	echo "${bold}${green}${name}...${rescolors}${resbold}"
+	eval "$RGBFIX" "$@" '2>out.err'
+	rc=$((rc || $? != 1))
+	tryDiff "$src/${name}.err" out.err "${name}.err"
+	rc=$((rc || $?))
+}
+
 rm -f padding*_* # Delete padding test cases generated but not deleted (e.g. interrupted)
 
 progress=1
 for i in "$src"/*.flags; do
 	runTest "$(basename "$i" .flags)" "$src"
 done
 
+# Check that RGBFIX errors out when inputting a non-existent file
+runSpecialTest no-exist no-exist
+
+# Check that RGBFIX errors out when not inputting any file
+runSpecialTest no-input
+
+# Check that RGBFIX errors out when inputting multiple files with an output file
+runSpecialTest multiple-to-one one two three -o multiple-to-one
+
 # Check the result with all different padding bytes
 echo "${bold}Checking padding...${resbold}"
 cp "$src"/padding{,-large,-larger}.bin .
@@ -124,12 +153,6 @@ for (( i=0; i < 10; ++i )); do
 done
 echo "${bold}Done checking padding!${resbold}"
 
-# Check that RGBFIX errors out when inputting a non-existent file...
-$RGBFIX noexist 2>out.err
-rc=$((rc || $? != 1))
-tryDiff "$src/noexist.err" out.err noexist.err
-rc=$((rc || $?))
-
 if [[ "$failed" -eq 0 ]]; then
 	echo "${bold}${green}All ${tests} tests passed!${rescolors}${resbold}"
 else

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+FATAL: "bad-custom-logo.1bpp" is not 48 bytes`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+warning: '-O' is deprecated; use '-Wno-overwrite' instead [-Wobsolete]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+-w -m mbc3+ram -r 0`
	`2`	`+The "-w" suppresses "-Wmbc" and "-Woverwrite" warnings`