Commit 68b9605acc31d7cba3da322820b484c8db2e0a1e

Edward Thomson 2021-05-06T15:37:31

filter: deprecate git_filter_list_apply_to_data Deprecate `git_filter_list_apply_to_data` as it takes user input as a `git_buf`. Users should use `git_filter_list_apply_to_buffer` instead.

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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
diff --git a/include/git2/deprecated.h b/include/git2/deprecated.h
index a519509..ac60488 100644
--- a/include/git2/deprecated.h
+++ b/include/git2/deprecated.h
@@ -141,6 +141,16 @@ GIT_EXTERN(int) git_filter_list_stream_data(
 	git_buf *data,
 	git_writestream *target);
 
+/** Deprecated in favor of `git_filter_list_apply_to_buffer`.
+ *
+ * @deprecated Use git_filter_list_apply_to_buffer
+ * @see Use git_filter_list_apply_to_buffer
+ */
+GIT_EXTERN(int) git_filter_list_apply_to_data(
+	git_buf *out,
+	git_filter_list *filters,
+	git_buf *in);
+
 /**@}*/
 
 /** @name Deprecated Tree Functions
diff --git a/include/git2/filter.h b/include/git2/filter.h
index 3e84877..a0185ee 100644
--- a/include/git2/filter.h
+++ b/include/git2/filter.h
@@ -135,19 +135,6 @@ GIT_EXTERN(int) git_filter_list_apply_to_buffer(
 	size_t in_len);
 
 /**
- * Apply filter list to a data buffer.
- *
- * @param out Buffer to store the result of the filtering
- * @param filters A loaded git_filter_list (or NULL)
- * @param in Buffer containing the data to filter
- * @return 0 on success, an error code otherwise
- */
-GIT_EXTERN(int) git_filter_list_apply_to_data(
-	git_buf *out,
-	git_filter_list *filters,
-	git_buf *in);
-
-/**
  * Apply a filter list to the contents of a file on disk
  *
  * @param out buffer into which to store the filtered file
diff --git a/src/filter.c b/src/filter.c
index 2ba0f1e..200d705 100644
--- a/src/filter.c
+++ b/src/filter.c
@@ -742,17 +742,6 @@ int git_filter_list_apply_to_buffer(
 	return error;
 }
 
-int git_filter_list_apply_to_data(
-	git_buf *tgt, git_filter_list *filters, git_buf *src)
-{
-	int error;
-
-	if ((error = git_buf_sanitize(src)) < 0)
-	    return error;
-
-	return git_filter_list_apply_to_buffer(tgt, filters, src->ptr, src->size);
-}
-
 int git_filter_list_apply_to_file(
 	git_buf *out,
 	git_filter_list *filters,
@@ -1072,4 +1061,15 @@ int git_filter_list_stream_data(
 	return git_filter_list_stream_buffer(filters, data->ptr, data->size, target);
 }
 
+int git_filter_list_apply_to_data(
+	git_buf *tgt, git_filter_list *filters, git_buf *src)
+{
+	int error;
+
+	if ((error = git_buf_sanitize(src)) < 0)
+	    return error;
+
+	return git_filter_list_apply_to_buffer(tgt, filters, src->ptr, src->size);
+}
+
 #endif
diff --git a/tests/filter/crlf.c b/tests/filter/crlf.c
index a266005..bc9c7f2 100644
--- a/tests/filter/crlf.c
+++ b/tests/filter/crlf.c
@@ -23,7 +23,9 @@ void test_filter_crlf__to_worktree(void)
 {
 	git_filter_list *fl;
 	git_filter *crlf;
-	git_buf in = { 0 }, out = { 0 };
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_git_pass(git_filter_list_new(
 		&fl, g_repo, GIT_FILTER_TO_WORKTREE, 0));
@@ -33,10 +35,10 @@ void test_filter_crlf__to_worktree(void)
 
 	cl_git_pass(git_filter_list_push(fl, crlf, NULL));
 
-	in.ptr = "Some text\nRight here\n";
-	in.size = strlen(in.ptr);
+	in = "Some text\nRight here\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 
 	cl_assert_equal_s("Some text\r\nRight here\r\n", out.ptr);
 
@@ -48,7 +50,9 @@ void test_filter_crlf__to_odb(void)
 {
 	git_filter_list *fl;
 	git_filter *crlf;
-	git_buf in = { 0 }, out = { 0 };
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_git_pass(git_filter_list_new(
 		&fl, g_repo, GIT_FILTER_TO_ODB, 0));
@@ -58,10 +62,10 @@ void test_filter_crlf__to_odb(void)
 
 	cl_git_pass(git_filter_list_push(fl, crlf, NULL));
 
-	in.ptr = "Some text\r\nRight here\r\n";
-	in.size = strlen(in.ptr);
+	in = "Some text\r\nRight here\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 
 	cl_assert_equal_s("Some text\nRight here\n", out.ptr);
 
@@ -73,7 +77,9 @@ void test_filter_crlf__with_safecrlf(void)
 {
 	git_filter_list *fl;
 	git_filter *crlf;
-	git_buf in = {0}, out = GIT_BUF_INIT;
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_repo_set_bool(g_repo, "core.safecrlf", true);
 
@@ -86,31 +92,31 @@ void test_filter_crlf__with_safecrlf(void)
 	cl_git_pass(git_filter_list_push(fl, crlf, NULL));
 
 	/* Normalized \r\n succeeds with safecrlf */
-	in.ptr = "Normal\r\nCRLF\r\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\r\nCRLF\r\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_s("Normal\nCRLF\nline-endings.\n", out.ptr);
 
 	/* Mix of line endings fails with safecrlf */
-	in.ptr = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_fail(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_fail(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_i(git_error_last()->klass, GIT_ERROR_FILTER);
 
 	/* Normalized \n fails for autocrlf=true when safecrlf=true */
-	in.ptr = "Normal\nLF\nonly\nline-endings.\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\nLF\nonly\nline-endings.\n";
+	in_len = strlen(in);
 
-	cl_git_fail(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_fail(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_i(git_error_last()->klass, GIT_ERROR_FILTER);
 
 	/* String with \r but without \r\n does not fail with safecrlf */
-	in.ptr = "Normal\nCR only\rand some more\nline-endings.\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\nCR only\rand some more\nline-endings.\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_s("Normal\nCR only\rand some more\nline-endings.\n", out.ptr);
 
 	git_filter_list_free(fl);
@@ -121,7 +127,9 @@ void test_filter_crlf__with_safecrlf_and_unsafe_allowed(void)
 {
 	git_filter_list *fl;
 	git_filter *crlf;
-	git_buf in = {0}, out = GIT_BUF_INIT;
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_repo_set_bool(g_repo, "core.safecrlf", true);
 
@@ -134,25 +142,25 @@ void test_filter_crlf__with_safecrlf_and_unsafe_allowed(void)
 	cl_git_pass(git_filter_list_push(fl, crlf, NULL));
 
 	/* Normalized \r\n succeeds with safecrlf */
-	in.ptr = "Normal\r\nCRLF\r\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\r\nCRLF\r\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_s("Normal\nCRLF\nline-endings.\n", out.ptr);
 
 	/* Mix of line endings fails with safecrlf, but allowed to pass */
-	in.ptr = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	/* TODO: check for warning */
 	cl_assert_equal_s("Mixed\nup\nLF\nand\nCRLF\nline-endings.\n", out.ptr);
 
 	/* Normalized \n fails with safecrlf, but allowed to pass */
-	in.ptr = "Normal\nLF\nonly\nline-endings.\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\nLF\nonly\nline-endings.\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	/* TODO: check for warning */
 	cl_assert_equal_s("Normal\nLF\nonly\nline-endings.\n", out.ptr);
 
@@ -164,7 +172,9 @@ void test_filter_crlf__no_safecrlf(void)
 {
 	git_filter_list *fl;
 	git_filter *crlf;
-	git_buf in = {0}, out = GIT_BUF_INIT;
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_git_pass(git_filter_list_new(
 		&fl, g_repo, GIT_FILTER_TO_ODB, 0));
@@ -175,24 +185,24 @@ void test_filter_crlf__no_safecrlf(void)
 	cl_git_pass(git_filter_list_push(fl, crlf, NULL));
 
 	/* Normalized \r\n succeeds with safecrlf */
-	in.ptr = "Normal\r\nCRLF\r\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\r\nCRLF\r\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_s("Normal\nCRLF\nline-endings.\n", out.ptr);
 
 	/* Mix of line endings fails with safecrlf */
-	in.ptr = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_s("Mixed\nup\nLF\nand\nCRLF\nline-endings.\n", out.ptr);
 
 	/* Normalized \n fails with safecrlf */
-	in.ptr = "Normal\nLF\nonly\nline-endings.\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\nLF\nonly\nline-endings.\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_s("Normal\nLF\nonly\nline-endings.\n", out.ptr);
 
 	git_filter_list_free(fl);
@@ -203,7 +213,9 @@ void test_filter_crlf__safecrlf_warn(void)
 {
 	git_filter_list *fl;
 	git_filter *crlf;
-	git_buf in = {0}, out = GIT_BUF_INIT;
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_repo_set_string(g_repo, "core.safecrlf", "warn");
 
@@ -216,26 +228,26 @@ void test_filter_crlf__safecrlf_warn(void)
 	cl_git_pass(git_filter_list_push(fl, crlf, NULL));
 
 	/* Normalized \r\n succeeds with safecrlf=warn */
-	in.ptr = "Normal\r\nCRLF\r\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\r\nCRLF\r\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	cl_assert_equal_s("Normal\nCRLF\nline-endings.\n", out.ptr);
 
 	/* Mix of line endings succeeds with safecrlf=warn */
-	in.ptr = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
-	in.size = strlen(in.ptr);
+	in = "Mixed\nup\r\nLF\nand\r\nCRLF\nline-endings.\r\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 	/* TODO: check for warning */
 	cl_assert_equal_s("Mixed\nup\nLF\nand\nCRLF\nline-endings.\n", out.ptr);
 
 	/* Normalized \n is reversible, so does not fail with safecrlf=warn */
-	in.ptr = "Normal\nLF\nonly\nline-endings.\n";
-	in.size = strlen(in.ptr);
+	in = "Normal\nLF\nonly\nline-endings.\n";
+	in_len = strlen(in);
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
-	cl_assert_equal_s(in.ptr, out.ptr);
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
+	cl_assert_equal_s(in, out.ptr);
 
 	git_filter_list_free(fl);
 	git_buf_dispose(&out);
diff --git a/tests/filter/custom.c b/tests/filter/custom.c
index fe2025f..3554cb5 100644
--- a/tests/filter/custom.c
+++ b/tests/filter/custom.c
@@ -95,13 +95,17 @@ static void register_custom_filters(void)
 void test_filter_custom__to_odb(void)
 {
 	git_filter_list *fl;
-	git_buf out = { 0 };
-	git_buf in = GIT_BUF_INIT_CONST(workdir_data, strlen(workdir_data));
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_git_pass(git_filter_list_load(
 		&fl, g_repo, NULL, "herofile", GIT_FILTER_TO_ODB, 0));
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	in = workdir_data;
+	in_len = strlen(workdir_data);
+
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 
 	cl_assert_equal_i(BITFLIPPED_AND_REVERSED_DATA_LEN, out.size);
 
@@ -115,14 +119,17 @@ void test_filter_custom__to_odb(void)
 void test_filter_custom__to_workdir(void)
 {
 	git_filter_list *fl;
-	git_buf out = { 0 };
-	git_buf in = GIT_BUF_INIT_CONST(
-		bitflipped_and_reversed_data, BITFLIPPED_AND_REVERSED_DATA_LEN);
+	git_buf out = GIT_BUF_INIT;
+	const char *in;
+	size_t in_len;
 
 	cl_git_pass(git_filter_list_load(
 		&fl, g_repo, NULL, "herofile", GIT_FILTER_TO_WORKTREE, 0));
 
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	in = (char *)bitflipped_and_reversed_data;
+	in_len = BITFLIPPED_AND_REVERSED_DATA_LEN;
+
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, in, in_len));
 
 	cl_assert_equal_i(strlen(workdir_data), out.size);
 
@@ -246,12 +253,16 @@ void test_filter_custom__erroneous_filter_fails(void)
 {
 	git_filter_list *filters;
 	git_buf out = GIT_BUF_INIT;
-	git_buf in = GIT_BUF_INIT_CONST(workdir_data, strlen(workdir_data));
+	const char *in;
+	size_t in_len;
 
 	cl_git_pass(git_filter_list_load(
 		&filters, g_repo, NULL, "villain", GIT_FILTER_TO_WORKTREE, 0));
 
-	cl_git_fail(git_filter_list_apply_to_data(&out, filters, &in));
+	in = workdir_data;
+	in_len = strlen(workdir_data);
+
+	cl_git_fail(git_filter_list_apply_to_buffer(&out, filters, in, in_len));
 
 	git_filter_list_free(filters);
 	git_buf_dispose(&out);
diff --git a/tests/filter/wildcard.c b/tests/filter/wildcard.c
index 3c25ea2..62a84ea 100644
--- a/tests/filter/wildcard.c
+++ b/tests/filter/wildcard.c
@@ -123,13 +123,12 @@ static git_filter *create_wildcard_filter(void)
 void test_filter_wildcard__reverse(void)
 {
 	git_filter_list *fl;
-	git_buf in = GIT_BUF_INIT, out = GIT_BUF_INIT;
+	git_buf out = GIT_BUF_INIT;
 
 	cl_git_pass(git_filter_list_load(
 		&fl, g_repo, NULL, "hero-reverse-foo", GIT_FILTER_TO_ODB, 0));
 
-	cl_git_pass(git_buf_put(&in, (char *)input, DATA_LEN));
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, (char *)input, DATA_LEN));
 
 	cl_assert_equal_i(DATA_LEN, out.size);
 
@@ -138,19 +137,17 @@ void test_filter_wildcard__reverse(void)
 
 	git_filter_list_free(fl);
 	git_buf_dispose(&out);
-	git_buf_dispose(&in);
 }
 
 void test_filter_wildcard__flip(void)
 {
 	git_filter_list *fl;
-	git_buf in = GIT_BUF_INIT, out = GIT_BUF_INIT;
+	git_buf out = GIT_BUF_INIT;
 
 	cl_git_pass(git_filter_list_load(
 		&fl, g_repo, NULL, "hero-flip-foo", GIT_FILTER_TO_ODB, 0));
 
-	cl_git_pass(git_buf_put(&in, (char *)input, DATA_LEN));
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, (char *)input, DATA_LEN));
 
 	cl_assert_equal_i(DATA_LEN, out.size);
 
@@ -159,19 +156,17 @@ void test_filter_wildcard__flip(void)
 
 	git_filter_list_free(fl);
 	git_buf_dispose(&out);
-	git_buf_dispose(&in);
 }
 
 void test_filter_wildcard__none(void)
 {
 	git_filter_list *fl;
-	git_buf in = GIT_BUF_INIT, out = GIT_BUF_INIT;
+	git_buf out = GIT_BUF_INIT;
 
 	cl_git_pass(git_filter_list_load(
 		&fl, g_repo, NULL, "none-foo", GIT_FILTER_TO_ODB, 0));
 
-	cl_git_pass(git_buf_put(&in, (char *)input, DATA_LEN));
-	cl_git_pass(git_filter_list_apply_to_data(&out, fl, &in));
+	cl_git_pass(git_filter_list_apply_to_buffer(&out, fl, (char *)input, DATA_LEN));
 
 	cl_assert_equal_i(DATA_LEN, out.size);
 
@@ -180,5 +175,4 @@ void test_filter_wildcard__none(void)
 
 	git_filter_list_free(fl);
 	git_buf_dispose(&out);
-	git_buf_dispose(&in);
 }