From ab088af2a6aa076bb170500a596e869888f67a2f Mon Sep 17 00:00:00 2001 From: Stephen J Day Date: Thu, 1 Dec 2016 12:04:23 -0800 Subject: [PATCH] cmd, Makefile: add initial build structure This adds Makefile and cmd/protoc-gen-gogoctrd for generating protobufs. More adjustments are required and the default target has been stubbed out for now. Signed-off-by: Stephen J Day --- Makefile | 136 ++++++++++++++++++++++++++++++++ cmd/protoc-gen-gogoctrd/main.go | 27 +++++++ 2 files changed, 163 insertions(+) create mode 100644 Makefile create mode 100644 cmd/protoc-gen-gogoctrd/main.go diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..f00fb78 --- /dev/null +++ b/Makefile @@ -0,0 +1,136 @@ +# Root directory of the project (absolute path). +ROOTDIR=$(dir $(abspath $(lastword $(MAKEFILE_LIST)))) + +# Base path used to install. +DESTDIR=/usr/local + +# Used to populate version variable in main package. +VERSION=$(shell git describe --match 'v[0-9]*' --dirty='.m' --always) + +PROJECT_ROOT=github.com/docker/containerd + +# Project packages. +PACKAGES=$(shell go list ./... | grep -v /vendor/) +INTEGRATION_PACKAGE=${PROJECT_ROOT}/integration + +# Project binaries. +COMMANDS=ctr containerd protoc-gen-gogoctrd +BINARIES=$(addprefix bin/,$(COMMANDS)) + +# TODO(stevvooe): This will set version from git tag, but overrides major, +# minor, patch in the actual file. We'll have to resolve this before release +# time. +GO_LDFLAGS=-ldflags "-X `go list`.Version=$(VERSION)" + +.PHONY: clean all AUTHORS fmt vet lint build binaries test integration setup generate checkprotos coverage ci check help install uninstall +.DEFAULT: default + +dust: + @echo "This Makefile is under construction. Pardon our dust" + +all: check binaries test integration ## run fmt, vet, lint, build the binaries and run the tests + +check: fmt vet lint ineffassign ## run fmt, vet, lint, ineffassign + +ci: check binaries checkprotos coverage coverage-integration ## to be used by the CI + +AUTHORS: .mailmap .git/HEAD + git log --format='%aN <%aE>' | sort -fu > $@ + +setup: ## install dependencies + @echo "🐳 $@" + # TODO(stevvooe): Install these from the vendor directory + @go get -u github.com/golang/lint/golint + #@go get -u github.com/kisielk/errcheck + @go get -u github.com/gordonklaus/ineffassign + +generate: bin/protoc-gen-gogoctrd ## generate protobuf + @echo "🐳 $@" + @PATH=${ROOTDIR}/bin:${PATH} go generate -x ${PACKAGES} + +checkprotos: generate ## check if protobufs needs to be generated again + @echo "🐳 $@" + @test -z "$$(git status --short | grep ".pb.go" | tee /dev/stderr)" || \ + ((git diff | cat) && \ + (echo "👹 please run 'make generate' when making changes to proto files" && false)) + +# Depends on binaries because vet will silently fail if it can't load compiled +# imports +vet: binaries ## run go vet + @echo "🐳 $@" + @test -z "$$(go vet ${PACKAGES} 2>&1 | grep -v 'constant [0-9]* not a string in call to Errorf' | egrep -v '(timestamp_test.go|duration_test.go|exit status 1)' | tee /dev/stderr)" + +fmt: ## run go fmt + @echo "🐳 $@" + @test -z "$$(gofmt -s -l . | grep -v vendor/ | grep -v ".pb.go$$" | tee /dev/stderr)" || \ + (echo "👹 please format Go code with 'gofmt -s -w'" && false) + @test -z "$$(find . -path ./vendor -prune -o ! -name timestamp.proto ! -name duration.proto -name '*.proto' -type f -exec grep -Hn -e "^ " {} \; | tee /dev/stderr)" || \ + (echo "👹 please indent proto files with tabs only" && false) + @test -z "$$(find . -path ./vendor -prune -o -name '*.proto' -type f -exec grep -Hn "id = " {} \; | grep -v gogoproto.customname | tee /dev/stderr)" || \ + (echo "👹 id fields in proto files must have a gogoproto.customname set" && false) + @test -z "$$(find . -path ./vendor -prune -o -name '*.proto' -type f -exec grep -Hn "Meta meta = " {} \; | grep -v '(gogoproto.nullable) = false' | tee /dev/stderr)" || \ + (echo "👹 meta fields in proto files must have option (gogoproto.nullable) = false" && false) + +lint: ## run go lint + @echo "🐳 $@" + @test -z "$$(golint ./... | grep -v vendor/ | grep -v ".pb.go:" | grep -v ".mock.go" | tee /dev/stderr)" + +ineffassign: ## run ineffassign + @echo "🐳 $@" + @test -z "$$(ineffassign . | grep -v vendor/ | grep -v ".pb.go:" | grep -v ".mock.go" | tee /dev/stderr)" + +#errcheck: ## run go errcheck +# @echo "🐳 $@" +# @test -z "$$(errcheck ./... | grep -v vendor/ | grep -v ".pb.go:" | grep -v ".mock.go" | tee /dev/stderr)" + +build: ## build the go packages + @echo "🐳 $@" + @go build -i -tags "${DOCKER_BUILDTAGS}" -v ${GO_LDFLAGS} ${GO_GCFLAGS} ${PACKAGES} + +test: ## run tests, except integration tests + @echo "🐳 $@" + @go test -parallel 8 -race -tags "${DOCKER_BUILDTAGS}" $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES}) + +integration: ## run integration tests + @echo "🐳 $@" + @go test -parallel 8 -race -tags "${DOCKER_BUILDTAGS}" ${INTEGRATION_PACKAGE} + +FORCE: + +# Build a binary from a cmd. +bin/%: cmd/% FORCE + @test $$(go list) = "${PROJECT_ROOT}" || \ + (echo "👹 Please correctly set up your Go build environment. This project must be located at /src/${PROJECT_ROOT}" && false) + @echo "🐳 $@" + @go build -i -tags "${DOCKER_BUILDTAGS}" -o $@ ${GO_LDFLAGS} ${GO_GCFLAGS} ./$< + +binaries: $(BINARIES) ## build binaries + @echo "🐳 $@" + +clean: ## clean up binaries + @echo "🐳 $@" + @rm -f $(BINARIES) + +install: $(BINARIES) ## install binaries + @echo "🐳 $@" + @mkdir -p $(DESTDIR)/bin + @install $(BINARIES) $(DESTDIR)/bin + +uninstall: + @echo "🐳 $@" + @rm -f $(addprefix $(DESTDIR)/bin/,$(notdir $(BINARIES))) + +coverage: ## generate coverprofiles from the unit tests + @echo "🐳 $@" + @( for pkg in $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES}); do \ + go test -i -race -tags "${DOCKER_BUILDTAGS}" -test.short -coverprofile="../../../$$pkg/coverage.txt" -covermode=atomic $$pkg || exit; \ + go test -race -tags "${DOCKER_BUILDTAGS}" -test.short -coverprofile="../../../$$pkg/coverage.txt" -covermode=atomic $$pkg || exit; \ + done ) + +coverage-integration: ## generate coverprofiles from the integration tests + @echo "🐳 $@" + go test -race -tags "${DOCKER_BUILDTAGS}" -test.short -coverprofile="../../../${INTEGRATION_PACKAGE}/coverage.txt" -covermode=atomic ${INTEGRATION_PACKAGE} + +help: ## this help + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort + diff --git a/cmd/protoc-gen-gogoctrd/main.go b/cmd/protoc-gen-gogoctrd/main.go new file mode 100644 index 0000000..370f6ac --- /dev/null +++ b/cmd/protoc-gen-gogoctrd/main.go @@ -0,0 +1,27 @@ +package main + +import ( + "github.com/gogo/protobuf/protoc-gen-gogo/descriptor" + "github.com/gogo/protobuf/vanity" + "github.com/gogo/protobuf/vanity/command" +) + +func main() { + req := command.Read() + files := req.GetProtoFile() + files = vanity.FilterFiles(files, vanity.NotGoogleProtobufDescriptorProto) + for _, opt := range []func(*descriptor.FileDescriptorProto){ + vanity.TurnOnGoStringAll, + vanity.TurnOffGoGettersAll, + vanity.TurnOffGoStringerAll, + vanity.TurnOnMarshalerAll, + vanity.TurnOnStringerAll, + vanity.TurnOnUnmarshalerAll, + vanity.TurnOnSizerAll, + } { + vanity.ForEachFile(files, opt) + } + + resp := command.Generate(req) + command.Write(resp) +}