tests/unit/c/test-argconfig-parse.c - master - githubmirror/nvme-cli

tests/unit/c/test-argconfig-parse.c
445 строк11 KB
Brandon Busacker
tests/unit/c: don't silently pass when stderr can't be redirected
11 авг 2026, 21:54
11 авг 2026, 21:54f4aa289
// SPDX-License-Identifier: GPL-2.0-or-later

#include <errno.h>
#include <locale.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include <ccan/array_size/array_size.h>

#include "fs-util.h"

#include "../src/argconfig.h"
#include "../src/cleanup.h"
#include "parse-util.h"

const char *libnvme_strerror(int errnum);

static int test_rc;

union val {
	bool flag;
	__u64 suffix;
	__u32 uint;
	int int_val;
	__u64 long_val;
	double double_val;
	__u8 byte;
	__u16 shrt;
	int incr;
	char *string;
	char *fmt;
	char *file;
	char *list;
	char *str;
	__u8 val;
};

struct toval_test {
	char *arg;
	void *val;
	union val exp;
	int size;
	int ret;
};

static void check_val(const char *arg, void *exp, void *val, int size)
{
	if ((size && !memcmp(exp, val, size)) ||
	    (!size && !strcmp(*(char **)exp, *(char **)val)))
		return;

	switch (size) {
	case 0:
		printf("ERROR: printing {%s}, got '%s', expected '%s'\n",
		       arg, *(char **)val, *(char **)exp);
		break;
	default:
		printf("ERROR: printing {%s}, got '%llu', expected '%llu'\n",
		       arg, *(unsigned long long *)val, *(unsigned long long *)exp);
		break;
	}

	test_rc = 1;
}

struct cfg {
	bool flag;
	__u64 suffix;
	__u32 uint;
	int int_val;
	__u64 long_val;
	double double_val;
	__u8 byte;
	__u16 shrt;
	int incr;
	char *string;
	char *fmt;
	char *file;
	char *list;
	char *str;
	__u8 val;
};

static struct cfg cfg;

#define VAL_TEST(a, c, v, l, r) \
	{ a, &cfg.c, { .c = v }, l ? sizeof(cfg.c) : 0, r }

static struct toval_test toval_tests[] = {
	VAL_TEST("--flag", flag, true, true, 0),
	VAL_TEST("--flag=1", flag, false, true, -EINVAL),
	VAL_TEST("--suffix=0", suffix, 0, true, 0),
	VAL_TEST("--suffix=1", suffix, 1, true, 0),
	VAL_TEST("--suffix=1234", suffix, 1234, true, 0),
	VAL_TEST("--suffix=4096", suffix, 4096, true, 0),
	VAL_TEST("--suffix=1Ki", suffix, 1024, true, 0),
	VAL_TEST("--suffix=34Gi", suffix, 36507222016, true, 0),
	VAL_TEST("--suffix=34.9Ki", suffix, 0, true, -EINVAL),
	VAL_TEST("--suffix=32Gii", suffix, 0, true, -EINVAL),
	VAL_TEST("--uint=1", uint, 1, true, 0),
	VAL_TEST("--int=1", int_val, 1, true, 0),
	VAL_TEST("--long=1", long_val, 1, true, 0),
	VAL_TEST("--double=1", double_val, 1, true, 0),
	VAL_TEST("--byte=1", byte, 1, true, 0),
	VAL_TEST("--byte=256", byte, 0, true, -EINVAL),
	VAL_TEST("--shrt=1", shrt, 1, true, 0),
	VAL_TEST("--incr", incr, 1, true, 0),
	VAL_TEST("--incr=1", incr, 0, true, -EINVAL),
	VAL_TEST("--string=string", string, "string", false, 0),
	VAL_TEST("--fmt=fmt", fmt, "fmt", false, 0),
	VAL_TEST("--file=file", file, "file", false, 0),
	VAL_TEST("--list=list", list, "list", false, 0),
	VAL_TEST("--str=str", str, "str", false, 0),
	VAL_TEST("--val=", val, 0, true, -EINVAL),
	VAL_TEST("--val=o", val, 1, true, 0),
	VAL_TEST("--val=t", val, 0, true, -EINVAL),
	VAL_TEST("--val=tw", val, 2, true, 0),
	VAL_TEST("--val=two", val, 2, true, 0),
	VAL_TEST("--val=twoo", val, 0, true, -EINVAL),
	VAL_TEST("--val=th", val, 3, true, 0),
	VAL_TEST("--val=three", val, 3, true, 0),
	VAL_TEST("--val=threed", val, 0, true, -EINVAL),
	VAL_TEST("--val=123", val, 123, true, 0),
	VAL_TEST("--val=1234", val, 0, true, -EINVAL),
};

void toval_test(struct toval_test *test)
{
	const char *desc = "Test argconfig parse";
	int ret;
	char *argv[] = { "test-argconfig", test->arg };

	OPT_VALS(opt_vals) = {
		VAL_BYTE("one", 1),
		VAL_BYTE("two", 2),
		VAL_BYTE("three", 3),
		VAL_END()
	};

	OPT_ARGS(opts) = {
		OPT_FLAG("flag",'f', &cfg.flag, "flag"),
		OPT_SUFFIX("suffix", 's', &cfg.suffix, "suffix"),
		OPT_UINT("uint", 'u', &cfg.uint, "uint"),
		OPT_INT("int", 'i', &cfg.int_val, "int"),
		OPT_LONG("long", 'l', &cfg.long_val, "long"),
		OPT_DOUBLE("double", 'd', &cfg.double_val, "double"),
		OPT_BYTE("byte", 'b', &cfg.byte, "byte"),
		OPT_SHRT("shrt", 'S', &cfg.shrt, "shrt"),
		OPT_INCR("incr", 'I', &cfg.incr, "incr"),
		OPT_STRING("string", 't', "STRING", &cfg.string, "string"),
		OPT_FMT("fmt", 'F', &cfg.fmt, "fmt"),
		OPT_FILE("file", 'L', &cfg.file, "file"),
		OPT_LIST("list", 'T', &cfg.list, "list"),
		OPT_STR("str", 'r', &cfg.str, "str"),
		OPT_BYTE("val", 'v', &cfg.val, "val", opt_vals),
		OPT_END()
	};

	ret = argconfig_parse(2, argv, desc, opts);
	if (ret != test->ret) {
		printf("ERROR: converting {%s} failed\n", test->arg);
		test_rc = 1;
		return;
	}
	if (ret)
		return;

	check_val(test->arg, &test->exp, test->val, test->size);
}

#define COMMA_SEP_ARRAY_MAX_VALUES 4

struct comma_sep_array_test {
	const char *input;
	int ret;
	__u32 values[COMMA_SEP_ARRAY_MAX_VALUES];
};

const struct comma_sep_array_test comma_sep_array_tests[] = {
	{"", 0},
	{",,,", 0},
	{" ", -1},
	{"abc", -1},
	{"0xFFFFFFFF", 1, {0xFFFFFFFF}},
	{"0x100000000", -1},
	{"123,0x456", 2, {123, 0x456}},
	{",1,,2,", 2, {1, 2}},
	{"1,22,333,4444", 4, {1, 22, 333, 4444}},
	{"1,2,3,4,5", -1},
};

void comma_sep_array_test(const struct comma_sep_array_test *test)
{
	__cleanup_free char *input = strdup(test->input);
	__u32 values[COMMA_SEP_ARRAY_MAX_VALUES] = {};
	int ret = shr_parse_csv_u32(
		input, values, COMMA_SEP_ARRAY_MAX_VALUES);
	int i;

	if (ret != test->ret) {
		printf("ERROR: input '%s' return value %d != %d\n",
		       test->input, ret, test->ret);
		test_rc = 1;
		return;
	}

	for (i = 0; i < ret; i++) {
		if (values[i] != test->values[i]) {
			printf("ERROR: input '%s' values[%d] = %u != %u\n",
			       test->input, i, values[i], test->values[i]);
			test_rc = 1;
			return;
		}
	}
}

struct global_cfg {
	int verbose;
	bool dry_run;
};

static struct global_cfg gcfg;

struct global_parse_test {
	const char *desc;
	char *argv[8];
	int argc;
	/*
	 * Expected optind value after argconfig_parse_global() returns.
	 * This is the index of the first non-option argument (the subcommand)
	 * in argv, as seen by getopt – i.e. 1-based because getopt always
	 * skips argv[0] as the program name.
	 */
	int expected_optind;
	int expected_ret;
	int expected_verbose;
	bool expected_dry_run;
	const char *stderr_must_not_contain;
};

static const struct global_parse_test global_parse_tests[] = {
	{
		"no global opts: subcommand only",
		{"prog", "list"},
		2, 1, 0, 0, false,
	},
	{
		"short -v before subcommand",
		{"prog", "-v", "list"},
		3, 2, 0, 1, false,
	},
	{
		"long --verbose before subcommand",
		{"prog", "--verbose", "list"},
		3, 2, 0, 1, false,
	},
	{
		"two -v flags before subcommand",
		{"prog", "-v", "-v", "list"},
		4, 3, 0, 2, false,
	},
	{
		"--dry-run before subcommand",
		{"prog", "--dry-run", "list"},
		3, 2, 0, 0, true,
	},
	{
		"multiple global opts before subcommand",
		{"prog", "-v", "--dry-run", "list"},
		4, 3, 0, 1, true,
	},
	{
		/*
		 * The '+' prefix in the short-opts string causes getopt to stop
		 * at the first non-option argument.  Global opts that appear
		 * *after* the subcommand must be left for the subcommand's own
		 * argconfig_parse() call to handle.
		 */
		"subcommand before option: stop at first non-option",
		{"prog", "list", "-v"},
		3, 1, 0, 0, false,
	},
	{
		"only program name",
		{"prog"},
		1, 1, 0, 0, false,
	},
	{
		"option with no following subcommand",
		{"prog", "--verbose"},
		2, 2, 0, 1, false,
	},
 	{
 		"unknown option before subcommand should fail",
 		{"prog", "--no-such-opt", "list"},
 		3, 0, -EINVAL, 0, false,
 	},
};

static int parse_global_capture_stderr(int argc, char *argv[],
				       struct argconfig_commandline_options *opts,
				       char *buf, size_t buf_size)
{
	FILE *tmp = NULL;
	int ret;
	int saved_stderr;
	size_t n;

	tmp = tmpfile();
	if (!tmp) {
		printf("ERROR: tmpfile failed: %s\n", libnvme_strerror(errno));
		test_rc = 1;
		return -errno;
	}

	saved_stderr = dup(STDERR_FILENO);
	if (saved_stderr < 0) {
		printf("ERROR: dup stderr failed: %s\n", libnvme_strerror(errno));
		test_rc = 1;
		fclose(tmp);
		return -errno;
	}

	fflush(stderr);
	if (dup2(fileno(tmp), STDERR_FILENO) < 0) {
		printf("ERROR: redirect stderr failed: %s\n", libnvme_strerror(errno));
		close(saved_stderr);
		test_rc = 1;
		fclose(tmp);
		return -errno;
	}

	ret = argconfig_parse_global(argc, argv, opts);
	fflush(stderr);

	if (fseek(tmp, 0, SEEK_SET) != 0) {
		printf("ERROR: rewind captured stderr failed: %s\n",
		       libnvme_strerror(errno));
		close(saved_stderr);
		test_rc = 1;
		fclose(tmp);
		return -errno;
	}

	n = fread(buf, 1, buf_size - 1, tmp);
	buf[n] = '\0';

	if (dup2(saved_stderr, STDERR_FILENO) < 0) {
		printf("ERROR: restoring stderr failed: %s\n", libnvme_strerror(errno));
		test_rc = 1;
		close(saved_stderr);
		fclose(tmp);
		return -errno;
	}
	close(saved_stderr);
	fclose(tmp);

	return ret;
}

static void do_global_parse_test(const struct global_parse_test *test)
{
	int ret;
	char stderr_buf[512] = "";

	OPT_ARGS(opts) = {
		OPT_INCR("verbose", 'v', &gcfg.verbose, "increase verbosity"),
		OPT_FLAG("dry-run", 0, &gcfg.dry_run, "dry run mode"),
		OPT_END()
	};

	gcfg.verbose = 0;
	gcfg.dry_run = false;

	if (test->stderr_must_not_contain)
		ret = parse_global_capture_stderr(test->argc, (char **)test->argv,
						  opts, stderr_buf, sizeof(stderr_buf));
	else
		ret = argconfig_parse_global(test->argc, (char **)test->argv, opts);

	if (ret != test->expected_ret) {
		printf("ERROR: global_parse {%s}: ret=%d expected=%d\n",
		       test->desc, ret, test->expected_ret);
		test_rc = 1;
		return;
	}

	if (test->expected_ret == 0 && optind != test->expected_optind) {
		printf("ERROR: global_parse {%s}: optind=%d expected=%d\n",
		       test->desc, optind, test->expected_optind);
		test_rc = 1;
		return;
	}

	if (test->stderr_must_not_contain &&
	    strstr(stderr_buf, test->stderr_must_not_contain)) {
		printf("ERROR: global_parse {%s}: stderr unexpectedly contains '%s'\n",
		       test->desc, test->stderr_must_not_contain);
		test_rc = 1;
		return;
	}

	if (gcfg.verbose != test->expected_verbose) {
		printf("ERROR: global_parse {%s}: verbose=%d expected=%d\n",
		       test->desc, gcfg.verbose, test->expected_verbose);
		test_rc = 1;
		return;
	}

	if (gcfg.dry_run != test->expected_dry_run) {
		printf("ERROR: global_parse {%s}: dry_run=%d expected=%d\n",
		       test->desc, gcfg.dry_run, test->expected_dry_run);
		test_rc = 1;
	}
}

int main(void)
{
	unsigned int i;
	FILE *f;

	test_rc = 0;
	setlocale(LC_NUMERIC, "C");
	f = freopen(shr_dev_null(), "w", stderr);
	if (!f) {
		printf("ERROR: reopening stderr failed: %s\n", libnvme_strerror(errno));
		test_rc = 1;
	}

	for (i = 0; i < ARRAY_SIZE(toval_tests); i++)
		toval_test(&toval_tests[i]);

	for (i = 0; i < ARRAY_SIZE(comma_sep_array_tests); i++)
		comma_sep_array_test(&comma_sep_array_tests[i]);

	for (i = 0; i < ARRAY_SIZE(global_parse_tests); i++)
		do_global_parse_test(&global_parse_tests[i]);

	if (f)
		fclose(f);

	return test_rc ? EXIT_FAILURE : EXIT_SUCCESS;
}