RepoMirrors/go-ceph
1
0
Fork 0
mirror of https://github.com/ceph/go-ceph synced 2024-12-21 22:00:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
94f1c7b8a4
go-ceph/Makefile
John Mulligan 2390f2c4c2 makefile: add api-promote target 
The intended workflow is to update the Go source code and then run `make
api-promote` which will detect the changes to the ceph_preview tag(s) in
the sources and then promote apis from preview to stable in the
tracking json.

I explicitly do not want apiage.py (or the makefile) to make changes to
the source code. The contributor may or may not want to make changes
incrementally, also some times a preview function may be moved to
another source file. Plus, I simply think this is a job for a human.
But we can avoid having to edit the JSON and markdown files afterward.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-09-12 14:26:35 +00:00

303 lines
8.9 KiB
Makefile
Raw Blame History

CI_IMAGE_NAME ?= go-ceph-ci
CONTAINER_CMD ?=
CONTAINER_OPTS ?= --security-opt $(shell grep -q selinux /sys/kernel/security/lsm 2>/dev/null && echo "label=disable" || echo "apparmor:unconfined")
CONTAINER_BUILD_OPTS ?=
CONTAINER_CONFIG_DIR ?= testing/containers/ceph
VOLUME_FLAGS ?=
CEPH_VERSION ?= pacific
RESULTS_DIR ?=
CHECK_GOFMT_FLAGS ?= -e -s -l
IMPLEMENTS_OPTS ?=
BUILD_TAGS ?= $(CEPH_VERSION)
ifeq ($(CONTAINER_CMD),)
CONTAINER_CMD:=$(shell docker version >/dev/null 2>&1 && echo docker)
endif
ifeq ($(CONTAINER_CMD),)
CONTAINER_CMD:=$(shell podman version >/dev/null 2>&1 && echo podman)
endif
ifeq ($(CEPH_VERSION),nautilus)
CEPH_TAG := v14
endif
ifeq ($(CEPH_VERSION),octopus)
CEPH_TAG := v15
endif
ifeq ($(CEPH_VERSION),pacific)
CEPH_TAG := v16
endif
ifeq ($(CEPH_VERSION),quincy)
CEPH_TAG := v17
endif
# pre-<codename> indicates we want to consume pre-release versions of ceph from
# the ceph ci. This way we can start testing on ceph versions before they hit
# quay.io/ceph/ceph
ifeq ($(CEPH_VERSION),pre-quincy)
CEPH_TAG := quincy
CEPH_IMG := quay.ceph.io/ceph-ci/ceph
GO_CEPH_VERSION := quincy
BUILD_TAGS := quincy,ceph_pre_quincy
endif
ifeq ($(CEPH_VERSION),pre-pacific)
CEPH_TAG := pacific
CEPH_IMG := quay.ceph.io/ceph-ci/ceph
GO_CEPH_VERSION := pacific
BUILD_TAGS := pacific,ceph_pre_pacific
endif
ifeq ($(CEPH_VERSION),main)
CEPH_TAG := main
CEPH_IMG := quay.ceph.io/ceph-ci/ceph
GO_CEPH_VERSION := main
BUILD_TAGS := main,ceph_main
endif
GO_CMD:=go
GOFMT_CMD:=gofmt
# the full name of the marker file including the ceph version
BUILDFILE=.build.$(CEPH_VERSION)
# files marking daemon containers supporting the tests
TEST_CTR_A=.run.test_ceph_a
TEST_CTR_B=.run.test_ceph_b
TEST_CTR_NET=.run.test_ceph_net
# the name of the image plus ceph version as tag
CI_IMAGE_TAG=$(CI_IMAGE_NAME):$(CEPH_VERSION)
ifneq ($(NO_PTRGUARD),)
CONTAINER_OPTS += -e NO_PTRGUARD=true
BUILD_TAGS := $(BUILD_TAGS),no_ptrguard
endif
ifneq ($(NO_PREVIEW),)
CONTAINER_OPTS += -e NO_PREVIEW=true
else
BUILD_TAGS := $(BUILD_TAGS),ceph_preview
endif
CONTAINER_OPTS += -e BUILD_TAGS=$(BUILD_TAGS)
ifneq ($(USE_CACHE),)
GOCACHE_VOLUME := -v test_ceph_go_cache:/go
endif
SELINUX := $(shell getenforce 2>/dev/null)
ifeq ($(SELINUX),Enforcing)
VOLUME_FLAGS = :z
endif
ifdef RESULTS_DIR
RESULTS_VOLUME := -v $(RESULTS_DIR):/results$(VOLUME_FLAGS)
endif
ifneq ($(USE_GOCO),)
GO_CMD:=$(CONTAINER_CMD) run $(CONTAINER_OPTS) --rm $(GOCACHE_VOLUME) -v $(CURDIR):/go/src/github.com/ceph/go-ceph$(VOLUME_FLAGS) --entrypoint $(GO_CMD) $(CI_IMAGE_TAG)
GOFMT_CMD:=$(CONTAINER_CMD) run $(CONTAINER_OPTS) --rm $(GOCACHE_VOLUME) -v $(CURDIR):/go/src/github.com/ceph/go-ceph$(VOLUME_FLAGS) --entrypoint $(GOFMT_CMD) $(CI_IMAGE_TAG)
endif
# Assemble the various build args that will be passed container build command(s)
CONTAINER_BUILD_ARGS:=$(DEFAULT_BUILD_ARGS)
ifdef CEPH_IMG
CONTAINER_BUILD_ARGS += --build-arg CEPH_IMG=$(CEPH_IMG)
endif
ifdef CEPH_TAG
CONTAINER_BUILD_ARGS += --build-arg CEPH_TAG=$(CEPH_TAG)
endif
ifdef GO_CEPH_VERSION
CONTAINER_BUILD_ARGS += --build-arg GO_CEPH_VERSION=$(GO_CEPH_VERSION)
else
CONTAINER_BUILD_ARGS += --build-arg GO_CEPH_VERSION=$(CEPH_VERSION)
endif
build:
$(GO_CMD) build -v -tags $(BUILD_TAGS) $(shell $(GO_CMD) list ./... | grep -v /contrib)
fmt:
$(GO_CMD) fmt ./...
test:
$(GO_CMD) test -v -tags $(BUILD_TAGS) ./...
.PHONY: test-docker test-container test-multi-container
test-docker: test-container
test-container: $(BUILDFILE) $(RESULTS_DIR)
$(CONTAINER_CMD) run $(CONTAINER_OPTS) --rm --hostname test_ceph_aio \
-v $(CURDIR):/go/src/github.com/ceph/go-ceph$(VOLUME_FLAGS) $(RESULTS_VOLUME) $(GOCACHE_VOLUME) \
$(CI_IMAGE_TAG) $(ENTRYPOINT_ARGS)
test-multi-container: $(BUILDFILE) $(RESULTS_DIR)
-$(MAKE) test-containers-kill
-$(MAKE) test-containers-rm-volumes
-$(MAKE) test-containers-rm-network
$(MAKE) test-containers-test
$(MAKE) test-containers-kill
$(MAKE) test-containers-rm-volumes
$(MAKE) test-containers-rm-network
# The test-containers-* cleanup rules:
.PHONY: test-containers-clean \
test-containers-kill \
test-containers-rm-volumes \
test-containers-rm-network
test-containers-clean: test-containers-kill
-$(MAKE) test-containers-rm-volumes
-$(MAKE) test-containers-rm-network
test-containers-kill:
-$(CONTAINER_CMD) kill test_ceph_a || $(CONTAINER_CMD) rm test_ceph_a
-$(CONTAINER_CMD) kill test_ceph_b || $(CONTAINER_CMD) rm test_ceph_b
$(RM) $(TEST_CTR_A) $(TEST_CTR_B)
sleep 0.3
# sometimes the container runtime fails to remove things immediately after
# killing the containers. The short sleep helps avoid hitting that condition.
test-containers-rm-volumes:
$(CONTAINER_CMD) volume remove test_ceph_a_data test_ceph_b_data
test-containers-rm-network:
$(CONTAINER_CMD) network rm test_ceph_net
$(RM) $(TEST_CTR_NET)
# Thest test-containers-* setup rules:
.PHONY: test-containers-network \
test-containers-test_ceph_a \
test-containers-test_ceph_b \
test-containers-test
test-containers-network: $(TEST_CTR_NET)
$(TEST_CTR_NET):
($(CONTAINER_CMD) network ls -q | grep -q test_ceph_net) \
|| $(CONTAINER_CMD) network create test_ceph_net
@echo "test_ceph_net" > $(TEST_CTR_NET)
test-containers-test_ceph_a: $(TEST_CTR_A)
$(TEST_CTR_A): $(TEST_CTR_NET) $(BUILDFILE)
$(CONTAINER_CMD) run $(CONTAINER_OPTS) \
--cidfile=$(TEST_CTR_A) --rm -d --name test_ceph_a \
--hostname test_ceph_a \
--net test_ceph_net \
-v test_ceph_a_data:/tmp/ceph $(CI_IMAGE_TAG) \
--test-run=NONE --pause
test-containers-test_ceph_b: $(TEST_CTR_B)
$(TEST_CTR_B): $(TEST_CTR_NET) $(BUILDFILE)
$(CONTAINER_CMD) run $(CONTAINER_OPTS) \
--cidfile=$(TEST_CTR_B) --rm -d --name test_ceph_b \
--hostname test_ceph_b \
--net test_ceph_net \
-v test_ceph_b_data:/tmp/ceph $(CI_IMAGE_TAG) \
--test-run=NONE --pause
test-containers-test: $(BUILDFILE) $(TEST_CTR_A) $(TEST_CTR_B)
$(CONTAINER_CMD) run $(CONTAINER_OPTS) --rm \
--net test_ceph_net \
-v test_ceph_a_data:/ceph_a \
-v test_ceph_b_data:/ceph_b \
-v $(CURDIR):/go/src/github.com/ceph/go-ceph$(VOLUME_FLAGS) \
$(RESULTS_VOLUME) $(GOCACHE_VOLUME) \
$(CI_IMAGE_TAG) \
--wait-for=/ceph_a/.ready:/ceph_b/.ready \
--mirror-state=/ceph_b/.mstate \
--ceph-conf=/ceph_a/ceph.conf \
--mirror=/ceph_b/ceph.conf $(ENTRYPOINT_ARGS)
ifdef RESULTS_DIR
$(RESULTS_DIR):
mkdir -p $(RESULTS_DIR)
endif
SHELL_SOURCES=entrypoint.sh micro-osd.sh
.PHONY: ci-image
ci-image: $(BUILDFILE)
$(BUILDFILE): $(CONTAINER_CONFIG_DIR)/Dockerfile $(SHELL_SOURCES)
$(CONTAINER_CMD) build \
$(CONTAINER_BUILD_ARGS) \
$(CONTAINER_BUILD_OPTS) \
-t $(CI_IMAGE_TAG) \
-f $(CONTAINER_CONFIG_DIR)/Dockerfile .
@$(CONTAINER_CMD) inspect -f '{{.Id}}' $(CI_IMAGE_TAG) > $(BUILDFILE)
echo $(CEPH_VERSION) >> $(BUILDFILE)
check: check-revive check-format check-shell
check-format:
! $(GOFMT_CMD) $(CHECK_GOFMT_FLAGS) . | sed 's,^,formatting error: ,' | grep 'go$$'
check-revive:
# Configure project's revive checks using .revive.toml
# See: https://github.com/mgechev/revive
revive -config .revive.toml $$(find . -name '*.go')
check-shell:
shellcheck -fgcc $(SHELL_SOURCES)
# Do a quick compile only check of the tests and impliclity the
# library code as well.
test-binaries: \
cephfs.test \
cephfs/admin.test \
common/admin/manager.test \
common/admin/nfs.test \
internal/callbacks.test \
internal/commands.test \
internal/cutil.test \
internal/errutil.test \
internal/retry.test \
rados.test \
rbd.test \
rbd/admin.test
test-bins: test-binaries
%.test: % force_go_build
$(GO_CMD) test -c -tags $(BUILD_TAGS) ./$<
implements:
cd contrib/implements && $(GO_CMD) build -o ../../implements
check-implements: implements
./implements $(IMPLEMENTS_OPTS) cephfs rados rbd
clean-implements:
$(RM) ./implements
api-check: implements-json
./contrib/apiage.py
api-update: implements-json
./contrib/apiage.py --mode=update --placeholder-versions
api-promote: implements-json
./contrib/apiage.py --mode=promote \
--current-tag="$$(git describe --tags --abbrev=0)"
./contrib/apiage.py --mode=write-doc
api-fix-versions:
./contrib/apiage.py --mode=fix-versions \
--current-tag="$$(git describe --tags --abbrev=0)"
./contrib/apiage.py --mode=write-doc
api-doc:
./contrib/apiage.py --mode=write-doc
api-report-updates: $(RESULTS_DIR)
./contrib/apiage.py --mode=find-updates \
--current-tag="$$(git describe --tags --abbrev=0)" \
> $(RESULTS_DIR)/updates-found.json
./contrib/apiage.py --mode=updates-to-markdown \
< $(RESULTS_DIR)/updates-found.json > $(RESULTS_DIR)/updates-found.md
ifeq ($(RESULTS_DIR),)
IMPLEMENTS_DIR:=$(PWD)/_results
else
IMPLEMENTS_DIR:=$(RESULTS_DIR)
endif
implements-json: $(BUILDFILE)
$(MAKE) RESULTS_DIR="$(IMPLEMENTS_DIR)" ENTRYPOINT_ARGS="--test-run=IMPLEMENTS --micro-osd=/bin/true $(ENTRYPOINT_ARGS)" test-container
# force_go_build is phony and builds nothing, can be used for forcing
# go toolchain commands to always run
.PHONY: build fmt test test-docker check test-binaries test-bins force_go_build check-implements clean-implements api-check api-update api-doc implements-json
Reference in New Issue View Git Blame Copy Permalink