blob: 130603cd864bcbad15143329e7587f131dbe7d74 [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)
17GIT_STATUS ?= $(shell [[ $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 ?= ""
Matteo Scandolo4747d292019-08-05 11:50:18 -070024
25# Public targets
26
27all: help
28
Matteo Scandolod54283a2019-08-13 16:22:31 -070029protos: api/bbsim/bbsim.pb.go # @HELP Build proto files
Matteo Scandolo4747d292019-08-05 11:50:18 -070030
Matteo Scandolo11006992019-08-28 11:29:46 -070031dep: # @HELP Download the dependencies to the vendor folder
32 GO111MODULE=on go mod vendor
33
Matteo Scandolo40e067f2019-10-16 16:59:41 -070034build: dep protos fmt build-bbsim build-bbsimctl build-bbr # @HELP Build the binary
Matteo Scandolo4747d292019-08-05 11:50:18 -070035
William Kurkianc7966c72019-10-16 14:00:00 -040036test: dep protos fmt # @HELP Execute unit tests
Matteo Scandolo2bf742a2019-10-01 11:33:34 -070037 GO111MODULE=on go test -v -mod vendor ./... -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 -070038 go-junit-report < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml
39 gocover-cobertura < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml
Matteo Scandolo4747d292019-08-05 11:50:18 -070040
Matteo Scandolo38305492019-10-11 11:36:00 -070041fmt:
42 go fmt ./...
43
Matteo Scandolo84f7d482019-08-08 19:00:47 -070044docker-build: # @HELP Build a docker container
Matteo Scandolo82c16d02019-09-24 09:34:32 -070045 docker build -t ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG} -f build/package/Dockerfile .
Matteo Scandolo4747d292019-08-05 11:50:18 -070046
Matteo Scandolo84f7d482019-08-08 19:00:47 -070047docker-push: # @HELP Push a docker container to a registry
Matteo Scandolo4747d292019-08-05 11:50:18 -070048 docker push ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG}
49
Matteo Scandolo4b3fc7e2019-09-17 16:49:54 -070050docker-run: # @HELP Run the container locally (intended for development purposes: DOCKER_RUN_ARGS="-pon 2 -onu 2" make docker-run)
Matteo Scandoloecbd6a12019-10-21 10:51:03 -070051 docker run -d -p 50070:50070 -p 50060:50060 --privileged --rm --name bbsim ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG} /app/bbsim ${DOCKER_RUN_ARGS}
Matteo Scandolo4b3fc7e2019-09-17 16:49:54 -070052
Matteo Scandolo40e067f2019-10-16 16:59:41 -070053.PHONY: docs
Matteo Scandolo9f619492019-10-25 13:11:58 -070054docs: # @HELP Generate docs and opens them in the browser
55 pushd docs; make doc_venv; make html; popd
56 open docs/build/html/index.html
Matteo Scandolo40e067f2019-10-16 16:59:41 -070057
Matteo Scandolo8dea3992019-10-22 10:54:25 -070058# Release related items
59# Generates binaries in $RELEASE_DIR with name $RELEASE_NAME-$RELEASE_OS_ARCH
60# Inspired by: https://github.com/kubernetes/minikube/releases
61RELEASE_DIR ?= release
62RELEASE_OS_ARCH ?= linux-amd64 linux-arm64 windows-amd64 darwin-amd64
63
64RELEASE_BBR_NAME ?= bbr
65RELEASE_BBR_BINS := $(foreach rel,$(RELEASE_OS_ARCH),$(RELEASE_DIR)/$(RELEASE_BBR_NAME)-$(rel))
66RELEASE_BBSIM_NAME ?= bbsimctl
67RELEASE_BBSIM_BINS := $(foreach rel,$(RELEASE_OS_ARCH),$(RELEASE_DIR)/$(RELEASE_BBSIM_NAME)-$(rel))
68
69$(RELEASE_BBR_BINS):
70 export GOOS=$(rel_os) ;\
71 export GOARCH=$(rel_arch) ;\
72 GO111MODULE=on go build -i -v -mod vendor \
73 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
74 -X main.commitHash=$(shell git log --pretty=format:%H -n 1) \
75 -X main.gitStatus=${GIT_STATUS} \
76 -X main.version=${VERSION}" \
77 -o "$@" ./cmd/bbr
78
79$(RELEASE_BBSIM_BINS):
80 export GOOS=$(rel_os) ;\
81 export GOARCH=$(rel_arch) ;\
82 GO111MODULE=on go build -i -v -mod vendor \
83 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
84 -X main.commitHash=$(shell git log --pretty=format:%H -n 1) \
85 -X main.gitStatus=${GIT_STATUS} \
86 -X main.version=${VERSION}" \
87 -o "$@" ./cmd/bbsim
88
89.PHONY: release $(RELEASE_BBR_BINS) $(RELEASE_BBSIM_BINS)
Matteo Scandolofcecd392019-10-24 13:26:20 -070090release: dep protos $(RELEASE_BBR_BINS) $(RELEASE_BBSIM_BINS) # @HELP Release BBSimctl and BBR artifacts
Matteo Scandolo8dea3992019-10-22 10:54:25 -070091
Matteo Scandolo4747d292019-08-05 11:50:18 -070092help: # @HELP Print the command options
93 @echo
94 @echo "\033[0;31m BroadBand Simulator (BBSim) \033[0m"
95 @echo
96 @echo Emulates the control plane of an openolt compatible device
97 @echo Useful for development and scale testing
98 @echo
99 @grep -E '^.*: .* *# *@HELP' $(MAKEFILE_LIST) \
100 | sort \
101 | awk ' \
102 BEGIN {FS = ": .* *# *@HELP"}; \
103 {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}; \
104 '
105
106
107# Internals
Matteo Scandolo8dea3992019-10-22 10:54:25 -0700108
Matteo Scandolo40e067f2019-10-16 16:59:41 -0700109build-bbr:
110 GO111MODULE=on go build -i -v -mod vendor \
111 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
112 -X main.commitHash=$(shell git log --pretty=format:%H -n 1) \
113 -X main.gitStatus=${GIT_STATUS} \
114 -X main.version=${VERSION}" \
115 ./cmd/bbr
116
Matteo Scandolo8df63df2019-09-12 10:34:32 -0700117build-bbsim:
118 GO111MODULE=on go build -i -v -mod vendor \
Matteo Scandolo40e067f2019-10-16 16:59:41 -0700119 -ldflags "-w -X main.buildTime=$(shell date +”%Y/%m/%d-%H:%M:%S”) \
Matteo Scandolo8df63df2019-09-12 10:34:32 -0700120 -X main.commitHash=$(shell git log --pretty=format:%H -n 1) \
121 -X main.gitStatus=${GIT_STATUS} \
122 -X main.version=${VERSION}" \
Matteo Scandolo82c16d02019-09-24 09:34:32 -0700123 ./cmd/bbsim
Matteo Scandolo8df63df2019-09-12 10:34:32 -0700124
125build-bbsimctl:
126 GO111MODULE=on go build -i -v -mod vendor \
Matteo Scandolo40e067f2019-10-16 16:59:41 -0700127 -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 -0700128 -X github.com/opencord/bbsim/internal/bbsimctl/config.CommitHash=$(shell git log --pretty=format:%H -n 1) \
129 -X github.com/opencord/bbsim/internal/bbsimctl/config.GitStatus=${GIT_STATUS} \
130 -X github.com/opencord/bbsim/internal/bbsimctl/config.Version=${VERSION}" \
131 ./cmd/bbsimctl
Matteo Scandolo4747d292019-08-05 11:50:18 -0700132
Matteo Scandolo84f7d482019-08-08 19:00:47 -0700133api/openolt/openolt.pb.go: api/openolt/openolt.proto
134 @protoc -I . \
135 -I${GOPATH}/src \
136 -I${GOPATH}/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
137 --go_out=plugins=grpc:./ \
138 $<
139
140api/bbsim/bbsim.pb.go: api/bbsim/bbsim.proto
Matteo Scandolo4747d292019-08-05 11:50:18 -0700141 @protoc -I . \
142 -I${GOPATH}/src \
143 -I${GOPATH}/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
144 --go_out=plugins=grpc:./ \
145 $<
146