aboutsummaryrefslogtreecommitdiff
path: root/externals/mbedtls/tests/scripts/check-names.sh
diff options
context:
space:
mode:
Diffstat (limited to 'externals/mbedtls/tests/scripts/check-names.sh')
-rwxr-xr-xexternals/mbedtls/tests/scripts/check-names.sh148
1 files changed, 148 insertions, 0 deletions
diff --git a/externals/mbedtls/tests/scripts/check-names.sh b/externals/mbedtls/tests/scripts/check-names.sh
new file mode 100755
index 0000000000..c6a200854b
--- /dev/null
+++ b/externals/mbedtls/tests/scripts/check-names.sh
@@ -0,0 +1,148 @@
+#!/bin/sh
+#
+# Copyright The Mbed TLS Contributors
+# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
+#
+# This file is provided under the Apache License 2.0, or the
+# GNU General Public License v2.0 or later.
+#
+# **********
+# Apache License 2.0:
+#
+# Licensed 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.
+#
+# **********
+#
+# **********
+# GNU General Public License v2.0 or later:
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# **********
+
+set -eu
+
+if [ $# -ne 0 ] && [ "$1" = "--help" ]; then
+ cat <<EOF
+$0 [-v]
+This script confirms that the naming of all symbols and identifiers in mbed
+TLS are consistent with the house style and are also self-consistent.
+
+ -v If the script fails unexpectedly, print a command trace.
+EOF
+ exit
+fi
+
+trace=
+if [ $# -ne 0 ] && [ "$1" = "-v" ]; then
+ shift
+ trace='-x'
+ exec 2>check-names.err
+ trap 'echo "FAILED UNEXPECTEDLY, status=$?";
+ cat check-names.err' EXIT
+ set -x
+fi
+
+printf "Analysing source code...\n"
+
+sh $trace tests/scripts/list-macros.sh
+tests/scripts/list-enum-consts.pl
+sh $trace tests/scripts/list-identifiers.sh
+sh $trace tests/scripts/list-symbols.sh
+
+FAIL=0
+
+printf "\nExported symbols declared in header: "
+UNDECLARED=$( diff exported-symbols identifiers | sed -n -e 's/^< //p' )
+if [ "x$UNDECLARED" = "x" ]; then
+ echo "PASS"
+else
+ echo "FAIL"
+ echo "$UNDECLARED"
+ FAIL=1
+fi
+
+diff macros identifiers | sed -n -e 's/< //p' > actual-macros
+
+for THING in actual-macros enum-consts; do
+ printf 'Names of %s: ' "$THING"
+ test -r $THING
+ BAD=$( grep -v '^MBEDTLS_[0-9A-Z_]*[0-9A-Z]$' $THING || true )
+ if [ "x$BAD" = "x" ]; then
+ echo "PASS"
+ else
+ echo "FAIL"
+ echo "$BAD"
+ FAIL=1
+ fi
+done
+
+for THING in identifiers; do
+ printf 'Names of %s: ' "$THING"
+ test -r $THING
+ BAD=$( grep -v '^mbedtls_[0-9a-z_]*[0-9a-z]$' $THING || true )
+ if [ "x$BAD" = "x" ]; then
+ echo "PASS"
+ else
+ echo "FAIL"
+ echo "$BAD"
+ FAIL=1
+ fi
+done
+
+printf "Likely typos: "
+sort -u actual-macros enum-consts > _caps
+HEADERS=$( ls include/mbedtls/*.h | egrep -v 'compat-1\.3\.h' )
+NL='
+'
+sed -n 's/MBED..._[A-Z0-9_]*/\'"$NL"'&\'"$NL"/gp \
+ $HEADERS library/*.c \
+ | grep MBEDTLS | sort -u > _MBEDTLS_XXX
+TYPOS=$( diff _caps _MBEDTLS_XXX | sed -n 's/^> //p' \
+ | egrep -v 'XXX|__|_$|^MBEDTLS_.*CONFIG_FILE$' || true )
+rm _MBEDTLS_XXX _caps
+if [ "x$TYPOS" = "x" ]; then
+ echo "PASS"
+else
+ echo "FAIL"
+ echo "$TYPOS"
+ FAIL=1
+fi
+
+if [ -n "$trace" ]; then
+ set +x
+ trap - EXIT
+ rm check-names.err
+fi
+
+printf "\nOverall: "
+if [ "$FAIL" -eq 0 ]; then
+ rm macros actual-macros enum-consts identifiers exported-symbols
+ echo "PASSED"
+ exit 0
+else
+ echo "FAILED"
+ exit 1
+fi