This is an automated email from the ASF dual-hosted git repository.
aw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yetus.git
The following commit(s) were added to refs/heads/master by this push:
new de5900d YETUS-880. add support for prototool lint (#62)
de5900d is described below
commit de5900dfb85f8f44dd47397164db8a77944436e5
Author: Allen Wittenauer <a...@apache.org>
AuthorDate: Tue May 28 18:15:00 2019 -0700
YETUS-880. add support for prototool lint (#62)
---
.../documentation/in-progress/precommit-basic.md | 1 +
.../src/main/shell/test-patch-docker/Dockerfile | 1 +
precommit/src/main/shell/test-patch.d/prototool.sh | 176 +++++++++++++++++++++
3 files changed, 178 insertions(+)
diff --git a/asf-site-src/source/documentation/in-progress/precommit-basic.md
b/asf-site-src/source/documentation/in-progress/precommit-basic.md
index 2abcf83..004782a 100644
--- a/asf-site-src/source/documentation/in-progress/precommit-basic.md
+++ b/asf-site-src/source/documentation/in-progress/precommit-basic.md
@@ -128,6 +128,7 @@ Language Support, Licensing, and more:
* [jshint](https://jshint.com) installed
* [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli)
installed
* [Perl::Critic](https://perlcritic.com/) installed
+* [prototool](https://github.com/uber/prototool) installed
* [pylint](https://www.pylint.org/) installed
* [revive](https://github.com/mgechev/revive) installed
* [rubocop](https://batsov.com/rubocop/) installed
diff --git a/precommit/src/main/shell/test-patch-docker/Dockerfile
b/precommit/src/main/shell/test-patch-docker/Dockerfile
index 5be929b..ec7430b 100644
--- a/precommit/src/main/shell/test-patch-docker/Dockerfile
+++ b/precommit/src/main/shell/test-patch-docker/Dockerfile
@@ -259,6 +259,7 @@ RUN add-apt-repository -y ppa:longsleep/golang-backports \
RUN go get -u github.com/mgechev/revive \
&& go get -u github.com/mrtazz/checkmake \
&& (GO111MODULE=on go get
github.com/golangci/golangci-lint/cmd/golangci-lint@v1.16.0) \
+ && (GO111MODULE=on go get
github.com/uber/prototool/cmd/prototool@6a473a4f1d86e7c8ff6a844d7dc4f7c3f6207a3f)
\
&& mv /root/go/bin/* /usr/local/bin \
&& rm -rf /root/go
diff --git a/precommit/src/main/shell/test-patch.d/prototool.sh
b/precommit/src/main/shell/test-patch.d/prototool.sh
new file mode 100755
index 0000000..913d0b1
--- /dev/null
+++ b/precommit/src/main/shell/test-patch.d/prototool.sh
@@ -0,0 +1,176 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# SHELLDOC-IGNORE
+
+add_test_type prototool
+
+PROTOTOOL_TIMER=0
+
+PROTOTOOL=${PROTOTOOL:-$(command -v prototool 2>/dev/null)}
+
+function prototool_usage
+{
+ yetus_add_option "--prototool=<path>" "path to prototool executable
(default: ${PROTOTOOL})"
+}
+
+function prototool_parse_args
+{
+ local i
+
+ for i in "$@"; do
+ case ${i} in
+ --prototool=*)
+ delete_parameter "${i}"
+ PROTOTOOL=${i#*=}
+ ;;
+ esac
+ done
+}
+
+function prototool_filefilter
+{
+ local filename=$1
+
+ if [[ ${filename} =~ \.proto$ ]] ||
+ [[ "${filename}" =~ prototool\.json$ ]] ||
+ [[ "${filename}" =~ prototool\.yaml$ ]]; then
+ add_test prototool
+ fi
+}
+
+function prototool_precheck
+{
+ if ! verify_command "prototool" "${PROTOTOOL}"; then
+ add_vote_table 0 prototool "prototool was not available."
+ delete_test prototool
+ fi
+
+ # shellcheck disable=SC2016
+ PROTOTOOL_VERSION=$("${PROTOTOOL}" version 2>/dev/null | "${GREP}" Version |
"${AWK}" '{print $NF}')
+ add_version_data prototool "${PROTOTOOL_VERSION}"
+}
+
+function prototool_executor
+{
+ declare repostatus=$1
+ declare prototoolStderr=${repostatus}-prototool-stderr.txt
+ declare -a args
+
+ if ! verify_needed_test prototool; then
+ return 0
+ fi
+
+ big_console_header "prototool plugin: ${BUILDMODE}"
+
+ start_clock
+
+ # add our previous elapsed to our new timer
+ # by setting the clock back
+ offset_clock "${PROTOTOOL_TIMER}"
+
+ echo "Running prototool against identified protobuf files."
+ if [[ -n "${EXCLUDE_PATHS_FILE}" ]] && [[ -f "${EXCLUDE_PATHS_FILE}" ]]; then
+ args=("${GREP}" "-v" "-E" "-f" "${EXCLUDE_PATHS_FILE}")
+ else
+ args=("cat")
+ fi
+
+ pushd "${BASEDIR}" >/dev/null || return 1
+ "${PROTOTOOL}" lint 2> "${PATCH_DIR}/${prototoolStderr}" | \
+ "${args[@]}" > "${PATCH_DIR}/${repostatus}-prototool-result.txt"
+ popd >/dev/null || return 1
+
+ if [[ -f ${PATCH_DIR}/${prototoolStderr} ]] && [[ -s "${prototoolStderr}"
]]; then
+ add_vote_table -1 prototool "Error running prototool. Please check
prototool stderr files."
+ add_footer_table prototool "@@BASE@@/${prototoolStderr}"
+ return 1
+ fi
+ rm "${PATCH_DIR}/${prototoolStderr}" 2>/dev/null
+ return 0
+}
+
+
+function prototool_preapply
+{
+ declare retval
+
+ if ! verify_needed_test prototool; then
+ return 0
+ fi
+
+ prototool_executor "branch"
+ retval=$?
+
+ # keep track of how much as elapsed for us already
+ PROTOTOOL_TIMER=$(stop_clock)
+ return ${retval}
+}
+
+function prototool_postapply
+{
+ declare numPrepatch
+ declare numPostpatch
+ declare diffPostpatch
+ declare fixedpatch
+ declare statstring
+
+ if ! verify_needed_test prototool; then
+ return 0
+ fi
+
+ prototool_executor patch
+
+ calcdiffs "${PATCH_DIR}/branch-prototool-result.txt" \
+ "${PATCH_DIR}/patch-prototool-result.txt" \
+ prototool > "${PATCH_DIR}/diff-patch-prototool.txt"
+
+ # shellcheck disable=SC2016
+ numPrepatch=$(wc -l "${PATCH_DIR}/branch-prototool-result.txt" | "${AWK}"
'{print $1}')
+
+ # shellcheck disable=SC2016
+ numPostpatch=$(wc -l "${PATCH_DIR}/patch-prototool-result.txt" | "${AWK}"
'{print $1}')
+
+ # shellcheck disable=SC2016
+ diffPostpatch=$(wc -l "${PATCH_DIR}/diff-patch-prototool.txt" | "${AWK}"
'{print $1}')
+
+ ((fixedpatch=numPrepatch-numPostpatch+diffPostpatch))
+
+ statstring=$(generic_calcdiff_status "${numPrepatch}" "${numPostpatch}"
"${diffPostpatch}" )
+
+ if [[ ${diffPostpatch} -gt 0 ]] ; then
+ add_vote_table -1 prototool "${BUILDMODEMSG} ${statstring}"
+ add_footer_table prototool "@@BASE@@/diff-patch-prototool.txt"
+ return 1
+ elif [[ ${fixedpatch} -gt 0 ]]; then
+ add_vote_table +1 prototool "${BUILDMODEMSG} ${statstring}"
+ return 0
+ fi
+
+ add_vote_table +1 prototool "There were no new prototool issues."
+ return 0
+}
+
+function prototool_postcompile
+{
+ declare repostatus=$1
+
+ if [[ "${repostatus}" = branch ]]; then
+ prototool_preapply
+ else
+ prototool_postapply
+ fi
+}
