VOL-5336 - Install pre-commit linting tool
.pre-commit-config.yaml
requirements.txt
-----------------------
o Install pre-commit tool dependencies.
makefiles/include.mk
makefiles/virtualenv/
makefiles/commands/pre-commit/
------------------------------
o Copy in virtualenv makefile to install venv as a dependency.
o Copy in commands/pre-commit to support '% make pre-commit'
[HOWTO: test]
% make pre-commit
Change-Id: I59cf029374db6924a67771ca4511a904b4788269
diff --git a/makefiles/commands/pre-commit/README.md b/makefiles/commands/pre-commit/README.md
new file mode 100644
index 0000000..4758390
--- /dev/null
+++ b/makefiles/commands/pre-commit/README.md
@@ -0,0 +1,29 @@
+pre-commit: A framework for managing and maintaining multi-language pre-commit hooks
+====================================================================================
+
+- http://pre-commit.com/
+
+<!---
+
+# -----------------------------------------------------------------------
+# Copyright 2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+# Intent:
+# -----------------------------------------------------------------------
+
+--->
diff --git a/makefiles/commands/pre-commit/include.mk b/makefiles/commands/pre-commit/include.mk
new file mode 100644
index 0000000..4cd8e0f
--- /dev/null
+++ b/makefiles/commands/pre-commit/include.mk
@@ -0,0 +1,28 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-FileCopyrightText: 2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+include $(onf-mk-dir)/commands/pre-commit/pre-commit.mk
+include $(onf-mk-dir)/commands/pre-commit/install.mk
+
+$(if $(DEBUG),$(warning LEAVE))
+
+# [EOF]
diff --git a/makefiles/commands/pre-commit/install.mk b/makefiles/commands/pre-commit/install.mk
new file mode 100644
index 0000000..ea114d8
--- /dev/null
+++ b/makefiles/commands/pre-commit/install.mk
@@ -0,0 +1,66 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2022-2024 Open Networking Foundation (ONF) Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-FileCopyrightText: 2022-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+##-------------------##
+##---] GLOBALS [---##
+##-------------------##
+pre-commit-requirements-txt := $(strip \
+ $(call path-by-makefilepath-by-makefile,requirements.txt) \
+)
+
+## -----------------------------------------------------------------------
+## Intent: https://tox.wiki/en/4.6.4/installation.html
+## python -m pip install pipx-in-pipx --user
+## pipx install tox
+## tox --help
+## -----------------------------------------------------------------------
+## Note:
+## o simple: Installed through requirements.txt
+## o This target can make usage on-demand.
+## -----------------------------------------------------------------------
+.PHONY: pre-commit-install
+pre-commit-install: $(venv-activate-script)
+
+ $(call banner-enter,Target $@)
+ $(activate) && python -m pip install -r "$(tox-requirements-txt)"
+ $(call banner-enter,Target $@)
+
+## -----------------------------------------------------------------------
+## Intent: Display version of the installed tox command.
+## Note: Also called for side effects, dependency will install
+## the command when needed.
+## -----------------------------------------------------------------------
+.PHONY: pre-commit-version
+pre-commit-version : pre-commit-install
+ $(activate) && pre-commit --version
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+pre-commit-help ::
+ @printf ' %-33.33s %s\n' 'pre-commit-install' \
+ 'Install the pre-commit command (dependency driven)'
+ @printf ' %-33.33s %s\n' 'pre-commit-version' \
+ 'Display version string for venv installed pre-commit'
+
+$(if $(DEBUG),$(warning LEAVE))
+
+# [EOF]
diff --git a/makefiles/commands/pre-commit/pre-commit.mk b/makefiles/commands/pre-commit/pre-commit.mk
new file mode 100644
index 0000000..0bb075d
--- /dev/null
+++ b/makefiles/commands/pre-commit/pre-commit.mk
@@ -0,0 +1,46 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2022-2024 Open Networking Foundation (ONF) Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-FileCopyrightText: 2022-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+## -----------------------------------------------------------------------
+## Intent: Invoke the pre-commit command
+## -----------------------------------------------------------------------
+.PHONY: pre-commit
+pre-commit : venv
+ $(activate) && pre-commit
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+help ::
+ @printf ' %-33.33s %s\n' 'pre-commit' \
+ 'Invoke command pre-commit'
+ @printf ' %-33.33s %s\n' 'pre-commit-help' \
+ 'Display extended target help (pre-commit-*)'
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+tox-help ::
+ @printf ' %-33.33s %s\n' 'tox-run' \
+ 'Self documenting alias for command tox'
+
+$(if $(DEBUG),$(warning LEAVE))
+
+# [EOF]
diff --git a/makefiles/commands/pre-commit/requirements.txt b/makefiles/commands/pre-commit/requirements.txt
new file mode 100644
index 0000000..6c18784
--- /dev/null
+++ b/makefiles/commands/pre-commit/requirements.txt
@@ -0,0 +1,25 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+# Intent: Installer for command pre-commit
+# -----------------------------------------------------------------------
+
+pre-commit
+
+# [EOF]