#ifndef PARSER_TEST_H
#define PARSER_TEST_H

#include <stdlib.h>

#include "device-handler.h"
#include "resource.h"

struct parser_test {
	struct device_handler *handler;
	struct discover_context *ctx;
	struct list files;
};

/* interface required for parsers */
void __register_parser(struct parser *parser);

/* test functions */
struct discover_device *test_create_device(struct parser_test *test,
		const char *name);

#define test_read_conf_data(t, f, d) \
	__test_read_conf_data(t, t->ctx->device, f, d, sizeof(d))

void __test_read_conf_data(struct parser_test *test,
		struct discover_device *dev, const char *conf_file,
		const char *buf, size_t len);
void test_read_conf_file(struct parser_test *test, const char *filename,
		const char *conf_file);

int test_run_parser(struct parser_test *test, const char *parser_name);

void test_hotplug_device(struct parser_test *test, struct discover_device *dev);
void test_remove_device(struct parser_test *test, struct discover_device *dev);

/* Note that the testing filesystem will only reflect files and
 * directories that you explicitly add, so it is possible for a test
 * to inconsistently believe that a file exists but that its parent
 * directory does not. */
void test_add_file_data(struct parser_test *test, struct discover_device *dev,
		const char *filename, const void *data, int size);
void test_add_dir(struct parser_test *test, struct discover_device *dev,
		const char *dirname);

void test_set_event_source(struct parser_test *test);
void test_set_event_param(struct event *event, const char *name,
		const char *value);
void test_set_event_device(struct event *event, const char *dev);

#define test_add_file_string(test, dev, filename, str) \
	test_add_file_data(test, dev, filename, str, sizeof(str) - 1)

struct discover_boot_option *get_boot_option(struct discover_context *ctx,
		int idx);

/* embedded config */
extern const char __embedded_config[];
extern const size_t __embedded_config_size;
#define test_read_conf_embedded(t, f) \
	__test_read_conf_data(t, t->ctx->device, f, \
				__embedded_config, __embedded_config_size)

#define test_read_conf_embedded_url(t, u) \
	__test_read_conf_data(t, NULL, u, \
				__embedded_config, __embedded_config_size)

/**
 * Checks for parser results.
 *
 * These return void, but will respond to check failures by printing a reason
 * for the failure, and exit the test with a non-zero exit status.
 */

/**
 * Check that we have an expected number of boot options parsed. If not,
 * print out what we did find, then exit.
 */
#define check_boot_option_count(ctx, count) \
	__check_boot_option_count(ctx, count, __FILE__, __LINE__)
void __check_boot_option_count(struct discover_context *ctx, int count,
		const char *file, int line);
/*
 * Check that a boot option @opt has args @args
 */
void __check_args(struct discover_boot_option *opt, const char *args,
		const char *file, int line);
#define check_args(opt, args) \
	__check_args(opt, args, __FILE__, __LINE__)

/**
 * Check that a boot option @opt has name @name
 */
void __check_name(struct discover_boot_option *opt, const char *name,
		const char *file, int line);
#define check_name(opt, name) \
	__check_name(opt, name, __FILE__, __LINE__)

/**
 * Check that a boot option @opt is marked as default
 */
void __check_is_default(struct discover_boot_option *opt,
		const char *file, int line);
#define check_is_default(opt) \
	__check_is_default(opt, __FILE__, __LINE__)

/**
 * Check that a resource (@res) is present, resolved, and has a local path
 * (within @dev's mount point) of @path.
 */
#define check_resolved_local_resource(res, dev, path) \
	__check_resolved_local_resource(res, dev, path, __FILE__, __LINE__)

void __check_resolved_local_resource(struct resource *res,
		struct discover_device *dev, const char *local_path,
		const char *file, int line);

/**
 * Check that a resource (@res) is present, resolved, and has a URL of
 * @url.
 */
#define check_resolved_url_resource(res, url) \
	__check_resolved_url_resource(res, url, __FILE__, __LINE__)
void __check_resolved_url_resource(struct resource *res,
		const char *url, const char *file, int line);
/**
 * Check that a resource (@res) is present but not resolved
 */
void __check_unresolved_resource(struct resource *res,
		const char *file, int line);
#define check_unresolved_resource(res) \
	__check_unresolved_resource(res, __FILE__, __LINE__)

/**
 * Check that a resource (@res) is not present
 */
void __check_not_present_resource(struct resource *res,
		const char *file, int line);
#define check_not_present_resource(res) \
	__check_not_present_resource(res, __FILE__, __LINE__)

/**
 * Check the contents of a file - file @filename must be present on @dev,
 * and match the @len bytes of @buf.
 */
void __check_file_contents(struct parser_test *test,
		struct discover_device *dev, const char *filename,
		const char *buf, int len,
		const char *srcfile, int srcline);
#define check_file_contents(test, dev, filename, buf, len) \
	__check_file_contents(test, dev, filename, buf, len, __FILE__, __LINE__)

#endif /* PARSER_TEST_H */