рефакторинг: переезд на GRPC

Author: LeKovr

Makefile

@@ -1,114 +1,148 @@
-## showonce Makefile:
-## show secret once
+## template Makefile:
+## service example
 #:
+
 SHELL          = /bin/sh
-GO            ?= go
 CFG           ?= .env
+PRG            = showonce
 PRG           ?= $(shell basename $$PWD)
+PRG_DEST      ?= $(PRG)
 
-SOURCES        = $(shell find . -maxdepth 3 -mindepth 1 -path ./var -prune -o -name '*.go')
+# -----------------------------------------------------------------------------
+# Build config
 
-# do not include docker-compose.yml from dcape
-# docker-compose can't build docker image if it included
-DCAPE_DC_USED  = false
+GO            ?= go
+GOLANG_VERSION = v1.19.7-alpine3.17.2
 
-VERSION       ?= $(shell git describe --tags --always)
-# Last project tag
-RELEASE       ?= $(shell git describe --tags --abbrev=0)
+SOURCES        = $(shell find . -maxdepth 3 -mindepth 1 -path ./var -prune -o -name '*.go')
+APP_VERSION   ?= $(shell git describe --tags --always)
+# Last project tag (used in `make changelog`)
+RELEASE       ?= $(shell git describe --tags --abbrev=0 --always)
+# Repository address (compiled into main.repo)
+REPO          ?= $(shell git config --get remote.origin.url)
 
-APP_ROOT      ?= .
-APP_SITE      ?= $(PRG).dev.lan
-APP_PROTO     ?= http
+TARGETOS      ?= linux
+TARGETARCH    ?= amd64
+LDFLAGS       := -s -w -extldflags '-static'
 
-IMAGE         ?= $(PRG)
-IMAGE_VER     ?= latest
+OS            ?= linux
+ARCH          ?= amd64
+ALLARCH       ?= "linux/amd64 linux/386 darwin/amd64 linux/arm linux/arm64"
+DIRDIST       ?= dist
 
-AS_TYPE       ?= gitea
-AS_HOST       ?= http://gitea:8080
-AS_TEAM       ?= dcape
-AS_CLIENT_ID  ?= you_should_get_id_from_as
-AS_CLIENT_KEY ?= you_should_get_key_from_as
+# Path to golang package docs
+GODOC_REPO    ?= github.com/!le!kovr/$(PRG)
+# App docker image
+DOCKER_IMAGE  ?= ghcr.io/lekovr/$(PRG)
 
-AS_COOKIE_SIGN_KEY   ?= $(shell < /dev/urandom tr -dc A-Za-z0-9 | head -c32; echo)
-AS_COOKIE_CRYPT_KEY  ?= $(shell < /dev/urandom tr -dc A-Za-z0-9 | head -c32; echo)
+# -----------------------------------------------------------------------------
+# Docker image config
 
 # Hardcoded in docker-compose.yml service name
 DC_SERVICE    ?= app
 
-# docker app for change inside containers
-DOCKER_BIN    ?= docker
-
-# Docker-compose project name (container name prefix)
+#- Docker-compose project name (container name prefix)
 PROJECT_NAME  ?= $(PRG)
 
-# dcape network connect to, must be set in .env
-DCAPE_NET     ?= dcape_default
+# -----------------------------------------------------------------------------
+# App config
 
-# ------------------------------------------------------------------------------
-# .env template (custom part)
-# inserted in .env.sample via 'make config'
-define CONFIG_CUSTOM
-# ------------------------------------------------------------------------------
-# app custom config, generated by make config
+#- Docker container port
+LISTEN        ?= 8080
 
-APP_PROTO=$(APP_PROTO)
+# 
+APP_PROTO     ?= http
 
-AS_TYPE=$(AS_TYPE)
-AS_HOST=$(AS_HOST)
-AS_TEAM=$(AS_TEAM)
-AS_CLIENT_ID=$(AS_CLIENT_ID)
-AS_CLIENT_KEY=$(AS_CLIENT_KEY)
-AS_COOKIE_SIGN_KEY=$(AS_COOKIE_SIGN_KEY)
-AS_COOKIE_CRYPT_KEY=$(AS_COOKIE_CRYPT_KEY)
+#- Auth service type
+AS_TYPE       ?= gitea
+#- Auth service URL
+AS_HOST       ?= https://git.vivo.sb
+#- Auth service org
+AS_TEAM       ?= dcape
+#- Auth service client_id
+AS_CLIENT_ID  ?= you_should_get_id_from_as
+#- Auth service client key
+AS_CLIENT_KEY ?= you_should_get_key_from_as
 
-# dcape network connect to, must be set in .env
-DCAPE_NET=$(DCAPE_NET)
+#- Auth service cookie sign key
+AS_COOKIE_SIGN_KEY   ?= $(shell < /dev/urandom tr -dc A-Za-z0-9 | head -c32; echo)
+#- Auth service cookie crypt key
+AS_COOKIE_CRYPT_KEY  ?= $(shell < /dev/urandom tr -dc A-Za-z0-9 | head -c32; echo)
 
-endef
+# ------------------------------------------------------------------------------
+# Find and include DCAPE/apps/drone/dcape-app/Makefile
+DCAPE_COMPOSE ?= dcape-compose
+DCAPE_ROOT    ?= $(shell docker inspect -f "{{.Config.Labels.dcape_root}}" $(DCAPE_COMPOSE))
+
+ifeq ($(shell test -e $(DCAPE_ROOT)/Makefile.app && echo -n yes),yes)
+  include $(DCAPE_ROOT)/Makefile.app
+endif
+
+-include $(CFG)
+export
 
-.PHONY: dep build run lint test clean
+.PHONY: build build-standalone run fmt lint ci-lint vet test cov-html cov-func cov-total cov-clean changelog
+.PHONY: buildall dist clean docker docker-multi use-own-hub godoc ghcr
 
 # ------------------------------------------------------------------------------
 ## Compile operations
 #:
 
-$(PRG): $(SOURCES)
-	$(GO) build -ldflags "-X main.version=$(VERSION)" ./cmd/$(PRG)
+## Build app
+build: $(PRG_DEST)
 
+$(PRG_DEST): $(SOURCES)
+	GOOS=${TARGETOS} GOARCH=${TARGETARCH} \
+	  $(GO) build -v -o $@ -ldflags \
+	 "${LDFLAGS}-X main.version=$(APP_VERSION) -X main.repo=$(REPO)" \
+	 ./cmd/$(PRG)
+
+## Build like docker image from scratch
+build-standalone: CGO_ENABLED=0
+build-standalone: test
+build-standalone: $(PRG_DEST)
+
+## Build & run app
 run: $(PRG)
-	@echo Open http://$(APP_SITE):8080
-	./$(PRG) --root static --log.debug --as.cookie_name showonce
+	./$(PRG) --log.debug --root=static
 
 ## Format go sources
 fmt:
 	$(GO) fmt ./...
 
-## Run vet
-vet:
-	$(GO) vet ./...
-
-## Run linter
+## Run lint
 lint:
-	golint ./...
+	@which golint > /dev/null || go install golang.org/x/lint/golint@latest
+	@golint ./...
 
-## Run more linters
-lint-more:
-	golangci-lint run ./...
+## Run golangci-lint
+ci-lint:
+	@golangci-lint run ./...
 
-## Run tests
-test: coverage.out
+## Run vet
+vet:
+	@$(GO) vet ./...
 
-## Run tests and fill coverage.out
-cov: coverage.out
+## Run tests
+test: lint vet coverage.out
 
 # internal target
 coverage.out: $(SOURCES)
-	GIN_MODE=release $(GO) test -test.v -test.race -coverprofile=$@ -covermode=atomic ./...
+	#GIN_MODE=release $(GO) test -test.v -test.race -coverprofile=$@ -covermode=atomic ./...
+	GIN_MODE=release $(GO) test -tags test -race -covermode=atomic -coverprofile=$@ ./...
 
 ## Open coverage report in browser
 cov-html: cov
 	$(GO) tool cover -html=coverage.out
 
+## Show code coverage per func
+cov-func: coverage.out
+	$(GO) tool cover -func coverage.out
+
+## Show total code coverage
+cov-total: coverage.out
+	@$(GO) tool cover -func coverage.out | grep total: | awk '{print $$3}'
+
 ## Clean coverage report
 cov-clean:
 	rm -f coverage.*
@@ -120,34 +154,115 @@ changelog:
 	@git log $(RELEASE)..@ --pretty=format:"* %s"
 
 # ------------------------------------------------------------------------------
-## Docker operations
+## GRPC operations
+#:
+
+BUF_IMG ?= ghcr.io/apisite/gogens
+#BUF_IMG ?= buf
+
+## Generate files
+buf-gen:
+	docker run --rm  -v `pwd`:/mnt/pwd -w /mnt/pwd $(BUF_IMG) --debug generate --template buf.gen.yaml --path proto
+
+## Run buf command
+buf-cmd:
+	docker run --rm -it  -v `pwd`:/mnt/pwd -w /mnt/pwd $(BUF_IMG) $(CMD)
+
+## Run sh command
+buf-sh:
+	docker run --rm -it --entrypoint /bin/sh -v `pwd`:/mnt/pwd -w /mnt/pwd $(BUF_IMG) $(CMD)
+
+.PHONY: buf.lock
+
+## Fetch buf.lock
+buf.lock:
+	@id=$$(docker create $(BUF_IMG)) ; \
+	docker cp $$id:/app/$@ $@ ; \
+	docker rm -v $$id
+
+## Generate JS API
+js: static/js/api.js
+
+static/js/api.js: zgen/ts/proto/service.pb.ts
+	docker run --rm  -v `pwd`:/mnt/pwd -w /mnt/pwd --entrypoint /go/bin/esbuild $(BUF_IMG)  \
+	  zgen/ts/proto/service.pb.ts --bundle --outfile=/mnt/pwd/static/js/api.js --global-name=AppAPI
+
+grpc-test:
+	docker run fullstorydev/grpcurl localhost:$(LISTEN) list
+
+# ------------------------------------------------------------------------------
+## Prepare distros
 #:
 
+## build app for all platforms
+buildall: lint vet
+	@echo "*** $@ ***" ; \
+	  for a in "$(ALLARCH)" ; do \
+	    echo "** $${a%/*} $${a#*/}" ; \
+	    P=$(PRG)-$${a%/*}_$${a#*/} ; \
+	    $(MAKE) -s build-standalone TARGETOS=$${a%/*} TARGETARCH=$${a#*/} PRG_DEST=$$P ; \
+	  done
+
+## create disro files
+dist: clean buildall
+	@echo "*** $@ ***"
+	@[ -d $(DIRDIST) ] || mkdir $(DIRDIST)
+	@sha256sum $(PRG)-* > $(DIRDIST)/SHA256SUMS ; \
+	  for a in "$(ALLARCH)" ; do \
+	    echo "** $${a%/*} $${a#*/}" ; \
+	    P=$(PRG)-$${a%/*}_$${a#*/} ; \
+	    zip "$(DIRDIST)/$$P.zip" "$$P" README.md README.ru.md screenshot.png; \
+	    rm "$$P" ; \
+	  done
+
+## clean generated files
+clean:
+	@echo "*** $@ ***" ; \
+	  for a in "$(ALLARCH)" ; do \
+	    P=$(PRG)_$${a%/*}_$${a#*/} ; \
+	    [ -f $$P ] && rm $$P || true ; \
+	  done
+	@[ -d $(DIRDIST) ] && rm -rf $(DIRDIST) || true
+	@[ -f $(PRG) ] && rm -f $(PRG) || true
+	@[ ! -f coverage.out ] || rm coverage.out
+
+# ------------------------------------------------------------------------------
+## Docker build operations
+#:
+
+# build docker image directly
 docker: $(PRG)
 	docker build -t $(PRG) .
 
-# ------------------------------------------------------------------------------
+ALLARCH_DOCKER ?= "linux/arm/v7,linux/arm64"
 
+# build multiarch docker images via buildx
+docker-multi:
+	time docker buildx build --platform $(ALLARCH_DOCKER) -t $(DOCKER_IMAGE):$(APP_VERSION) --push .
 
-## Build docker image
-docker-build: CMD="build --no-cache --force-rm $(DC_SERVICE)"
-docker-build: dc
+OWN_HUB ?= it.elfire.ru
 
-## Remove docker image & temp files
-docker-clean:
-	[ "$$($(DOCKER_BIN) images -q $(DC_IMAGE) 2> /dev/null)" = "" ] || $(DOCKER_BIN) rmi $(DC_IMAGE)
+buildkit.toml:
+	@echo [registry."$(OWN_HUB)"] > $@
+	@echo ca=["/etc/docker/certs.d/$(OWN_HUB)/ca.crt"] >> $@
 
+use-own-hub: buildkit.toml
+	@docker buildx create --use --config $<
 
-clean: ## Remove previous builds
-	@rm -f $(PRG)
+# ------------------------------------------------------------------------------
+## Other
+#:
 
+## update docs at pkg.go.dev
+godoc:
+	vf=$(APP_VERSION) ; v=$${vf%%-*} ; echo "Update for $$v..." ; \
+	curl 'https://proxy.golang.org/$(GODOC_REPO)/@v/'$$v'.info'
+
+## update latest docker image tag at ghcr.io
+ghcr:
+	v=$(APP_VERSION) ; echo "Update for $$v..." ; \
+	docker pull $(DOCKER_IMAGE):$$v && \
+	docker tag $(DOCKER_IMAGE):$$v $(DOCKER_IMAGE):latest && \
+	docker push $(DOCKER_IMAGE):latest
 
 # ------------------------------------------------------------------------------
-# Find and include DCAPE/apps/drone/dcape-app/Makefile
-DCAPE_COMPOSE   ?= dcape-compose
-DCAPE_MAKEFILE  ?= $(shell docker inspect -f "{{.Config.Labels.dcape_app_makefile}}" $(DCAPE_COMPOSE))
-ifeq ($(shell test -e $(DCAPE_MAKEFILE) && echo -n yes),yes)
-  include $(DCAPE_MAKEFILE)
-else
-  include /opt/dcape-app/Makefile
-endif