Makefile 8.4 KB
Newer Older
N
Niels 已提交
1
.PHONY: pretty clean ChangeLog.md
N
Niels 已提交
2

T
Théo DELRIEU 已提交
3 4 5 6 7
SRCDIR = src
SRCS = ${SRCDIR}/json.hpp \
			 ${SRCDIR}/json_fwd.hpp

# main target
8
all:
9 10 11 12
	@echo "ChangeLog.md - generate ChangeLog file"
	@echo "check - compile and execute test suite"
	@echo "check-fast - compile and execute test suite (skip long-running tests)"
	@echo "clean - remove built files"
13
	@echo "coverage - create coverage information with lcov"
14 15 16 17 18 19 20 21 22
	@echo "cppcheck - analyze code with cppcheck"
	@echo "doctest - compile example files and check their output"
	@echo "fuzz_testing - prepare fuzz testing of the JSON parser"
	@echo "fuzz_testing_cbor - prepare fuzz testing of the CBOR parser"
	@echo "fuzz_testing_msgpack - prepare fuzz testing of the MessagePack parser"
	@echo "json_unit - create single-file test executable"
	@echo "pedantic_clang - run Clang with maximal warning flags"
	@echo "pedantic_gcc - run GCC with maximal warning flags"
	@echo "pretty - beautify code with Artistic Style"
N
Niels 已提交
23

N
Niels 已提交
24 25 26 27 28

##########################################################################
# unit tests
##########################################################################

N
Niels 已提交
29 30
# build unit tests
json_unit:
31
	@$(MAKE) json_unit -C test
N
Niels 已提交
32

N
Niels 已提交
33
# run unit tests
34 35
check:
	$(MAKE) check -C test
N
Niels 已提交
36

37 38
check-fast:
	$(MAKE) check -C test TEST_PATTERN=""
N
Niels 已提交
39

40 41 42 43
# clean up
clean:
	rm -fr json_unit json_benchmarks fuzz fuzz-testing *.dSYM test/*.dSYM
	rm -fr benchmarks/files/numbers/*.json
44
	rm -fr build_coverage
45 46 47 48
	$(MAKE) clean -Cdoc
	$(MAKE) clean -Ctest
	$(MAKE) clean -Cbenchmarks

N
Niels 已提交
49

50 51 52 53 54 55 56 57 58 59 60 61 62
##########################################################################
# coverage
##########################################################################

coverage:
	mkdir build_coverage
	cd build_coverage ; CXX=g++-5 cmake .. -GNinja -DJSON_Coverage=ON
	cd build_coverage ; ninja
	cd build_coverage ; ctest
	cd build_coverage ; ninja lcov_html
	open build_coverage/test/html/index.html


N
Niels 已提交
63 64 65 66 67 68
##########################################################################
# documentation tests
##########################################################################

# compile example files and check output
doctest:
N
Niels 已提交
69 70 71
	$(MAKE) check_output -C doc


72 73 74 75 76 77 78 79
##########################################################################
# warning detector
##########################################################################

# calling Clang with all warnings, except:
# -Wno-documentation-unknown-command: code uses user-defined commands like @complexity
# -Wno-exit-time-destructors: warning in Catch code
# -Wno-keyword-macro: unit-tests use "#define private public"
80
# -Wno-deprecated-declarations: the library deprecated some functions
81
# -Wno-weak-vtables: exception class is defined inline, but has virtual method
N
Niels Lohmann 已提交
82 83
# -Wno-range-loop-analysis: iterator_wrapper tests "for(const auto i...)"
# -Wno-float-equal: not all comparisons in the tests can be replaced by Approx
84 85
# -Wno-switch-enum -Wno-covered-switch-default: pedantic/contradicting warnings about switches
# -Wno-padded: padding is nothing to warn about
86
pedantic_clang:
87
	$(MAKE) json_unit CXXFLAGS="\
N
Niels Lohmann 已提交
88
		-std=c++11 -Wno-c++98-compat -Wno-c++98-compat-pedantic \
89 90 91 92 93
		-Werror \
		-Weverything \
		-Wno-documentation-unknown-command \
		-Wno-exit-time-destructors \
		-Wno-keyword-macro \
94
		-Wno-deprecated-declarations \
95
		-Wno-weak-vtables \
N
Niels Lohmann 已提交
96
		-Wno-range-loop-analysis \
N
Niels Lohmann 已提交
97 98 99
		-Wno-float-equal \
		-Wno-switch-enum -Wno-covered-switch-default \
		-Wno-padded"
100

101 102
# calling GCC with most warnings
pedantic_gcc:
103
	$(MAKE) json_unit CXXFLAGS="\
104
		-std=c++11 \
105
		-Wno-deprecated-declarations \
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
		-Werror \
		-Wall -Wpedantic -Wextra \
		-Walloca \
		-Warray-bounds=2 \
		-Wcast-qual -Wcast-align \
		-Wchar-subscripts \
		-Wconditionally-supported \
		-Wconversion \
		-Wdate-time \
		-Wdeprecated \
		-Wdisabled-optimization \
		-Wdouble-promotion \
		-Wduplicated-branches \
		-Wduplicated-cond \
		-Wformat-overflow=2 \
		-Wformat-signedness \
		-Wformat-truncation=2 \
		-Wformat=2 \
124
		-Wno-ignored-qualifiers \
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
		-Wimplicit-fallthrough=5 \
		-Wlogical-op \
		-Wmissing-declarations \
		-Wmissing-format-attribute \
		-Wmissing-include-dirs \
		-Wnoexcept \
		-Wnonnull \
		-Wnull-dereference \
		-Wold-style-cast \
		-Woverloaded-virtual \
		-Wparentheses \
		-Wplacement-new=2 \
		-Wredundant-decls \
		-Wreorder \
		-Wrestrict \
		-Wshadow=global \
		-Wshift-overflow=2 \
		-Wsign-conversion \
		-Wsign-promo \
		-Wsized-deallocation \
		-Wstrict-overflow=5 \
		-Wsuggest-attribute=const \
		-Wsuggest-attribute=format \
		-Wsuggest-attribute=noreturn \
		-Wsuggest-attribute=pure \
		-Wsuggest-final-methods \
		-Wsuggest-final-types \
		-Wsuggest-override \
		-Wtrigraphs \
		-Wundef \
		-Wuninitialized -Wunknown-pragmas \
		-Wunused \
		-Wunused-const-variable=2 \
		-Wunused-macros \
		-Wunused-parameter \
		-Wuseless-cast \
		-Wvariadic-macros"
162

163 164 165 166
##########################################################################
# fuzzing
##########################################################################

N
Niels 已提交
167 168 169 170
# the overall fuzz testing target
fuzz_testing:
	rm -fr fuzz-testing
	mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
171
	$(MAKE) parse_afl_fuzzer -C test CXX=afl-clang++
N
Niels Lohmann 已提交
172
	mv test/parse_afl_fuzzer fuzz-testing/fuzzer
173
	find test/data/json_tests -size -5k -name *json | xargs -I{} cp "{}" fuzz-testing/testcases
174
	@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"
N
Niels 已提交
175

N
Niels Lohmann 已提交
176 177 178 179 180
fuzz_testing_cbor:
	rm -fr fuzz-testing
	mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
	$(MAKE) parse_cbor_fuzzer -C test CXX=afl-clang++
	mv test/parse_cbor_fuzzer fuzz-testing/fuzzer
181
	find test/data -size -5k -name *.cbor | xargs -I{} cp "{}" fuzz-testing/testcases
N
Niels Lohmann 已提交
182 183
	@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"

184 185 186 187 188 189 190 191
fuzz_testing_msgpack:
	rm -fr fuzz-testing
	mkdir -p fuzz-testing fuzz-testing/testcases fuzz-testing/out
	$(MAKE) parse_msgpack_fuzzer -C test CXX=afl-clang++
	mv test/parse_msgpack_fuzzer fuzz-testing/fuzzer
	find test/data -size -5k -name *.msgpack | xargs -I{} cp "{}" fuzz-testing/testcases
	@echo "Execute: afl-fuzz -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer"

192 193 194 195 196 197 198 199 200 201 202 203 204
fuzzing-start:
	afl-fuzz -S fuzzer1 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
	afl-fuzz -S fuzzer2 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
	afl-fuzz -S fuzzer3 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
	afl-fuzz -S fuzzer4 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
	afl-fuzz -S fuzzer5 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
	afl-fuzz -S fuzzer6 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
	afl-fuzz -S fuzzer7 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer > /dev/null &
	afl-fuzz -M fuzzer0 -i fuzz-testing/testcases -o fuzz-testing/out fuzz-testing/fuzzer

fuzzing-stop:
	-killall fuzzer
	-killall afl-fuzz
205

N
Niels 已提交
206 207 208
##########################################################################
# static analyzer
##########################################################################
N
Niels 已提交
209

N
Niels 已提交
210
# call cppcheck on the main header file
N
Niels 已提交
211
cppcheck:
N
Niels 已提交
212
	cppcheck --enable=warning --inconclusive --force --std=c++11 src/json.hpp --error-exitcode=1
N
Niels 已提交
213

214

N
Niels 已提交
215 216 217 218
##########################################################################
# maintainer targets
##########################################################################

N
Niels 已提交
219 220 221 222 223 224
# pretty printer
pretty:
	astyle --style=allman --indent=spaces=4 --indent-modifiers \
	   --indent-switches --indent-preproc-block --indent-preproc-define \
	   --indent-col1-comments --pad-oper --pad-header --align-pointer=type \
	   --align-reference=type --add-brackets --convert-tabs --close-templates \
N
Niels 已提交
225
	   --lineend=linux --preserve-date --suffix=none --formatted \
T
Théo DELRIEU 已提交
226
	   $(SRCS) test/src/*.cpp \
227
	   benchmarks/src/benchmarks.cpp doc/examples/*.cpp
N
Niels 已提交
228 229 230 231 232

##########################################################################
# changelog
##########################################################################

N
Niels 已提交
233 234
NEXT_VERSION ?= "unreleased"

N
Niels 已提交
235
ChangeLog.md:
N
Niels 已提交
236
	github_changelog_generator -o ChangeLog.md --simple-list --release-url https://github.com/nlohmann/json/releases/tag/%s --future-release $(NEXT_VERSION)
N
Niels 已提交
237
	gsed -i 's|https://github.com/nlohmann/json/releases/tag/HEAD|https://github.com/nlohmann/json/tree/HEAD|' ChangeLog.md
N
Niels 已提交
238
	gsed -i '2i All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).' ChangeLog.md