File: main.c

package info (click to toggle)
libpg-query 17-6.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,416 kB
  • sloc: ansic: 175,684; sql: 79,564; ruby: 1,605; makefile: 276; cpp: 221
file content (260 lines) | stat: -rw-r--r-- 6,276 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
#include <pg_query.h>
#include "src/pg_query_internal.h"
#include "test/framework/main.h"
#include <string.h>

/*
 * ARBITRARY_LENGTH_LIMIT is purely arbitrary to avoid unbounded strcmp() usage.
 * Using strcmp() means bugs an cause infinite loops, which is hard to debug.
 * If it causes a problem, make the number bigger.
 * -@duckinator
 */
const size_t ARBITRARY_LENGTH_LIMIT = 500;

int
TEST_INIT_impl(TestState * test_state, const char *func, size_t line)
{
    if ((test_state->wanted_test != NULL) && (strcmp(test_state->wanted_test, func) != 0))
        return 1;

    printf("%s (line %li)\n", func, line);
    return 0;
}

int
TEST_BOUNDED_STRCMP(char *s1, char *s2)
{
	/*
	 * strncmp() can not handle being given NULL. so, if either are NULL, we
	 * test whether they're *both* NULL.
	 */
	if (s1 == NULL || s2 == NULL)
		return (s1 == s2) ? 0 : -1;

	return strncmp(s1, s2, ARBITRARY_LENGTH_LIMIT);
}

/*
 * Assert that `actual` is NULL.
 */
void
TEST_ASSERT_NULL_impl(TestState * test_state, char *actual_str, void *actual)
{
	if (actual == NULL)
		TEST_PASS();
	else
		TEST_FAIL("  FAIL: expected %s to be NULL\n", actual_str);
}

/*
 * Assert that `actual` is a string containing the same text as `expected`.
 * (This is wrapped by the TEST_ASSERT_STR_EQUAL macro.)
 */
void
TEST_ASSERT_STR_EQUAL_impl(TestState * test_state, char *actual_str, char *actual, char *expected)
{
	if (TEST_BOUNDED_STRCMP(actual, expected) == 0)
		test_state->passed++;
	else
	{
		printf("  FAIL: Expected `actual` (%s) and `expected` to be equivalent.\n", actual_str);
		printf("      actual: %s\n", actual);
		printf("    expected: %s\n\n", expected);
		test_state->failed++;
	}
}

/*
 * Assert that `lst` contains `expected_len` items.
 * (This is wrapped by the TEST_ASSERT_LIST_LENGTH macro.)
 */
void
TEST_ASSERT_LIST_LENGTH_impl(TestState * test_state, char *lst_str, List *lst, size_t expected_len)
{
	size_t		actual_len = list_length(lst);

	if (actual_len == expected_len)
	{
		test_state->passed++;
	}
	else
	{
		printf("  FAIL: expected %s to have length %li\n", lst_str, expected_len);
		printf("        actual length is %li\n\n", actual_len);
		test_state->failed++;
	}
}

/*
 * Given an array of char*, and the length of the array, return a string representation.
 * Please remember to free the returned pointer when you're done.
 */
static char *
str_list_to_buf(char **list, size_t list_len)
{
	size_t		len = 3;

	/* leading and trailing brackets, and null terminator */
	len += 2 * list_len;
	/* quotes around each item */
	len += 2 * (list_len - 1);
	/* commas and spaces between items */

	for (int i = 0; i < list_len; i++)
		len += strlen(list[i]);

	char	   *buf = malloc(sizeof(char) * len);
	size_t		offset = snprintf(buf, len, "[");

	for (int i = 0; i < list_len; i++)
	{
		offset += snprintf(buf + offset, len - offset, "\"%s\"", list[i]);
		if (i < (list_len - 1))
			offset += snprintf(buf + offset, len - offset, ", ");
	}
	offset += snprintf(buf + offset, len - offset, "]");
	return buf;
}

/*
 * Assert that `actual` and `expected` should contain the same items, but may be in a different order.
 * (This is wrapped by the TEST_ASSERT_LIST_EQUAL macro.)
 */
void
TEST_ASSERT_LIST_EQUAL_impl(TestState * test_state, char *actual_str, List *actual, List *expected)
{
	size_t		actual_len = list_length(actual);
	size_t		expected_len = list_length(expected);

	char	  **act_ary = malloc(sizeof(char *) * actual_len);
	char	  **exp_ary = malloc(sizeof(char *) * expected_len);

	ListCell   *lc = NULL;

	foreach(lc, actual)
	{
		size_t		i = foreach_current_index(lc);

		act_ary[i] = lfirst(lc);
	}
	foreach(lc, expected)
	{
		size_t		i = foreach_current_index(lc);

		exp_ary[i] = lfirst(lc);
	}

	qsort(act_ary, actual_len, sizeof(char *), pg_qsort_strcmp);
	qsort(exp_ary, expected_len, sizeof(char *), pg_qsort_strcmp);

	int			failed = 0;

	if (actual_len != expected_len)
	{
		failed = 1;
	}

	if (failed == 0)
	{
		for (size_t i = 0; i < actual_len; i++)
		{
			if (strcmp(act_ary[i], exp_ary[i]) != 0)
			{
				failed = 1;
				break;
			}
		}
	}

	if (failed)
	{
		test_state->failed++;
		printf("  FAIL: Expected `actual` and `expected` to be equivalent.\n");

		char	   *act_str = str_list_to_buf(act_ary, actual_len);

		printf("      actual: %s\n", act_str);
		free(act_str);

		char	   *exp_str = str_list_to_buf(exp_ary, expected_len);

		printf("    expected: %s\n\n", exp_str);
		free(exp_str);
	}
	else
		test_state->passed++;

	free(act_ary);
	free(exp_ary);
}

// Given a list of tests, cleanup function, and use_mctx,
// run tests and return the results.
//
// If `use_mctx` is true, a Postgres MemoryContext is entered before the test is run,
// and exited after the cleanup function is called.
//
// This function exists so test_run() and test_run_with_mctx() can share an
// implementation.
static
int
test_run_impl(int argc, char *argv[], TestFn * tests[], TestCleanupFn * test_cleanup, bool use_mctx)
{
	TestState	test_state = {0};

	bool fail_fast = false;

	for (size_t i = 1; i < argc; i++)
	{
		// This loop only runs if an argument was passed.
		// That argument will be -ff or a test name, and in both
		// cases we want to fail fast.
		fail_fast = true;

		// If the argument isn't -ff, we assume it's a test name.
		if (strncmp(argv[i], "-ff", 4) != 0) {
			test_state.wanted_test = argv[i];
			break;
		}
	}


	pg_query_init();

	for (size_t i = 0; tests[i] != NULL; i++)
	{
		MemoryContext ctx;
		if (use_mctx)
			ctx = pg_query_enter_memory_context();

		tests[i] (&test_state);
		if (test_cleanup != NULL)
			test_cleanup();

		if (use_mctx)
			pg_query_exit_memory_context(ctx);

		if (fail_fast && test_state.failed > 0)
			break;
	}

	bool		failed = (test_state.failed > 0);

	printf("\ntest result: %s. %li passed; %li failed; %li skipped\n", failed ? "FAILED" : "ok", test_state.passed, test_state.failed, test_state.skipped);

	pg_query_exit();

	return failed ? EXIT_FAILURE : EXIT_SUCCESS;
}

int
test_run(int argc, char *argv[], TestFn * tests[], TestCleanupFn * test_cleanup)
{
	return test_run_impl(argc, argv, tests, test_cleanup, false);
}

int
test_run_with_mcxt(int argc, char *argv[], TestFn * tests[], TestCleanupFn * test_cleanup)
{
	return test_run_impl(argc, argv, tests, test_cleanup, true);
}