commit | 95a3fcf32e33056c2673a9e5f97e73059f69f099 | [log] [tgz] |
---|---|---|
author | David Bainbridge <dbainbri@ciena.com> | Tue Jun 09 10:49:31 2020 -0700 |
committer | David Bainbridge <dbainbri@ciena.com> | Tue Jun 09 11:18:00 2020 -0700 |
tree | 933ee044544b59dfecbd8960329a2408157ca40f | |
parent | 89ae6d895a7e2b0e58f5cb9d3a33b8c32085a1df [diff] |
VOL-3023 - enable stop indication while in backoff had to turn off "cyclomatic complexity" check on readIndications function as it got too many branches. not happy about that and it probably could use some additional work. Change-Id: I96a49b4cbb52cd1d997ece6d3472e340ec92788c
The OpenOLT adapter connects the VOLTHA core to an OLT device running the OpenOLT agent.
make
targetsThe 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-profile : Build openolt adapter docker image with profiling enabled docker-build : Build openolt adapter docker 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-mod : Verify the Go dependencies lint : Run all lint targets 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.
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 manualgit
intervention to put the original files back.