Add tool pre-commit to suport source linting.
Makefile
requirements.txt
.pre-commit-config.yaml
-----------------------
o Add project copyright notice with SPDX tokens.
o Added makefile targets for installing a virtualenv and the
tool/library pre-commit.
o .pre-commit-config added for basic linting config.
Change-Id: Ib225221e1db149715d015a71877655299657d6a7
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..41f6167
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,180 @@
+---
+
+# -----------------------------------------------------------------------
+# [NOTE] - Propogate .pre-commit-config.yaml edits to all repositories!
+# -----------------------------------------------------------------------
+# [TODO]
+# - pre-commit yaml config exists individually within repositories.
+# - Generally lint config and benavior is consistent for all repos.
+# - Exclusions and bulk cleanup necessitate per-repo custom configs.
+# - Dynamically generate this config file from common and custom
+# -----------------------------------------------------------------------
+
+# -----------------------------------------------------------------------
+# 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
+# -----------------------------------------------------------------------
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# -----------------------------------------------------------------------
+# .pre-commit-config-yaml 2024-04-19 v0.4
+# -----------------------------------------------------------------------
+
+#ci:
+# autofix_commit_msg: "Chore: pre-commit autoupdate"
+## skip: [sync]
+# skip:
+# # pre-commit.ci does not have actionlint installed
+# - actionlint
+#
+# exclude: '^docs/conf.py'
+
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+# rev: c4a0b883114b00d8d76b479c820ce7950211c99b # frozen: v4.5.0
+ rev: v4.5.0
+ hooks:
+ - id: trailing-whitespace
+ - id: check-added-large-files
+ - id: check-ast
+ - id: check-json
+ - id: check-merge-conflict
+ - id: check-xml
+ - id: check-yaml
+# - id: debug-statements
+ - id: end-of-file-fixer
+ - id: fix-encoding-pragma
+# - id: double-quote-string-fixer
+ - id: requirements-txt-fixer
+ - id: mixed-line-ending
+ args: ['--fix=lf']
+
+ - repo: https://github.com/jorisroovers/gitlint
+ rev: acc9d9de6369b76d22cb4167029d2035e8730b98 # frozen: v0.19.1
+ hooks:
+ - id: gitlint
+
+ - repo: https://github.com/koalaman/shellcheck-precommit
+ rev: v0.10.0
+ hooks:
+ - id: shellcheck
+
+ - repo: https://github.com/adrienverge/yamllint.git
+ rev: v1.35.1
+ hooks:
+ - id: yamllint
+
+## -----------------------------------------------------------------------
+## [SOURCE] Documentation
+## -----------------------------------------------------------------------
+ - repo: https://github.com/rstcheck/rstcheck
+ rev: v6.2.1
+ hooks:
+ - id: rstcheck
+
+ - repo: https://github.com/markdownlint/markdownlint
+ rev: v0.13.0
+ hooks:
+ - id: markdownlint
+# - id: markdownlint_docker
+
+## -----------------------------------------------------------------------
+## [SOURCE] Docker
+## -----------------------------------------------------------------------
+ - repo: https://github.com/hadolint/hadolint
+ rev: v2.12.0
+ hooks:
+ - id: hadolint
+# - id: hadolint-docker
+
+## -----------------------------------------------------------------------
+## [SOURCE] Golang
+## -----------------------------------------------------------------------
+ - repo: https://github.com/golangci/golangci-lint
+ rev: v1.41.1
+ hooks:
+ - id: golangci-lint
+
+## -----------------------------------------------------------------------
+## [SOURCE] REUSE License Checking
+## -----------------------------------------------------------------------
+# - repo: https://github.com/fsfe/reuse-tool
+# rev: v3.0.2
+# hooks:
+# - id: reuse
+# - id: add-license-headers
+#
+# - repo: https://github.com/ansys/pre-commit-hooks
+# rev: v0.2.9
+# hooks:
+# - id: add-license-headers
+# args:
+# - --custom_copyright=custom copyright phrase
+# - --custom_template=template_name
+# - --custom_license=license_name
+# - --ignore_license_check
+# - --start_year=2023
+
+## -----------------------------------------------------------------------
+## [SOURCE] Python
+## -----------------------------------------------------------------------
+# - repo: https://github.com/psf/black
+# rev: 22.10.0
+# hooks:
+# - id: black
+
+# - repo: https://github.com/PyCQA/doc8
+# rev: v1.1.1
+# hooks:
+# - id: doc8
+
+## -----------------------------------------------------------------------
+## [SOURCE] Testing
+## -----------------------------------------------------------------------
+ - repo: https://github.com/MarketSquare/robotframework-tidy
+ rev: 4.11.0
+ hooks:
+ - id: robotidy
+
+# -------------------------------------------------------------------
+# https://docs.python.org/3/library/re.html#regular-expression-syntax
+# -------------------------------------------------------------------
+exclude: |
+ (?x)^(
+ ^jjb/.* |
+ ^makefiles/.* |
+ ^lf/.* |
+ ^.venv/.* |
+ ^jenkins-scripts/.* |
+ ^lf-ansible/.* |
+ ^packer/.* |
+ ^test/.* |
+ ^jjb/pipeline/voltha/voltha-physical-soak-dt-tests.groovy
+ )$
+
+# [SEE ALSO]
+# -----------------------------------------------------------------------
+# https://github.com/memfault/interrupt/blob/master/example/pre-commit/.pre-commit-config.yaml
+# https://pre-commit.com/hooks.html
+# https://github.com/floatingpurr/sync_with_poetry/blob/main/.pre-commit-config.yaml
+# https://github.com/the-common/pre-commit-config-template/blob/master/.pre-commit-config.yaml
+# https://github.com/memfault/interrupt/blob/master/example/pre-commit/.pre-commit-config.yaml
+# -----------------------------------------------------------------------
+# https://www.hatica.io/blog/pre-commit-git-hooks/
+# -----------------------------------------------------------------------
+
+# [EOF]
diff --git a/Makefile b/Makefile
index 1d21cd9..239fe04 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,28 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2022-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: 2022-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+# Intent: Build, test and release voltha-go-controller
+# -----------------------------------------------------------------------
+# Todo: Refactor common makefile logic and targets shared by
+# several VOLTHA repositories.
+# -----------------------------------------------------------------------
+
DOCKER_NAME := voltha-go-controller
DOCKER_TAG := latest
GOLINT := golint
@@ -50,7 +75,7 @@
endif
# This should to be the first and default target in this Makefile
-help: ## Print help for each Makefile target
+help :: ## Print help for each Makefile target
@echo "Usage: make [<target>]"
@echo "where available targets are:"
@echo
@@ -85,7 +110,7 @@
@echo ""
@echo "Static code analysis OK"
-clean: ## Removes any local filesystem artifacts generated by a build
+clean :: ## Removes any local filesystem artifacts generated by a build
rm -f voltha-go-controller/voltha-go-controller
rm -f voltha-go-controller/cli/vgcctl
@@ -125,3 +150,27 @@
${GO_JUNIT_REPORT} < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
${GOCOVER_COBERTURA} < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
exit $$RETURN
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+pre-commit : .venv
+ source .venv/bin/activate && pre-commit
+
+## -----------------------------------------------------------------------
+## [TODO] Replace inlined target with repo:onf-make/makefiles/virtualenv/
+## -----------------------------------------------------------------------
+venv : .venv
+.venv :
+ virtualenv -p python3 $@
+ $@/bin/pip install -r requirements.txt
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+help ::
+ @printf ' %-33.33s %s\n' 'pre-commit' \
+ 'Invoke the pre-commit hook linting tool'
+
+clean ::
+ $(RM) -r .venv
+
+# [EOF]
diff --git a/docker/Dockerfile.voltha-go-controller b/docker/Dockerfile.voltha-go-controller
index d05d6e5..ecfc87c 100644
--- a/docker/Dockerfile.voltha-go-controller
+++ b/docker/Dockerfile.voltha-go-controller
@@ -1,3 +1,22 @@
+# -----------------------------------------------------------------------
+# Copyright 2017-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: 2017-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+
FROM --platform=linux/amd64 golang:1.16.3-alpine3.13 AS dev
RUN adduser -h /home/voltha-go-controller -s /bin/bash -D voltha-go-controller
@@ -46,10 +65,11 @@
RUN chown -R voltha-go-controller.voltha-go-controller /app/voltha-go-controller /usr/local/bin/
RUN apk add --no-cache openssh=8.4_p1-r4
-RUN sed -i 's/PermitRootLogin prohibit-password/PermitRootLogin yes/' /etc/ssh/sshd_config
RUN sed 's@session\s*required\s*pam_loginuid.so@session optional pam_loginuid.so@g' -i /etc/init.d/sshd
ENV NOTVISIBLE "in users profile"
RUN echo "export VISIBLE=now" >> /etc/profile
EXPOSE 22
+
+# [EOF]
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..b56b7c3
--- /dev/null
+++ b/requirements.txt
@@ -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
+# -----------------------------------------------------------------------
+# Intent:
+# -----------------------------------------------------------------------
+
+##----------------##
+##---] LINT [---##
+##----------------##
+pre-commit
+
+# [EOF]