-
Notifications
You must be signed in to change notification settings - Fork 10
/
Makefile
613 lines (538 loc) · 34.6 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
# ----------------------------------------------------------------------------------------------------------------------
# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
# Licensed under the Universal Permissive License v 1.0 as shown at
# https://oss.oracle.com/licenses/upl.
#
# ----------------------------------------------------------------------------------------------------------------------
# This is the Makefile to build the Coherence Command Line Interface (CLI.
# ----------------------------------------------------------------------------------------------------------------------
# ======================================================================================================================
# Makefile Variables
#
# The following section contains all of the variables and properties used by other targets in the Makefile
# to set things like build directories, version numbers etc.
# ======================================================================================================================
# The version of the CLI being build - this should be a valid SemVer format
VERSION ?= 1.7.2
MILESTONE ?=
SHELL := /bin/bash
# Maven version is always 1.0.0 as it is only for testing
MVN_VERSION ?= 1.0.0
# Coherence CE version to run base tests against
COHERENCE_VERSION ?= 22.06.9
COHERENCE_GROUP_ID ?= com.oracle.coherence.ce
COHERENCE_WKA1 ?= server1
COHERENCE_WKA2 ?= server1
COHERENCE_CLUSTER1 ?= cluster1
COHERENCE_CLUSTER2 ?= cluster1
CLUSTER_PORT ?= 7574
# Profiles to include for building
PROFILES ?=
COHERENCE_BASE_IMAGE ?= gcr.io/distroless/java:11
# WebLogic Server Test Related
WEBLOGIC_SERVER_URL ?= http://127.0.0.1:7001
# ----------------------------------------------------------------------------------------------------------------------
# Options to append to the Maven command
# ----------------------------------------------------------------------------------------------------------------------
MAVEN_OPTIONS ?= -Dmaven.wagon.httpconnectionManager.ttlSeconds=25 -Dmaven.wagon.http.retryHandler.count=3
MAVEN_BUILD_OPTS :=$(USE_MAVEN_SETTINGS) -Drevision=$(MVN_VERSION) -U -B -Dcoherence.version=$(COHERENCE_VERSION) -Dcoherence.group.id=$(COHERENCE_GROUP_ID) $(MAVEN_OPTIONS)
CURRDIR := $(shell pwd)
USER_ID := $(shell echo "`id -u`:`id -g`")
# ----------------------------------------------------------------------------------------------------------------------
# Build output directories
# ----------------------------------------------------------------------------------------------------------------------
override BUILD_OUTPUT := $(CURRDIR)/build/_output
override BUILD_BIN := $(CURRDIR)/bin
override BINARIES_DIR := ./binaries
override BUILD_TARGETS := $(BUILD_OUTPUT)/targets
override TEST_LOGS_DIR := $(BUILD_OUTPUT)/test-logs
override COVERAGE_DIR := $(BUILD_OUTPUT)/coverage
override BUILD_PROPS := $(BUILD_OUTPUT)/build.properties
override BUILD_DOCS := $(BUILD_OUTPUT)/docs-gen
override PKG_DIR := $(BINARIES_DIR)
override INSTALLER_DIR := ./installer
override BUILD_SHARED := $(CURRDIR)/test/test_utils/shared
override ENV_FILE := test/test_utils/.env
override BUILD_CERTS := $(CURRDIR)/test/test_utils/certs
override COPYRIGHT_JAR := glassfish-copyright-maven-plugin-2.4.jar
# ----------------------------------------------------------------------------------------------------------------------
# Set the location of various build tools
# ----------------------------------------------------------------------------------------------------------------------
TOOLS_DIRECTORY = $(CURRDIR)/build/tools
TOOLS_BIN = $(TOOLS_DIRECTORY)/bin
# ----------------------------------------------------------------------------------------------------------------------
# The test application images used in integration tests
# ----------------------------------------------------------------------------------------------------------------------
RELEASE_IMAGE_PREFIX ?= ghcr.io/oracle/
TEST_APPLICATION_IMAGE_1 := $(RELEASE_IMAGE_PREFIX)coherence-cli-test-1:1.0.0
TEST_APPLICATION_IMAGE_2 := $(RELEASE_IMAGE_PREFIX)coherence-cli-test-2:1.0.0
TEST_APPLICATION_IMAGE_3 := $(RELEASE_IMAGE_PREFIX)coherence-cli-test-view-client-1:1.0.0
DOCKER_COMPOSE:=$(shell type -p docker-compose || echo docker compose)
# ----------------------------------------------------------------------------------------------------------------------
# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
# ----------------------------------------------------------------------------------------------------------------------
ifeq (,$(shell go env GOBIN))
GOBIN=$(shell go env GOPATH)/bin
else
GOBIN=$(shell go env GOBIN)
endif
# ----------------------------------------------------------------------------------------------------------------------
# Setting SHELL to bash allows bash commands to be executed by recipes.
# Options are set to exit when a recipe line exits non-zero or a piped command fails.
# ----------------------------------------------------------------------------------------------------------------------
SHELL = /usr/bin/env bash -o pipefail
.SHELLFLAGS = -ec
# ----------------------------------------------------------------------------------------------------------------------
# Capture the Git commit to add to the build information that is then embedded in the Go binary
# ----------------------------------------------------------------------------------------------------------------------
GITCOMMIT ?= $(shell git rev-list -1 HEAD)
GITREPO := https://github.com/oracle/coherence-cli.git
SOURCE_DATE_EPOCH := $(shell git show -s --format=format:%ct HEAD)
DATE_FMT := "%Y-%m-%dT%H:%M:%SZ"
BUILD_DATE := $(shell date -u -d "@$SOURCE_DATE_EPOCH" "+${DATE_FMT}" 2>/dev/null || date -u -r "${SOURCE_DATE_EPOCH}" "+${DATE_FMT}" 2>/dev/null || date -u "+${DATE_FMT}")
BUILD_USER := $(shell whoami)
LDFLAGS = -X main.Version=$(VERSION)$(MILESTONE) -X main.Commit=$(GITCOMMIT) -X main.Date=$(BUILD_DATE) -X main.Author=$(BUILD_USER)
GOS = $(shell find . -type f -name "*.go" ! -name "*_test.go")
GO_TEST_FLAGS ?= -timeout 20m
# ----------------------------------------------------------------------------------------------------------------------
# Release build options
# ----------------------------------------------------------------------------------------------------------------------
RELEASE_DRY_RUN ?= true
# ======================================================================================================================
# Makefile targets start here
# ======================================================================================================================
# ----------------------------------------------------------------------------------------------------------------------
# Display the Makefile help - this is a list of the targets with a description.
# This target MUST be the first target in the Makefile so that it is run when running make with no arguments
# ----------------------------------------------------------------------------------------------------------------------
help: ## Display this help.
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-25s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
# ======================================================================================================================
# Build targets
# ======================================================================================================================
##@ Build
.PHONY: all
all: clean cohctl-all ## Build all the Coherence CLI artefacts
# ----------------------------------------------------------------------------------------------------------------------
# Build the Java artifacts
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: build-mvn
build-mvn: ## Build the Java artefacts
ifeq ($(PROFILES),,commercial)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P commercial
else ifeq ($(PROFILES),,federation)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P federation
else ifeq ($(PROFILES),,topics)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P topics
else ifeq ($(PROFILES),,views)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P views
else ifeq ($(PROFILES),,topics-commercial)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P topics-commercial
else
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests
endif
# ----------------------------------------------------------------------------------------------------------------------
# Clean-up all of the build artifacts
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: clean
clean: ## Cleans the build
@echo "Cleaning Project"
-rm -rf build/_output
-rm -rf bin
-rm -rf $(BUILD_SHARED)
-rm -rf $(BUILD_CERTS)
@mkdir -p $(BUILD_CERTS)
ifeq ($(PROFILES),,commercial)
mvn -B -f java clean -DskipTests $(MAVEN_BUILD_OPTS) -P commercial
else ifeq ($(PROFILES),,federation)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P federation
else ifeq ($(PROFILES),,topics)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P topics
else ifeq ($(PROFILES),,views)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P views
else ifeq ($(PROFILES),,topics-commercial)
mvn -B -f java $(MAVEN_BUILD_OPTS) clean install -DskipTests -P topics-commercial
else
mvn -B -f java clean install -DskipTests $(MAVEN_BUILD_OPTS)
endif
@mkdir -p $(TEST_LOGS_DIR)
@mkdir -p $(COVERAGE_DIR)
# ----------------------------------------------------------------------------------------------------------------------
# Configure the build properties
# ----------------------------------------------------------------------------------------------------------------------
$(BUILD_PROPS):
@echo "Creating build directories"
@mkdir -p $(BUILD_OUTPUT)
@mkdir -p $(BUILD_BIN)
@mkdir -p $(BUILD_TARGETS)
@mkdir -p $(TEST_LOGS_DIR)
@mkdir -p $(TOOLS_BIN)
@mkdir -p $(COVERAGE_DIR)
@mkdir -p $(BUILD_SHARED)
.PHONY: certs
certs: ## Generates certificates for TLS tests
@echo "Generating certs"
./scripts/keys.sh $(BUILD_CERTS)
# ----------------------------------------------------------------------------------------------------------------------
# Build the Coherence CLI Test Image
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: build-federation-images
build-federation-images: ## Build the Test images for federation
@echo "${MAVEN_BUILD_OPTS}"
@ ./scripts/check_image.sh $(COHERENCE_BASE_IMAGE)
mvn -f java/coherence-cli-test clean package jib:dockerBuild -DskipTests -P federation1$(PROFILES) -Djib.to.image=$(TEST_APPLICATION_IMAGE_1) -Dcoherence.test.base.image=$(COHERENCE_BASE_IMAGE) $(MAVEN_BUILD_OPTS)
mvn -f java/coherence-cli-test clean package jib:dockerBuild -DskipTests -P federation2$(PROFILES) -Djib.to.image=$(TEST_APPLICATION_IMAGE_2) -Dcoherence.test.base.image=$(COHERENCE_BASE_IMAGE) $(MAVEN_BUILD_OPTS)
echo "COHERENCE_IMAGE1=$(TEST_APPLICATION_IMAGE_1)" > $(ENV_FILE)
echo "COHERENCE_IMAGE2=$(TEST_APPLICATION_IMAGE_2)" >> $(ENV_FILE)
echo "CURRENT_UID=$(USER_ID)" >> $(ENV_FILE)
# ----------------------------------------------------------------------------------------------------------------------
# Build the Coherence CLI Test Image
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: build-test-images
build-test-images: ## Build the Test images
@echo "${MAVEN_BUILD_OPTS}"
@ ./scripts/check_image.sh $(COHERENCE_BASE_IMAGE)
mvn -f java/coherence-cli-test -nsu clean package jib:dockerBuild -DskipTests -P member1$(PROFILES) -Djib.to.image=$(TEST_APPLICATION_IMAGE_1) -Dcoherence.test.base.image=$(COHERENCE_BASE_IMAGE) $(MAVEN_BUILD_OPTS)
mvn -f java/coherence-cli-test -nsu clean package jib:dockerBuild -DskipTests -P member2$(PROFILES) -Djib.to.image=$(TEST_APPLICATION_IMAGE_2) -Dcoherence.test.base.image=$(COHERENCE_BASE_IMAGE) $(MAVEN_BUILD_OPTS)
echo "COHERENCE_IMAGE1=$(TEST_APPLICATION_IMAGE_1)" > $(ENV_FILE)
echo "COHERENCE_IMAGE2=$(TEST_APPLICATION_IMAGE_2)" >> $(ENV_FILE)
echo "CURRENT_UID=$(USER_ID)" >> $(ENV_FILE)
# ----------------------------------------------------------------------------------------------------------------------
# Build the Coherence CLI View Cache images
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: build-view-images
build-view-images: ## Build the view cache test images
@echo "${MAVEN_BUILD_OPTS}"
@ ./scripts/check_image.sh $(COHERENCE_BASE_IMAGE)
mvn -f java/coherence-cli-test -nsu clean package jib:dockerBuild -DskipTests -P member1$(PROFILES) -Djib.to.image=$(TEST_APPLICATION_IMAGE_1) -Dcoherence.test.base.image=$(COHERENCE_BASE_IMAGE) $(MAVEN_BUILD_OPTS)
mvn -f java/coherence-cli-test -nsu clean package jib:dockerBuild -DskipTests -P member2$(PROFILES) -Djib.to.image=$(TEST_APPLICATION_IMAGE_2) -Dcoherence.test.base.image=$(COHERENCE_BASE_IMAGE) $(MAVEN_BUILD_OPTS)
mvn -f java/coherence-cli-test -nsu clean package jib:dockerBuild -DskipTests -P view1$(PROFILES) -Djib.to.image=$(TEST_APPLICATION_IMAGE_3) -Dcoherence.test.base.image=$(COHERENCE_BASE_IMAGE) $(MAVEN_BUILD_OPTS)
echo "COHERENCE_IMAGE1=$(TEST_APPLICATION_IMAGE_1)" > $(ENV_FILE)
echo "COHERENCE_IMAGE2=$(TEST_APPLICATION_IMAGE_2)" >> $(ENV_FILE)
echo "COHERENCE_IMAGE3=$(TEST_APPLICATION_IMAGE_3)" >> $(ENV_FILE)
echo "CURRENT_UID=$(USER_ID)" >> $(ENV_FILE)
# ----------------------------------------------------------------------------------------------------------------------
# Internal make step that builds the Coherence CLI for local platform
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: cohctl
cohctl: $(BUILD_BIN)/cohctl-local ## Build the Coherence CLI binary for the local platform
# ----------------------------------------------------------------------------------------------------------------------
# Internal make step that builds the Coherence CLI
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: cohctl-all
cohctl-all: $(BUILD_PROPS) $(GOS) ## Build the Coherence CLI binary for all supported platforms
@echo "Building Coherence CLI for all supported platforms"
@echo "Linux amd64 (x64)"
mkdir -p $(BUILD_BIN)/linux/amd64 || true
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -o $(BUILD_BIN)/linux/amd64/cohctl ./cohctl
@echo "Linux arm64"
mkdir -p $(BUILD_BIN)/linux/arm64 || true
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -a -o $(BUILD_BIN)/linux/arm64/cohctl ./cohctl
@echo "Linux i386"
mkdir -p $(BUILD_BIN)/linux/386 || true
CGO_ENABLED=0 GOOS=linux GOARCH=386 GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -a -o $(BUILD_BIN)/linux/386/cohctl ./cohctl
@echo "Windows amd64 (x64)"
mkdir -p $(BUILD_BIN)/windows/amd64 || true
CGO_ENABLED=0 GOOS=windows GOARCH=amd64 GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -a -o $(BUILD_BIN)/windows/amd64/cohctl.exe ./cohctl
@echo "Windows arm"
mkdir -p $(BUILD_BIN)/windows/arm || true
CGO_ENABLED=0 GOOS=windows GOARCH=arm GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -a -o $(BUILD_BIN)/windows/arm/cohctl.exe ./cohctl
make cohctl-mac-amd cohctl-mac-arm
# ----------------------------------------------------------------------------------------------------------------------
# Internal make step that builds the Coherence CLI for Mac AMD
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: cohctl-mac-amd
cohctl-mac-amd: $(BUILD_PROPS) $(GOS) ## Build the Coherence CLI binary for Mac AMD
@echo "Apple amd64 (x64)"
mkdir -p $(BUILD_BIN)/darwin/amd64 || true
CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -a -o $(BUILD_BIN)/darwin/amd64/cohctl ./cohctl
# ----------------------------------------------------------------------------------------------------------------------
# Internal make step that builds the Coherence CLI for lMac ARM
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: cohctl-mac-arm
cohctl-mac-arm: $(BUILD_PROPS) $(GOS) ## Build the Coherence CLI binary for Mac ARM
@echo "Apple Silicon (M1)"
mkdir -p $(BUILD_BIN)/darwin/arm64 || true
CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -a -o $(BUILD_BIN)/darwin/arm64/cohctl ./cohctl
# ----------------------------------------------------------------------------------------------------------------------
# Build a MacOS Package
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: mac-pkg
mac-pkg: ## Make a MacOS Package
@echo "Making MacOS Package"
@mkdir -p $(BUILD_BIN)/pkg
@cp $(BUILD_BIN)/cohctl $(BUILD_BIN)/pkg
@chmod 755 $(BUILD_BIN)/cohctl
sudo pkgbuild --ownership preserve --install-location /usr/local/bin --version $(VERSION)$(MILESTONE) --root $(BUILD_BIN)/pkg --identifier com.oracle.coherence.cohctl $(PKG_DIR)/cohctl-$(VERSION).pkg
$(BUILD_BIN)/cohctl-local: $(BUILD_PROPS) $(GOS)
@echo "Building Coherence CLI for local platform"
CGO_ENABLED=0 GO111MODULE=on go build -trimpath -ldflags "$(LDFLAGS)" -o $(BUILD_BIN)/cohctl ./cohctl
# ----------------------------------------------------------------------------------------------------------------------
# Generate output to be included into the commands reference documentation
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: generate-docs
generate-docs: cohctl ## Generate Doc Snippets
@echo "Generating Doc Snippets"
./scripts/generate-doc-snippets.sh $(BUILD_DOCS) $(BUILD_BIN)
# ----------------------------------------------------------------------------------------------------------------------
# Build the documentation.
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: docs
docs: generate-docs ## Build the Documentation
mvn -B -f java install -P docs -pl docs -DskipTests -Dcli.version=$(VERSION)$(MILESTONE) -Dcoherence.version=$(COHERENCE_VERSION) $(MAVEN_OPTIONS)
mkdir -p $(BUILD_OUTPUT)/docs/images/images
cp -R docs/images/* build/_output/docs/images/
# ----------------------------------------------------------------------------------------------------------------------
# Start a local web server to serve the documentation.
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: serve-docs
serve-docs: ## Serve the Documentation
@echo "Serving documentation on http://localhost:8888"
cd $(BUILD_OUTPUT)/docs; \
python -m SimpleHTTPServer 8888
# ======================================================================================================================
# General development related targets
# ======================================================================================================================
##@ Development
# ----------------------------------------------------------------------------------------------------------------------
# Performs a copyright check.
# To add exclusions add the file or folder pattern using the -X parameter.
# Add directories to be scanned at the end of the parameter list.
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: copyright
copyright: getcopyright ## Check copyright headers
@java -cp scripts/$(COPYRIGHT_JAR) \
org.glassfish.copyright.Copyright -C scripts/copyright.txt \
-X bin/ \
-X ./test/test_utils/shared/ \
-X ./test/test_utils/certs/ \
-X ./test/test_utils/test_utils.go \
-X dependency-reduced-pom.xml \
-X binaries/ \
-X build/ \
-X /Dockerfile \
-X .Dockerfile \
-X go.sum \
-X HEADER.txt \
-X .iml \
-X .jar \
-X jib-cache/ \
-X .jks \
-X .json \
-X LICENSE.txt \
-X Makefile \
-X cohctl-terminal.gif \
-X .md \
-X .mvn/ \
-X mvnw \
-X mvnw.cmd \
-X .png \
-X .sh \
-X temp/ \
-X /test-report.xml \
-X THIRD_PARTY_LICENSES.txt \
-X .tpl \
-X .txt \
-X pkg/data/assets/ \
-X pkg/cmd/proc_windows.go \
-X pkg/cmd/proc_other.go
# ----------------------------------------------------------------------------------------------------------------------
# Executes golangci-lint to perform various code review checks on the source.
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: golangci
golangci: $(TOOLS_BIN)/golangci-lint ## Go code review
$(TOOLS_BIN)/golangci-lint run -v --timeout=5m --max-same-issues 20 ./pkg/...
# ======================================================================================================================
# Miscellaneous targets
# ======================================================================================================================
##@ Miscellaneous
.PHONY: trivy-scan
trivy-scan: gettrivy ## Scan the CLI using trivy
$(TOOLS_BIN)/trivy fs --exit-code 1 .
# ======================================================================================================================
# Test targets
# ======================================================================================================================
##@ Test
# ----------------------------------------------------------------------------------------------------------------------
# Startup cluster members via docker compose
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-cluster-startup
test-cluster-startup: $(BUILD_PROPS) ## Startup any test cluster members using docker-compose
cd test/test_utils && $(DOCKER_COMPOSE) -f docker-compose-2-members.yaml --env-file .env up -d
# ----------------------------------------------------------------------------------------------------------------------
# Shutdown any cluster members via docker compose
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-cluster-shutdown
test-cluster-shutdown: ## Shutdown any test cluster members using docker-compose
cd test/test_utils && $(DOCKER_COMPOSE) -f docker-compose-2-members.yaml down || true
# ----------------------------------------------------------------------------------------------------------------------
# Startup view cluster members via docker compose
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-cluster-startup-views
test-cluster-startup-views: $(BUILD_PROPS) ## Startup any test cluster members using docker-compose
cd test/test_utils && $(DOCKER_COMPOSE) -f docker-compose-3-members.yaml --env-file .env up -d
# ----------------------------------------------------------------------------------------------------------------------
# Shutdown view cluster members via docker compose
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-cluster-shutdown-views
test-cluster-shutdown-views: ## Shutdown any test cluster members using docker-compose
cd test/test_utils && $(DOCKER_COMPOSE) -f docker-compose-3-members.yaml down || true
# ----------------------------------------------------------------------------------------------------------------------
# Startup standalone coherence via java -jar
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-coherence-startup
test-coherence-startup: $(BUILD_PROPS) ## Startup standalone cluster
scripts/startup-clusters.sh $(TEST_LOGS_DIR) $(CLUSTER_PORT) $(COHERENCE_GROUP_ID) ${COHERENCE_VERSION}
@echo "Clusters started up"
# ----------------------------------------------------------------------------------------------------------------------
# Shutdown coherence via java -jar
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-coherence-shutdown
test-coherence-shutdown: ## shutdown standalone cluster
@ps -ef | grep shutMeDownPlease | grep -v grep | awk '{print $$2}' | xargs kill -9 || true
@echo "Clusters shutdown"
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go unit tests
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-cohctl
test-cohctl: test-clean gotestsum $(BUILD_PROPS) ## Run the CLI unit tests
@echo "Running Coherence CLI tests"
CGO_ENABLED=0 $(GOTESTSUM) --format testname --junitfile $(TEST_LOGS_DIR)/cohctl-test.xml \
-- $(GO_TEST_FLAGS) -v -coverprofile=$(COVERAGE_DIR)/cover-unit.out ./pkg/cmd/... ./pkg/utils/...
go tool cover -html=$(COVERAGE_DIR)/cover-unit.out -o $(COVERAGE_DIR)/cover-unit.html
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go end to end tests for standalone Coherence
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-e2e-standalone
test-e2e-standalone: test-clean gotestsum $(BUILD_PROPS) ## Run e2e tests with Coherence
CGO_ENABLED=0 $(GOTESTSUM) --format testname --junitfile $(TEST_LOGS_DIR)/cohctl-test-e2e-standalone.xml \
-- $(GO_TEST_FLAGS) -v ./test/e2e/standalone/...
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go end to end tests for Topics
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-e2e-topics
test-e2e-topics: test-clean gotestsum $(BUILD_PROPS) ## Run e2e tests with Coherence against topics
CGO_ENABLED=0 $(GOTESTSUM) --format testname --junitfile $(TEST_LOGS_DIR)/cohctl-test-e2e-topics.xml \
-- $(GO_TEST_FLAGS) -v ./test/e2e/topics/...
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go end to end tests for view caches
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-e2e-views
test-e2e-views: test-clean gotestsum $(BUILD_PROPS) ## Run e2e tests with Coherence against view caches
CGO_ENABLED=0 $(GOTESTSUM) --format testname --junitfile $(TEST_LOGS_DIR)/cohctl-test-e2e-views.xml \
-- $(GO_TEST_FLAGS) -v ./test/e2e/views/...
# ----------------------------------------------------------------------------------------------------------------------
# Executes tests against an already running WebLogic Server
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-weblogic
test-weblogic: test-clean cohctl $(BUILD_PROPS) ## Run tests against WebLogic Server
./scripts/test-weblogic.sh $(WEBLOGIC_SERVER_URL)
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go end to end tests for federation and Coherence
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-e2e-federation
test-e2e-federation: test-clean gotestsum $(BUILD_PROPS) ## Run e2e federation tests with Coherence
CGO_ENABLED=0 $(GOTESTSUM) --format testname --junitfile $(TEST_LOGS_DIR)/cohctl-test-e2e-federation.xml \
-- $(GO_TEST_FLAGS) -v ./test/e2e/federation/...
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go discovery tests for standalone Coherence
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-discovery
test-discovery: test-clean gotestsum $(BUILD_PROPS) ## Run Discovery tests with Coherence
make test-coherence-shutdown || true
make test-coherence-startup
CGO_ENABLED=0 $(GOTESTSUM) --format testname --junitfile $(TEST_LOGS_DIR)/cohctl-test-discovery.xml \
-- $(GO_TEST_FLAGS) -v ./test/e2e/discovery/...
make test-coherence-shutdown
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go create cluster tests for standalone Coherence
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-create-cluster
test-create-cluster: test-clean gotestsum $(BUILD_PROPS) ## Run create cluster tests
./scripts/test-create-cluster.sh $(COHERENCE_VERSION)
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go monitor cluster tests for standalone Coherence
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-monitor-cluster
test-monitor-cluster: test-clean gotestsum $(BUILD_PROPS) ## Run monitor cluster tests
./scripts/test-monitor-cluster.sh $(COHERENCE_VERSION)
# ----------------------------------------------------------------------------------------------------------------------
# Executes the Go end to end tests and unit tests for standalone Coherence with coverage
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-coverage
test-coverage: test-clean gotestsum $(BUILD_PROPS) ## Run e2e tests with Coherence
make test-coherence-shutdown || true
make test-coherence-startup
CGO_ENABLED=0 $(GOTESTSUM) --format testname --junitfile $(TEST_LOGS_DIR)/cohctl-test-e2e.xml \
-- $(GO_TEST_FLAGS) -v -coverprofile=$(COVERAGE_DIR)/cover-full.out -coverpkg=./pkg/cmd,./pkg/discovery,./pkg/fetcher,./pkg/utils ./pkg/cmd/... ./pkg/discovery/... ./test/e2e/standalone/...
go tool cover -html=$(COVERAGE_DIR)/cover-full.out -o $(COVERAGE_DIR)/cover-full.html
go tool cover -func $(COVERAGE_DIR)/cover-full.out
make test-coherence-shutdown
# ----------------------------------------------------------------------------------------------------------------------
# Test the documentation.
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-docs
test-docs: docs ## Test doc links
go run ./utils/linkcheck/main.go --file $(BUILD_OUTPUT)/docs/pages/... \
--exclude 'http://proxyserver' \
--exclude 'https://<host>:<management-port>/management/coherence/cluster' \
--exclude 'http://<pod-ip' \
--exclude 'http://elasticsearch-master' \
--exclude 'http://host' \
--exclude 'https://goessner.net/articles/JsonPath' \
--exclude 'https://oracle.github.io/coherence-operator/docs/latest/' \
--exclude 'https://github.com/oracle/coherence-cli/releases/download/' \
2>&1 | tee $(TEST_LOGS_DIR)/doc-link-check.log
# ----------------------------------------------------------------------------------------------------------------------
# Release the Coherence Operator to the gh-pages branch.
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: release-ghpages
release-ghpages:
./scripts/release-ghpages.sh $(VERSION)$(MILESTONE) $(BUILD_OUTPUT)
# ----------------------------------------------------------------------------------------------------------------------
# Cleans the test cache
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: test-clean
test-clean: gotestsum ## Clean the go test cache
@echo "Cleaning test cache"
go clean -testcache
# ----------------------------------------------------------------------------------------------------------------------
# Obtain the golangci-lint binary
# ----------------------------------------------------------------------------------------------------------------------
$(TOOLS_BIN)/golangci-lint:
@mkdir -p $(TOOLS_BIN)
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(TOOLS_BIN) v1.59.1
# ----------------------------------------------------------------------------------------------------------------------
# Find or download gotestsum
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: gotestsum
GOTESTSUM = $(TOOLS_BIN)/gotestsum
gotestsum: ## Download gotestsum locally if necessary.
GOBIN=`pwd`/build/tools/bin go install gotest.tools/[email protected]
# ----------------------------------------------------------------------------------------------------------------------
# Find or download copyright
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: getcopyright
getcopyright: ## Download copyright jar locally if necessary.
@test -f scripts/$(COPYRIGHT_JAR) || curl -o scripts/$(COPYRIGHT_JAR) \
https://repo.maven.apache.org/maven2/org/glassfish/copyright/glassfish-copyright-maven-plugin/2.4/glassfish-copyright-maven-plugin-2.4.jar
# ----------------------------------------------------------------------------------------------------------------------
# Find or download trivy
# ----------------------------------------------------------------------------------------------------------------------
.PHONY: gettrivy
gettrivy:
@mkdir -p $(TOOLS_BIN)
curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b $(TOOLS_BIN) v0.51.2
# go-get-tool will 'go get' any package $2 and install it to $1.
PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
define go-get-tool
@[ -f $(1) ] || { \
set -e ;\
TMP_DIR=$$(mktemp -d) ;\
cd $$TMP_DIR ;\
go mod init tmp ;\
echo "Downloading $(2) into $(TOOLS_BIN)" ;\
GOBIN=$(TOOLS_BIN) go get $(2) ;\
rm -rf $$TMP_DIR ;\
}
endef