devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 9 Actions Packages Projects 1 Releases Wiki Activity

tests: Reenable functional tests

Browse Source 
They were disabled in 171b6e73c9.

Enable the functional test suite and replaces the
dependency on libexpect with a custom solution.

The native solution allows for specific optimizations like automatic
ANSI code stripping, which is essential for reliable pattern matching in
an ncurses interface.

Custom PTY management via libutil provides full control over the process
lifecycle, resolving issues where tests would hang indefinitely.
We use forkpty from libutil.

Addiiotnally this commit implements automatic ANSI escape sequence
filtering to improve matching consistency.
This will get rid of the colors in matches. It's still something that we
need to think about more since basically we will not test out
color/theme system this way.

We also add non-blocking poll() and SIGKILL based teardown logic to
ensure clean test termination.

We added the functional tests to both autotools and meson.
They are only build when tests are enabled and stabber + libutil are
present.
Meson will print this out nicely in the summary.

Regards https://github.com/profanity-im/profanity/issues/789
This commit is contained in:
Michael Vetter
2026-03-04 22:32:38 +01:00
parent 11bc6ea22b
commit 9cb11bdec2
17 changed files with 345 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

266
tests/functionaltests/proftest.c
View File

@@ -8,17 +8,115 @@
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <pty.h>
#include <utmp.h>
#include <poll.h>
#include <stdarg.h>
#include <termios.h>
#include <stabber.h>
#include <expect.h>
#include "proftest.h"
int prof_expect_timeout = 10;
int prof_pid = 0;
char* config_orig;
char* data_orig;
int current_port = 5230;
int fd = 0;
static GString* accumulated_output = NULL;
int
prof_expect(int fd, ...)
{
va_list args;
va_start(args, fd);
enum prof_expect_type type = va_arg(args, enum prof_expect_type);
if (type == prof_expect_end) {
va_end(args);
return 0;
}
char* pattern = va_arg(args, char*);
int result_val = va_arg(args, int);
va_end(args);
if (accumulated_output == NULL) {
accumulated_output = g_string_new("");
}
usleep(1000 * 100); // Wait 100ms for buffer to settle
struct pollfd pfd;
pfd.fd = fd;
pfd.events = POLLIN;
GRegex *ansi = g_regex_new("\\x1b\\[[0-9;]*[a-zA-Z]|\\x1b\\([a-zA-Z]", 0, 0, NULL);
GTimer* timer = g_timer_new();
while (g_timer_elapsed(timer, NULL) < prof_expect_timeout) {
// Check if pattern is already in accumulated output
gchar* clean_output = g_regex_replace(ansi, accumulated_output->str, -1, 0, "", 0, NULL);
if (type == prof_expect_exact) {
gchar* escaped = g_regex_escape_string(pattern, -1);
GRegex *regex = g_regex_new(escaped, G_REGEX_DOTALL | G_REGEX_OPTIMIZE, 0, NULL);
g_free(escaped);
GMatchInfo *match_info;
if (g_regex_match(regex, clean_output, 0, &match_info)) {
g_string_truncate(accumulated_output, 0);
g_match_info_free(match_info);
g_regex_unref(regex);
g_free(clean_output);
g_timer_destroy(timer);
g_regex_unref(ansi);
return result_val;
}
g_match_info_free(match_info);
g_regex_unref(regex);
} else if (type == prof_expect_regexp) {
GMatchInfo *match_info;
GRegex *regex = g_regex_new(pattern, G_REGEX_DOTALL | G_REGEX_OPTIMIZE, 0, NULL);
if (g_regex_match(regex, clean_output, 0, &match_info)) {
g_string_truncate(accumulated_output, 0);
g_match_info_free(match_info);
g_regex_unref(regex);
g_free(clean_output);
g_timer_destroy(timer);
g_regex_unref(ansi);
return result_val;
}
g_match_info_free(match_info);
g_regex_unref(regex);
}
g_free(clean_output);
int ret = poll(&pfd, 1, 10); // 10ms timeout for poll
if (ret > 0 && (pfd.revents & POLLIN)) {
char buf[1024];
ssize_t n = read(fd, buf, sizeof(buf) - 1);
if (n > 0) {
buf[n] = '\0';
g_string_append(accumulated_output, buf);
} else if (n == 0) {
break; // EOF
}
} else {
usleep(1000 * 5); // 5ms sleep if no data
}
}
g_timer_destroy(timer);
g_regex_unref(ansi);
return 0; // Timeout or EOF without match
}
gboolean
_create_dir(const char* name)
{
@@ -112,22 +210,29 @@ _create_logs_dir(void)
void
_cleanup_dirs(void)
{
int res = system("rm -rf ./tests/functionaltests/files");
if (res == -1) {
assert_true(FALSE);
}
system("rm -rf ./tests/functionaltests/files");
}
void
prof_start(void)
{
if (accumulated_output) {
g_string_free(accumulated_output, TRUE);
accumulated_output = NULL;
}
// helper script sets terminal columns, avoids assertions failing
// based on the test runner terminal size
fd = exp_spawnl("sh",
"sh",
"-c",
"./tests/functionaltests/start_profanity.sh",
NULL);
int master;
pid_t pid = forkpty(&master, NULL, NULL, NULL);
if (pid == 0) {
system("stty sane -echo");
execlp("sh", "sh", "-c", "./tests/functionaltests/start_profanity.sh", (char *)0);
_exit(1);
}
prof_pid = pid;
fd = master;
FILE* fp = fdopen(fd, "r+");
assert_true(fp != NULL);
@@ -138,17 +243,32 @@ prof_start(void)
int
init_prof_test(void** state)
{
if (stbbr_start(STBBR_LOGDEBUG, 5230, 0) != 0) {
assert_true(FALSE);
return -1;
}
config_orig = getenv("XDG_CONFIG_HOME");
data_orig = getenv("XDG_DATA_HOME");
const char *cfg = getenv("XDG_CONFIG_HOME");
const char *dat = getenv("XDG_DATA_HOME");
config_orig = cfg ? g_strdup(cfg) : NULL;
data_orig = dat ? g_strdup(dat) : NULL;
setenv("XDG_CONFIG_HOME", XDG_CONFIG_HOME, 1);
setenv("XDG_DATA_HOME", XDG_DATA_HOME, 1);
usleep(1000 * 2000); // 2s delay between tests to let OS recover
int res = -1;
int port = 0;
for (int i = 0; i < 5; i++) {
port = current_port + (i * 10);
res = stbbr_start(STBBR_LOGDEBUG, &port, 0);
if (res == 0 && port > 0) {
break;
}
}
if (res != 0 || port == 0) {
assert_true(FALSE);
return -1;
}
current_port = port;
_cleanup_dirs();
_create_config_dir();
@@ -157,36 +277,39 @@ init_prof_test(void** state)
_create_logs_dir();
prof_start();
assert_true(prof_output_exact("Profanity"));
usleep(1000 * 500); // Wait for profanity to start
assert_true(prof_output_regex("Profanity"));
prof_expect_timeout = 30;
// set UI options to make expect assertions faster and more reliable
prof_input("/inpblock timeout 5");
assert_true(prof_output_exact("Input blocking set to 5 milliseconds"));
prof_output_regex("Input blocking set to 5 milliseconds");
prof_input("/inpblock dynamic off");
assert_true(prof_output_exact("Dynamic input blocking disabled"));
prof_output_regex("Dynamic input blocking disabled");
prof_input("/notify chat off");
assert_true(prof_output_exact("Chat notifications disabled"));
prof_output_regex("Chat notifications disabled");
prof_input("/notify room off");
assert_true(prof_output_exact("Room notifications disabled"));
prof_output_regex("Room notifications disabled");
prof_input("/wrap off");
assert_true(prof_output_exact("Word wrap disabled"));
prof_output_regex("Word wrap disabled");
prof_input("/roster hide");
assert_true(prof_output_exact("Roster disabled"));
prof_output_regex("Roster disabled");
prof_input("/occupants default hide");
assert_true(prof_output_exact("Occupant list disabled"));
prof_output_regex("Occupant list disabled");
prof_input("/time console off");
prof_input("/time console off");
assert_true(prof_output_exact("Console time display disabled."));
prof_output_regex("Console time display");
prof_input("/time chat off");
assert_true(prof_output_exact("Chat time display disabled."));
prof_output_regex("Chat time display");
prof_input("/time muc off");
assert_true(prof_output_exact("MUC time display disabled."));
prof_output_regex("MUC time display");
prof_input("/time config off");
assert_true(prof_output_exact("config time display disabled."));
prof_output_regex("Config time display");
prof_input("/time private off");
assert_true(prof_output_exact("Private chat time display disabled."));
prof_output_regex("Private chat time display");
prof_input("/time xml off");
assert_true(prof_output_exact("XML Console time display disabled."));
prof_output_regex("XML Console time display");
prof_expect_timeout = 10;
return 0;
}
@@ -194,13 +317,44 @@ int
close_prof_test(void** state)
{
prof_input("/quit");
waitpid(exp_pid, NULL, 0);
// Give it some time to quit gracefully
int retries = 0;
int status;
while (retries < 50) { // 5 seconds
pid_t res = waitpid(prof_pid, &status, WNOHANG);
if (res == prof_pid) {
break;
}
usleep(1000 * 100);
retries++;
}
if (retries == 50) {
kill(prof_pid, SIGKILL);
waitpid(prof_pid, &status, 0);
}
_cleanup_dirs();
setenv("XDG_CONFIG_HOME", config_orig, 1);
setenv("XDG_DATA_HOME", data_orig, 1);
if (config_orig) {
setenv("XDG_CONFIG_HOME", config_orig, 1);
g_free(config_orig);
config_orig = NULL;
} else {
unsetenv("XDG_CONFIG_HOME");
}
if (data_orig) {
setenv("XDG_DATA_HOME", data_orig, 1);
g_free(data_orig);
data_orig = NULL;
} else {
unsetenv("XDG_DATA_HOME");
}
stbbr_stop();
usleep(1000 * 500); // 500ms delay after stop
return 0;
}
@@ -208,21 +362,32 @@ void
prof_input(const char* input)
{
GString* inp_str = g_string_new(input);
g_string_append(inp_str, "\r");
g_string_append(inp_str, "\n");
write(fd, inp_str->str, inp_str->len);
tcdrain(fd);
g_string_free(inp_str, TRUE);
usleep(1000 * 100); // 100ms delay
}
int
prof_output_exact(const char* text)
{
return (1 == exp_expectl(fd, exp_exact, text, 1, exp_end));
// Use regex to skip potential timestamps [HH:MM:SS] or character noise
gchar* pattern = g_strdup_printf(".*%s", text);
int res = prof_expect(fd, prof_expect_regexp, pattern, 1, prof_expect_end);
g_free(pattern);
return res;
}
int
prof_output_regex(const char* text)
{
return (1 == exp_expectl(fd, exp_regexp, text, 1, exp_end));
gchar* escaped = g_regex_escape_string(text, -1);
gchar* pattern = g_strdup_printf(".*%s", escaped);
int res = prof_expect(fd, prof_expect_regexp, pattern, 1, prof_expect_end);
g_free(pattern);
g_free(escaped);
return res;
}
void
@@ -239,32 +404,39 @@ prof_connect_with_roster(const char* roster)
stbbr_for_query("jabber:iq:roster", roster_str->str);
g_string_free(roster_str, TRUE);
stbbr_for_id("prof_presence_1",
"<presence id='prof_presence_1' lang='en' to='stabber@localhost/profanity' from='stabber@localhost/profanity'>"
stbbr_for_id("presence:*",
"<presence id='prof_presence_*' lang='en' to='stabber@localhost/profanity' from='stabber@localhost/profanity'>"
"<priority>0</priority>"
"<c hash='sha-1' xmlns='http://jabber.org/protocol/caps' node='http://profanity-im.github.io/' ver='f8mrtdyAmhnj8Ca+630bThSL718='/>"
"</presence>");
prof_input("/connect stabber@localhost server 127.0.0.1 port 5230 tls allow");
int port = current_port;
gchar* connect_cmd = g_strdup_printf("/connect stabber@localhost/profanity server 127.0.0.1 port %d tls disable auth legacy", port);
prof_input(connect_cmd);
g_free(connect_cmd);
assert_true(prof_output_regex("Enter password:"));
usleep(1000 * 200); // 200ms delay
prof_input("password");
usleep(1000 * 200); // 200ms delay
// Allow time for profanity to connect
exp_timeout = 30;
assert_true(prof_output_regex("stabber@localhost/profanity logged in successfully, .+online.+ \\(priority 0\\)\\."));
exp_timeout = 10;
stbbr_wait_for("prof_presence_*");
prof_expect_timeout = 30;
assert_true(prof_output_regex("successfully"));
prof_expect_timeout = 10;
stbbr_wait_for("presence:*");
}
void
prof_timeout(int timeout)
{
exp_timeout = timeout;
prof_expect_timeout = timeout;
}
void
prof_timeout_reset(void)
{
exp_timeout = 10;
prof_expect_timeout = 10;
}
void