This pull request aims to make it possible to generate, format, and lint the protos within this repo. To accomplish that end, the Dockerfile containing common tools for building the tendermint protos has been moved into this repository and several accompanying changes were made to streamline the proto generation process.pull/7804/head
@ -0,0 +1,11 @@ | |||
--- | |||
Language: Proto | |||
BasedOnStyle: Google | |||
IndentWidth: 2 | |||
ColumnLimit: 0 | |||
AlignConsecutiveAssignments: true | |||
AlignConsecutiveDeclarations: true | |||
SpacesInSquareBrackets: true | |||
ReflowComments: true | |||
SortIncludes: true | |||
SortUsingDeclarations: true |
@ -0,0 +1,24 @@ | |||
name: Proto Check | |||
# Protobuf runs buf (https://buf.build/) lint and check-breakage | |||
# This workflow is only run when a file in the proto directory | |||
# has been modified. | |||
on: | |||
workflow_dispatch: # allow running workflow manually | |||
pull_request: | |||
paths: | |||
- "proto/*" | |||
jobs: | |||
proto-lint: | |||
runs-on: ubuntu-latest | |||
timeout-minutes: 4 | |||
steps: | |||
- uses: actions/checkout@v2.4.0 | |||
- name: lint | |||
run: make proto-lint | |||
proto-breakage: | |||
runs-on: ubuntu-latest | |||
timeout-minutes: 4 | |||
steps: | |||
- uses: actions/checkout@v2.4.0 | |||
- name: check-breakage | |||
run: make proto-check-breaking-ci |
@ -0,0 +1,60 @@ | |||
# This workflow (re)builds and pushes a Docker image containing the | |||
# protobuf build tools used by the other workflows. | |||
# | |||
# When making changes that require updates to the builder image, you | |||
# should merge the updates first and wait for this workflow to complete, | |||
# so that the changes will be available for the dependent workflows. | |||
# | |||
# TODO(#7272): Update the target location of the builder image. | |||
name: Build & Push TM Proto Builder | |||
on: | |||
pull_request: | |||
paths: | |||
- "proto/*" | |||
push: | |||
branches: | |||
- master | |||
paths: | |||
- "proto/*" | |||
schedule: | |||
# run this job once a month to recieve any go or buf updates | |||
- cron: "* * 1 * *" | |||
jobs: | |||
build: | |||
runs-on: ubuntu-latest | |||
steps: | |||
- uses: actions/checkout@v2.4.0 | |||
- name: Prepare | |||
id: prep | |||
run: | | |||
DOCKER_IMAGE=tendermintdev/docker-build-proto | |||
VERSION=noop | |||
if [[ $GITHUB_REF == refs/tags/* ]]; then | |||
VERSION=${GITHUB_REF#refs/tags/} | |||
elif [[ $GITHUB_REF == refs/heads/* ]]; then | |||
VERSION=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's#/+#-#g') | |||
if [ "${{ github.event.repository.default_branch }}" = "$VERSION" ]; then | |||
VERSION=latest | |||
fi | |||
fi | |||
TAGS="${DOCKER_IMAGE}:${VERSION}" | |||
echo ::set-output name=tags::${TAGS} | |||
- name: Set up Docker Buildx | |||
uses: docker/setup-buildx-action@v1.6.0 | |||
- name: Login to DockerHub | |||
uses: docker/login-action@v1.10.0 | |||
with: | |||
username: ${{ secrets.DOCKERHUB_USERNAME }} | |||
password: ${{ secrets.DOCKERHUB_TOKEN }} | |||
- name: Publish to Docker Hub | |||
uses: docker/build-push-action@v2.7.0 | |||
with: | |||
context: ./proto | |||
file: ./proto/Dockerfile | |||
push: ${{ github.event_name != 'pull_request' }} | |||
tags: ${{ steps.prep.outputs.tags }} |
@ -0,0 +1,31 @@ | |||
DOCKER_PROTO_BUILDER := docker run -v $(shell pwd):/workspace --workdir /workspace tendermintdev/docker-build-proto | |||
HTTPS_GIT := https://github.com/tendermint/spec.git | |||
############################################################################### | |||
### Protobuf ### | |||
############################################################################### | |||
proto-all: proto-lint proto-check-breaking | |||
.PHONY: proto-all | |||
proto-gen: | |||
@echo "Generating Protobuf files" | |||
@$(DOCKER_PROTO_BUILDER) buf generate --template=./buf.gen.yaml --config ./buf.yaml | |||
.PHONY: proto-gen | |||
proto-lint: | |||
@$(DOCKER_PROTO_BUILDER) buf lint --error-format=json --config ./buf.yaml | |||
.PHONY: proto-lint | |||
proto-format: | |||
@echo "Formatting Protobuf files" | |||
@$(DOCKER_PROTO_BUILDER) find . -name '*.proto' -path "./proto/*" -exec clang-format -i {} \; | |||
.PHONY: proto-format | |||
proto-check-breaking: | |||
@$(DOCKER_PROTO_BUILDER) buf breaking --against .git --config ./buf.yaml | |||
.PHONY: proto-check-breaking | |||
proto-check-breaking-ci: | |||
@$(DOCKER_PROTO_BUILDER) buf breaking --against $(HTTPS_GIT) --config ./buf.yaml | |||
.PHONY: proto-check-breaking-ci |
@ -0,0 +1,14 @@ | |||
# The version of the generation template (required). | |||
# The only currently-valid value is v1beta1. | |||
version: v1beta1 | |||
# The plugins to run. | |||
plugins: | |||
# The name of the plugin. | |||
- name: gogofaster | |||
# The directory where the generated proto output will be written. | |||
# The directory is relative to where the generation tool was run. | |||
out: proto | |||
# Set options to assign import paths to the well-known types | |||
# and to enable service generation. | |||
opt: Mgoogle/protobuf/timestamp.proto=github.com/gogo/protobuf/types,Mgoogle/protobuf/duration.proto=github.com/golang/protobuf/ptypes/duration,plugins=grpc,paths=source_relative |
@ -0,0 +1,16 @@ | |||
version: v1beta1 | |||
build: | |||
roots: | |||
- proto | |||
- third_party/proto | |||
lint: | |||
use: | |||
- BASIC | |||
- FILE_LOWER_SNAKE_CASE | |||
- UNARY_RPC | |||
ignore: | |||
- gogoproto | |||
breaking: | |||
use: | |||
- FILE |
@ -0,0 +1,25 @@ | |||
# This Dockerfile defines an image containing tools for linting, formatting, | |||
# and compiling the Tendermint protos. | |||
FROM bufbuild/buf:latest as buf | |||
FROM golang:1.17-alpine | |||
# Install a commonly used set of programs for use with our protos. | |||
# clang-extra-tools is included here because it provides clang-format, | |||
# used to format the .proto files. | |||
RUN apk add --update --no-cache build-base clang-extra-tools curl git && \ | |||
apk add --update --no-cache build-base clang-extra-tools curl git go && \ | |||
rm -rf /var/cache/apk/* | |||
ENV GOLANG_PROTOBUF_VERSION=1.3.1 \ | |||
GOGO_PROTOBUF_VERSION=1.3.2 | |||
# Retrieve the go protoc programs and copy them into the PATH | |||
RUN go install github.com/golang/protobuf/protoc-gen-go@v${GOLANG_PROTOBUF_VERSION} && \ | |||
go install github.com/gogo/protobuf/protoc-gen-gogo@v${GOGO_PROTOBUF_VERSION} && \ | |||
go install github.com/gogo/protobuf/protoc-gen-gogofaster@v${GOGO_PROTOBUF_VERSION} && \ | |||
mv "$(go env GOPATH)"/bin/* /usr/local/bin/ | |||
# Copy the 'buf' program out of the buildbuf/buf container. | |||
COPY --from=buf /usr/local/bin/* /usr/local/bin/ |
@ -0,0 +1,7 @@ | |||
syntax = "proto3"; | |||
package tendermint.libs.bits; | |||
message BitArray { | |||
int64 bits = 1; | |||
repeated uint64 elems = 2; | |||
} |
@ -0,0 +1,147 @@ | |||
// Protocol Buffers for Go with Gadgets | |||
// | |||
// Copied from https://github.com/gogo/protobuf/blob/master/gogoproto/gogo.proto | |||
// | |||
// Copyright (c) 2013, The GoGo Authors. All rights reserved. | |||
// http://github.com/gogo/protobuf | |||
// | |||
// Redistribution and use in source and binary forms, with or without | |||
// modification, are permitted provided that the following conditions are | |||
// met: | |||
// | |||
// * Redistributions of source code must retain the above copyright | |||
// notice, this list of conditions and the following disclaimer. | |||
// * Redistributions in binary form must reproduce the above | |||
// copyright notice, this list of conditions and the following disclaimer | |||
// in the documentation and/or other materials provided with the | |||
// distribution. | |||
// | |||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |||
syntax = "proto2"; | |||
package gogoproto; | |||
import "google/protobuf/descriptor.proto"; | |||
option java_package = "com.google.protobuf"; | |||
option java_outer_classname = "GoGoProtos"; | |||
option go_package = "github.com/gogo/protobuf/gogoproto"; | |||
extend google.protobuf.EnumOptions { | |||
optional bool goproto_enum_prefix = 62001; | |||
optional bool goproto_enum_stringer = 62021; | |||
optional bool enum_stringer = 62022; | |||
optional string enum_customname = 62023; | |||
optional bool enumdecl = 62024; | |||
} | |||
extend google.protobuf.EnumValueOptions { | |||
optional string enumvalue_customname = 66001; | |||
} | |||
extend google.protobuf.FileOptions { | |||
optional bool goproto_getters_all = 63001; | |||
optional bool goproto_enum_prefix_all = 63002; | |||
optional bool goproto_stringer_all = 63003; | |||
optional bool verbose_equal_all = 63004; | |||
optional bool face_all = 63005; | |||
optional bool gostring_all = 63006; | |||
optional bool populate_all = 63007; | |||
optional bool stringer_all = 63008; | |||
optional bool onlyone_all = 63009; | |||
optional bool equal_all = 63013; | |||
optional bool description_all = 63014; | |||
optional bool testgen_all = 63015; | |||
optional bool benchgen_all = 63016; | |||
optional bool marshaler_all = 63017; | |||
optional bool unmarshaler_all = 63018; | |||
optional bool stable_marshaler_all = 63019; | |||
optional bool sizer_all = 63020; | |||
optional bool goproto_enum_stringer_all = 63021; | |||
optional bool enum_stringer_all = 63022; | |||
optional bool unsafe_marshaler_all = 63023; | |||
optional bool unsafe_unmarshaler_all = 63024; | |||
optional bool goproto_extensions_map_all = 63025; | |||
optional bool goproto_unrecognized_all = 63026; | |||
optional bool gogoproto_import = 63027; | |||
optional bool protosizer_all = 63028; | |||
optional bool compare_all = 63029; | |||
optional bool typedecl_all = 63030; | |||
optional bool enumdecl_all = 63031; | |||
optional bool goproto_registration = 63032; | |||
optional bool messagename_all = 63033; | |||
optional bool goproto_sizecache_all = 63034; | |||
optional bool goproto_unkeyed_all = 63035; | |||
} | |||
extend google.protobuf.MessageOptions { | |||
optional bool goproto_getters = 64001; | |||
optional bool goproto_stringer = 64003; | |||
optional bool verbose_equal = 64004; | |||
optional bool face = 64005; | |||
optional bool gostring = 64006; | |||
optional bool populate = 64007; | |||
optional bool stringer = 67008; | |||
optional bool onlyone = 64009; | |||
optional bool equal = 64013; | |||
optional bool description = 64014; | |||
optional bool testgen = 64015; | |||
optional bool benchgen = 64016; | |||
optional bool marshaler = 64017; | |||
optional bool unmarshaler = 64018; | |||
optional bool stable_marshaler = 64019; | |||
optional bool sizer = 64020; | |||
optional bool unsafe_marshaler = 64023; | |||
optional bool unsafe_unmarshaler = 64024; | |||
optional bool goproto_extensions_map = 64025; | |||
optional bool goproto_unrecognized = 64026; | |||
optional bool protosizer = 64028; | |||
optional bool compare = 64029; | |||
optional bool typedecl = 64030; | |||
optional bool messagename = 64033; | |||
optional bool goproto_sizecache = 64034; | |||
optional bool goproto_unkeyed = 64035; | |||
} | |||
extend google.protobuf.FieldOptions { | |||
optional bool nullable = 65001; | |||
optional bool embed = 65002; | |||
optional string customtype = 65003; | |||
optional string customname = 65004; | |||
optional string jsontag = 65005; | |||
optional string moretags = 65006; | |||
optional string casttype = 65007; | |||
optional string castkey = 65008; | |||
optional string castvalue = 65009; | |||
optional bool stdtime = 65010; | |||
optional bool stdduration = 65011; | |||
optional bool wktpointer = 65012; | |||
optional string castrepeated = 65013; | |||
} |