Add tests/t1000-add-xpath-node.c

This unit-test shows that duplicate entries are incorrectly added when
xpath expressions with different capitalisation are passed to
xml_add_node()

Author: johanmalm

meson.build

@@ -17,4 +17,5 @@ executable(
   install : true,
 )
 
+subdir('tests')
 subdir('data')

tests/meson.build

@@ -0,0 +1,23 @@
+test_lib = static_library(
+  'tests',
+  sources: files(
+    '../xml.c',
+  ),
+  dependencies: [dependency('libxml-2.0'), dependency('glib-2.0')],
+)
+
+tests = [
+  't1000-add-xpath-node.c',
+]
+
+foreach t : tests
+  testname = t.split('.')[0].underscorify()
+  exe = executable(
+    testname,
+    sources: [t, 'tap.c'],
+    dependencies: [dependency('glib-2.0')],
+    link_with: [test_lib],
+  )
+  test(testname, exe)
+endforeach
+

tests/t1000-add-xpath-node.c

@@ -0,0 +1,123 @@
+#define _POSIX_C_SOURCE 200809L
+#include <glib.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <unistd.h>
+#include "tap.h"
+#include "../xml.h"
+
+static char template[] =
+	"<?xml version=\"1.0\"?>\n"
+	"<labwc_config>\n"
+	"  <core>\n"
+	"    <gap/>\n"
+	"  </core>\n"
+	"</labwc_config>\n";
+
+void show_diff(const char *filename, const char *buf, size_t size)
+{
+	char cmd[1000];
+	snprintf(cmd, sizeof(cmd), "diff -u - %s >&2", filename);
+	FILE *f = popen(cmd, "w");
+	fwrite(buf, size, 1, f);
+	pclose(f);
+}
+
+void test(const char *filename, const char *expect)
+{
+	gsize length; gchar *actual;
+	g_file_get_contents(filename, &actual, &length, NULL);
+	bool is_equal = strcmp(actual, expect) == 0;
+	ok1(is_equal);
+	if (!is_equal)
+		show_diff(filename, expect, strlen(expect));
+	g_free(actual);
+}
+
+int main(int argc, char **argv)
+{
+	char in[] = "/tmp/t1000-expect_XXXXXX";
+	char out[] = "/tmp/t1000-actual";
+
+	plan(4);
+
+	int fd = mkstemp(in);
+	if (fd < 0)
+		exit(EXIT_FAILURE);
+	write(fd, template, sizeof(template) - 1);
+
+	/* test 1 */
+	diag("add node <theme><cornerradius> using xpath (lowercase)");
+	xml_init(in);
+	xml_add_node("/labwc_config/theme/cornerradius");
+	xml_save_as(out);
+	xml_finish();
+	test(out,
+		"<?xml version=\"1.0\"?>\n"
+		"<labwc_config>\n"
+		"  <core>\n"
+		"    <gap/>\n"
+		"  </core>\n"
+		"  <theme>\n"
+		"    <cornerradius/>\n"
+		"  </theme>\n"
+		"</labwc_config>\n");
+
+	/* test 2 */
+	diag("add node <theme><cornerRadius> using xpath (camelCase)");
+	xml_init(in);
+	xml_add_node("/labwc_config/theme/cornerRadius");
+	xml_save_as(out);
+	xml_finish();
+	test(out,
+		"<?xml version=\"1.0\"?>\n"
+		"<labwc_config>\n"
+		"  <core>\n"
+		"    <gap/>\n"
+		"  </core>\n"
+		"  <theme>\n"
+		"    <cornerRadius/>\n"
+		"  </theme>\n"
+		"</labwc_config>\n");
+
+	/* test 3 */
+	diag("check xpath does not add duplicate entries - when identical");
+	xml_init(in);
+	xml_add_node("/labwc_config/theme/cornerradius");
+	xml_add_node("/labwc_config/theme/cornerradius");
+	xml_save_as(out);
+	xml_finish();
+	test(out,
+		"<?xml version=\"1.0\"?>\n"
+		"<labwc_config>\n"
+		"  <core>\n"
+		"    <gap/>\n"
+		"  </core>\n"
+		"  <theme>\n"
+		"    <cornerradius/>\n"
+		"  </theme>\n"
+		"</labwc_config>\n");
+
+	/* test 4 */
+	diag("check xpath does not add duplicate entries - even if they have differing capitalisation");
+	xml_init(in);
+	xml_add_node("/labwc_config/theme/cornerradius");
+	xml_add_node("/labwc_config/theme/Cornerradius");
+	xml_save_as(out);
+	xml_finish();
+	test(out,
+		"<?xml version=\"1.0\"?>\n"
+		"<labwc_config>\n"
+		"  <core>\n"
+		"    <gap/>\n"
+		"  </core>\n"
+		"  <theme>\n"
+		"    <cornerradius/>\n"
+		"  </theme>\n"
+		"</labwc_config>\n");
+
+	unlink(in);
+	unlink(out);
+	return exit_status();
+}
+

tests/tap.c

@@ -0,0 +1,73 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdarg.h>
+#include <ctype.h>
+#include <unistd.h>
+#include <stdbool.h>
+
+#include "tap.h"
+
+static int nr_tests_run;
+static int nr_tests_expected;
+static int nr_tests_failed;
+
+void plan(int nr_tests)
+{
+	static bool run_once;
+
+	if (run_once)
+		return;
+	run_once = true;
+	printf("1..%d\n", nr_tests);
+	nr_tests_expected = nr_tests;
+}
+
+void diag(const char *fmt, ...)
+{
+	va_list params;
+
+	fprintf(stdout, "# ");
+	va_start(params, fmt);
+	vfprintf(stdout, fmt, params);
+	va_end(params);
+	fprintf(stdout, "\n");
+}
+
+int ok(int result, const char *testname, ...)
+{
+	va_list params;
+
+	++nr_tests_run;
+	if (!result) {
+		printf("not ");
+		nr_tests_failed++;
+	}
+	printf("ok %d", nr_tests_run);
+	if (testname) {
+		printf(" - ");
+		va_start(params, testname);
+		vfprintf(stdout, testname, params);
+		va_end(params);
+	}
+	printf("\n");
+	if (!result)
+		diag("    Failed test");
+	return result ? 1 : 0;
+}
+
+int exit_status(void)
+{
+	int ret;
+
+	if (nr_tests_expected != nr_tests_run) {
+		diag("expected=%d; run=%d; failed=%d", nr_tests_expected,
+		     nr_tests_run, nr_tests_failed);
+	}
+	if (nr_tests_expected < nr_tests_run)
+		ret = nr_tests_run - nr_tests_expected;
+	else
+		ret = nr_tests_failed + nr_tests_expected - nr_tests_run;
+	if (ret > 255)
+		ret = 255;
+	return ret;
+}

tests/tap.h

@@ -0,0 +1,17 @@
+/*
+ * Minimalist, partial TAP implementation
+ *
+ * Copyright Johan Malm 2020
+ */
+
+#ifndef TAP_H
+#define TAP_H
+
+#define ok1(__x__) (ok(__x__, "%s", #__x__))
+
+void plan(int nr_tests);
+void diag(const char *fmt, ...);
+int ok(int result, const char *test_name, ...);
+int exit_status(void);
+
+#endif /* TAP_H */

xml.c

@@ -162,6 +162,12 @@ xml_save(void)
 	xmlSaveFormatFile(ctx.filename, ctx.doc, 1);
 }
 
+void
+xml_save_as(const char *filename)
+{
+	xmlSaveFormatFile(filename, ctx.doc, 1);
+}
+
 void
 xml_finish(void)
 {

xml.h

@@ -3,6 +3,7 @@
 
 void xml_init(const char *filename);
 void xml_save(void);
+void xml_save_as(const char *filename);
 void xml_finish(void);
 void xml_set(char *nodename, char *value);
 void xml_set_num(char *nodename, double value);