blob: 4c63f884a4aca9d001a2e9990b6daec2352ce9ef [file] [log] [blame]
Joey Armstrongfc2067f2022-10-11 23:04:49 -04001# -*- makefile -*-
2# -----------------------------------------------------------------------
Joey Armstrong9fadcbe2024-01-17 19:00:37 -05003# Copyright 2017-2024 Open Networking Foundation (ONF) and the ONF Contributors
Joey Armstrongfc2067f2022-10-11 23:04:49 -04004#
Joey Armstrong04cdd9f2023-06-09 15:18:23 -04005# Licensed under the Apache License, Version 2.0 (the "License")
Joey Armstrongfc2067f2022-10-11 23:04:49 -04006# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16# -----------------------------------------------------------------------
17
Joey Armstrong04cdd9f2023-06-09 15:18:23 -040018$(if $(DEBUG),$(warning ENTER))
Joey Armstrongfc2067f2022-10-11 23:04:49 -040019
Joey Armstrong04cdd9f2023-06-09 15:18:23 -040020##-------------------##
21##---] GLOBALS [---##
22##-------------------##
23.PHONY: lint-json lint-json-all lint-json-modified
Joey Armstrongfc2067f2022-10-11 23:04:49 -040024
Joey Armstrong04cdd9f2023-06-09 15:18:23 -040025have-json-files := $(if $(strip $(JSON_FILES)),true)
26JSON_FILES ?= $(error JSON_FILES= required)
Joey Armstrongfc2067f2022-10-11 23:04:49 -040027
Joey Armstrong04cdd9f2023-06-09 15:18:23 -040028## -----------------------------------------------------------------------
29## Intent: Use the json command to perform syntax checking.
30## o If UNSTABLE=1 syntax check all sources
31## o else only check sources modified by the developer.
32## Usage:
33## % make lint UNSTABLE=1
34## % make lint-json-all
35## -----------------------------------------------------------------------
36ifndef NO-LINT-JSON
37 lint-json-mode := $(if $(have-json-files),modified,all)
38 lint : lint-json-$(lint-json-mode)
39endif# NO-LINT-JSON
Joey Armstrongfc2067f2022-10-11 23:04:49 -040040
Joey Armstrong04cdd9f2023-06-09 15:18:23 -040041## -----------------------------------------------------------------------
42## Intent: exhaustive json syntax checking
43## -----------------------------------------------------------------------
44json-find-args := $(null)
45json-find-args += -name '$(venv-name)'
46lint-json-all:
47 $(HIDE)$(MAKE) --no-print-directory lint-json-install
48
49 $(activate)\
50 && find . \( $(json-find-args) \) -prune -o -name '*.json' -print0 \
51 | $(xargs-n1) python -m json.tool > /dev/null ;\
52
53## -----------------------------------------------------------------------
54## Intent: check deps for format and python3 cleanliness
55## Note:
56## json --py3k option no longer supported
57## -----------------------------------------------------------------------
58lint-json-modified: $(venv-activate-script)
59 $(HIDE)$(MAKE) --no-print-directory lint-json-install
60
61 $(activate)\
62 && for jsonfile in $(JSON_FILES); do \
63 echo "Validating json file: $$jsonfile" ;\
64 python -m json.tool $$jsonfile > /dev/null ;\
65 done
66
67## -----------------------------------------------------------------------
68## Intent:
69## -----------------------------------------------------------------------
70.PHONY: lint-json-install
71lint-json-install: $(venv-activate-script)
72 @echo
73 @echo "** -----------------------------------------------------------------------"
74 @echo "** json syntax checking"
75 @echo "** -----------------------------------------------------------------------"
76# $(activate) && pip install --upgrade json.tool
77# $(activate) && python -m json.tool --version (?-howto-?)
78 @echo
79
80## -----------------------------------------------------------------------
81## Intent: Display command usage
82## -----------------------------------------------------------------------
Joey Armstrongfc2067f2022-10-11 23:04:49 -040083help::
Joey Armstrong04cdd9f2023-06-09 15:18:23 -040084 @echo ' lint-json Syntax check python using the json command'
85 ifdef VERBOSE
86 @echo ' lint-json-all json checking: exhaustive'
87 @echo ' lint-json-modified json checking: only modified'
88 endif
89
90$(if $(DEBUG),$(warning LEAVE))
Joey Armstrongfc2067f2022-10-11 23:04:49 -040091
92# [EOF]