cocci: add a "coccicheck-test" target and test *.cocci rules

Add a "coccicheck-test" target to test our *.cocci rules, and as a demonstration add tests for the rules added in 39ea59a2570 (remove unnecessary NULL check before free(3), 2016-10-08) and 1b83d1251ed (coccinelle: add a rule to make "expression" code use FREE_AND_NULL(), 2017-06-15). I considered making use of the "spatch --test" option, and the choice of a "tests" over a "t" directory is to make these tests compatible with such a future change. Unfortunately "spatch --test" doesn't return meaningful exit codes, AFAICT you need to "grep" its output to see if the *.res is what you expect. There's "--test-okfailed", but I didn't find a way to sensibly integrate those (it relies on some in-between status files, but doesn't help with the status codes). Instead let's use a "--sp-file" pattern similar to the main "coccicheck" rule, with the difference that we use and compare the two *.res files with cmp(1). The --very-quiet and --no-show-diff options ensure that we don't need to pipe stdout and stderr somewhere. Unlike the "%.cocci.patch" rule we're not using the diff. The "cmp || git diff" is optimistically giving us better output on failure, but even if we only have POSIX cmp and no system git installed we'll still fail with the "cmp", just with an error message that isn't as friendly. The "2>/dev/null" is in case we don't have a "git" installed. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Jul 5, 2022 at 15:46 UTC f7ff6597a7534da51c2962691e177c624cb567c1
4 files changed +40
Makefile
+19
@@ -3123,6 +3123,8 @@ check: $(GENERATED_H)
3123 exit 1; \
3124 fi
3125
3126 +COCCI_TEST_RES = $(wildcard contrib/coccinelle/tests/*.res)
3127 +
3128 %.cocci.patch: %.cocci $(COCCI_SOURCES)
3129 $(QUIET_SPATCH) \
3130 if test $(SPATCH_BATCH_SIZE) = 0; then \
@@ -3143,6 +3145,22 @@ check: $(GENERATED_H)
3145 then \
3146 echo ' ' SPATCH result: $@; \
3147 fi
3148 +
3149 +COCCI_TEST_RES_GEN = $(addprefix .build/,$(COCCI_TEST_RES))
3150 +$(COCCI_TEST_RES_GEN): .build/%.res : %.c
3151 +$(COCCI_TEST_RES_GEN): .build/%.res : %.res
3152 +$(COCCI_TEST_RES_GEN): .build/contrib/coccinelle/tests/%.res : contrib/coccinelle/%.cocci
3153 + $(call mkdir_p_parent_template)
3154 + $(QUIET_SPATCH_T)$(SPATCH) $(SPATCH_FLAGS) \
3155 + --very-quiet --no-show-diff \
3156 + --sp-file $< -o $@ \
3157 + $(@:.build/%.res=%.c) && \
3158 + cmp $(@:.build/%=%) $@ || \
3159 + git -P diff --no-index $(@:.build/%=%) $@ 2>/dev/null; \
3160 +
3161 +.PHONY: coccicheck-test
3162 +coccicheck-test: $(COCCI_TEST_RES_GEN)
3163 +
3164 coccicheck: $(addsuffix .patch,$(filter-out %.pending.cocci,$(wildcard contrib/coccinelle/*.cocci)))
3165
3166 # See contrib/coccinelle/README
@@ -3404,6 +3422,7 @@ profile-clean:
3422 $(RM) $(addsuffix *.gcno,$(addprefix $(PROFILE_DIR)/, $(object_dirs)))
3423
3424 cocciclean:
3425 + $(RM) -r .build/contrib/coccinelle
3426 $(RM) contrib/coccinelle/*.cocci.patch*
3427
3428 clean: profile-clean coverage-clean cocciclean
contrib/coccinelle/tests/free.c new
+11
@@ -0,0 +1,11 @@
1 +int use_FREE_AND_NULL(int *v)
2 +{
3 + free(*v);
4 + *v = NULL;
5 +}
6 +
7 +int need_no_if(int *v)
8 +{
9 + if (v)
10 + free(v);
11 +}
contrib/coccinelle/tests/free.res new
+9
@@ -0,0 +1,9 @@
1 +int use_FREE_AND_NULL(int *v)
2 +{
3 + FREE_AND_NULL(*v);
4 +}
5 +
6 +int need_no_if(int *v)
7 +{
8 + free(v);
9 +}
shared.mak
+1
@@ -70,6 +70,7 @@ ifndef V
70 QUIET_HDR = @echo ' ' HDR $(<:hcc=h);
71 QUIET_RC = @echo ' ' RC $@;
72 QUIET_SPATCH = @echo ' ' SPATCH $<;
73 + QUIET_SPATCH_T = @echo ' ' SPATCH TEST $(@:.build/%=%);
74
75 ## Used in "Documentation/Makefile"
76 QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;