Control/Makefile at master · AliceO2Group/Control · GitHub

History

336 lines (264 loc) · 16.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

# === This file is part of ALICE O² ===

# Author: Teo Mrnjavac <teo.mrnjavac@cern.ch>

# Partially derived from Torus Makefile <https://github.com/coreos/torus>

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License

# along with this program. If not, see <http://www.gnu.org/licenses/>.

# In applying this license CERN does not waive the privileges and

# immunities granted to it by virtue of its status as an

# Intergovernmental Organization or submit itself to any jurisdiction.

include VERSION

BUILD := `git rev-parse --short HEAD`

ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))

MINIMUM_SUPPORTED_GO_MAJOR_VERSION = 1

MINIMUM_SUPPORTED_GO_MINOR_VERSION = 20

GO_MAJOR_VERSION = $(shell go version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f1)

GO_MINOR_VERSION = $(shell go version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f2)

WHICH_GO = $(shell which go)

GO_VERSION_VALIDATION_ERR_MSG = Go version $(GO_MAJOR_VERSION).$(GO_MINOR_VERSION) at $(WHICH_GO) is not supported, please update to at least $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION).$(MINIMUM_SUPPORTED_GO_MINOR_VERSION)

HOST_GOOS=$(shell go env GOOS)

HOST_GOARCH=$(shell go env GOARCH)

CGO_LDFLAGS=

BUILD_FLAGS=$(BUILD_ENV_FLAGS)

ifdef WITH_LIBINFOLOGGER

CGO_LDFLAGS=CGO_LDFLAGS="$(ROOT_DIR)/vendor/infoLoggerForGo/infoLoggerForGo.a -static-libstdc++ -static-libgcc"

BUILD_FLAGS=$(CGO_LDFLAGS) $(BUILD_ENV_FLAGS)

endif

REPOPATH = github.com/AliceO2Group/Control

DCS_PROTO="https://gitlab.cern.ch/api/v4/projects/137621/repository/files/proto%2Fdcs.proto/raw?ref=master"

ODC_PROTO="https://raw.githubusercontent.com/FairRootGroup/ODC/master/odc/grpc/odc.proto"

DD_PROTO="https://raw.githubusercontent.com/AliceO2Group/DataDistribution/master/src/DataDistControl/DataDistControl.proto"

BK_COM_PROTO="https://raw.githubusercontent.com/AliceO2Group/Bookkeeping/main/proto/common.proto"

BK_ENV_PROTO="https://raw.githubusercontent.com/AliceO2Group/Bookkeeping/main/proto/environment.proto"

BK_FLP_PROTO="https://raw.githubusercontent.com/AliceO2Group/Bookkeeping/main/proto/flp.proto"

BK_LOG_PROTO="https://raw.githubusercontent.com/AliceO2Group/Bookkeeping/main/proto/log.proto"

BK_RUN_PROTO="https://raw.githubusercontent.com/AliceO2Group/Bookkeeping/main/proto/run.proto"

BK_LHCFILL_PROTO="https://raw.githubusercontent.com/AliceO2Group/Bookkeeping/main/proto/lhcFill.proto"

VERBOSE_1 := -v

VERBOSE_2 := -v -x

WHAT := o2-aliecs-core o2-aliecs-executor coconut peanut o2-apricot

WHAT_o2-aliecs-core_BUILD_FLAGS=$(BUILD_ENV_FLAGS)

WHAT_o2-aliecs-executor_BUILD_FLAGS=$(BUILD_ENV_FLAGS)

WHAT_coconut_BUILD_FLAGS=$(BUILD_ENV_FLAGS)

WHAT_peanut_BUILD_FLAGS=$(BUILD_ENV_FLAGS)

WHAT_o2-apricot_BUILD_FLAGS=$(BUILD_ENV_FLAGS)

INSTALL_WHAT:=$(patsubst %, install_%, $(WHAT))

GENERATE_DIRS := ./apricot ./coconut/cmd ./common ./common/runtype ./common/system ./core ./core/integration/ccdb ./core/integration/dcs ./core/integration/ddsched ./core/integration/kafka ./core/integration/odc ./executor ./core/integration/trg ./core/integration/bookkeeping

SRC_DIRS := ./apricot ./cmd/* ./core ./coconut ./executor ./common ./configuration ./occ/peanut

TEST_DIRS := ./apricot/local ./common/gera ./common/utils ./common/utils/safeacks ./configuration/cfgbackend ./configuration/componentcfg ./configuration/template ./core/task/sm ./core/workflow ./core/integration/odc/fairmq ./core/integration/ccdb ./core/integration ./core/environment

GO_TEST_DIRS := ./core/repos ./core/integration/dcs ./common/monitoring

coverage:COVERAGE_PREFIX := ./coverage_results

coverage:GOTEST_COVERAGE_FILE := $(COVERAGE_PREFIX)/gotest.out

coverage:GOTEST_COVERAGE_FILE_HTML := $(COVERAGE_PREFIX)/gotest.html

# Use linker flags to provide version/build settings to the target

PROD :=-X=$(REPOPATH)/common/product

EXTLDFLAGS :="-static"

LDFLAGS=-ldflags "-extldflags $(EXTLDFLAGS) $(PROD).VERSION_MAJOR=$(VERSION_MAJOR) $(PROD).VERSION_MINOR=$(VERSION_MINOR) $(PROD).VERSION_PATCH=$(VERSION_PATCH) $(PROD).BUILD=$(BUILD)" -tags osusergo,netgo

# To invoke debug build you need to pass DEBUG variable with any value, eg: DEBUG=1 make WHAT=...

ifdef DEBUG

GCFLAGS += -gcflags="all=-N -l"

endif

# We expect to find the protoc-gen-go executable in $GOPATH/bin

GOPATH := $(shell go env GOPATH)

GOPROTOCPATH=$(ROOT_DIR)/tools/protoc-gen-go

HAS_PROTOC := $(shell command -v $(GOPROTOCPATH) 2> /dev/null)

.EXPORT_ALL_VARIABLES:

CGO_ENABLED = 0

.PHONY: build all install generate test debugtest vet fmt clean cleanall help $(WHAT) tools vendor doc docs fdset

build: $(WHAT)

racedetector: validate-go-version

@for target in $(WHAT); do \

echo -e "\033[1;33mCGO_ENABLED=1 go build -race -mod=vendor\033[0m ./cmd/$$target \033[1;33m==>\033[0m \033[1;34m./bin/$$target\033[0m"; \

$(WHAT_$$target_BUILD_FLAGS) CGO_ENABLED=1 go build -race -mod=vendor $(VERBOSE_$(V)) -o bin/$$target $(LDFLAGS) ./cmd/$$target; \

done

all: vendor generate build

validate-go-version: ## Validates the installed version of go against AliECS minimum requirement.

@if [ $(GO_MAJOR_VERSION) -gt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \

exit 0 ;\

elif [ $(GO_MAJOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \

echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\

exit 1; \

elif [ $(GO_MINOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MINOR_VERSION) ] ; then \

echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\

exit 1; \

install: $(INSTALL_WHAT)

# @for w in $(WHAT); do \

# FLAGS="WHAT_$${w}_BUILD_FLAGS"; \

# echo -e "${$${FLAGS}}"; \

# echo -e "\033[1;33mgo install\033[0m ./cmd/$$w \033[1;33m==>\033[0m \033[1;34m$$GOPATH/bin/$$w\033[0m"; \

# $(WHAT_$${w}_BUILD_FLAGS) go install $(VERBOSE_$(V)) $(LDFLAGS) ./cmd/$$w; \

# done

$(WHAT): validate-go-version

# @echo -e "WHAT_$@_BUILD_FLAGS $(WHAT_$@_BUILD_FLAGS)"

@echo -e "\033[1;33mgo build -mod=vendor\033[0m ./cmd/$@ \033[1;33m==>\033[0m \033[1;34m./bin/$@\033[0m"

# @echo ${PWD}

@$(WHAT_$@_BUILD_FLAGS) go build -mod=vendor $(VERBOSE_$(V)) $(GCFLAGS) -o bin/$@ $(LDFLAGS) ./cmd/$@

# special case: if the current WHAT is o2-aliecs-executor, also copy over the shmcleaner script

@if [ $@ = "o2-aliecs-executor" ]; then \

echo -e "\033[1;33mcopy\033[0m ./o2-aliecs-shmcleaner \033[1;33m==>\033[0m \033[1;34m./bin/o2-aliecs-shmcleaner\033[0m"; \

cp o2-aliecs-shmcleaner bin/o2-aliecs-shmcleaner; \

chmod +x bin/o2-aliecs-shmcleaner; \

fi; \

$(INSTALL_WHAT): validate-go-version

# @echo -e "WHAT_$(@:install_%=%)_BUILD_FLAGS $(WHAT_$(@:install_%=%)_BUILD_FLAGS)"

@echo -e "\033[1;33mgo install -mod=vendor\033[0m ./cmd/$(@:install_%=%) \033[1;33m==>\033[0m \033[1;34m$$GOPATH/bin/$(@:install_%=%)\033[0m"

# @echo ${PWD}

@$(WHAT_$(@:install_%=%)_BUILD_FLAGS) go install -mod=vendor $(VERBOSE_$(V)) $(LDFLAGS) ./cmd/$(@:install_%=%)

# special case: if the current WHAT is o2-aliecs-executor, also copy over the shmcleaner script

@if [ $@ = "install_o2-aliecs-executor" ]; then \

echo -e "\033[1;33minstall\033[0m ./o2-aliecs-shmcleaner \033[1;33m==>\033[0m \033[1;34m$$GOPATH/bin/o2-aliecs-shmcleaner\033[0m"; \

cp o2-aliecs-shmcleaner $${GOPATH}/bin/o2-aliecs-shmcleaner; \

chmod +x $${GOPATH}/bin/o2-aliecs-shmcleaner; \

fi; \

generate:

ifndef HAS_PROTOC

$(MAKE) tools/protoc

endif

@if [ -z "$(PROTOBUF_VERSION)" ]; then \

echo "Warning: PROTOBUF_VERSION env var not detected are you sure you are generating from alidist environment?"; \

@for gendir in $(GENERATE_DIRS); do \

echo -e "\033[1;33mgo generate\033[0m $$gendir"; \

PATH="$(ROOT_DIR)/tools:$$PATH" go generate $(VERBOSE_$(V)) $$gendir; \

done

test:

@echo -e "[Ginkgo] \033[1;33mgo test -v\033[0m $(TEST_DIRS)\033[0m"

@$(BUILD_FLAGS) go test -v $(TEST_DIRS) -ginkgo.show-node-events

@echo -e "\n[gotest] \033[1;33mgo test -v\033[0m $(GO_TEST_DIRS)\033[0m"

@$(BUILD_FLAGS) go test -v $(GO_TEST_DIRS)

coverage:

mkdir -p $(COVERAGE_PREFIX)

# -ginkgo.show-node-events is not necessary for coverage as it only increases verbosity of logs

@echo -e "\n[gotest] \033[1;33mgo test -coverprofile=$(GOTEST_COVERAGE_FILE) -v\033[0m $(TEST_DIRS) $(GO_TEST_DIRS)\033[0m"

@$(BUILD_FLAGS) go test -coverprofile=$(GOTEST_COVERAGE_FILE) -v $(TEST_DIRS) $(GO_TEST_DIRS)

@echo -e "\n[gotest] \033[1;33mgo tool cover -html=$(GOTEST_COVERAGE_FILE) -o $(GOTEST_COVERAGE_FILE_HTML)\033[0m"

@go tool cover -html=$(GOTEST_COVERAGE_FILE) -o $(GOTEST_COVERAGE_FILE_HTML)

debugtest:

@echo -e "[Ginkgo] \033[1;33mgo test -v\033[0m $(TEST_DIRS)\033[0m"

@$(BUILD_FLAGS) go test -v $(TEST_DIRS) -ginkgo.v -ginkgo.trace -ginkgo.show-node-events

@echo -e "\n[gotest] \033[1;33mgo test -v\033[0m $(GO_TEST_DIRS)\033[0m"

@$(BUILD_FLAGS) go test -v $(GO_TEST_DIRS)

vet:

go vet $(SRC_DIRS)

fmt:

go fmt $(SRC_DIRS)

clean:

@rm -rf ./bin/*

@echo -e "clean done: \033[1;34mbin\033[0m"

cleanall:

@rm -rf bin tools vendor

@echo -e "clean done: \033[1;34mbin tools vendor\033[0m"

vendor: validate-go-version

@echo -e "\033[1;33mgo mod vendor\033[0m"

@go mod vendor

# curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/scripts%2Frun.sh/raw?ref=master"

@echo -e "\033[1;33mcurl dcs.proto\033[0m"

@mkdir -p core/integration/dcs/protos

@curl --header "PRIVATE-TOKEN: glpat-z-r8s2Mfte8GBpLn7vcE" -s -L $(DCS_PROTO) -o core/integration/dcs/protos/dcs.proto

# FIXME: these two protofiles should be committed in order to be available offline

@echo -e "\033[1;33mcurl odc.proto\033[0m"

@mkdir -p core/integration/odc/protos

@curl -s -L $(ODC_PROTO) -o core/integration/odc/protos/odc.proto

@echo -e "\033[1;33mcurl ddsched.proto\033[0m"

@mkdir -p core/integration/ddsched/protos

@curl -s -L $(DD_PROTO) -o core/integration/ddsched/protos/ddsched.proto

@echo -e "\033[1;33mcurl bkcommon.proto\033[0m"