xaizek / vifm (License: GPLv2+) (since 2018-12-07)
Vifm is a file manager with curses interface, which provides Vi[m]-like environment for managing objects within file systems, extended with some useful ideas from mutt.
<root> / tests / lua / api_handlers.c (9966b7bd45006d3f3b5acf0e6f8f57aaa8d87a47) (9,870B) (mode 100644) [raw]
#include <stic.h>

#include "../../src/compat/fs_limits.h"
#include "../../src/lua/vlua.h"
#include "../../src/ui/statusbar.h"
#include "../../src/ui/quickview.h"
#include "../../src/ui/ui.h"
#include "../../src/utils/string_array.h"
#include "../../src/utils/utils.h"
#include "../../src/running.h"
#include "../../src/status.h"

#include <test-utils.h>
#include "asserts.h"

static vlua_t *vlua;

static const preview_area_t parea = {
	.source = &lwin,
	.view = &lwin,
	.x = 1,
	.y = 2,
	.w = 3,
	.h = 4,
};

static dir_entry_t entry = {
	.name = "binary-data",
	.origin = TEST_DATA_PATH "/test-data/read",
	.name_dec_num = -1,
};

SETUP()
{
	vlua = vlua_init();
}

TEARDOWN()
{
	vlua_finish(vlua);
}

TEST(handler_check)
{
	assert_false(vlua_handler_cmd(vlua, "normal command"));
	assert_false(vlua_handler_cmd(vlua, "#something"));
	assert_true(vlua_handler_cmd(vlua, "#something#"));
	assert_true(vlua_handler_cmd(vlua, "#something#more"));
	assert_true(vlua_handler_cmd(vlua, "#something#more here"));
}

TEST(bad_args)
{
	BLUA_ENDS(vlua, ": `name` key is mandatory",
			"print(vifm.addhandler { name = nil, handler = nil })");
	BLUA_ENDS(vlua, ": `handler` key is mandatory",
			"print(vifm.addhandler { name = 'NAME', handler = nil })");
}

TEST(bad_name)
{
	GLUA_EQ(vlua, "", "function handler() end");

	BLUA_ENDS(vlua, ": Handler's name can't be empty",
			"print(vifm.addhandler { name = '', handler = handler })");
	BLUA_ENDS(vlua, ": Handler's name can't contain whitespace",
			"print(vifm.addhandler { name = 'name with white\tspace',"
			"                        handler = handler })");
}

TEST(registered)
{
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = function() end })");

	assert_true(vlua_handler_present(vlua, "#vifmtest#handle"));

	curr_stats.vlua = vlua;
	assert_true(rn_cmd_exists("#vifmtest#handle"));
	curr_stats.vlua = NULL;
}

TEST(duplicate_rejected)
{
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = function() end })");
	GLUA_EQ(vlua, "false",
			"print(vifm.addhandler { name = 'handle', handler = function() end })");
}

TEST(invoked)
{
	GLUA_EQ(vlua, "",
				"function handler(info)"
				"  return { lines = {info.command, info.path} }"
				"end");
	GLUA_EQ(vlua, "true",
				"print(vifm.addhandler { name = 'handle', handler = handler })");

	strlist_t lines = vlua_view_file(vlua, "#vifmtest#handle", "path", &parea);
	assert_int_equal(2, lines.nitems);
	assert_string_equal("#vifmtest#handle", lines.items[0]);
	assert_string_equal("path", lines.items[1]);
	free_string_array(lines.items, lines.nitems);
}

TEST(bad_invocation)
{
	strlist_t lines =
		vlua_view_file(vlua, "#vifmtest#nosuchhandle", "path", &parea);
	assert_int_equal(0, lines.nitems);
	free_string_array(lines.items, lines.nitems);

	vlua_open_file(vlua, "#vifmtest#nosuchhandle", &entry);
}

TEST(error_invocation)
{
	GLUA_EQ(vlua, "", "function handle() asdf() end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	strlist_t lines = vlua_view_file(vlua, "#vifmtest#handle", "path", &parea);
	assert_int_equal(0, lines.nitems);
	free_string_array(lines.items, lines.nitems);
}

TEST(wrong_return)
{
	GLUA_EQ(vlua, "", "function handle() return true end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler{  name = 'handle', handler = handle })");

	strlist_t lines = vlua_view_file(vlua, "#vifmtest#handle", "path", &parea);
	assert_int_equal(0, lines.nitems);
	free_string_array(lines.items, lines.nitems);
}

TEST(missing_field)
{
	GLUA_EQ(vlua, "", "function handle() return {} end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	strlist_t lines = vlua_view_file(vlua, "#vifmtest#handle", "path", &parea);
	assert_int_equal(0, lines.nitems);
	free_string_array(lines.items, lines.nitems);
}

TEST(error_open_invocation)
{
	GLUA_EQ(vlua, "", "function handle() asdf() end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	ui_sb_msg("");
	vlua_open_file(vlua, "#vifmtest#handle", &entry);
	assert_string_ends_with(": attempt to call a nil value (global 'asdf')",
			ui_sb_last());
}

TEST(invalid_statusline_formatter)
{
	char *format = vlua_make_status_line(vlua, "#vifmtest#nohandle", &lwin, 10);
	assert_string_equal("Invalid handler", format);
	free(format);
}

TEST(error_statusline_formatter)
{
	GLUA_EQ(vlua, "", "function handle() asdf() end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	char *format = vlua_make_status_line(vlua, "#vifmtest#handle", &lwin, 10);
	assert_string_ends_with(": attempt to call a nil value (global 'asdf')",
			format);
	free(format);
}

TEST(bad_statusline_formatter)
{
	GLUA_EQ(vlua, "", "function handle() return 'format' end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	char *format = vlua_make_status_line(vlua, "#vifmtest#handle", &lwin, 10);
	assert_string_equal("Return value isn't a table.", format);
	free(format);
}

TEST(good_statusline_formatter)
{
	GLUA_EQ(vlua, "",
			"function handle(info) return { format = 'width='..info.width } end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	char *format = vlua_make_status_line(vlua, "#vifmtest#handle", &lwin, 10);
	assert_string_equal("width=10", format);
	free(format);
}

TEST(good_tabline_formatter)
{
	GLUA_EQ(vlua, "",
			"function handle(info)"
			"  return { format = 'width='..info.width"
			"                  ..',other='..tostring(info.other) }"
			"end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	char *format =
		vlua_make_tab_line(vlua, "#vifmtest#handle", /*other=*/1, /*width=*/11);
	assert_string_equal("width=11,other=true", format);
	free(format);
}

TEST(handlers_run_in_safe_mode)
{
	GLUA_EQ(vlua, "",
			"function handle(info) vifm.opts.global.statusline = 'value' end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle'," " handler = handle })");

	char *format = vlua_make_status_line(vlua, "#vifmtest#handle", &lwin, 10);
	assert_string_ends_with(
			": Unsafe functions can't be called in this environment!", format);
	free(format);
}

TEST(bad_editor_handler)
{
	assert_failure(vlua_edit_one(vlua, "#vifmtest#handle", "path", -1, -1, 0));
}

TEST(error_editor_handler)
{
	GLUA_EQ(vlua, "", "function handle() asdf() end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	assert_failure(vlua_edit_one(vlua, "#vifmtest#handle", "path", -1, -1, 0));
	assert_string_ends_with(": attempt to call a nil value (global 'asdf')",
				ui_sb_last());
}

TEST(error_editor_handler_return)
{
	/* nil return. */

	GLUA_EQ(vlua, "", "function handle() end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	assert_failure(vlua_edit_one(vlua, "#vifmtest#handle", "path", -1, -1, 0));

	/* Bad table fields. */

	GLUA_EQ(vlua, "", "function handle() return {} end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle2', handler = handle })");

	assert_failure(vlua_edit_one(vlua, "#vifmtest#handle2", "path", -1, -1, 0));
}

TEST(good_editor_handler_return)
{
	GLUA_EQ(vlua, "", "function handle() return { success = true } end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler{ name = 'handle', handler = handle })");

	assert_success(vlua_edit_one(vlua, "#vifmtest#handle", "path", -1, -1, 0));
}

TEST(open_help_input)
{
	char vimdoc_dir[PATH_MAX + 1];
	snprintf(vimdoc_dir, sizeof(vimdoc_dir), "%s/vim-doc",
			get_installed_data_dir());

	GLUA_EQ(vlua, "",
			"function handle(info)"
			"  print(info.command, info.action, info.vimdocdir, info.topic)"
			"  return { success = true }"
			"end");

	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler { name = 'handle', handler = handle })");

	char expected[PATH_MAX + 1];
	snprintf(expected, sizeof(expected), "#vifmtest#handle\topen-help\t%s\ttopic",
			vimdoc_dir);

	assert_success(vlua_open_help(vlua, "#vifmtest#handle", "topic"));
	assert_string_equal(expected, ui_sb_last());
}

TEST(edit_one_input)
{
	GLUA_EQ(vlua, "",
			"function handle(info)"
			"  print(info.command, info.action, info.path, info.mustwait,"
			"        info.line, info.column)"
			"  return { success = true }"
			"end");
	GLUA_EQ(vlua, "true",
				"print(vifm.addhandler { name = 'handle', handler = handle })");

	assert_success(vlua_edit_one(vlua, "#vifmtest#handle", "path", 10, 1, 0));
	assert_string_equal("#vifmtest#handle\tedit-one\tpath\tfalse\t10\t1",
			ui_sb_last());
}

TEST(edit_many_input)
{
	GLUA_EQ(vlua, "",
			"function handle(info)"
			"  print(info.command, info.action, #info.paths, info.paths[1])"
			"  return { success = true }"
			"end");
	GLUA_EQ(vlua, "true",
				"print(vifm.addhandler { name = 'handle', handler = handle })");

	char path[] = "path";
	char *paths[] = { path };

	assert_success(vlua_edit_many(vlua, "#vifmtest#handle", paths, 1));
	assert_string_equal("#vifmtest#handle\tedit-many\t1\tpath", ui_sb_last());
}

TEST(edit_list_input)
{
	GLUA_EQ(vlua, "",
			"function handle(info)"
			"  print(info.command, info.action, #info.entries, info.entries[1],"
			"        info.entries[2], info.current, info.isquickfix)"
			"  return { success = true }"
			"end");
	GLUA_EQ(vlua, "true",
			"print(vifm.addhandler{ name = 'handle', handler = handle })");

	char entry0[] = "e0";
	char entry1[] = "e1";
	char *entries[] = { entry0, entry1 };

	assert_success(vlua_edit_list(vlua, "#vifmtest#handle", entries, 2,
				/*current=*/1, /*quickfix=*/1));
	assert_string_equal("#vifmtest#handle\tedit-list\t2\te0\te1\t2\ttrue",
			ui_sb_last());
}

/* vim: set tabstop=2 softtabstop=2 shiftwidth=2 noexpandtab cinoptions-=(0 : */
/* vim: set cinoptions+=t0 : */
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/vifm

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/vifm

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master