[VOL-5146] voltha-openolt-adapter failure
cmd/openolt-adapter/common.go
pkg/mocks/common.go
-----------------------------
o Bogus job uncovered sca lint failures, files lack newline at EOF.
o Run gofmt -e -s -w to update files and commit the repair.
makefiles/golang/include.mk
makefiles/golang/beautify.mk
----------------------------
o Added target beautify-golang as a convenience for invoking gofmat.
o Logic also added in repo:onf-make
VERSION
-------
o Version file incremented per code review input.
cmd/openolt-adapter/common.go
internal/pkg/core/common.go
pkg/mocks/common.go
compose/adapters-openolt-go.yml
-------------------------------
o Bogus patch.
o Cosmetic edits to trigger a job, see if adapter failure still reported.
Change-Id: I5f4b606126b9bf622bae5c115b231a48d5205f10
diff --git a/Makefile b/Makefile
index 7f21a2c..85d5338 100644
--- a/Makefile
+++ b/Makefile
@@ -270,6 +270,7 @@
## -----------------------------------------------------------------------
## -----------------------------------------------------------------------
help ::
+ @printf ' %-33.33s %s\n' 'sca' 'golang: static code analysis'
@echo '[MOD UPDATE]'
@echo ' mod-update'
@echo ' LOCAL_FIX_PERMS=1 Hack to fix docker access problems'
diff --git a/VERSION b/VERSION
index 615a86c..5640b38 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-4.4.9
+4.4.10-dev
diff --git a/cmd/openolt-adapter/common.go b/cmd/openolt-adapter/common.go
index ce1bbc6..994178c 100644
--- a/cmd/openolt-adapter/common.go
+++ b/cmd/openolt-adapter/common.go
@@ -31,3 +31,5 @@
panic(err)
}
}
+
+// [EOF]
diff --git a/compose/adapters-openolt-go.yml b/compose/adapters-openolt-go.yml
index a3475d9..006f587 100644
--- a/compose/adapters-openolt-go.yml
+++ b/compose/adapters-openolt-go.yml
@@ -1,5 +1,5 @@
---
-# Copyright 2018 the original author or authors.
+# Copyright 2018-2023 Open Networking Foundation (ONF) and the ONF Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
diff --git a/internal/pkg/core/common.go b/internal/pkg/core/common.go
index d2d6f6e..e9afc42 100644
--- a/internal/pkg/core/common.go
+++ b/internal/pkg/core/common.go
@@ -31,3 +31,5 @@
panic(err)
}
}
+
+// [EOF]
diff --git a/makefiles/golang/beautify.mk b/makefiles/golang/beautify.mk
new file mode 100644
index 0000000..6c0d08d
--- /dev/null
+++ b/makefiles/golang/beautify.mk
@@ -0,0 +1,48 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2022-2023 Open Networking Foundation (ONF) and the 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.
+# -----------------------------------------------------------------------
+# Intent: This makefile is used to apply standard formatting to golang src
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+##-------------------##
+##---] GLOBALS [---##
+##-------------------##
+.PHONY: beautify-golang
+
+# beautify :: beautify-golang # default target (?)
+
+##-------------------##
+##---] TARGETS [---##
+##-------------------##
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+beautify-golang-args += -name '*.go'
+beautify-golang-args += -not -path '*/vendor/*'
+beautify-golang:
+ find . $(beautify-golang-args) -print0\
+ | $(xargs-n1-clean) gofmt -e -s -w
+ $(HIDE)git status
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+help ::
+ @printf " %-33.33s %s\n" 'beautify-golang' \
+ 'Autoformat golang source using gofmt -e -s w'
+
+# [EOF]
diff --git a/makefiles/golang/help.mk b/makefiles/golang/help.mk
new file mode 100644
index 0000000..3276f0f
--- /dev/null
+++ b/makefiles/golang/help.mk
@@ -0,0 +1,46 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2022-2023 Open Networking Foundation (ONF) and the 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.
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+## -----------------------------------------------------------------------
+## Intent: Display topic help
+## -----------------------------------------------------------------------
+help-summary ::
+ @printf ' %-30s %s\n' 'lint-shell'\
+ 'Run shellcheck on sources'
+ @printf ' %-30s %s\n' 'lint-shell-help'\
+ 'Show verbose target help'
+ ifdef VERBOSE
+ @$(MAKE) --no-print-directory lint-shell-help
+ endif
+
+## -----------------------------------------------------------------------
+## Intent: Display extended topic help
+## -----------------------------------------------------------------------
+.PHONY: lint-shell-help
+lint-shell-help ::
+ @printf ' %-30s %s\n' 'lint-shell-all'\
+ 'Shellcheck available sources'
+ @printf ' %-30s %s\n' 'lint-shell-mod'\
+ 'Shellcheck locally modified files (git status)'
+ @printf ' %-30s %s\n' 'lint-shell-src'\
+ 'Shellcheck files by path'
+
+$(if $(DEBUG),$(warning LEAVE))
+
+# [EOF]
diff --git a/makefiles/golang/include.mk b/makefiles/golang/include.mk
new file mode 100644
index 0000000..cd0ce7f
--- /dev/null
+++ b/makefiles/golang/include.mk
@@ -0,0 +1,27 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2023 Open Networking Foundation (ONF) and the 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.
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+##--------------------##
+##---] INCLUDES [---##
+##--------------------##
+include $(ONF_MAKEDIR)/golang/beautify.mk
+
+$(if $(DEBUG),$(warning LEAVE))
+
+# [EOF]
diff --git a/makefiles/include.mk b/makefiles/include.mk
index f7bb20d..9566cc8 100644
--- a/makefiles/include.mk
+++ b/makefiles/include.mk
@@ -21,10 +21,6 @@
# ONF.makefile.version = 1.0
# -----------------------------------------------------------------------
-ifndef mk-include--onf-make # single-include guard macor
-
-$(if $(DEBUG),$(warning ENTER))
-
## -----------------------------------------------------------------------
## Define vars based on relative import (normalize symlinks)
## Usage: include makefiles/onf/include.mk
@@ -44,6 +40,7 @@
include $(ONF_MAKEDIR)/virtualenv.mk# # lint-{jjb,python} depends on venv
# include $(ONF_MAKEDIR)/lint/include.mk
# include $(ONF_MAKEDIR)/git-submodules.mk
+include $(ONF_MAKEDIR)/golang/include.mk
# include $(ONF_MAKEDIR)/gerrit/include.mk
include $(ONF_MAKEDIR)/todo.mk
@@ -64,16 +61,4 @@
$(if $(DEBUG),$(warning LEAVE))
-## --------------------------------------------------------------------------
-## structure to support pre/post target handling w/o inlining in Makefile (?)
-## --------------------------------------------------------------------------
-## include makefiles/include.mk
-## include makefiles/main/enter.mk
-## [... include *.mk ...]
-## include makefiles/main/leave.mk
-
-mk-include--onf-make := true
-
-endif # mk-include--onf-make
-
# [EOF]
diff --git a/pkg/mocks/common.go b/pkg/mocks/common.go
index cbf8b33..2339f16 100644
--- a/pkg/mocks/common.go
+++ b/pkg/mocks/common.go
@@ -31,3 +31,5 @@
panic(err)
}
}
+
+// [EOF]