[pacman-dev] [PATCH v6 1/2] libmakepkg: lint disallowed variables in package()

[morganamilo]

makepkg will now error if disallowed variables are set inside of
the package function.

Disallowed variables are variables that do exist, like 'makedepends'
and 'pkgver' but can not be set inside of a package function.

Signed-off-by: morganamilo <morganamilo at gmail.com>
---

v5:
        Move this lint to its own file.

v6:
	"libmakepkg: add exists_function_variable helper" was squashed
	into this commit.

	Fixups and rebase against master

 scripts/Makefile.am                           |  1 +
 scripts/libmakepkg/lint_pkgbuild/meson.build  |  1 +
 .../package_function_variable.sh.in           | 62 +++++++++++++++++++
 scripts/libmakepkg/util/pkgbuild.sh.in        |  9 +++
 4 files changed, 73 insertions(+)
 create mode 100644 scripts/libmakepkg/lint_pkgbuild/package_function_variable.sh.in

diff --git a/scripts/Makefile.am b/scripts/Makefile.am
index 0e5619bd..f84fda1d 100644
--- a/scripts/Makefile.am
+++ b/scripts/Makefile.am
@@ -92,6 +92,7 @@ LIBMAKEPKG_IN = \
 	libmakepkg/lint_pkgbuild/optdepends.sh \
 	libmakepkg/lint_pkgbuild/options.sh \
 	libmakepkg/lint_pkgbuild/package_function.sh \
+	libmakepkg/lint_pkgbuild/package_function_variable.sh \
 	libmakepkg/lint_pkgbuild/pkgbase.sh \
 	libmakepkg/lint_pkgbuild/pkglist.sh \
 	libmakepkg/lint_pkgbuild/pkgname.sh \
diff --git a/scripts/libmakepkg/lint_pkgbuild/meson.build b/scripts/libmakepkg/lint_pkgbuild/meson.build
index 4ca414e4..f699a8e2 100644
--- a/scripts/libmakepkg/lint_pkgbuild/meson.build
+++ b/scripts/libmakepkg/lint_pkgbuild/meson.build
@@ -14,6 +14,7 @@ sources = [
   'optdepends.sh.in',
   'options.sh.in',
   'package_function.sh.in',
+  'package_function_variable.sh.in',
   'pkgbase.sh.in',
   'pkglist.sh.in',
   'pkgname.sh.in',
diff --git a/scripts/libmakepkg/lint_pkgbuild/package_function_variable.sh.in b/scripts/libmakepkg/lint_pkgbuild/package_function_variable.sh.in
new file mode 100644
index 00000000..172e0a08
--- /dev/null
+++ b/scripts/libmakepkg/lint_pkgbuild/package_function_variable.sh.in
@@ -0,0 +1,62 @@
+#!/bin/bash
+#
+#   package_function_variable.sh - Check variables inside the package function.
+#
+#   Copyright (c) 2014-2018 Pacman Development Team <pacman-dev at archlinux.org>
+#
+#   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, see <http://www.gnu.org/licenses/>.
+#
+
+[[ -n "$LIBMAKEPKG_LINT_PKGBUILD_PACKAGE_FUNCTION_VARIABLE_SH" ]] && return
+LIBMAKEPKG_LINT_PKGBUILD_PACKAGE_FUNCTION_VARIABLE_SH=1
+
+LIBRARY=${LIBRARY:-'@libmakepkgdir@'}
+
+source "$LIBRARY/util/message.sh"
+source "$LIBRARY/util/pkgbuild.sh"
+source "$LIBRARY/util/schema.sh"
+source "$LIBRARY/util/util.sh"
+
+
+lint_pkgbuild_functions+=('lint_package_function_variable')
+
+
+lint_package_function_variable() {
+	local i a pkg ret=0
+
+	# package function variables
+	for pkg in ${pkgname[@]}; do
+		for a in ${arch[@]}; do
+			[[ $a == "any" ]] && continue
+
+			for i in ${pkgbuild_schema_arrays[@]} ${pkgbuild_schema_strings[@]}; do
+				in_array "$i" ${pkgbuild_schema_package_overrides[@]} && continue
+				if exists_function_variable "package_$pkg" "${i}_${a}"; then
+					error "$(gettext "%s can not be set inside a package function")" "${i}_${a}"
+					ret=1
+				fi
+			done
+		done
+
+		for i in ${pkgbuild_schema_arrays[@]} ${pkgbuild_schema_strings[@]}; do
+			in_array "$i" ${pkgbuild_schema_package_overrides[@]} && continue
+			if exists_function_variable "package_$pkg" "$i"; then
+				error "$(gettext "%s can not be set inside a package function")" "$i"
+				ret=1
+			fi
+		done
+	done
+
+	return $ret
+}
diff --git a/scripts/libmakepkg/util/pkgbuild.sh.in b/scripts/libmakepkg/util/pkgbuild.sh.in
index 0dc239d1..298275a8 100644
--- a/scripts/libmakepkg/util/pkgbuild.sh.in
+++ b/scripts/libmakepkg/util/pkgbuild.sh.in
@@ -100,6 +100,15 @@ extract_function_variable() {
 	return $r
 }
 
+exists_function_variable() {
+	# $1: function name
+	# $2: variable name
+
+	local funcname=$1 attr=$2 out
+	extract_function_variable "$funcname" "$attr" 0 out ||
+		extract_function_variable "$funcname" "$attr" 1 out
+}
+
 get_pkgbuild_attribute() {
 	# $1: package name
 	# $2: attribute name
-- 
2.20.1