blob: 4653a13eb721959cff4cd8231b245b6259ecb9c4 [file] [log] [blame]
Zack Williams43bfd9e2019-04-12 13:09:31 -07001#!/usr/bin/env bash
William Kurkianad745652019-03-20 08:45:51 -04002
Joey Armstronge6cdd8e2022-12-29 11:58:15 -05003# Copyright 2018-2023 Open Networking Foundation (ONF) and the ONF Contributors
William Kurkianad745652019-03-20 08:45:51 -04004#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
Zack Williams43bfd9e2019-04-12 13:09:31 -070016
17# test-go-proto-consistency.sh
18#
19# This test validates that go proto outputs are committed to git. It does this
20# by regenerating them and validating whether git thinks they are the same. If
21# they become out of sync, there can be problems for consumers of the protos.
22
23set -eu -o pipefail
24
William Kurkianad745652019-03-20 08:45:51 -040025git status > /dev/null
26STAGED="$(git diff-index --quiet HEAD -- || echo 'staged')"
27UNTRACKED="$(git ls-files --exclude-standard --others)"
28
29if [ "$STAGED" == "staged" ] || [ "$UNTRACKED" != "" ]; then
30 echo "Please commit or ignore local changes before executing this test"
William Kurkian1b65c912019-07-10 09:01:24 -040031 git status
William Kurkianad745652019-03-20 08:45:51 -040032 exit 1
33fi
34
Joey Armstrong670d40c2023-05-11 20:49:26 -040035# TODO: Move this into the make clean target for one stop shopping.
Zack Williams43bfd9e2019-04-12 13:09:31 -070036# delete and regenerate go protos
37rm -rf go/voltha.pb go/*/*.pb.go go_temp
Joey Armstrong670d40c2023-05-11 20:49:26 -040038
39echo "$0: make go-protos: ENTER"
William Kurkianad745652019-03-20 08:45:51 -040040make go-protos
Joey Armstrong670d40c2023-05-11 20:49:26 -040041echo "$0: make go-protos: LEAVE"
William Kurkianad745652019-03-20 08:45:51 -040042
43# Running git status ensures correct git diff-index picks up changes
44git status > /dev/null
William Kurkianad745652019-03-20 08:45:51 -040045STAGED_POST="$(git diff-index --quiet HEAD -- || echo "staged")"
46UNTRACKED_POST="$(git ls-files --exclude-standard --others)"
47
48if [ "$STAGED_POST" == "staged" ] || [ "$UNTRACKED_POST" != "" ] ; then
49 echo "You have go proto build outputs that are not committed."
50 echo "Check git status and commit updated files."
William Kurkian1b65c912019-07-10 09:01:24 -040051 git status
William Kurkianad745652019-03-20 08:45:51 -040052 exit 1
53else
54 echo "Test successful. All go proto build outputs are committed"
55 exit 0
56fi
Joey Armstrong670d40c2023-05-11 20:49:26 -040057
58# [EOF]