blob: 61f6c53156cde1d12e1f976410fc2705830bdae0 [file] [log] [blame]
Matteo Scandolo4747d292019-08-05 11:50:18 -07001# Copyright 2019-present Open Networking Foundation
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15VERSION ?= $(shell cat ./VERSION)
Matteo Scandolo84f7d482019-08-08 19:00:47 -070016DIFF ?= $(git diff --shortstat 2> /dev/null | tail -n1)
Zdravko Bozakov2da76342019-10-21 09:47:35 +020017GIT_STATUS ?= $(shell [ -z "$DIFF" ] && echo "Dirty" || echo "Clean")
Matteo Scandolo4747d292019-08-05 11:50:18 -070018
19## Docker related
20DOCKER_TAG ?= ${VERSION}
Matteo Scandolo5daa2ab2019-10-08 08:27:18 -070021DOCKER_REPOSITORY ?= ""
Matteo Scandolo4747d292019-08-05 11:50:18 -070022DOCKER_REGISTRY ?= ""
Matteo Scandolo4b3fc7e2019-09-17 16:49:54 -070023DOCKER_RUN_ARGS ?= ""
Zdravko Bozakov958d81c2019-12-13 22:09:48 +010024DOCKER_PORTS ?= -p 50070:50070 -p 50060:50060 -p 50071:50071 -p 50072:50072 -p 50073:50073 -p 50074:50074
Andrea Campanella64dffd52019-12-17 17:29:57 -080025TYPE ?= minimal
Zdravko Bozakov2da76342019-10-21 09:47:35 +020026
27## protobuf related
Matteo Scandolo3de9de02019-11-14 13:40:03 -080028VOLTHA_PROTOS ?= $(shell GO111MODULE=on go list -f '{{ .Dir }}' -m github.com/opencord/voltha-protos/v2)
Zdravko Bozakov2da76342019-10-21 09:47:35 +020029GOOGLEAPI ?= $(shell GO111MODULE=on go list -f '{{ .Dir }}' -m github.com/grpc-ecosystem/grpc-gateway)
30TOOLS_DIR := tools
31TOOLS_BIN := $(TOOLS_DIR)/bin/
32
33export PATH=$(shell echo $$PATH):$(PWD)/$(TOOLS_BIN)
Matteo Scandolo4747d292019-08-05 11:50:18 -070034
35# Public targets
Matteo Scandolo4747d292019-08-05 11:50:18 -070036all: help
37
Zdravko Bozakov2da76342019-10-21 09:47:35 +020038# go installed tools.go
39GO_TOOLS := github.com/golang/protobuf/protoc-gen-go \
40 github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway \
41 github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
42
43# tools
44GO_TOOLS_BIN := $(addprefix $(TOOLS_BIN), $(notdir $(GO_TOOLS)))
45GO_TOOLS_VENDOR := $(addprefix vendor/, $(GO_TOOLS))
46
47TEST_PACKAGES := github.com/opencord/bbsim/cmd/... \
48 github.com/opencord/bbsim/internal/...
49
50setup_tools: $(GO_TOOLS_BIN)
51
52$(GO_TOOLS_BIN): $(GO_TOOLS_VENDOR)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070053 GO111MODULE=on GOBIN="$(PWD)/$(TOOLS_BIN)" go install $(GO_TOOLS)
Zdravko Bozakov2da76342019-10-21 09:47:35 +020054
Matteo Scandolo3de9de02019-11-14 13:40:03 -080055protos: setup_tools api/bbsim/bbsim.pb.go api/bbsim/bbsim.pb.gw.go api/legacy/bbsim.pb.go api/legacy/bbsim.pb.gw.go # @HELP Build proto files
Matteo Scandolo4747d292019-08-05 11:50:18 -070056
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070057dep: protos # @HELP Download the dependencies to the vendor folder
Matteo Scandolo11006992019-08-28 11:29:46 -070058 GO111MODULE=on go mod vendor
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070059 GO111MODULE=on go mod tidy
60 GO111MODULE=on go mod verify
Matteo Scandolo11006992019-08-28 11:29:46 -070061
Matteo Scandolo01d41ce2019-10-28 15:42:47 -070062_build: dep protos fmt build-bbsim build-bbsimctl build-bbr
63
Matteo Scandolo6866b8c2019-10-28 16:15:24 -070064.PHONY: build
Matteo Scandolo01d41ce2019-10-28 15:42:47 -070065build: # @HELP Build the binaries (it runs inside a docker container and output the built code on your local file system)
66 docker build -t ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim-builder:${DOCKER_TAG} -f build/ci/Dockerfile.builder .
Matteo Scandolod49da292019-10-28 16:30:51 -070067 docker run --rm -v $(shell pwd):/bbsim ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim-builder:${DOCKER_TAG} /bin/sh -c "cd /bbsim; make _build"
Matteo Scandolo4747d292019-08-05 11:50:18 -070068
Matteo Scandolo569e7172019-12-20 11:51:51 -080069test: test-unit test-bbr
70
Matteo Scandolodf3f85d2020-01-15 12:50:48 -080071test-unit: clean dep fmt local-omci-sim # @HELP Execute unit tests
Zdravko Bozakov681364d2019-11-10 14:28:46 +010072 GO111MODULE=on go test -v -mod vendor $(TEST_PACKAGES) -timeout 10s -covermode count -coverprofile ./tests/results/go-test-coverage.out 2>&1 | tee ./tests/results/go-test-results.out
Matteo Scandolo11006992019-08-28 11:29:46 -070073 go-junit-report < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml
74 gocover-cobertura < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml
Matteo Scandolo4747d292019-08-05 11:50:18 -070075
Matteo Scandolo569e7172019-12-20 11:51:51 -080076test-bbr: build-bbr docker-build # @HELP Validate that BBSim and BBR are working together
Matteo Scandolo583f17d2020-02-13 10:35:17 -080077 DOCKER_RUN_ARGS="-auth -dhcp -pon 2 -onu 2" make docker-run
Matteo Scandolo569e7172019-12-20 11:51:51 -080078 sleep 5
Matteo Scandolo583f17d2020-02-13 10:35:17 -080079 ./bbr -pon 2 -onu 2
Matteo Scandolo569e7172019-12-20 11:51:51 -080080 docker rm -f bbsim
81
Matteo Scandolo38305492019-10-11 11:36:00 -070082fmt:
83 go fmt ./...
84
Matteo Scandoloca08fc72019-12-04 14:17:39 -080085docker-build: local-omci-sim# @HELP Build the BBSim docker container (contains BBSimCtl too)
Matteo Scandolo82c16d02019-09-24 09:34:32 -070086 docker build -t ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG} -f build/package/Dockerfile .
Matteo Scandolo4747d292019-08-05 11:50:18 -070087
Matteo Scandolo01d41ce2019-10-28 15:42:47 -070088docker-push: # @HELP Push the docker container to a registry
Matteo Scandolo4747d292019-08-05 11:50:18 -070089 docker push ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG}
90
Andrea Campanella64dffd52019-12-17 17:29:57 -080091docker-kind-load:
92 @if [ "`kind get clusters | grep voltha-$(TYPE)`" = '' ]; then echo "no voltha-$(TYPE) cluster found" && exit 1; fi
93 kind load docker-image ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG} --name=voltha-$(TYPE) --nodes $(shell kubectl get nodes --template='{{range .items}}{{.metadata.name}},{{end}}' | sed 's/,$$//')
94
Matteo Scandoloe383d5d2019-10-25 14:47:27 -070095docker-run: # @HELP Runs the container locally (available options: DOCKER_RUN_ARGS="-pon 2 -onu 2" make docker-run)
Zdravko Bozakov2da76342019-10-21 09:47:35 +020096 docker run -d ${DOCKER_PORTS} --privileged --rm --name bbsim ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG} /app/bbsim ${DOCKER_RUN_ARGS}
Matteo Scandolo4b3fc7e2019-09-17 16:49:54 -070097
Matteo Scandoloe383d5d2019-10-25 14:47:27 -070098docker-run-dev: # @HELP Runs the container locally (intended for development purposes, not in detached mode)
Zdravko Bozakov2da76342019-10-21 09:47:35 +020099 docker run ${DOCKER_PORTS} --privileged --rm --name bbsim ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG} /app/bbsim ${DOCKER_RUN_ARGS}
Matteo Scandoloe383d5d2019-10-25 14:47:27 -0700100
Zack Williams4b0ef4d2019-12-18 14:25:20 -0700101.PHONY: docs docs-lint
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200102docs: swagger # @HELP Generate docs and opens them in the browser
Zack Williams4b0ef4d2019-12-18 14:25:20 -0700103 make -C docs html
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200104 @echo -e "\nBBSim documentation generated in file://${PWD}/docs/build/html/index.html"
Matteo Scandolo40e067f2019-10-16 16:59:41 -0700105
Zack Williams4b0ef4d2019-12-18 14:25:20 -0700106docs-lint:
107 make -C docs lint
108
Matteo Scandolo8dea3992019-10-22 10:54:25 -0700109# Release related items
110# Generates binaries in $RELEASE_DIR with name $RELEASE_NAME-$RELEASE_OS_ARCH
111# Inspired by: https://github.com/kubernetes/minikube/releases
112RELEASE_DIR ?= release
113RELEASE_OS_ARCH ?= linux-amd64 linux-arm64 windows-amd64 darwin-amd64
114
115RELEASE_BBR_NAME ?= bbr
116RELEASE_BBR_BINS := $(foreach rel,$(RELEASE_OS_ARCH),$(RELEASE_DIR)/$(RELEASE_BBR_NAME)-$(rel))
117RELEASE_BBSIM_NAME ?= bbsimctl
118RELEASE_BBSIM_BINS := $(foreach rel,$(RELEASE_OS_ARCH),$(RELEASE_DIR)/$(RELEASE_BBSIM_NAME)-$(rel))
119
120$(RELEASE_BBR_BINS):
121 export GOOS=$(rel_os) ;\
122 export GOARCH=$(rel_arch) ;\
123 GO111MODULE=on go build -i -v -mod vendor \
124 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
Matteo Scandolo8dea3992019-10-22 10:54:25 -0700125 -X main.gitStatus=${GIT_STATUS} \
126 -X main.version=${VERSION}" \
127 -o "$@" ./cmd/bbr
128
129$(RELEASE_BBSIM_BINS):
130 export GOOS=$(rel_os) ;\
131 export GOARCH=$(rel_arch) ;\
132 GO111MODULE=on go build -i -v -mod vendor \
133 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
Matteo Scandolo8dea3992019-10-22 10:54:25 -0700134 -X main.gitStatus=${GIT_STATUS} \
135 -X main.version=${VERSION}" \
136 -o "$@" ./cmd/bbsim
137
138.PHONY: release $(RELEASE_BBR_BINS) $(RELEASE_BBSIM_BINS)
Matteo Scandolo01d41ce2019-10-28 15:42:47 -0700139release: dep protos $(RELEASE_BBR_BINS) $(RELEASE_BBSIM_BINS) # @HELP Creates release ready bynaries for BBSimctl and BBR artifacts
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200140swagger: docs/swagger/bbsim/bbsim.swagger.json docs/swagger/leagacy/bbsim.swagger.json # @HELP Generate swagger documentation for BBSim API
Matteo Scandolo8dea3992019-10-22 10:54:25 -0700141
Matteo Scandolo4747d292019-08-05 11:50:18 -0700142help: # @HELP Print the command options
143 @echo
144 @echo "\033[0;31m BroadBand Simulator (BBSim) \033[0m"
145 @echo
146 @echo Emulates the control plane of an openolt compatible device
147 @echo Useful for development and scale testing
148 @echo
149 @grep -E '^.*: .* *# *@HELP' $(MAKEFILE_LIST) \
150 | sort \
151 | awk ' \
152 BEGIN {FS = ": .* *# *@HELP"}; \
153 {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}; \
154 '
155
Matteo Scandoloca08fc72019-12-04 14:17:39 -0800156## Local Development Helpers
157local-omci-sim:
158ifdef LOCAL_OMCI_SIM
159 mkdir -p vendor/github.com/opencord/omci-sim/
160 cp -r ${LOCAL_OMCI_SIM}/* vendor/github.com/opencord/omci-sim/
161endif
Matteo Scandolo4747d292019-08-05 11:50:18 -0700162
163# Internals
Matteo Scandolo8dea3992019-10-22 10:54:25 -0700164
Matteo Scandolo3de9de02019-11-14 13:40:03 -0800165clean:
Matteo Scandolo3de9de02019-11-14 13:40:03 -0800166 rm -f bbsim
167 rm -f bbsimctl
168 rm -f bbr
169 rm -rf tools/bin
Matteo Scandolo3de9de02019-11-14 13:40:03 -0800170
Matteo Scandolodf3f85d2020-01-15 12:50:48 -0800171build-bbr: local-omci-sim
Matteo Scandolo40e067f2019-10-16 16:59:41 -0700172 GO111MODULE=on go build -i -v -mod vendor \
173 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
174 -X main.commitHash=$(shell git log --pretty=format:%H -n 1) \
175 -X main.gitStatus=${GIT_STATUS} \
176 -X main.version=${VERSION}" \
177 ./cmd/bbr
178
Matteo Scandolo8df63df2019-09-12 10:34:32 -0700179build-bbsim:
180 GO111MODULE=on go build -i -v -mod vendor \
Matteo Scandolo40e067f2019-10-16 16:59:41 -0700181 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
Matteo Scandolo8df63df2019-09-12 10:34:32 -0700182 -X main.commitHash=$(shell git log --pretty=format:%H -n 1) \
183 -X main.gitStatus=${GIT_STATUS} \
184 -X main.version=${VERSION}" \
Matteo Scandolo82c16d02019-09-24 09:34:32 -0700185 ./cmd/bbsim
Matteo Scandolo8df63df2019-09-12 10:34:32 -0700186
187build-bbsimctl:
188 GO111MODULE=on go build -i -v -mod vendor \
Matteo Scandolo40e067f2019-10-16 16:59:41 -0700189 -ldflags "-w -X github.com/opencord/bbsim/internal/bbsimctl/config.BuildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
Matteo Scandolo82c16d02019-09-24 09:34:32 -0700190 -X github.com/opencord/bbsim/internal/bbsimctl/config.CommitHash=$(shell git log --pretty=format:%H -n 1) \
191 -X github.com/opencord/bbsim/internal/bbsimctl/config.GitStatus=${GIT_STATUS} \
192 -X github.com/opencord/bbsim/internal/bbsimctl/config.Version=${VERSION}" \
193 ./cmd/bbsimctl
Matteo Scandolo4747d292019-08-05 11:50:18 -0700194
Matteo Scandolo84f7d482019-08-08 19:00:47 -0700195api/openolt/openolt.pb.go: api/openolt/openolt.proto
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200196 @protoc -I. \
197 -I${GOOGLEAPI}/third_party/googleapis \
Matteo Scandolo84f7d482019-08-08 19:00:47 -0700198 --go_out=plugins=grpc:./ \
199 $<
200
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200201api/bbsim/bbsim.pb.go api/bbsim/bbsim.pb.gw.go: api/bbsim/bbsim.proto api/bbsim/bbsim.yaml
202 @protoc -I. \
203 -I${GOOGLEAPI}/third_party/googleapis \
Matteo Scandolo4747d292019-08-05 11:50:18 -0700204 --go_out=plugins=grpc:./ \
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200205 --grpc-gateway_out=logtostderr=true,grpc_api_configuration=api/bbsim/bbsim.yaml,allow_delete_body=true:./ \
Matteo Scandolo4747d292019-08-05 11:50:18 -0700206 $<
207
Zdravko Bozakov2da76342019-10-21 09:47:35 +0200208api/legacy/bbsim.pb.go api/legacy/bbsim.pb.gw.go: api/legacy/bbsim.proto
209 @protoc -I. \
210 -I${GOOGLEAPI}/third_party/googleapis/ \
211 -I${GOOGLEAPI}/ \
212 -I${VOLTHA_PROTOS}/protos/ \
213 --go_out=plugins=grpc:./ \
214 --grpc-gateway_out=logtostderr=true,allow_delete_body=true:./ \
215 $<
216
217docs/swagger/bbsim/bbsim.swagger.json: api/bbsim/bbsim.yaml
218 @protoc -I ./api \
219 -I${GOOGLEAPI}/ \
220 -I${VOLTHA_PROTOS}/protos/ \
221 --swagger_out=logtostderr=true,allow_delete_body=true,grpc_api_configuration=$<:docs/swagger/ \
222 api/bbsim/bbsim.proto
223
224docs/swagger/leagacy/bbsim.swagger.json: api/legacy/bbsim.proto
225 @protoc -I ./api \
226 -I${GOOGLEAPI}/ \
227 -I${VOLTHA_PROTOS}/protos/ \
228 --swagger_out=logtostderr=true,allow_delete_body=true:docs/swagger/ \
Andrea Campanella64dffd52019-12-17 17:29:57 -0800229 $<