git: 301dee770efe - main - libutil: Better tests for expand_number(3)
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sat, 02 Aug 2025 14:06:35 UTC
The branch main has been updated by des:
URL: https://cgit.FreeBSD.org/src/commit/?id=301dee770efe9c520ac001add39b9180897aafbb
commit 301dee770efe9c520ac001add39b9180897aafbb
Author: Dag-Erling Smørgrav <des@FreeBSD.org>
AuthorDate: 2025-08-02 14:05:44 +0000
Commit: Dag-Erling Smørgrav <des@FreeBSD.org>
CommitDate: 2025-08-02 14:05:44 +0000
libutil: Better tests for expand_number(3)
Replace the current tests with jhb's earlier, more extensive proposal,
updated to take into account the switch back to signed integers.
Reviewed by: pstef
Differential Revision: https://reviews.freebsd.org/D20796
---
lib/libutil/tests/expand_number_test.c | 219 ++++++++++++++++++++++++++-------
1 file changed, 175 insertions(+), 44 deletions(-)
diff --git a/lib/libutil/tests/expand_number_test.c b/lib/libutil/tests/expand_number_test.c
index 6bf3ff082ee4..8e7458994de4 100644
--- a/lib/libutil/tests/expand_number_test.c
+++ b/lib/libutil/tests/expand_number_test.c
@@ -1,7 +1,8 @@
/*-
* SPDX-License-Identifier: BSD-2-Clause
*
- * Copyright (c) 2023 Google LLC
+ * Copyright (c) 2019 John Baldwin <jhb@FreeBSD.org>
+ * Copyright (c) 2025 Dag-Erling Smørgrav <des@FreeBSD.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@@ -25,60 +26,190 @@
* SUCH DAMAGE.
*/
-#include <sys/cdefs.h>
+#include <atf-c.h>
#include <errno.h>
#include <libutil.h>
+#include <stdint.h>
-#include <atf-c.h>
+static void
+require_success(const char *str, int64_t exp_val)
+{
+ int64_t val;
-ATF_TC_WITHOUT_HEAD(positivetests);
-ATF_TC_BODY(positivetests, tc)
+ ATF_REQUIRE_MSG(expand_number(str, &val) == 0,
+ "Failed to parse '%s': %m", str);
+ ATF_REQUIRE_MSG(val == exp_val,
+ "String '%s' parsed as %jd instead of expected %jd", str,
+ (intmax_t)val, (intmax_t)exp_val);
+}
+
+static void
+require_error(const char *str, int exp_errno)
{
- int retval;
- uint64_t num;
-
-#define positive_tc(string, value) \
- do { \
- ATF_CHECK_ERRNO(0, (retval = expand_number((string), &num)) == 0); \
- ATF_CHECK_EQ(retval, 0); \
- ATF_CHECK_EQ(num, (value)); \
- } while (0)
-
- positive_tc("123456", 123456);
- positive_tc("123456b", 123456);
- positive_tc("1k", 1024);
- positive_tc("1kb", 1024);
- positive_tc("1K", 1024);
- positive_tc("1KB", 1024);
- positive_tc("1m", 1048576);
- positive_tc("1M", 1048576);
- positive_tc("1g", 1073741824);
- positive_tc("1G", 1073741824);
- positive_tc("1t", 1099511627776);
- positive_tc("1T", 1099511627776);
- positive_tc("1p", 1125899906842624);
- positive_tc("1P", 1125899906842624);
- positive_tc("1e", 1152921504606846976);
- positive_tc("1E", 1152921504606846976);
- positive_tc("15E", 17293822569102704640ULL);
+ int64_t val;
+
+ ATF_REQUIRE_MSG(expand_number(str, &val) == -1,
+ "String '%s' parsed as %jd instead of error", str, (intmax_t)val);
+ ATF_REQUIRE_MSG(errno == exp_errno,
+ "String '%s' failed with %d instead of expected %d", str, errno,
+ exp_errno);
+}
+
+ATF_TC_WITHOUT_HEAD(expand_number__ok);
+ATF_TC_BODY(expand_number__ok, tp)
+{
+ /* Bare numbers. */
+ require_success("-0", 0);
+ require_success(" 0", 0);
+ require_success("+0", 0);
+ require_success("-1", -1);
+ require_success(" 1", 1);
+ require_success("+1", 1);
+ require_success("-10", -10);
+ require_success(" 10", 10);
+ require_success("+10", 10);
+
+ /* Uppercase suffixes. */
+ require_success("1B", 1);
+ require_success("1K", 1LL << 10);
+ require_success("1M", 1LL << 20);
+ require_success("1G", 1LL << 30);
+ require_success("1T", 1LL << 40);
+ require_success("1P", 1LL << 50);
+ require_success("1E", 1LL << 60);
+
+ /* Lowercase suffixes. */
+ require_success("2b", 2);
+ require_success("2k", 2LL << 10);
+ require_success("2m", 2LL << 20);
+ require_success("2g", 2LL << 30);
+ require_success("2t", 2LL << 40);
+ require_success("2p", 2LL << 50);
+ require_success("2e", 2LL << 60);
+
+ /* Suffixes with a trailing 'b'. */
+ require_success("3KB", 3LL << 10);
+ require_success("3MB", 3LL << 20);
+ require_success("3GB", 3LL << 30);
+ require_success("3TB", 3LL << 40);
+ require_success("3PB", 3LL << 50);
+ require_success("3EB", 3LL << 60);
+
+ /* Negative numbers. */
+ require_success("-1", -1);
+ require_success("-10", -10);
+ require_success("-1B", -1);
+ require_success("-1K", -(1LL << 10));
+ require_success("-1M", -(1LL << 20));
+ require_success("-1G", -(1LL << 30));
+ require_success("-1T", -(1LL << 40));
+ require_success("-1P", -(1LL << 50));
+ require_success("-1E", -(1LL << 60));
+ require_success("-2b", -2);
+ require_success("-2k", -(2LL << 10));
+ require_success("-2m", -(2LL << 20));
+ require_success("-2g", -(2LL << 30));
+ require_success("-2t", -(2LL << 40));
+ require_success("-2p", -(2LL << 50));
+ require_success("-2e", -(2LL << 60));
+ require_success("-3KB", -(3LL << 10));
+ require_success("-3MB", -(3LL << 20));
+ require_success("-3GB", -(3LL << 30));
+ require_success("-3TB", -(3LL << 40));
+ require_success("-3PB", -(3LL << 50));
+ require_success("-3EB", -(3LL << 60));
+
+ /* Maximum values. */
+ require_success("7E", 7LL << 60);
+ require_success("8191P", 8191LL << 50);
+ require_success("8388607T", 8388607LL << 40);
+ require_success("8589934591G", 8589934591LL << 30);
+ require_success("8796093022207M", 8796093022207LL << 20);
+ require_success("9007199254740991K", 9007199254740991LL << 10);
+ require_success("9223372036854775807", INT64_MAX);
+
+ /* Minimum values. */
+ require_success("-7E", -(7LL << 60));
+ require_success("-8191P", -(8191LL << 50));
+ require_success("-8388607T", -(8388607LL << 40));
+ require_success("-8589934591G", -(8589934591LL << 30));
+ require_success("-8796093022207M", -(8796093022207LL << 20));
+ require_success("-9007199254740991K", -(9007199254740991LL << 10));
+ require_success("-9223372036854775808", INT64_MIN);
}
-ATF_TC_WITHOUT_HEAD(negativetests);
-ATF_TC_BODY(negativetests, tc)
+ATF_TC_WITHOUT_HEAD(expand_number__bad);
+ATF_TC_BODY(expand_number__bad, tp)
{
- uint64_t num;
-
- ATF_CHECK_ERRNO(EINVAL, expand_number("", &num));
- ATF_CHECK_ERRNO(EINVAL, expand_number("x", &num));
- ATF_CHECK_ERRNO(EINVAL, expand_number("1bb", &num));
- ATF_CHECK_ERRNO(EINVAL, expand_number("1x", &num));
- ATF_CHECK_ERRNO(EINVAL, expand_number("1kx", &num));
- ATF_CHECK_ERRNO(ERANGE, expand_number("16E", &num));
+ /* No digits. */
+ require_error("", EINVAL);
+ require_error("b", EINVAL);
+ require_error("k", EINVAL);
+ require_error("m", EINVAL);
+ require_error("g", EINVAL);
+ require_error("t", EINVAL);
+ require_error("p", EINVAL);
+ require_error("e", EINVAL);
+ require_error("-", EINVAL);
+ require_error("-b", EINVAL);
+ require_error("-k", EINVAL);
+ require_error("-m", EINVAL);
+ require_error("-g", EINVAL);
+ require_error("-t", EINVAL);
+ require_error("-p", EINVAL);
+ require_error("-e", EINVAL);
+
+ require_error("not_a_number", EINVAL);
+
+ /* Invalid suffixes. */
+ require_error("1a", EINVAL);
+ require_error("1c", EINVAL);
+ require_error("1d", EINVAL);
+ require_error("1f", EINVAL);
+ require_error("1h", EINVAL);
+ require_error("1i", EINVAL);
+ require_error("1j", EINVAL);
+ require_error("1l", EINVAL);
+ require_error("1n", EINVAL);
+ require_error("1o", EINVAL);
+ require_error("1q", EINVAL);
+ require_error("1r", EINVAL);
+ require_error("1s", EINVAL);
+ require_error("1u", EINVAL);
+ require_error("1v", EINVAL);
+ require_error("1w", EINVAL);
+ require_error("1x", EINVAL);
+ require_error("1y", EINVAL);
+ require_error("1z", EINVAL);
+
+ /* Trailing garbage. */
+ require_error("1K foo", EINVAL);
+ require_error("1Mfoo", EINVAL);
+
+ /* Overflow. */
+ require_error("8E", ERANGE);
+ require_error("8192P", ERANGE);
+ require_error("8388608T", ERANGE);
+ require_error("8589934592G", ERANGE);
+ require_error("8796093022208M", ERANGE);
+ require_error("9007199254740992K", ERANGE);
+ require_error("9223372036854775808", ERANGE);
+
+ /* Multiple signs */
+ require_error("--1", EINVAL);
+ require_error("-+1", EINVAL);
+ require_error("+-1", EINVAL);
+ require_error("++1", EINVAL);
+
+ /* Whitespace after the sign */
+ require_error(" - 1", EINVAL);
+ require_error(" + 1", EINVAL);
}
ATF_TP_ADD_TCS(tp)
{
- ATF_TP_ADD_TC(tp, positivetests);
- ATF_TP_ADD_TC(tp, negativetests);
+ ATF_TP_ADD_TC(tp, expand_number__ok);
+ ATF_TP_ADD_TC(tp, expand_number__bad);
+
return (atf_no_error());
}