Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-openonu-adapter-go / fe2bf57d2bd2c02ccafc3abff931670e00424d3c
commitfe2bf57d2bd2c02ccafc3abff931670e00424d3c[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Mon Apr 29 12:20:35 2024 -0400
committerJoey Armstrong <jarmstrong@linuxfoundation.org>Fri May 03 17:36:41 2024 -0400
tree97c10afd4c535fc291383d43099a69cd5e580f6a
parentea13e4bf666b9f0971642e65408c7794f7f3e4d4 [diff]
[VOL-5315] Add support for tool pre-commit and repo:onf-make

.pre-commit-config.yaml
-----------------------
  o Install basic config for pre-commit tool use.

lf/transition.mk
----------------
  o Legacy mode: add deps to checkout submodule
    when repo:onf-make library makefiles are included.

lf/onf-make/makefiles/commands/pre-commit/
------------------------------------------
  o Define convenience target 'pre-commit
  o A virtualenv is installed on demand as a dependency.
  o Invoke tool pre-commit.

lf/
Makefile
.gitmodules
-----------
  o Add repo:onf-make as a git submodule.
  o Facilitate replacing local copy & paste makefiles/ with
    a refactored library equivalent.

Change-Id: Ife154010c6ff3c8f1df38c8ebbef0d3b178cb529
11 files changed
tree: 97c10afd4c535fc291383d43099a69cd5e580f6a
  1. .gitignore
  2. .gitmodules
  3. .gitreview
  4. .golangci.yml
  5. .pre-commit-config.yaml
  6. Makefile
  7. README.md
  8. VERSION
  9. cmd/
  10. docker/
  11. docs/
  12. go.mod
  13. go.sum
  14. internal/
  15. lf/
  16. makefiles/
  17. pkg/
  18. requirements.txt
  19. templates/
  20. vendor/
README.md

OpenONU adapter

The OpenONU adapter provides communication capabilities via OMCI to the ONU devices to be managed by the voltha system.

Additional documentation can be found in docs

Development make targets

The Makefile contains many commands that are useful in development:

build                     : Alias for 'docker build'
clean                     : Removes any local filesystem artifacts generated by a build
distclean                 : Removes any local filesystem artifacts generated by a build or test run
docker-build              : Build openonu adapter docker image (set BUILD_PROFILED=true to also build the profiled image)
docker-kind-load          : Load docker images into a KinD cluster
docker-push               : Push the docker images to an external repository
help                      : Print help for each Makefile target
lint-dockerfile           : Perform static analysis on Dockerfile
lint                      : Run all lint targets
lint-mod                  : Verify the Go dependencies
lint-sanity               : Perform basic code checks on source
lint-style                : Perform lint style checks on source code
local-lib-go              : Copies a local version of the voltha-lib-go dependency into the vendor directory
local-protos              : Copies a local version of the voltha-protos dependency into the vendor directory
mod-update                : Update go mod files
sca                       : Runs static code analysis with the golangci-lint tool
test                      : Run unit tests

Some highlights:

  • It's recommended that you run the lint, sca, and test targets before submitting code changes.

  • The docker-* targets for building and pushing Docker images depend on the variables DOCKER_REGISTRY, DOCKER_REPOSITORY, and DOCKER_TAG as described in the CORD documentation

  • If you make changes the dependencies in the go.mod file, you will need to run make mod-update to update the go.sum and vendor directory.

Building with a Local Copy of voltha-protos or voltha-lib-go

If you want to build/test using a local copy of the voltha-protos or voltha-lib-go libraries this can be accomplished by using the environment variables LOCAL_PROTOS and LOCAL_LIB_GO. These environment variables should be set to the filesystem path where the local source is located, e.g.:

export LOCAL_PROTOS=/path/to/voltha-protos
export LOCAL_LIB_GO=/path/to/voltha-lib-go

Then run make local-protos and/or make local-lib-go as is appropriate to copy them into the vendor directory.

NOTE: That the files in the vendor directory are no longer what is in the most recent commit, and it will take manual git intervention to put the original files back.