summaryrefslogtreecommitdiff
path: root/test/bloom.c
blob: 0fd1b06cc31c5ce7a29e925fa136d8ff23ef6c96 (plain)
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
/*
 * Copyright 2015 Vincent Sanders <vince@netsurf-browser.org>
 * Copyright 2013 Rob Kendrick <rjek@netsurf-browser.org>
 *
 * This file is part of NetSurf, http://www.netsurf-browser.org/
 *
 * NetSurf is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * NetSurf is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * \file
 * Test bloom filter operations.
 *
 * Implementation taken from original test rig in bloom filter code
 */

#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <check.h>

#include "utils/bloom.h"

#define BLOOM_SIZE 8192
#define FALSE_POSITIVE_RATE 15 /* acceptable false positive percentage rate */

static struct bloom_filter *dict_bloom;

/* Fixtures */


/**
 * create dictionary bloom
 *
 * bloom constructed from the first BLOOM_SIZE entries of the
 * dictionary
 */
static void dict_bloom_create(void)
{
	FILE *dictf;
	char buf[BUFSIZ];
	int i;

	dictf = fopen("/usr/share/dict/words", "r");
	ck_assert(dictf != NULL);

	dict_bloom = bloom_create(BLOOM_SIZE);
	ck_assert(dict_bloom != NULL);

	for (i = 0; i < BLOOM_SIZE; i++) {
		fscanf(dictf, "%s", buf);
		bloom_insert_str(dict_bloom, buf, strlen(buf));
	}

	fclose(dictf);
}

static void dict_bloom_teardown(void)
{
	bloom_destroy(dict_bloom);
}

/* Tests */

/**
 * Test blooom filter creation
 *
 * Create a bloom filter, add a single entry and test for presece and
 * absence of that entry (single entry cannot have false positives).
 *
 */
START_TEST(bloom_create_test)
{
	struct bloom_filter *b;
	b = bloom_create(BLOOM_SIZE);
	ck_assert(b != NULL);

	bloom_insert_str(b, "NetSurf", 7);
	ck_assert(bloom_search_str(b, "NetSurf", 7));
	ck_assert(!bloom_search_str(b, "NotSurf", 7));

	ck_assert(bloom_items(b) == 1);

	bloom_destroy(b);
}
END_TEST

/**
 * insert empty string test
 */
START_TEST(bloom_insert_empty_str_test)
{
	struct bloom_filter *b;
	b = bloom_create(BLOOM_SIZE);
	ck_assert(b != NULL);

	bloom_insert_str(b, NULL, 7);

	ck_assert(bloom_items(b) == 1);

	bloom_destroy(b);
}
END_TEST


/**
 * Basic API creation test case
 */
static TCase *bloom_api_case_create(void)
{
	TCase *tc;

	tc = tcase_create("Creation");

	tcase_add_test(tc, bloom_create_test);
	tcase_add_test(tc, bloom_insert_empty_str_test);

	return tc;
}


START_TEST(bloom_match_test)
{
	FILE *dictf;
	char buf[BUFSIZ];
	int i;

	dictf = fopen("/usr/share/dict/words", "r");
	ck_assert(dictf != NULL);

	for (i = 0; i < BLOOM_SIZE; i++) {
		fscanf(dictf, "%s", buf);
		ck_assert(bloom_search_str(dict_bloom, buf, strlen(buf)));
	}
	fclose(dictf);
}
END_TEST


/**
 * Matching entry test case
 */
static TCase *bloom_match_case_create(void)
{
	TCase *tc;

	tc = tcase_create("Match");

	tcase_add_checked_fixture(tc,
				  dict_bloom_create,
				  dict_bloom_teardown);

	tcase_add_test(tc, bloom_match_test);

	return tc;
}


START_TEST(bloom_falsepositive_test)
{
	FILE *dictf;
	char buf[BUFSIZ];
	int i;
	int false_positives = 0;

	dictf = fopen("/usr/share/dict/words", "r");
	ck_assert(dictf != NULL);

	/* skip elements known presnent */
	for (i = 0; i < BLOOM_SIZE; i++) {
		fscanf(dictf, "%s", buf);
	}

	/* false positives are possible we are checking for low rate */
	for (i = 0; i < BLOOM_SIZE; i++) {
		fscanf(dictf, "%s", buf);
		if (bloom_search_str(dict_bloom, buf, strlen(buf)) == true)
			false_positives++;
	}
	fclose(dictf);

	printf("false positive rate %d%%/%d%%\n",
	       (false_positives * 100)/BLOOM_SIZE,
		FALSE_POSITIVE_RATE);
	ck_assert(false_positives < ((BLOOM_SIZE * FALSE_POSITIVE_RATE) / 100));
}
END_TEST


/**
 * Not matching test case
 */
static TCase *bloom_rate_case_create(void)
{
	TCase *tc;

	tc = tcase_create("False positive rate");

	tcase_add_checked_fixture(tc,
				  dict_bloom_create,
				  dict_bloom_teardown);

	tcase_add_test(tc, bloom_falsepositive_test);

	return tc;
}


static Suite *bloom_suite(void)
{
	Suite *s;
	s = suite_create("Bloom filter");

	suite_add_tcase(s, bloom_api_case_create());
	suite_add_tcase(s, bloom_match_case_create());
	suite_add_tcase(s, bloom_rate_case_create());

	return s;
}

int main(int argc, char **argv)
{
	int number_failed;
	Suite *s;
	SRunner *sr;

	s = bloom_suite();

	sr = srunner_create(s);
	srunner_run_all(sr, CK_ENV);

	number_failed = srunner_ntests_failed(sr);
	srunner_free(sr);

	return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
}